Naming Nomenclature

Note:

All the resource tags and names should be written in lowercase.
Use “-” to separate two words in the resource name.

Legend:

Key	Description
`<<customer_initials>>`	Initials for customer name, anything they want as a prefix across all resources globally. (eg: cornerstone – `cr`)
`<<env>>`	`mgmt` / `dev` / `uat` / `preprod` / `prod` / `test`
`<<region_short_code>>`	Region short code can be kept as `as2` for (asia-south2), `as1` for (asia-south1) and `ew1` for (europe-west1)
`<<random-id>>`	Random-id can be 4 letter words or 2–3 digit numbers (`01`, `02` or `001`, `002`)
`<<use_case>>`	Short use case for the resources created (eg: `jenkins-to-sonar`, `gcp-to-aws`)
`<<app_name>>`	Application name (eg: `jenkins`, `vault`, `nucleus`)

Resources	Naming Convention
Projects	Eg: `cr-bc-<<env>>-data` `cr-network-<<env>>-<<use_case>>` `cr-security-<<env>>-<<use_case>>`
VPC	`<<customer_initials>>-vpc-<<env>>` Eg: `cr-vpc-prod`, `cr-vpc-dev`
Subnets	`<<customer_initials>>-subnet-<<env>>-<<subnet_type>>-<<region_short_code>>` Eg: `cr-subnet-prod-app-uc1`
Router	`<<customer_initials>>-cr-<<env>>-<<use_case>>-<<region_short_code>>` Eg: `cr-cr-prod-gcp-to-aws-uc1`
NAT	`<<customer_initials>>-nat-<<env>>-<<use_case>>-<<region_short_code>>` Eg: `cr-nat-prod-gcp-to-aws-uc1`
Service Account	`<<customer_initials>>-sa-<<env>>-<<app_name>>` Eg: `cr-sa-prod-gitlab` App Service Account: `<<customer_initials>>-sa-<<env>>-<<app_name>>` Eg: `cr-sa-prod-<<app>>`
Buckets	`<<customer_initials>>-bucket-<<env>>-<<app_name>>` Eg: `cr-bucket-prod-tfstate`
VMs	`<<customer_initials>>-vm-<<env>>-<<app_name>>-<<region_short_code>>-<<random-id>>` Eg: `cr-vm-prod-jenkins-uc1-01`
Cloud Run	`<<customer_initials>>-<<app_name>>` Eg: `cr-app-plane`
Disks	`<<customer_initials>>-pd-<<env>>-<<app_name>>-<<region_short_code>>-<<random-id>>` Eg: `cr-pd-prod-jenkins-uc1-01`
Cloud SQL	`<<customer_initials>>-db-<<env>>-<<app_name>>-<<region_short_code>>-<<random-id>>` Eg: `cr-db-prod-sonar-uc1-01`
Firewall	`<<customer_initials>>-fw-<<env>>-<<use_case>>-<<region_short_code>>` Eg: `cr-fw-prod-jenkins-to-gitlab-uc1`
IP Address	`<<customer_initials>>-ip-<<env>>-<<use_case>>-<<region_short_code>>` Eg: `cr-ip-prod-jenkins-uc1`
GKE	`<<customer_initials>>-gke-<<env>>-<<use_case>>-<<region_short_code>>` Eg: `cr-gke-prod-uc1`, `cr-gke-prod-apps-uc1`
Load Balancer	`<<customer_initials>>-lb-<<env>>-<<app_name or use_case>>-<<region_short_code>>` Eg: `cr-lb-prod-gke-cluster-uc1`
VPN Gateway	`<<customer_initials>>-vpn-gw-<<source>>-<<destination>>-<<region_short_code>>-<<random-id>>` Eg: `cr-vpn-gw-gcp-onprem-colo-uc1-01`
VPN Tunnel	`<<customer_initials>>-vpn-tn-<<source>>-<<destination>>-<<region_short_code>>-<<random-id>>` Eg: `cr-vpn-tn-gcp-onprem-colo-uc1-01`
Artifact Registry	`<<customer_initials>>-ar-<<env>>-<<use_case>>-<<region_short_code>>` Eg: `cr-ar-prod-app-uc1`
Interconnect	`<<customer_initials>>-ic-<<source>>-to-<<destination>>-<<use_case>>-<<random-id>>` Eg: `cr-ic-gcp-to-onprem-01`
Interconnect Attachment	`<<customer_initials>>-vlan-<<use_case>>-<<random-id>>` Eg: `cr-vlan-gcp-to-onprem-01`
VPC Peering	`<<customer_initials>>-vpc-peer-<<vpc_1>>-to-<<vpc_2>>` Eg: `cr-vpc-peer-prod-transit-to-prod`

Common Labels for resources:

Key	Value
env	`mgmt` / `dev` / `qa` / `preprod` / `prod`
account	`cr-mgmt-apps`, `cr-dev-apps`
name	`<<resource_name>>` Eg: `cr-vm-mgmt-vault-as2-01`
pod_name	`devops` / `pre-terms` / `post-terms` / `customer-support` / etc
business_unit (Namespace)	`cxg` / `sbg` / `edg` / etc
app_name	`jenkins`, `vault`, `buddy-api`, `buddy-ui`, `website-nginx`, `app-nginx`, etc