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