Add tags (#17)

* Initial work

* Adding additional tag generation logic

* Adding additional tag merge to missed resources

* Adding example to action description

* Removing the merge(X+var.additional_tags), additional tags merged to default tags in provider

* removing sg postfix

* updating readme with `additional_tags` attribute

Co-authored-by: LeoDiazL <[email protected]>

Author: PhillypHenning

README.md

@@ -50,6 +50,7 @@ jobs:
         tf_state_bucket: my-terraform-state-bucket
         dot_env: ${{ secrets.DOT_ENV }}
         app_port: 3000
+        additional_tags: "{\"key1\": \"value1\",\"key2\": \"value2\"}"
 
 ```
 
@@ -77,6 +78,7 @@ The following inputs can be used as `step.with` keys
 | `stack_destroy` | String | Set to `true` to destroy the stack. Default is `""` - Will delete the tf_state_bucket after destroy. |
 | `aws_resource_identifier` | String | Set to override the AWS resource identifier for the deployment.  Defaults to `${org}-{repo}-{branch}`.  Use with destroy to destroy specific resources. |
 | `app_directory` | String | Relative path for the directory of the app (i.e. where `Dockerfile` and `docker-compose.yaml` files are located). This is the directory that is copied to the EC2 instance.  Default is the root of the repo. |
+| `additional_tags` | JSON | Add additional tags to the terraform [default tags](https://www.hashicorp.com/blog/default-tags-in-the-terraform-aws-provider), any tags put here will be added to all provisioned resources.|
 
 ## Note about resource identifiers
 

action.yaml

@@ -50,6 +50,8 @@ inputs:
     description: 'Define the sub-domain part of the URL. Defaults to `${org}-${repo}-{branch}`'
   app_directory:
     description: 'Relative path for the directory of the app (i.e. where `Dockerfile` and `docker-compose.yaml` files are located). This is the directory that is copied to the EC2 instance.  Default is the root of the repo.'
+  additional_tags:
+    description: 'A list of additional tags that will be included on created resources. Example: `{"key1": "value1", "key2": "value2"}`'
 outputs:
   vm_url:
     description: "The URL of the generated app"
@@ -83,6 +85,7 @@ runs:
         SUB_DOMAIN: ${{ inputs.sub_domain }}
         BITOPS_FAST_FAIL: true
         APP_DIRECTORY: ${{ inputs.app_directory }}
+        ADDITIONAL_TAGS: ${{ inputs.additional_tags }}
       run: |
         echo "running operations/_scripts/deploy/deploy.sh"
         $GITHUB_ACTION_PATH/operations/_scripts/deploy/deploy.sh

operations/_scripts/generate/generate_provider.sh

@@ -33,7 +33,12 @@ provider \"aws\" {
   region = \"${AWS_DEFAULT_REGION}\"
   profile = \"default\"
   default_tags {
-    tags = local.aws_tags
+    tags = {
+      merge(
+        local.aws_tags,
+        var.additional_tags
+      )
+    }
   }
 }
 " >> "${GITHUB_ACTION_PATH}/operations/deployment/terraform/provider.tf"

operations/_scripts/generate/generate_tf_vars.sh

@@ -32,6 +32,15 @@ if [ -z "${EC2_INSTANCE_PROFILE}" ]; then
   EC2_INSTANCE_PROFILE="${GITHUB_IDENTIFIER}"
 fi
 
+
+# ADDITIONAL TAGS
+IFS=',' read -ra ADDR <<< "$ADDITIONAL_TAGS"
+for i in "${ADDR[@]}"; do
+
+    IFS='=' read -r key val <<< "$i"
+    ADDITIONAL_TAGS_LIST+="\"$key\": \"$val\","
+done
+
 echo "
 app_port = \"$APP_PORT\"
 
@@ -69,4 +78,6 @@ sub_domain_name = \"${SUB_DOMAIN}\"
 
 domain_name = \"${DOMAIN_NAME}\"
 
+additional_tags = {$( IFS=','; echo "${ADDITIONAL_TAGS_LIST[*]}" )}
+
 " >> "${GITHUB_ACTION_PATH}/operations/deployment/terraform/terraform.tfvars"

operations/deployment/terraform/main.tf

@@ -24,7 +24,7 @@ resource "aws_instance" "server" {
   iam_instance_profile        = aws_iam_instance_profile.ec2_profile.name
 
   tags = {
-   Name = "${var.aws_resource_identifier} - Instance"
+    Name = "${var.aws_resource_identifier} - Instance"
   }
 }
 

operations/deployment/terraform/variables.tf

@@ -88,3 +88,9 @@ variable "domain_name" {
   description = "root domain name without any subdomains"
   default = ""
 }
+
+variable "additional_tags" {
+  type = map(string)
+  description = "A list of strings that will be added to created resources"
+  default = ""
+}