From 6968dbb78504b6e42a1771aac12839caa8bdf012 Mon Sep 17 00:00:00 2001 From: Brian Pham Date: Wed, 25 Sep 2024 00:26:28 +0000 Subject: [PATCH] docs(standard): add resource tagging standard Add resource tagging standard --- docs/style/resource-tagging.md | 40 ++++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) create mode 100644 docs/style/resource-tagging.md diff --git a/docs/style/resource-tagging.md b/docs/style/resource-tagging.md new file mode 100644 index 0000000..eca86cc --- /dev/null +++ b/docs/style/resource-tagging.md @@ -0,0 +1,40 @@ +# Resource Tagging Conventions + +Reference +https://docs.aws.amazon.com/whitepapers/latest/establishing-your-cloud-foundation-on-aws/tagging-standards.html +https://docs.aws.amazon.com/whitepapers/latest/tagging-best-practices/tagging-best-practices.html +https://docs.aws.amazon.com/whitepapers/latest/tagging-best-practices/what-are-tags.html + +## Standard Default Tags + +These are the standard default tags that are created and expected through our metadata module. +Standard default tags are proper case and allow us to be visualized in the AWS console better. + +- Component +- Contact +- Description +- Domain +- Environments +- Organization +- System +- Team + +## General Convention For New Tags + +For tags that are not the standard default tags, use the following convention: + +1. Use kebab case follow by colon + +Example: + +```aws +backup:required = true +backup:enabled = true + +pii = true +pii:description = some description +pii:contact-team = platform +pii:contact = bpham@bpham.com +``` + +## Tagging Dictionary