Updates subnet structure for module (#9)

- Adds `subnets` input list containing labels for the subnets
- Leaves subnet_count for backwards compatibility
- Adds `subnet_label_counts` output that gives subnet counts for each label
- Adds `subnets` output that returns list of objects containing subnet id and label
- Splits test cases into two, subnet count and subnets object, and runs tests in parallel

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

Author: Sean Sundberg

.github/scripts/validate-deploy.sh

@@ -59,4 +59,7 @@ elif [[ "${PUBLIC_GATEWAY}" == "false" ]] && [[ -n "${PGS}" ]]; then
   exit 1
 fi
 
+cat "./subnet_label_counts.json" | jq '.'
+cat "./subnets.json" | jq '.'
+
 exit 0

.github/workflows/verify.yaml

@@ -17,8 +17,9 @@ jobs:
 
     strategy:
       matrix:
-        platform: [ocp4_latest]
-    #      max-parallel: 1
+        platform:
+          - vpc_count
+          - vpc_subnets
       fail-fast: false
 
     env:

main.tf

@@ -1,21 +1,38 @@
 
 locals {
   zone_count        = 3
-  zone_ids          = range(var.subnet_count)
-  vpc_zone_names    = [ for index in local.zone_ids: "${var.region}-${(index % local.zone_count) + 1}" ]
+  subnet_count      = length(var.subnets) > 0 ? length(var.subnets) : var.subnet_count
+  vpc_zone_names    = [ for index in range(local.subnet_count): "${var.region}-${(index % local.zone_count) + 1}" ]
   prefix_name       = var.name_prefix != "" ? var.name_prefix : var.resource_group_name
   vpc_name          = lower(replace(var.name != "" ? var.name : "${local.prefix_name}-vpc", "_", "-"))
   vpc_id            = ibm_is_vpc.vpc.id
   subnet_ids        = ibm_is_subnet.vpc_subnet[*].id
   gateway_ids       = var.public_gateway ? ibm_is_public_gateway.vpc_gateway[*].id : [ for val in range(local.zone_count): "" ]
   security_group_id = ibm_is_vpc.vpc.default_security_group
   ipv4_cidr_blocks  = ibm_is_subnet.vpc_subnet[*].ipv4_cidr_block
+  distinct_subnet_labels = distinct([ for val in var.subnets: val.label ])
+  # creates an intermediate object where the key is the label and the value is an array of labels, one for each appearance
+  # e.g. [{label = "basic"}, {label = "basic"}, {label = "test"}] would yield {basic = ["basic", "basic"], test = ["test"]}
+  subnet_labels_tmp = { for subnet in var.subnets: subnet.label => subnet.label... }
+  # creates an object where the key is the label and the value is number of times the label appears in the original list
+  # e.g. {basic = ["basic", "basic"], test = ["test"]} would yield {basic = 2, test = 1}
+  subnet_label_counts = length(var.subnets) > 0 ? [ for val in local.distinct_subnet_labels:
+        {
+          label = val
+          count = length(local.subnet_labels_tmp[val])
+        } ] : [ {
+          label = "default"
+          count = local.subnet_count
+      } ]
 }
 
 resource null_resource print_names {
   provisioner "local-exec" {
     command = "echo 'Resource group: ${var.resource_group_name}'"
   }
+  provisioner "local-exec" {
+    command = "echo 'Subnets: ${jsonencode(local.subnet_labels_tmp)}'"
+  }
 }
 
 data ibm_resource_group resource_group {
@@ -31,7 +48,7 @@ resource ibm_is_vpc vpc {
 }
 
 resource ibm_is_public_gateway vpc_gateway {
-  count = var.public_gateway ? min(local.zone_count, var.subnet_count) : 0
+  count = var.public_gateway ? min(local.zone_count, local.subnet_count) : 0
 
   name           = "${local.vpc_name}-gateway-${format("%02s", count.index)}"
   vpc            = local.vpc_id
@@ -66,7 +83,7 @@ resource ibm_is_network_acl network_acl {
 }
 
 resource ibm_is_subnet vpc_subnet {
-  count                    = var.subnet_count
+  count                    = local.subnet_count
 
   name                     = "${local.vpc_name}-subnet-${format("%02s", count.index)}"
   zone                     = local.vpc_zone_names[count.index]
@@ -78,7 +95,7 @@ resource ibm_is_subnet vpc_subnet {
 }
 
 resource ibm_is_security_group_rule rule_tcp_k8s {
-  count     = var.subnet_count
+  count     = local.subnet_count
 
   group     = local.security_group_id
   direction = "inbound"

module.yaml

@@ -25,6 +25,8 @@ versions:
     - name: ibmcloud_api_key
       scope: global
     - name: subnet_count
+      scope: ignore
+    - name: subnets
       scope: module
     - name: public_gateway
       scope: module

outputs.tf

@@ -12,8 +12,13 @@ output "id" {
 }
 
 output "subnet_count" {
-  value       = var.subnet_count
-  description = "The number of subnets for the vpc"
+  value       = local.subnet_count
+  description = "The total number of subnets for the vpc"
+}
+
+output "subnet_label_counts" {
+  value       = local.subnet_label_counts
+  description = "The number of subnets for each label. e.g. [{label = 'default', count = 2}, {label = 'test', count = 1}]"
 }
 
 output "zone_names" {
@@ -27,3 +32,15 @@ output "subnet_ids" {
   depends_on  = [ibm_is_subnet.vpc_subnet]
   description = "The list of subnet ids"
 }
+
+output "subnets" {
+  value       = [
+    for subnet in ibm_is_subnet.vpc_subnet:
+    {
+      id    = subnet.id
+      label = length(var.subnets) > 0 ? var.subnets[index(ibm_is_subnet.vpc_subnet, subnet)].label : "default"
+    }
+  ]
+  depends_on  = [ibm_is_subnet.vpc_subnet]
+  description = "List of subnet objects that contain the subnet id and label, e.g. [{label='', id=''}]"
+}

test/stages/print-module/main.tf

@@ -0,0 +1,16 @@
+locals {
+  subnet_label_counts_file = "${path.cwd}/subnet_label_counts.json"
+  subnets_file             = "${path.cwd}/subnets.json"
+}
+
+resource local_file subnet_label_counts {
+  filename = local.subnet_label_counts_file
+
+  content = jsonencode(var.subnet_label_counts)
+}
+
+resource local_file subnets {
+  filename = local.subnets_file
+
+  content = jsonencode(var.subnets)
+}

test/stages/print-module/variables.tf

@@ -0,0 +1,14 @@
+
+variable "subnet_label_counts" {
+  type = list(object({
+    label = string
+    count = number
+  }))
+}
+
+variable "subnets" {
+  type = list(object({
+    id = string
+    label = string
+  }))
+}

test/stages/stage1-resource-group.tf

@@ -2,5 +2,5 @@ module "resource_group" {
   source = "github.com/cloud-native-toolkit/terraform-ibm-resource-group.git"
 
   resource_group_name = var.resource_group_name
-  provision           = false
+  provision           = true
 }

test/stages/stage2-vpc.tf

@@ -6,5 +6,6 @@ module "dev_vpc" {
   name_prefix         = var.name_prefix
   ibmcloud_api_key    = var.ibmcloud_api_key
   subnet_count        = var.vpc_subnet_count
+  subnets             = jsondecode(var.vpc_subnets)
   public_gateway      = var.vpc_public_gateway == "true"
 }

test/stages/stage3-print.tf

@@ -0,0 +1,6 @@
+module "print-result" {
+  source = "./print-module"
+
+  subnet_label_counts = module.dev_vpc.subnet_label_counts
+  subnets             = module.dev_vpc.subnets
+}