Adds support for common tags across resources (#71)

- Adds common_tags variable set to global scope in the metadata
- Concatenates common_tags and tags values when applied to vpc
- Updates resource_group dependency reference to new location

closes #70

Signed-off-by: Sean Sundberg <[email protected]>

Author: Sean Sundberg

.github/scripts/validate-deploy.sh

@@ -4,6 +4,10 @@ SCRIPT_DIR=$(cd $(dirname "$0"); pwd -P)
 
 BIN_DIR=$(cat .bin_dir)
 
+if [[ -n "${BIN_DIR}" ]]; then
+  export PATH="${BIN_DIR}:${PATH}"
+fi
+
 echo "terraform.tfvars"
 cat terraform.tfvars
 
@@ -18,28 +22,28 @@ echo "IBMCLOUD_API_KEY: ${IBMCLOUD_API_KEY}"
 
 VPC_NAME="${PREFIX_NAME}-vpc"
 
-${BIN_DIR}/ibmcloud login -r "${REGION}" -g "${RESOURCE_GROUP_NAME}" --apikey "${IBMCLOUD_API_KEY}"
+ibmcloud login -r "${REGION}" -g "${RESOURCE_GROUP_NAME}" --apikey "${IBMCLOUD_API_KEY}"
 
 echo "Retrieving VPC_ID for name: ${VPC_NAME}"
-VPC_ID=$(${BIN_DIR}/ibmcloud is vpcs | grep "${VPC_NAME}" | sed -E "s/^([A-Za-z0-9-]+).*/\1/g")
+VPC_ID=$(ibmcloud is vpcs | grep "${VPC_NAME}" | sed -E "s/^([A-Za-z0-9-]+).*/\1/g")
 
 if [[ -z "${VPC_ID}" ]]; then
   echo "VPC id not found: ${VPC_NAME}"
   exit 1
 fi
 
 echo "Retrieving VPC info for id: ${VPC_ID}"
-${BIN_DIR}/ibmcloud is vpc "${VPC_ID}"
-if ! ${BIN_DIR}/ibmcloud is vpc "${VPC_ID}"; then
+ibmcloud is vpc "${VPC_ID}" --output JSON
+if ! ibmcloud is vpc "${VPC_ID}"; then
   echo "Unable to find vpc for id: ${VPC_ID}"
   exit 1
 fi
 
 SG_NAME="${VPC_NAME}-base"
 
 echo "Testing security group rules"
-${BIN_DIR}/ibmcloud is security-groups --output JSON | ${BIN_DIR}/jq '.[]'
-OPEN_RULES=$(${BIN_DIR}/ibmcloud is security-groups --output JSON | ${BIN_DIR}/jq -c --arg SG_NAME "${SG_NAME}" '.[] | select(.name == $SG_NAME) | .rules[]')
+ibmcloud is security-groups --output JSON | jq '.[]'
+OPEN_RULES=$(ibmcloud is security-groups --output JSON | jq -c --arg SG_NAME "${SG_NAME}" '.[] | select(.name == $SG_NAME) | .rules[]')
 if [[ -z "${OPEN_RULES}" ]]; then
   echo "No rules found for '${SG_NAME}'"
   exit 1

.github/workflows/verify-pr.yaml

@@ -16,3 +16,10 @@ jobs:
 
   verifyMetadata:
     uses: cloud-native-toolkit/action-workflows/.github/workflows/verify-module-metadata.yaml@v1
+
+  verifyAll:
+    needs: [verify,verifyMetadata]
+    runs-on: ubuntu-latest
+
+    steps:
+      - run: echo "Success"

main.tf

@@ -16,6 +16,7 @@ locals {
   base_security_group_name = var.base_security_group_name != null && var.base_security_group_name != "" ? var.base_security_group_name : "${local.vpc_name}-base"
   vpc               = data.ibm_is_vpc.vpc
   resource_group_id = data.ibm_resource_group.resource_group.id
+  tags              = distinct(concat(var.common_tags, var.tags))
 }
 
 resource null_resource print_names {
@@ -39,7 +40,7 @@ resource ibm_is_vpc vpc {
   default_security_group_name = "${local.vpc_name}-default"
   default_network_acl_name    = "${local.vpc_name}-default"
   default_routing_table_name  = "${local.vpc_name}-default"
-  tags                        = var.tags
+  tags                        = local.tags
 }
 
 data ibm_is_vpc vpc {
@@ -52,14 +53,14 @@ resource ibm_resource_tag sg-tag {
   count = var.provision ? 1 : 0
 
   resource_id = local.vpc.default_security_group_crn
-  tags        = var.tags
+  tags        = local.tags
 }
 
 resource ibm_resource_tag nacl-tag {
   count = var.provision ? 1 : 0
 
   resource_id = local.vpc.default_network_acl_crn
-  tags        = var.tags
+  tags        = local.tags
 }
 
 resource ibm_is_vpc_address_prefix cidr_prefix {
@@ -148,7 +149,7 @@ resource ibm_is_security_group base {
   name = local.base_security_group_name
   vpc  = lookup(local.vpc, "id", "")
   resource_group = local.resource_group_id
-  tags = var.tags
+  tags = local.tags
 }
 
 data ibm_is_security_group base {

module.yaml

@@ -15,7 +15,7 @@ versions:
   dependencies:
     - id: resource_group
       refs:
-        - source: github.com/cloud-native-toolkit/terraform-ibm-resource-group
+        - source: github.com/terraform-ibm-modules/terraform-ibm-toolkit-resource-group
           version: ">= 2.1.0"
   variables:
     - name: resource_group_name
@@ -28,3 +28,6 @@ versions:
       scope: module
     - name: name_prefix
       scope: global
+    - name: common_tags
+      scope: global
+      important: true

test/stages/stage2-vpc.tf

@@ -6,5 +6,6 @@ module "dev_vpc" {
   name_prefix          = var.name_prefix
   address_prefix_count = var.address_prefix_count
   address_prefixes     = jsondecode(var.address_prefixes)
+  common_tags          = ["common", "test"]
   tags                 = ["test"]
 }

variables.tf

@@ -56,3 +56,9 @@ variable "tags" {
   default     = []
   description = "Tags that should be added to the instance"
 }
+
+variable "common_tags" {
+  type        = list(string)
+  default     = []
+  description = "Common tags that should be added to the instance"
+}