chore: align to serverless for naming and tags (#121)

mishraomp · web-flow · commit 0bb3731c746c · 2025-06-25T13:38:39.000-07:00
* chore: add prod , will be deleted later

* chore: align with serverless for naming and tags

* fix: vars
diff --git a/.github/workflows/.deployer.yml b/.github/workflows/.deployer.yml
@@ -112,6 +112,7 @@ jobs:
           api_image: ${{ steps.image-tags.outputs.api-image }}
           app_env: ${{inputs.app_env}}
           stack_prefix: ${{ inputs.stack_prefix }}
+          repo_name: ${{ github.event.repository.name }}
       run: |
           # Run terraform
           terragrunt run-all ${{inputs.command}} --terragrunt-non-interactive
@@ -127,6 +128,7 @@ jobs:
           api_image: ${{ steps.image-tags.outputs.api-image }}
           app_env: ${{inputs.app_env}}
           stack_prefix: ${{ inputs.stack_prefix }}
+          repo_name: ${{ github.event.repository.name }}
       run: |
           terragrunt output -json > outputs.json
           #print the output
@@ -144,6 +146,7 @@ jobs:
           api_image: ${{ steps.image-tags.outputs.api-image }}
           app_env: ${{inputs.app_env}}
           stack_prefix: ${{ inputs.stack_prefix }}
+          repo_name: ${{ github.event.repository.name }}
       run: |
           terragrunt output -json > outputs.json
           #print the output
diff --git a/.github/workflows/.stack-prefix.yml b/.github/workflows/.stack-prefix.yml
@@ -21,34 +21,32 @@ jobs:
         shell: bash
         run: |
           # Get repository name
-          REPO_NAME="${{ github.event.repository.name }}"
+          repo_name="${{ github.event.repository.name }}"
+          # 1. Clean the repository name
+          # Convert to lowercase, replace non-alphanumeric/hyphen with hyphen,
+          # reduce multiple hyphens, remove leading/trailing hyphens.
+          cleaned_name=$(echo "$repo_name" | tr '[:upper:]' '[:lower:]' | \
+                              sed 's/[^a-z0-9-]/-/g' | sed 's/-\{2,\}/-/g' | \
+                              sed 's/^-//;s/-$//')
 
-          # If repo name is less than 20 characters, use it directly
-          if [[ ${#REPO_NAME} -lt 20 ]]; then
-            STACK_PREFIX="${REPO_NAME}"
-          else
-            # Split by hyphen or underscore and get first letter of each word
-            PREFIX=$(echo "$REPO_NAME" | 
-                    awk -v RS='[-_]' '{printf "%s", tolower(substr($0,1,1))}' | 
-                    tr -d '\n')
+          # Define the target length for the human-readable prefix
+          prefix_len=5
 
-            # Ensure at least 4 characters without repetition
-            while [[ ${#PREFIX} -lt 4 ]]; do
-              # Concatenate with the next letter in the sequence (avoiding randomness)
-              SUFFIX="${PREFIX: -1}"  # Get the last character of the current PREFIX
-              INDEX=$(( $(echo "$PREFIX" | grep -o "$SUFFIX" | wc -l) + 1 ))  # Get the index of the next character
-              NEXT_CHAR=$(echo "$PREFIX" | cut -c $INDEX)  # Get the next character
-              PREFIX="${PREFIX}${NEXT_CHAR}"
-            done
+          # 2. Generate the 5-character human-readable prefix
+          prefix_part=""
+          # Remove all hyphens from the cleaned name to get a continuous string of letters/numbers
+          continuous_name=$(echo "$cleaned_name" | sed 's/-//g')
 
-            # Truncate if prefix exceeds 10 characters
-            if [[ ${#PREFIX} -gt 10 ]]; then
-              PREFIX="${PREFIX:0:10}"
-            fi
+          # Take up to 'prefix_len' (5) characters, but allow shorter prefixes
+          prefix_part="${continuous_name:0:$prefix_len}"
 
-            STACK_PREFIX="${PREFIX}"
-          fi
+          # 3. Generate the 4-character consistent hash suffix
+          # The MD5 hash of the original repo name ensures consistency and uniqueness
+          hash_suffix=$(echo -n "$repo_name" | md5sum | head -c 4)
+
+          # 4. Combine the prefix, hyphen, and hash suffix
+          final_name="${prefix_part}-${hash_suffix}"
 
           # Set output
-          echo "STACK_PREFIX=$STACK_PREFIX" >> $GITHUB_OUTPUT
-          echo "Generated prefix: $STACK_PREFIX"
+          echo "STACK_PREFIX=$final_name" >> $GITHUB_OUTPUT
+          echo "Generated prefix: $final_name"
diff --git a/.github/workflows/prune-env.yml b/.github/workflows/prune-env.yml
@@ -10,13 +10,15 @@ on:
       options:
         - dev
         - test
+        - prod
     app_env:
       required: true
       type: choice
       description: 'The APP env separates between AWS ENV and Actual APP, since AWS dev is where PR, and TEST is deployed'
       options:
         - dev
         - test
+        - prod
 permissions:
   id-token: write # This is required for requesting the JWT
   contents: write # This is required for actions/checkout
@@ -35,6 +37,14 @@ jobs:
     if: ( github.event.inputs.app_env == 'test' )
     uses: ./.github/workflows/.destroy_stack.yml
     secrets: inherit
+    with:
+      environment_name: ${{ github.event.inputs.environment_name }}
+      app_env: ${{ github.event.inputs.app_env }}
+  destroy-prod:
+    name: Destroy Stack Prod
+    if: ( github.event.inputs.app_env == 'prod' )
+    uses: ./.github/workflows/.destroy_stack.yml
+    secrets: inherit
     with:
       environment_name: ${{ github.event.inputs.environment_name }}
       app_env: ${{ github.event.inputs.app_env }}
diff --git a/infrastructure/api/api-gateway.tf b/infrastructure/api/api-gateway.tf
@@ -2,11 +2,13 @@ resource "aws_apigatewayv2_vpc_link" "app" {
   name               = var.app_name
   subnet_ids         = data.aws_subnets.web.ids
   security_group_ids = [data.aws_security_group.web.id]
+  tags = local.common_tags
 }
 
 resource "aws_apigatewayv2_api" "app" {
   name          = var.app_name
   protocol_type = "HTTP"
+  tags = local.common_tags
 }
 
 resource "aws_apigatewayv2_integration" "app" {
diff --git a/infrastructure/api/autoscaling.tf b/infrastructure/api/autoscaling.tf
@@ -4,6 +4,7 @@ resource "aws_appautoscaling_target" "api_target" {
   scalable_dimension = "ecs:service:DesiredCount"
   min_capacity       = var.min_capacity
   max_capacity       = var.max_capacity
+  tags = local.common_tags
 }
 
 # Automatically scale capacity up by one
diff --git a/infrastructure/api/ecs.tf b/infrastructure/api/ecs.tf
@@ -21,6 +21,7 @@ locals {
 
 resource "aws_ecs_cluster" "ecs_cluster" {
   name = "ecs-cluster-${var.app_name}"
+  tags = local.common_tags
 }
 
 resource "aws_ecs_cluster_capacity_providers" "ecs_cluster_capacity_providers" {
@@ -160,6 +161,7 @@ resource "aws_ecs_task_definition" "flyway_task" {
     fi
   EOF
   }
+  tags = local.common_tags
 }
 
 resource "aws_ecs_task_definition" "node_api_task" {
@@ -232,6 +234,7 @@ resource "aws_ecs_task_definition" "node_api_task" {
   lifecycle {
     create_before_destroy = true
   }
+  tags = local.common_tags
 }
 
 
diff --git a/infrastructure/api/vars.tf b/infrastructure/api/vars.tf
@@ -173,4 +173,8 @@ variable "postgres_pool_size" {
   description = "The size of the connection pool for the API"
   type        = string
   default     = "1"
+}
+variable "repo_name" {
+  description = "Name of the repository for resource descriptions and tags"
+  type        = string
 }
diff --git a/infrastructure/api/waf.tf b/infrastructure/api/waf.tf
@@ -40,13 +40,14 @@ resource "aws_wafv2_web_acl" "cloudfront_acl" {
         metric_name                = "AppWebACL"
         sampled_requests_enabled   = true
     }
+    tags = local.common_tags
 }
 
 resource "aws_cloudfront_distribution" "api" {
     count      = var.is_public_api ? 1 : 0
     provider   = aws.cloudfront_waf
     web_acl_id = aws_wafv2_web_acl.cloudfront_acl[0].arn
-    comment    = "Distribution for ${var.app_name} api."
+    comment    = "Distribution for ${var.app_name} api, for github repository :: ${var.repo_name}"
 
     origin {
         domain_name = "${aws_apigatewayv2_api.app.id}.execute-api.${var.aws_region}.amazonaws.com"
@@ -97,12 +98,14 @@ resource "aws_cloudfront_distribution" "api" {
     }
 
     depends_on = [aws_s3_bucket_policy.cloudfront_log_policy]
+    tags = local.common_tags
 }
 
 resource "aws_s3_bucket" "cloudfront_api_logs" {
     count         = var.is_public_api ? 1 : 0
     bucket        = "cloudfront-api-logs-${var.app_name}"
     force_destroy = true
+    tags = local.common_tags
 }
 
 resource "aws_s3_bucket_public_access_block" "cloudfront_api_logs_block" {
diff --git a/infrastructure/database/aurora-v2.tf b/infrastructure/database/aurora-v2.tf
@@ -13,10 +13,7 @@ resource "aws_db_subnet_group" "db_subnet_group" {
   description = "For Aurora cluster ${var.db_cluster_name}"
   name        = "${var.db_cluster_name}-subnet-group"
   subnet_ids  = [ for s in data.aws_subnet.data : s.id ]
-
-  tags = {
-    managed-by = "terraform"
-  }
+  tags = var.common_tags
 
   tags_all = {
     managed-by = "terraform"
@@ -32,9 +29,7 @@ data "aws_rds_engine_version" "postgresql" {
 resource "aws_secretsmanager_secret" "db_mastercreds_secret" {
   name = "${var.db_cluster_name}"
 
-  tags = {
-    managed-by = "terraform"
-  }
+  tags = var.common_tags
 }
 
 resource "aws_secretsmanager_secret_version" "db_mastercreds_secret_version" {
@@ -86,9 +81,7 @@ module "aurora_postgresql_v2" {
     two = {}
   }: {one = {}}
   
-  tags = {
-    managed-by = "terraform"
-  }
+  tags = var.common_tags
 
   enabled_cloudwatch_logs_exports = ["postgresql"]
   backup_retention_period = "${var.backup_retention_period}"
diff --git a/infrastructure/database/vars.tf b/infrastructure/database/vars.tf
@@ -45,4 +45,13 @@ variable "max_capacity" {
   description = "Maximum capacity for Aurora Serverless v2"
   type        = number
   default     = 1.0
+}
+variable "repo_name" {
+  description = "Name of the repository for resource descriptions and tags"
+  type        = string
+}
+variable "common_tags" {
+  description = "Common tags to be applied to resources"
+  type        = map(string)
+  default     = {}
 }
diff --git a/infrastructure/frontend/cloudfront.tf b/infrastructure/frontend/cloudfront.tf
@@ -1,8 +1,9 @@
 data "aws_caller_identity" "current" {}
 
 resource "aws_s3_bucket" "frontend" {
-  bucket = "${var.app_name}-frontend-${data.aws_caller_identity.current.account_id}-${var.aws_region}"
+  bucket = "${var.app_name}-static-assets"
   force_destroy = true
+  tags = var.common_tags
 }
 
 resource "aws_s3_bucket_server_side_encryption_configuration" "frontend_encryption" {
@@ -48,8 +49,9 @@ resource "aws_s3_bucket_policy" "site_policy" {
 }
 
 resource "aws_s3_bucket" "cloudfront_logs" {
-  bucket = "${var.app_name}-cloudfront-logs"
+  bucket = "${var.app_name}-cf-logs"
   force_destroy = true
+  tags = var.common_tags
 }
 
 resource "aws_s3_bucket_ownership_controls" "cloudfront_logs_ownership" {
@@ -111,7 +113,7 @@ resource "aws_cloudfront_distribution" "s3_distribution" {
   depends_on = [aws_s3_bucket_policy.cloudfront_logs_policy] 
   enabled             = true
   is_ipv6_enabled     = true
-  comment             = "Distribution for ${var.app_name} site."
+  comment             = "Distribution for ${var.app_name} site from github repository :: ${var.repo_name}"
   default_root_object = "index.html"
   price_class         = "PriceClass_100"
   web_acl_id          = aws_wafv2_web_acl.waf_cloudfront.arn
@@ -160,7 +162,5 @@ resource "aws_cloudfront_distribution" "s3_distribution" {
     cloudfront_default_certificate = true
   }
 
-  tags = {
-    Name = "${var.app_name}-distribution"
-  }
+  tags = var.common_tags
 }
diff --git a/infrastructure/frontend/vars.tf b/infrastructure/frontend/vars.tf
@@ -19,4 +19,13 @@ variable "app_name" {
 variable "aws_region" {
   type = string
   default = "ca-central-1"
+}
+variable "repo_name" {
+  description = "Name of the repository for resource descriptions and tags"
+  type        = string
+}
+variable "common_tags" {
+  description = "Common tags to be applied to resources"
+  type        = map(string)
+  default     = {}
 }
diff --git a/infrastructure/frontend/waf.tf b/infrastructure/frontend/waf.tf
@@ -115,10 +115,7 @@ resource "aws_wafv2_web_acl" "waf_cloudfront" {
         }
     }
 
-    tags = {
-        env = "${var.target_env}"
-        managed-by = "terraform"
-    }
+    tags = var.common_tags
 
     visibility_config {
         cloudwatch_metrics_enabled = true
diff --git a/terraform/api/terragrunt.hcl b/terraform/api/terragrunt.hcl
@@ -47,6 +47,7 @@ generate "tfvars" {
   contents          = <<-EOF
   app_name="${local.stack_prefix}-node-api-${local.app_env}"
   db_cluster_name = "${local.stack_prefix}-aurora-${local.rds_app_env}"
+  repo_name = "${get_env("repo_name")}"
 EOF
 }
 
diff --git a/terraform/database/terragrunt.hcl b/terraform/database/terragrunt.hcl
@@ -43,6 +43,7 @@ generate "tfvars" {
   contents          = <<-EOF
     db_cluster_name = "${local.stack_prefix}-aurora-${local.rds_app_env}"
     app_env = "${local.app_env}"
+    repo_name = "${get_env("repo_name")}"
 EOF
 }
 
diff --git a/terraform/frontend/terragrunt.hcl b/terraform/frontend/terragrunt.hcl
@@ -42,6 +42,7 @@ generate "tfvars" {
   contents          = <<-EOF
     app_env="${local.app_env}"
     app_name="${local.stack_prefix}-frontend-${local.app_env}"
+    repo_name="${get_env("repo_name")}"
 EOF
 }
 

Original file line number	Diff line number	Diff line change
`@@ -2,11 +2,13 @@ resource "aws_apigatewayv2_vpc_link" "app" {`
`2`	`2`	`name = var.app_name`
`3`	`3`	`subnet_ids = data.aws_subnets.web.ids`
`4`	`4`	`security_group_ids = [data.aws_security_group.web.id]`
	`5`	`+ tags = local.common_tags`
`5`	`6`	`}`
`6`	`7`
`7`	`8`	`resource "aws_apigatewayv2_api" "app" {`
`8`	`9`	`name = var.app_name`
`9`	`10`	`protocol_type = "HTTP"`
	`11`	`+ tags = local.common_tags`
`10`	`12`	`}`
`11`	`13`
`12`	`14`	`resource "aws_apigatewayv2_integration" "app" {`
Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,7 @@ resource "aws_appautoscaling_target" "api_target" {`
`4`	`4`	`scalable_dimension = "ecs:service:DesiredCount"`
`5`	`5`	`min_capacity = var.min_capacity`
`6`	`6`	`max_capacity = var.max_capacity`
	`7`	`+ tags = local.common_tags`
`7`	`8`	`}`
`8`	`9`
`9`	`10`	`# Automatically scale capacity up by one`
Original file line number	Diff line number	Diff line change
`@@ -21,6 +21,7 @@ locals {`
`21`	`21`
`22`	`22`	`resource "aws_ecs_cluster" "ecs_cluster" {`
`23`	`23`	`name = "ecs-cluster-${var.app_name}"`
	`24`	`+ tags = local.common_tags`
`24`	`25`	`}`
`25`	`26`
`26`	`27`	`resource "aws_ecs_cluster_capacity_providers" "ecs_cluster_capacity_providers" {`
`@@ -160,6 +161,7 @@ resource "aws_ecs_task_definition" "flyway_task" {`
`160`	`161`	`fi`
`161`	`162`	`EOF`
`162`	`163`	`}`
	`164`	`+ tags = local.common_tags`
`163`	`165`	`}`
`164`	`166`
`165`	`167`	`resource "aws_ecs_task_definition" "node_api_task" {`
`@@ -232,6 +234,7 @@ resource "aws_ecs_task_definition" "node_api_task" {`
`232`	`234`	`lifecycle {`
`233`	`235`	`create_before_destroy = true`
`234`	`236`	`}`
	`237`	`+ tags = local.common_tags`
`235`	`238`	`}`
`236`	`239`
`237`	`240`
Original file line number	Diff line number	Diff line change
`@@ -173,4 +173,8 @@ variable "postgres_pool_size" {`
`173`	`173`	`description = "The size of the connection pool for the API"`
`174`	`174`	`type = string`
`175`	`175`	`default = "1"`
	`176`	`+}`
	`177`	`+variable "repo_name" {`
	`178`	`+ description = "Name of the repository for resource descriptions and tags"`
	`179`	`+ type = string`
`176`	`180`	`}`
Original file line number	Diff line number	Diff line change
`@@ -40,13 +40,14 @@ resource "aws_wafv2_web_acl" "cloudfront_acl" {`
`40`	`40`	`metric_name = "AppWebACL"`
`41`	`41`	`sampled_requests_enabled = true`
`42`	`42`	`}`
	`43`	`+ tags = local.common_tags`
`43`	`44`	`}`
`44`	`45`
`45`	`46`	`resource "aws_cloudfront_distribution" "api" {`
`46`	`47`	`count = var.is_public_api ? 1 : 0`
`47`	`48`	`provider = aws.cloudfront_waf`
`48`	`49`	`web_acl_id = aws_wafv2_web_acl.cloudfront_acl[0].arn`
`49`		`- comment = "Distribution for ${var.app_name} api."`
	`50`	`+ comment = "Distribution for ${var.app_name} api, for github repository :: ${var.repo_name}"`
`50`	`51`
`51`	`52`	`origin {`
`52`	`53`	`domain_name = "${aws_apigatewayv2_api.app.id}.execute-api.${var.aws_region}.amazonaws.com"`
`@@ -97,12 +98,14 @@ resource "aws_cloudfront_distribution" "api" {`
`97`	`98`	`}`
`98`	`99`
`99`	`100`	`depends_on = [aws_s3_bucket_policy.cloudfront_log_policy]`
	`101`	`+ tags = local.common_tags`
`100`	`102`	`}`
`101`	`103`
`102`	`104`	`resource "aws_s3_bucket" "cloudfront_api_logs" {`
`103`	`105`	`count = var.is_public_api ? 1 : 0`
`104`	`106`	`bucket = "cloudfront-api-logs-${var.app_name}"`
`105`	`107`	`force_destroy = true`
	`108`	`+ tags = local.common_tags`
`106`	`109`	`}`
`107`	`110`
`108`	`111`	`resource "aws_s3_bucket_public_access_block" "cloudfront_api_logs_block" {`