feat: The operating_system input is now a required variable for OCP related DAs. Valid values are REDHAT_8_64 or RHCOS. Anyone who is using the override json will now also need to explicitly set this value. (#905)

Aashiq-J · web-flow · commit e2390eb9df74 · 2024-10-23T14:49:45.000+01:00
diff --git a/README.md b/README.md
diff --git a/cluster.tf b/cluster.tf
@@ -244,7 +244,7 @@ module "cluster" {
     if cluster.kube_type == "openshift"
   }
   source             = "terraform-ibm-modules/base-ocp-vpc/ibm"
-  version            = "3.32.1"
+  version            = "3.34.0"
   resource_group_id  = local.resource_groups[each.value.resource_group]
   region             = var.region
   cluster_name       = each.value.cluster_name
@@ -289,7 +289,6 @@ module "cluster" {
     ] : []
   )
   force_delete_storage                  = each.value.cluster_force_delete_storage
-  operating_system                      = each.value.operating_system
   ocp_version                           = each.value.kube_version == null || each.value.kube_version == "default" ? each.value.kube_version : replace(each.value.kube_version, "_openshift", "")
   import_default_worker_pool_on_create  = each.value.import_default_worker_pool_on_create
   allow_default_worker_pool_replacement = each.value.allow_default_worker_pool_replacement
diff --git a/dynamic_values/cluster.tf b/dynamic_values/cluster.tf
@@ -37,6 +37,7 @@ module "ut_cluster_map" {
           workers_per_subnet = 2
           flavor             = "spicy"
           secondary_storage  = "300gb.5iops-tier"
+          operating_system   = "REDHAT_8_64"
         }
       ]
     }
diff --git a/dynamic_values/cluster_worker_pools.tf b/dynamic_values/cluster_worker_pools.tf
@@ -36,6 +36,7 @@ module "ut_worker_pools" {
           workers_per_subnet = 2
           flavor             = "spicy"
           secondary_storage  = "300gb.5iops-tier"
+          operating_system   = "REDHAT_8_64"
         }
       ]
     }
diff --git a/dynamic_values/config_modules/cluster_worker_pools/worker_pools.tf b/dynamic_values/config_modules/cluster_worker_pools/worker_pools.tf
@@ -86,7 +86,7 @@ locals {
           vpc_id           = var.vpc_modules[pool.vpc_name].vpc_id                   # add vpc_id
           subnets          = module.worker_pool_subnets["${var.prefix}-${cluster.name}-${pool.name}"].subnets
           kube_type        = cluster.kube_type
-          operating_system = lookup(pool, "operating_system", null)
+          operating_system = lookup(pool, "operating_system", "REDHAT_8_64")
         }) if pool != null
       ] if cluster.worker_pools != null
     ]
diff --git a/examples/override-example/override.json b/examples/override-example/override.json
@@ -36,6 +36,7 @@
           "flavor": "bx2.16x64",
           "name": "logging-worker-pool",
           "secondary_storage": "300gb.5iops-tier",
+          "operating_system" : "REDHAT_8_64",
           "subnet_names": [
             "vsi-zone-1",
             "vsi-zone-2",
diff --git a/patterns/mixed/config.tf b/patterns/mixed/config.tf
@@ -133,6 +133,7 @@ locals {
               "vsi-zone-${zone}"
             ]
             entitlement          = var.entitlement
+            operating_system     = "REDHAT_8_64"
             workers_per_subnet   = var.workers_per_zone
             flavor               = var.flavor
             secondary_storage    = var.secondary_storage
diff --git a/patterns/mixed/override.json b/patterns/mixed/override.json
@@ -29,6 +29,7 @@
                     "entitlement": "cloud_pak",
                     "flavor": "bx2.16x64",
                     "name": "logging-worker-pool",
+                    "operating_system": "REDHAT_8_64",
                     "subnet_names": [
                         "vsi-zone-1",
                         "vsi-zone-2",
diff --git a/patterns/roks-quickstart/main.tf b/patterns/roks-quickstart/main.tf
@@ -34,7 +34,7 @@ locals {
          "resource_group": "workload-rg",
          "disable_outbound_traffic_protection": true,
          "cluster_force_delete_storage": true,
-         "operating_system": null,
+         "operating_system": "REDHAT_8_64",
          "kms_wait_for_apply": true,
          "kms_config": {
             "crk_name": "roks-key",
diff --git a/patterns/roks/module/config.tf b/patterns/roks/module/config.tf
@@ -122,6 +122,7 @@ locals {
           #   workers_per_subnet   = var.workers_per_zone
           #   flavor               = var.flavor
           #   boot_volume_crk_name = "${var.prefix}-roks-key"
+          #   operating_system     = "REDHAT_8_64"
           # }
         ]
       }
diff --git a/patterns/roks/module/variables.tf b/patterns/roks/module/variables.tf
@@ -272,10 +272,10 @@ variable "cluster_force_delete_storage" {
 variable "operating_system" {
   type        = string
   description = "The operating system of the workers in the default worker pool. If no value is specified, the current default version OS will be used. See https://cloud.ibm.com/docs/openshift?topic=openshift-openshift_versions#openshift_versions_available ."
-  default     = null
+  default     = "REDHAT_8_64"
   validation {
     error_message = "RHEL 8 (REDHAT_8_64) or Red Hat Enterprise Linux CoreOS (RHCOS) are the allowed OS values. RHCOS requires VPC clusters created from 4.15 onwards. Upgraded clusters from 4.14 cannot use RHCOS."
-    condition     = var.operating_system == null || var.operating_system == "REDHAT_8_64" || var.operating_system == "RHCOS"
+    condition     = var.operating_system == "REDHAT_8_64" || var.operating_system == "RHCOS"
   }
 }
 
diff --git a/patterns/roks/override.json b/patterns/roks/override.json
@@ -39,6 +39,7 @@
                         "vsi-zone-3"
                     ],
                     "vpc_name": "management",
+                    "operating_system": "REDHAT_8_64",
                     "workers_per_subnet": 2
                 }
             ],
@@ -76,6 +77,7 @@
                         "vsi-zone-3"
                     ],
                     "vpc_name": "workload",
