All AWS resources provisioned in MCAAS accounts will follow the naming and tagging convention outlined in the FAS Cloud Services Naming Standards Guide. The guide includes standards for naming VPC, Subnet, ELB, Auto Scaling Groups, Security Groups, EC2 Instances, Images, and IAM Policies.
Kubernetes Labels and Annotations
Kubernetes namespace configuration
NAME OF NAMESPACE | TYPE OF NAMESPACE | DESCRIPTION |
---|
<module>-<application>-<service> | Tenant application namespaces | MCAAS will leverage namespaces to separate applications deployed to the cluster. Enforcements of namespaces will be done by Helm charts provided to tenant developers’ teams. |
Besides Kubernetes namespaces, MCAAS will also leverage Kubernetes labels and annotations for resources management. All resources deployed in the cluster will and need to be properly tagged with required labels. Proper labeling will be enforced by Helm Charts provided to tenant developers’ teams. The following labels will need to be specified for resources deployed by tenant developers’ teams:
LABEL NAME | DESCRIPTION | EXAMPLE VALUE |
---|
tenant-short-code | The short code of the tenant | FAS |
module-short-code | The short code of the module | MOD1 |
application-short-code | The short code of the application | APP1 |
service-short-code | The short code of the service | SVC1 |
environment | The environment of residing application | Development, Test, Stage, Production |
git-commit-hash | The commit hash for specific git commit that created this resource | i-abcdefg12345 |
version | The version number | 1.1.123 |
tier | Which tier the app belongs to | app, web, batch jobs, cache |
Secrets naming convention
Below is the naming convention of tenants created secrets:
NAME | EXAMPLE |
---|
<tenant>-<module>-<service>-<Application>-<Secret-Name> | Tenant-Module1-development-App1-Credentials |
Github repository naming convention
NAME | EXAMPLE |
---|
<module>-<application>-<service> | module1-robotshop-web |