Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: document DevSecOps Azure naming conventions #1096

Merged
merged 1 commit into from
Oct 31, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions docs/deployment/infrastructure.md
Original file line number Diff line number Diff line change
Expand Up @@ -160,6 +160,35 @@ lifecycle {
}
```

### Naming conventions

The DevSecOps team sets the following naming convention for Resources:

```
<<Resource Type>>-<<Department>>-<<Public/Private>>-<<Project Category>>-<<Project Name>>-<<Region>><<OS Type>>-<<Environment>>-<<Sequence Number>>
```

#### Sample Names

- `RG-CDT-PUB-VIP-BNSCN-E-D-001`
- `ASP-CDT-PUB-VIP-BNSCN-EL-P-001`
- `AS-CDT-PUB-VIP-BNSCN-EL-D-001`

#### Resource Types

Use the following shorthand for conveying the Resource Type as part of the Resource Name:

| Resource | Convention |
| ---------------- | ---------- |
| App Service | `AS` |
| App Service Plan | `ASP` |
| Virtual Network | `VNET` |
| Resource Group | `RG` |
| Virtual Machine | `VM` |
| Database | `DB` |
| Subnet | `SNET` |
| Front Door | `FD` |

## Azure environment setup

The following steps are required to set up the environment, with linked issues to automate them:
Expand Down