+                    "operating_system": "REDHAT_8_64",
                     "workers_per_subnet": 2
                 }
             ],
diff --git a/patterns/roks/variables.tf b/patterns/roks/variables.tf
@@ -290,10 +290,10 @@ variable "cluster_force_delete_storage" {
 variable "operating_system" {
   type        = string
   description = "The operating system of the workers in the default worker pool. If no value is specified, the current default version OS will be used. See https://cloud.ibm.com/docs/openshift?topic=openshift-openshift_versions#openshift_versions_available ."
-  default     = null
+  default     = "REDHAT_8_64"
   validation {
     error_message = "RHEL 8 (REDHAT_8_64) or Red Hat Enterprise Linux CoreOS (RHCOS) are the allowed OS values. RHCOS requires VPC clusters created from 4.15 onwards. Upgraded clusters from 4.14 cannot use RHCOS."
-    condition     = var.operating_system == null || var.operating_system == "REDHAT_8_64" || var.operating_system == "RHCOS"
+    condition     = var.operating_system == "REDHAT_8_64" || var.operating_system == "RHCOS"
   }
 }
 
diff --git a/variables.tf b/variables.tf
@@ -889,7 +889,7 @@ variable "clusters" {
             entitlement          = optional(string)      # entitlement option for openshift
             secondary_storage    = optional(string)      # Secondary storage type
             boot_volume_crk_name = optional(string)      # Boot volume encryption key name
-            operating_system     = optional(string)      # The operating system of the workers in the default worker pool. If no value is specified, the current default version OS will be used. See https://cloud.ibm.com/docs/openshift?topic=openshift-openshift_versions#openshift_versions_available .
+            operating_system     = string                # The operating system of the workers in the default worker pool. See https://cloud.ibm.com/docs/openshift?topic=openshift-openshift_versions#openshift_versions_available .
             labels               = optional(map(string)) # A list of labels that you want to add to all the worker nodes in the worker pool.
           })
         )

Original file line number	Diff line number	Diff line change
`@@ -37,6 +37,7 @@ module "ut_cluster_map" {`
`37`	`37`	`workers_per_subnet = 2`
`38`	`38`	`flavor = "spicy"`
`39`	`39`	`secondary_storage = "300gb.5iops-tier"`
	`40`	`+ operating_system = "REDHAT_8_64"`
`40`	`41`	`}`
`41`	`42`	`]`
`42`	`43`	`}`
Original file line number	Diff line number	Diff line change
`@@ -36,6 +36,7 @@ module "ut_worker_pools" {`
`36`	`36`	`workers_per_subnet = 2`
`37`	`37`	`flavor = "spicy"`
`38`	`38`	`secondary_storage = "300gb.5iops-tier"`
	`39`	`+ operating_system = "REDHAT_8_64"`
`39`	`40`	`}`
`40`	`41`	`]`
`41`	`42`	`}`
Original file line number	Diff line number	Diff line change
`@@ -86,7 +86,7 @@ locals {`
`86`	`86`	`vpc_id = var.vpc_modules[pool.vpc_name].vpc_id # add vpc_id`
`87`	`87`	`subnets = module.worker_pool_subnets["${var.prefix}-${cluster.name}-${pool.name}"].subnets`
`88`	`88`	`kube_type = cluster.kube_type`
`89`		`- operating_system = lookup(pool, "operating_system", null)`
	`89`	`+ operating_system = lookup(pool, "operating_system", "REDHAT_8_64")`
`90`	`90`	`}) if pool != null`
`91`	`91`	`] if cluster.worker_pools != null`
`92`	`92`	`]`
Original file line number	Diff line number	Diff line change
`@@ -133,6 +133,7 @@ locals {`
`133`	`133`	`"vsi-zone-${zone}"`
`134`	`134`	`]`
`135`	`135`	`entitlement = var.entitlement`
	`136`	`+ operating_system = "REDHAT_8_64"`
`136`	`137`	`workers_per_subnet = var.workers_per_zone`
`137`	`138`	`flavor = var.flavor`
`138`	`139`	`secondary_storage = var.secondary_storage`
Original file line number	Diff line number	Diff line change
`@@ -122,6 +122,7 @@ locals {`
`122`	`122`	`# workers_per_subnet = var.workers_per_zone`
`123`	`123`	`# flavor = var.flavor`
`124`	`124`	`# boot_volume_crk_name = "${var.prefix}-roks-key"`
	`125`	`+ # operating_system = "REDHAT_8_64"`
`125`	`126`	`# }`
`126`	`127`	`]`
`127`	`128`	`}`