From a324e2d68a714faa048d8937dd4e5566d28a021b 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 --- docs/style/resource-tagging.md | 41 ++++++++++++++++++++++++++++++++++ 1 file changed, 41 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..f25e72d --- /dev/null +++ b/docs/style/resource-tagging.md @@ -0,0 +1,41 @@ +# Resource Tagging Conventions + +## Standard Default Tags + +These are the default standard tags that are created and expected through our metadata module. Standard default tags are always proper case and allow them to be visualized in the AWS console. + +- 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 +2. Use lowercase for all the words +3. Use `:` to help identify that the resource is associated with the prefix +4. Should not contain any personal identifiable information (PII) + +Example: + +```aws +backup:required = true +backup:enabled = true + +pii = true +pii:description = some description +pii:contact-team = platform +pii:contact = bpham@bpham.com +``` + +## Reference + +- [What Are Tags?](https://docs.aws.amazon.com/whitepapers/latest/tagging-best-practices/what-are-tags.html) +- [Tagging Best Practices](https://docs.aws.amazon.com/whitepapers/latest/tagging-best-practices/tagging-best-practices.html) +- [Tagging Standards](https://docs.aws.amazon.com/whitepapers/latest/establishing-your-cloud-foundation-on-aws/tagging-standards.html)