Naming Cloud Resources Standards · CLOUD-01

Naming conventions for resources in a cloud provider play a crucial role in maintaining a well-organized and easily manageable environment. By adhering to these guidelines, we can ensure consistency, clarity, and efficiency across all Audacia projects both ones hosted by us and ones hosted by our clients.

Determine the appropriate naming convention based on the project’s context:

• For a new project or environment - use this naming convention.
• For an existing project or environment without a clear convention - use this naming convention for new resources.
• For an existing project or environment with a clear convention - use the existing naming convention.

Use names that accurately describe the resource’s purpose, function, or role. Avoid ambiguous or generic names that may lead to confusion or misinterpretation. Ensure names convey relevant information without being overly long or complex.

Example 1:

• Good: olympus-dev-vm
• Bad: vm1

Example 2:

• Good: olympus-dev-asp-functions
• Bad: app-service-plan

Example 3:

• Good: olympusdevst
• Bad: storageaccount

Establish a consistent naming convention that is applied uniformly across all resources. Include all relevant teams and stakeholders in the development of the naming standard to ensure buy-in and alignment.

Good:

• olympus-dev-asp-functions
• olympus-qa-asp-functions
• olympus-uat-asp-functions

Bad:

• olympus-dev-service-plan-functions
• olympus-qa-asp-functions
• olympus-uat-app-service-plan-functions

Stick to lowercase letters and numbers to avoid potential case sensitivity issues and ensure consistency. Avoid using special characters, spaces, or uppercase letters in resource names.

Include environment indicators to differentiate resources across development, production, staging, or testing environments. Use abbreviations or standardized keywords such as “dev”, “prod”, “staging” or “qa”.

Generic: {project}-{environment}-*

Examples:

• olympus-dev-*
• olympus-qa-*
• olympus-uat-*
• olympus-prod-*

Use the purpose and the type of the resource to categorize the resources based on their purpose, department, or function. Prefixes provide a quick way to identify resource types and aid in navigation and management.

Generic: {project}-{environment}-{purpose*}-{resource}-*

purpose*: A prefix indicating the purpose of the resource in the context of the system.

Examples:

• olympus-qa-portal-api
• olympus-qa-public-api
• olympus-qa-orders-func
• olympus-qa-timers-func
• olympus-qa-customers-sqldb
• olympus-qa-sales-sqldb
• olympus-qa-language-vnet
• olympus-qa-build-vnet

Include location indicators for resources deployed across multiple regions or geographical locations. Use standardized location abbreviations or keywords to maintain consistency.

Generic: {project}-{environment}-{resource}-{location}

• olympus-qa-sqldb-uksouth
• olympus-qa-sqldb-westeu
• olympus-qa-cosmos-westus
• olympus-qa-cosmos-usva

Keep resource names concise while maintaining clarity and conveying relevant information. Avoid excessively long or cryptic names that may hinder readability and management.

If the project requires a different naming convention this should be documented and distributed among relevant teams and stakeholders. Provide clear guidelines, examples, and explanations to ensure proper understanding and adoption of the naming standard. Conduct training or workshops to educate teams on the importance of adhering to the naming conventions.

Azure Resources

For Azure resources that are not in the above table, refer to here for guidance.