ADDED tags module

azhar22k · azhar22k · commit 7cb8ca584d30 · 2020-06-13T17:15:12.000+05:30
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -2,7 +2,7 @@
 
 # Contributing to Peak's Terraform Modules
 
-Despite being primarily maintained by Peak, we welcome pull requests to this repo! We thank you for your time and efforts in making this library better 🙌🏻
+Despite being primarily maintained by Peak, we welcome pull requests to this repo! We thank you for your time and efforts in making these modules better 🙌🏻
 
 ## Consider raising an issue first if your proposed PR:
 
@@ -15,6 +15,7 @@ Despite being primarily maintained by Peak, we welcome pull requests to this rep
 
 * Follow best pacticies for Terraform modules like
     - Folder Structure ( distribute code in `variables.tf`, `main.tf` and `outputs.tf`)
+    - Name each resource as `default` for consistency of this repo (this makes outputs consistent).
     - Do not hardcode values and keep them configurable
     - Mention minimum required provider version
     - Provide default values when possible
diff --git a/README.md b/README.md
@@ -8,7 +8,7 @@ This repo list some open to use Terraform modules we use at `Peak AI` because we
 
 ## List of avilable modules
 
-TODO
+- [tags (aka labels)](/tags)
 
 ## Example usage
 
diff --git a/tags/README.md b/tags/README.md
@@ -0,0 +1,70 @@
+# Tags
+
+`Tags` for AWS Resources or `Labels` for Kubernetes objects allows Users to add metadta to Resource/Objects. Each tag is simple key-value pair which makes it easier to manage, search for, and filter resources.
+
+This modules defines base `tags` we here at Peak assign to each of our resources and are just a base Idea. You might might change that as per your organisation's needs. In that  case feel free to fork this repo and define base tags fits your organisation needs.
+
+
+## Gist
+
+All tags and their values are converted to lower case to avoid confusions and duplications
+
+`stage`: Stagging environment the resource belogs to. Must be one of [latest, test, beta, prod]
+
+`tenant`: Tenant the resource belongs to. Defaults to `platform`
+
+`feature`: Feature this resource belogs to say `shopping-cart`
+
+`service`: Service this resource belogs to say `shopiing-cart-database`
+
+## Example usage
+
+Once initialised tags added to as many resources as you want.
+
+### Example 1 > Using latest module
+
+```hcl
+# Importing module
+module "tags" {
+    source  = "git@github.com:peak-ai/terraform-modules.git//tags"
+    # Passing values from here will overide the default values
+    tenant  = "new-client"
+    # It is good practice to make workspaces matching four staging environment rather than hardcoing them
+    stage   = terraform.workspace
+    # hardcoing example
+    # stage = "latest"
+    feature = "example"
+    service = "example"
+}
+
+# Using module to to add tags to a resource say a S3 bucket
+provider "aws" {
+    version = "~> 2.62"
+}
+
+resource "aws_s3_bucket" "example" {
+  bucket = "example"
+  tags   = module.tags.default
+}
+```
+### Example 2 > Minimal using specific version
+
+```hcl
+# Importing module
+module "tags" {
+    source  = "git@github.com:peak-ai/terraform-modules.git//tags?ref=v0.1.0"
+    tenant  = "new-client"
+    stage = "latest"
+    feature = "example"
+    service = "example"
+}
+
+provider "aws" {
+    version = "~> 2.62"
+}
+
+resource "aws_s3_bucket" "example" {
+  bucket = "example"
+  tags   = module.tags.default
+}
+```
diff --git a/tags/main.tf b/tags/main.tf
@@ -0,0 +1,8 @@
+locals {
+    tags = {
+        stage = lower(var.stage)
+        tenant = lower(var.tenant)
+        feature = lower(var.feature)
+        service = lower(var.service)
+    }
+}
diff --git a/tags/outputs.tf b/tags/outputs.tf
@@ -0,0 +1,19 @@
+output "default" {
+    value = local.tags
+}
+
+output "stage" {
+    value = var.stage
+}
+
+output "tenant" {
+    value = var.tenant
+}
+
+output "feature" {
+    value = var.feature
+}
+
+output "service" {
+    value = var.service
+}
diff --git a/tags/variables.tf b/tags/variables.tf
@@ -0,0 +1,26 @@
+terraform {
+  # This is enabled to use validation in variable
+  experiments = [variable_validation]
+}
+
+variable "stage" {
+    description = "Stage on which infra should be deployed"
+    type = string
+    validation {
+        condition = can(regex("latest|test|beta|prod", var.stage))
+        error_message = "Invalid stage! Allowed values are [latest, test, beta, prod]."
+    }
+}
+
+variable "tenant" {
+    type    = string
+    default = "platform"
+}
+
+variable "feature" {
+    type = string
+}
+
+variable "service" {
+    type = string
+}
