just check compute keys

sjpb · sjpb · commit e9230682d11e · 2025-05-16T15:38:44.000Z
diff --git a/environments/.stackhpc/tofu/main.tf b/environments/.stackhpc/tofu/main.tf
@@ -74,7 +74,7 @@ module "cluster" {
             flavor: var.other_node_flavor
         }
     }
-    compute = tomap({
+    compute = {
         standard: { # NB: can't call this default!
             nodes: ["compute-0", "compute-1"]
             flavor: var.other_node_flavor
@@ -87,7 +87,7 @@ module "cluster" {
             #nodes: ["extra-0", "extra-1"]
             flavor: var.other_node_flavor
         }
-    })
+    }
 
     volume_backed_instances = var.volume_backed_instances
 
diff --git a/environments/skeleton/{{cookiecutter.environment}}/tofu/compute.tf b/environments/skeleton/{{cookiecutter.environment}}/tofu/compute.tf
@@ -14,20 +14,21 @@ module "compute" {
   environment_root = var.environment_root
   
   # can be set for group, defaults to top-level value:
-  image_id = coalesce(each.value.image_id, var.cluster_image_id)
-  vnic_types = coalesce(each.value.vnic_types, var.vnic_types)
-  volume_backed_instances = coalesce(each.valuevolume_backed_instances, var.volume_backed_instances)
-  root_volume_size = coalesce(each.value.root_volume_size, var.root_volume_size)
-  gateway_ip = coalesce(each.value.gateway_ip, var.gateway_ip)
-  nodename_template = coalesce(each.value.nodename_template, var.cluster_nodename_template)
+  image_id = lookup(each.value, "image_id", var.cluster_image_id)
+  vnic_types = lookup(each.value, "vnic_types", var.vnic_types)
+  volume_backed_instances = lookup(each.value, "volume_backed_instances", var.volume_backed_instances)
+  root_volume_size = lookup(each.value, "root_volume_size", var.root_volume_size)
+  gateway_ip = lookup(each.value, "gateway_ip", var.gateway_ip)
+  nodename_template = lookup(each.value, "nodename_template", var.cluster_nodename_template)
 
   # optionally set for group:
-  networks = concat(var.cluster_networks, coalesce(each.value.extra_networks, []))
-  extra_volumes = coalesce(each.value.extra_volumes, {})
-  compute_init_enable = coalesce(each.value.compute_init_enable, [])
-  ignore_image_changes = coalesce(each.value.ignore_image_changes, false)
-  match_ironic_node = coalesce(each.value.match_ironic_node, false)
-  availability_zone = coalesce(each.value.availability_zone, "nova")
+  networks = concat(var.cluster_networks, lookup(each.value, "extra_networks", []))
+  # here null means "use module var default"
+  extra_volumes = lookup(each.value, "extra_volumes", null)
+  compute_init_enable = lookup(each.value, "compute_init_enable", null)
+  ignore_image_changes = lookup(each.value, "ignore_image_changes", null)
+  match_ironic_node = lookup(each.value, "match_ironic_node", null)
+  availability_zone = lookup(each.value, "availability_zone", null)
 
   # computed
   # not using openstack_compute_instance_v2.control.access_ip_v4 to avoid
diff --git a/environments/skeleton/{{cookiecutter.environment}}/tofu/node_group/variables.tf b/environments/skeleton/{{cookiecutter.environment}}/tofu/node_group/variables.tf
@@ -63,6 +63,7 @@ variable "extra_volumes" {
         })
     )
     default = {}
