foomo-docs/assets/js/c7c8c3b9.5c1a0196.js

"use strict";(self.webpackChunkfoomo=self.webpackChunkfoomo||[]).push([[1647],{3905:(e,t,n)=>{n.d(t,{Zo:()=>p,kt:()=>f});var r=n(7294);function o(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function s(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function i(e){for(var t=1;t<arguments.length;t++){var n=null!=arguments[t]?arguments[t]:{};t%2?s(Object(n),!0).forEach((function(t){o(e,t,n[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(n)):s(Object(n)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(n,t))}))}return e}function a(e,t){if(null==e)return{};var n,r,o=function(e,t){if(null==e)return{};var n,r,o={},s=Object.keys(e);for(r=0;r<s.length;r++)n=s[r],t.indexOf(n)>=0||(o[n]=e[n]);return o}(e,t);if(Object.getOwnPropertySymbols){var s=Object.getOwnPropertySymbols(e);for(r=0;r<s.length;r++)n=s[r],t.indexOf(n)>=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(o[n]=e[n])}return o}var c=r.createContext({}),u=function(e){var t=r.useContext(c),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},p=function(e){var t=u(e.components);return r.createElement(c.Provider,{value:t},e.children)},l={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var n=e.components,o=e.mdxType,s=e.originalType,c=e.parentName,p=a(e,["components","mdxType","originalType","parentName"]),m=u(n),f=o,d=m["".concat(c,".").concat(f)]||m[f]||l[f]||s;return n?r.createElement(d,i(i({ref:t},p),{},{components:n})):r.createElement(d,i({ref:t},p))}));function f(e,t){var n=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var s=n.length,i=new Array(s);i[0]=m;var a={};for(var c in t)hasOwnProperty.call(t,c)&&(a[c]=t[c]);a.originalType=e,a.mdxType="string"==typeof e?e:o,i[1]=a;for(var u=2;u<s;u++)i[u]=n[u];return r.createElement.apply(null,i)}return r.createElement.apply(null,n)}m.displayName="MDXCreateElement"},9135:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>i,default:()=>l,frontMatter:()=>s,metadata:()=>a,toc:()=>u});var r=n(7462),o=(n(7294),n(3905));const s={sidebar_label:"Conventions"},i="Conventions",a={unversionedId:"devops/infrastructure/conventions",id:"devops/infrastructure/conventions",title:"Conventions",description:"When creating resources the most important thing is to be consistent.",source:"@site/docs/devops/infrastructure/conventions.md",sourceDirName:"devops/infrastructure",slug:"/devops/infrastructure/conventions",permalink:"/docs/devops/infrastructure/conventions",draft:!1,editUrl:"https://github.com/foomo/foomo-docs/tree/main/foomo/docs/devops/infrastructure/conventions.md",tags:[],version:"current",frontMatter:{sidebar_label:"Conventions"},sidebar:"devopsSidebar",previous:{title:"Jaeger",permalink:"/docs/devops/monitoring/jaeger"},next:{title:"Bookmarks",permalink:"/docs/devops/bookmarks"}},c={},u=[],p={toc:u};function l(e){let{components:t,...n}=e;return(0,o.kt)("wrapper",(0,r.Z)({},p,n,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("h1",{id:"conventions"},"Conventions"),(0,o.kt)("p",null,"When creating resources the most important thing is to be consistent."),(0,o.kt)("h1",{id:"resource-naming-conventions"},"Resource Naming Conventions"),(0,o.kt)("p",null,"The following resource convention is preferred if no other exist in the project:"),(0,o.kt)("p",null,(0,o.kt)("inlineCode",{parentName:"p"},"[customer*]-[project]-[resource*]-[env*]-[name*]-[region/location]-[index]")),(0,o.kt)("p",null,"The fields with a * are required."),(0,o.kt)("p",null,"Legend:"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre"},"customer:          bestbytes, foomo\nproject:           hmd\nreqource:          s3, pql, vpc\nenv:               prod, stage, dev, int, test\nname:              default, general, catalogue-backend\nregion/location:   region for this resource if it's region specific\nindex:             numbering of the resource, starting from 1 (3 numbers, leading zeros)\n")),(0,o.kt)("p",null,"Examples:"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre"},"# Foomo customer s3 bucket for prod environment with the described role (catalogue-backend/site-images)\nfoomo-s3-prod-NAME\n\n    - foomo-s3-prod-catalogue-backend\n    - foomo-s3-prod-site-images\n\n# Foomo customer VPC for stage environment with the described role (default/mongodb)\nfoomo-vpc-stage-NAME\n\n    - foomo-vpc-stage-default\n    - foomo-vpc-stage-mongodb\n\n# Bestbytes customer for HMD project, postgresql instance for stage environment and default usage\nbestbytes-hmd-pql-stage-default\n    \n# Bestbytes customer VPN Tunnel #1 in the stage environment for externalcustomer with numbering\nbestbytes-vpt-stage-externalcustomer-001\n")))}l.isMDXComponent=!0}}]);