Skip to content

chore: updating tagging standards and how to guide #29

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.

Sign up for GitHub

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

Merged
acanbym merged 3 commits into from
May 14, 2025
Merged

chore: updating tagging standards and how to guide #29

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7e4f8ef
chore: updating tagging standards and how to guide
acanbym May 14, 2025
f7a831e
chore: remove unnecessary part
acanbym May 14, 2025
0a5289a
chore: update tag in serverless
acanbym May 14, 2025
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
4 changes: 2 additions & 2 deletions docs/technical-standards/How-to guides/tagging.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ provider "aws" {
tags = {
Application = "Developer Playbook"
TeamEmail = "developers@hackney.gov.uk"
Environment = "production"
Environment = "prod"
}
}
}
Expand Down Expand Up @@ -69,7 +69,7 @@ In order to add tagging to AWS resources managed by Serverless Framework:
stackTags:
Application: "Developer Playbook"
TeamEmail: "developers@hackney.gov.uk"
Environment: "production"
Environment: "prod"

# For CircleCI
AutomationBuildUrl: ${env:CIRCLE_BUILD_URL}
Expand Down
13 changes: 12 additions & 1 deletion docs/technical-standards/Reference/hosting-standards/tagging.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,22 @@ To ensure we can consistently search for, and report on, the tags we use, you sh
- `TeamEmail`: The email address of the team responsible for the operation of the service. Must be a valid email group, not an individual.
- `Environment`: The name of the environment, must be one of `dev`, `stg`, `prod` or `mgmt`[^environment-tags-source].
Copy link

@cgloker cgloker May 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

just a little comment here, we've added "pre-prod" to the tag policy.


### Mandatory tags for data-holding resources

The following potentially data-holding resources must have the Confidentiality tag:
- EC2 instance
- EBS volume
- RDS instance
- RDS cluster
- DynamoDB table
You will not be able to deploy the above resources if they are not tagged with the Confidentiality tag.
- `Confidentiality`: Data confidentiality of the infrastructure. Must be one of `Internal`, `Restricted`, or `Public`.

### Optional tags

- `AutomationBuildUrl`: URL of the automation build, must be a valid URL.
- `BackupPolicy`: The backup policy to apply to the resource. If present must be one of `Dev`, `Stg`, `Preprod`, `Prod`, `Mgmt`.
- `Confidentiality`: Data confidentiality of the infrastructure. Only applicable to infrastructure which holds data, e.g. EC2, RDS, EBS, DynamoDB, Glue, and S3. Must be one of `Internal`, `Restricted`, or `Public`[^confidentiality-tags-source].
- `Confidentiality`: Data confidentiality of the infrastructure. Only mandatory for infrastructure which holds data, e.g. EC2, RDS, EBS, DynamoDB, Glue, and S3. Optional for all other infrastructure. Must be one of `Internal`, `Restricted`, or `Public`[^confidentiality-tags-source].
- `Department`: The service area this system serves.
- `WeekendShutdown`: If present, regardless of the value provided the resource will be shut down over the weekend.
- `OutOfHoursShutdown`: If present, regardless of the value provided the resource will be shut down out of working hours.
Expand Down