+    nullable = false
 }
 
 variable "security_group_ids" {
@@ -78,17 +79,18 @@ variable "compute_init_enable" {
     type = list(string)
     description = "Groups to activate for ansible-init compute rebuilds"
     default = []
+    nullable = false
 }
 
 variable "ignore_image_changes" {
     type = bool
     description = "Whether to ignore changes to the image_id parameter"
     default = false
+    nullable = false
 }
 
 variable "networks" {
     type = list(map(string))
-    default = []
 }
 
 variable "fip_addresses" {
@@ -114,12 +116,14 @@ variable "match_ironic_node" {
     type = bool
     description = "Whether to launch instances on the Ironic node of the same name as each cluster node"
     default = false
+    nullable = false
 }
 
 variable "availability_zone" {
     type = string
     description = "Name of availability zone - ignored unless match_ironic_node is true"
     default = "nova"
+    nullable = false
 }
 
 variable "baremetal_nodes" {
diff --git a/environments/skeleton/{{cookiecutter.environment}}/tofu/variables.tf b/environments/skeleton/{{cookiecutter.environment}}/tofu/variables.tf
@@ -101,28 +101,55 @@ variable "compute" {
             nodename_template: Overrides variable cluster_nodename_template
     EOF
     default = {}
-    type = map( # i.e. arbitrary keys, values are of given type ...
-        object({
-            # Only need to specify required/optional *keys* here to
-            # e.g. prevent missing/typos - value types are defined in
-            # module inputs so don't repeat here
-            nodes = any
-            flavor = any
-            
-            image_id = optional(any)
-            extra_networks = optional(any)
-            vnic_types = optional(any)
-            compute_init_enable = optional(any)
-            ignore_image_changes = optional(any)
-            volume_backed_instances = optional(any)
-            root_volume_size = optional(any)
-            extra_volumes = optional(any)
-            match_ironic_node = optional(any)
-            availability_zone = optional(any)
-            gateway_ip = optional(any)
-            nodename_template = optional(any)
-        })
-    )
+    type = any # can't do any better; TF type constraints can't cope with inhomogenous mappings
+    # module call will fail if missing required values so only need to check for unexpected ones
+    validation {
+        condition = length(
+                        setsubtract(
+                            flatten([for k, v in var.compute: keys(v)]),
+                            [
+                                "nodes",
+                                "flavor",
+                                "image_id",
+                                "extra_networks",
+                                "vnic_types",
+                                "compute_init_enable",
+                                "ignore_image_changes",
+                                "volume_backed_instances",
+                                "root_volume_size",
+                                "extra_volumes",
+                                "match_ironic_node",
+                                "availability_zone",
+                                "gateway_ip",
+                                "nodename_template"
+                            ]
+                        )
+                    ) == 0
+        error_message = <<-EOT
+            var.compute contains mappings with invalid keys: ${
+                join(", ", setsubtract(
+                                flatten([for k, v in var.compute: keys(v)]),
+                                [
+                                    "nodes",
+                                    "flavor",
+                                    "image_id",
+                                    "extra_networks",
+                                    "vnic_types",
+                                    "compute_init_enable",
+                                    "ignore_image_changes",
+                                    "volume_backed_instances",
+                                    "root_volume_size",
+                                    "extra_volumes",
+                                    "match_ironic_node",
+                                    "availability_zone",
+                                    "gateway_ip",
+                                    "nodename_template"
+                                ]
+                            )
+                            )
+            }
+        EOT
+    }
 }
 
 variable "environment_root" {

Original file line number	Diff line number	Diff line change
`@@ -74,7 +74,7 @@ module "cluster" {`
`74`	`74`	`flavor: var.other_node_flavor`
`75`	`75`	`}`
`76`	`76`	`}`
`77`		`- compute = tomap({`
	`77`	`+ compute = {`
`78`	`78`	`standard: { # NB: can't call this default!`
`79`	`79`	`nodes: ["compute-0", "compute-1"]`
`80`	`80`	`flavor: var.other_node_flavor`
`@@ -87,7 +87,7 @@ module "cluster" {`
`87`	`87`	`#nodes: ["extra-0", "extra-1"]`
`88`	`88`	`flavor: var.other_node_flavor`
`89`	`89`	`}`
`90`		`- })`
	`90`	`+ }`
`91`	`91`
`92`	`92`	`volume_backed_instances = var.volume_backed_instances`
`93`	`93`
Original file line number	Diff line number	Diff line change
`@@ -63,6 +63,7 @@ variable "extra_volumes" {`
`63`	`63`	`})`
`64`	`64`	`)`
`65`	`65`	`default = {}`
	`66`	`+ nullable = false`
`66`	`67`	`}`
`67`	`68`
`68`	`69`	`variable "security_group_ids" {`
`@@ -78,17 +79,18 @@ variable "compute_init_enable" {`
`78`	`79`	`type = list(string)`
`79`	`80`	`description = "Groups to activate for ansible-init compute rebuilds"`
`80`	`81`	`default = []`
	`82`	`+ nullable = false`
`81`	`83`	`}`
`82`	`84`
`83`	`85`	`variable "ignore_image_changes" {`
`84`	`86`	`type = bool`
`85`	`87`	`description = "Whether to ignore changes to the image_id parameter"`
`86`	`88`	`default = false`
	`89`	`+ nullable = false`
`87`	`90`	`}`
`88`	`91`
`89`	`92`	`variable "networks" {`
`90`	`93`	`type = list(map(string))`
`91`		`- default = []`
`92`	`94`	`}`
`93`	`95`
`94`	`96`	`variable "fip_addresses" {`
`@@ -114,12 +116,14 @@ variable "match_ironic_node" {`
`114`	`116`	`type = bool`
`115`	`117`	`description = "Whether to launch instances on the Ironic node of the same name as each cluster node"`
`116`	`118`	`default = false`
	`119`	`+ nullable = false`
`117`	`120`	`}`
`118`	`121`
`119`	`122`	`variable "availability_zone" {`
`120`	`123`	`type = string`
`121`	`124`	`description = "Name of availability zone - ignored unless match_ironic_node is true"`
`122`	`125`	`default = "nova"`
	`126`	`+ nullable = false`
`123`	`127`	`}`
`124`	`128`
`125`	`129`	`variable "baremetal_nodes" {`