Naming Conventions
All resources deployed inside Black Lung’s Azure cloud environment abide by the same naming standards regardless of if they were created manually or through Terraform. This is done so that all developers can identify resource’s owners, purpose, and type simply by looking at its name. The design below includes resources deployed currently and historically that following Microsoft best practice recommendations.
Design
All resources deployed inside the Black Lung Azure environment utilizes the following parts in listed order. Each section is separated by ‘-’ when possible.
| Part | Length | Example | Description |
|---|---|---|---|
| Company | 3 | blk | This section contains information of which company the resource belongs to in the event Black Lung’s cloud grows into a multi-tenant environment. |
| Environment | 3-4 | dev | This section lists what environment/subscription the resource is located in. |
| Type | - | func | This section lists what type of azure resource the resource is. |
| Project | - | fleshwound | This section lists what project or purpose the resource is a part of or serves. |
| ID | 2 | 01 | This section serves as an ID for when multiple instances of the same resource might need to be created. |
Example blk-dev-pe-fleshwound-01
Company
| Entry | Company |
|---|---|
| blk | Black Lung Ink |
Environment
| Entry | Environment |
|---|---|
| dev | Development |
| prod | Production |
Resource Type
| Entry | Type |
|---|---|
| afd | azure front door |
| ep | end point |
| func | function app |
| og | origin group |
| origin | origin |
| pe | private endpoint |
| rg | resource group |
| route | route |
| sc | service connection |
| sec | security policy |
| snet | subnet |
| st | storage account |
| vnet | virtual network |
| waf | web application firewall policy |
ID
The Id is a two digit number, with the first digit representing how it was deployed, and the second being an identifying number.
| First Digit | Deployed… |
|---|---|
| 0 | Terraform |
| 1 | Manually |
| 2 | User Script |
For example, the resource blk-prod-func-battles-12 would be the second function app deployed manually for the ‘battles’ project.
Security
| Regulation | Requirement | Description | Compliance |
|---|---|---|---|
| PCI DSS v4 | 10.2.1 | Requires that resource names appearing in audit logs are consistent enough to trace an event to a specific system component. | Black Lung naming conventions complete this requirement by utilizing the above convention to achieve log viable consistency. |
Related
Microsoft - Define Your Naming Convention
Microsoft - Abbreviation Recommendations for Azure Resources