feat: improved user experience for validating input variable values <br>* updated required terraform to be >= 1.9.0 (#994)

mukulpalit-ibm · web-flow · commit 17a4c1adb581 · 2025-05-16T12:14:00.000+05:30
diff --git a/README.md b/README.md
@@ -842,7 +842,7 @@ module "cluster_pattern" {
 
 | Name | Version |
 |------|---------|
-| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.3 |
+| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.9.0 |
 | <a name="requirement_ibm"></a> [ibm](#requirement\_ibm) | >= 1.78.0, < 2.0.0 |
 | <a name="requirement_random"></a> [random](#requirement\_random) | >= 3.4.3, < 4.0.0 |
 | <a name="requirement_time"></a> [time](#requirement\_time) | >= 0.9.1, < 1.0.0 |
diff --git a/dynamic_values/config_modules/appid/versions.tf b/dynamic_values/config_modules/appid/versions.tf
@@ -3,7 +3,7 @@
 ##############################################################################
 
 terraform {
-  required_version = ">= 1.3"
+  required_version = ">= 1.9.0"
 }
 
 ##############################################################################
diff --git a/dynamic_values/config_modules/bastion_vsi_list_to_map/versions.tf b/dynamic_values/config_modules/bastion_vsi_list_to_map/versions.tf
@@ -3,7 +3,7 @@
 ##############################################################################
 
 terraform {
-  required_version = ">= 1.3"
+  required_version = ">= 1.9.0"
 }
 
 ##############################################################################
diff --git a/dynamic_values/config_modules/cluster_worker_pools/versions.tf b/dynamic_values/config_modules/cluster_worker_pools/versions.tf
@@ -3,7 +3,7 @@
 ##############################################################################
 
 terraform {
-  required_version = ">= 1.3"
+  required_version = ">= 1.9.0"
 }
 
 ##############################################################################
diff --git a/dynamic_values/config_modules/clusters/versions.tf b/dynamic_values/config_modules/clusters/versions.tf
@@ -3,7 +3,7 @@
 ##############################################################################
 
 terraform {
-  required_version = ">= 1.3"
+  required_version = ">= 1.9.0"
 }
 
 ##############################################################################
diff --git a/dynamic_values/config_modules/cos/versions.tf b/dynamic_values/config_modules/cos/versions.tf
@@ -3,7 +3,7 @@
 ##############################################################################
 
 terraform {
-  required_version = ">= 1.3"
+  required_version = ">= 1.9.0"
 }
 
 ##############################################################################
diff --git a/dynamic_values/config_modules/f5/versions.tf b/dynamic_values/config_modules/f5/versions.tf
@@ -3,7 +3,7 @@
 ##############################################################################
 
 terraform {
-  required_version = ">= 1.3"
+  required_version = ">= 1.9.0"
 }
 
 ##############################################################################
diff --git a/dynamic_values/config_modules/flow_logs/versions.tf b/dynamic_values/config_modules/flow_logs/versions.tf
@@ -3,7 +3,7 @@
 ##############################################################################
 
 terraform {
-  required_version = ">= 1.3"
+  required_version = ">= 1.9.0"
 }
 
 ##############################################################################
diff --git a/dynamic_values/config_modules/get_subnets/versions.tf b/dynamic_values/config_modules/get_subnets/versions.tf
@@ -3,7 +3,7 @@
 ##############################################################################
 
 terraform {
-  required_version = ">= 1.3"
+  required_version = ">= 1.9.0"
 }
 
 ##############################################################################
diff --git a/dynamic_values/config_modules/list_to_map/versions.tf b/dynamic_values/config_modules/list_to_map/versions.tf
@@ -3,7 +3,7 @@
 ##############################################################################
 
 terraform {
-  required_version = ">= 1.3"
+  required_version = ">= 1.9.0"
 }
 
 ##############################################################################
diff --git a/dynamic_values/config_modules/list_to_map_value/versions.tf b/dynamic_values/config_modules/list_to_map_value/versions.tf
@@ -3,7 +3,7 @@
 ##############################################################################
 
 terraform {
-  required_version = ">= 1.3"
+  required_version = ">= 1.9.0"
 }
 
 ##############################################################################
diff --git a/dynamic_values/config_modules/nested_list_to_map_and_merge/versions.tf b/dynamic_values/config_modules/nested_list_to_map_and_merge/versions.tf
@@ -3,7 +3,7 @@
 ##############################################################################
 
 terraform {
-  required_version = ">= 1.3"
+  required_version = ">= 1.9.0"
 }
 
 ##############################################################################
diff --git a/dynamic_values/config_modules/service_authorizations/versions.tf b/dynamic_values/config_modules/service_authorizations/versions.tf
@@ -3,7 +3,7 @@
 ##############################################################################
 
 terraform {
-  required_version = ">= 1.3"
+  required_version = ">= 1.9.0"
 }
 
 ##############################################################################
diff --git a/dynamic_values/config_modules/vpe/versions.tf b/dynamic_values/config_modules/vpe/versions.tf
@@ -3,7 +3,7 @@
 ##############################################################################
 
 terraform {
-  required_version = ">= 1.3"
+  required_version = ">= 1.9.0"
 }
 
 ##############################################################################
diff --git a/dynamic_values/config_modules/vpn/versions.tf b/dynamic_values/config_modules/vpn/versions.tf
@@ -3,7 +3,7 @@
 ##############################################################################
 
 terraform {
-  required_version = ">= 1.3"
+  required_version = ">= 1.9.0"
 }
 
 ##############################################################################
diff --git a/dynamic_values/config_modules/vsi/versions.tf b/dynamic_values/config_modules/vsi/versions.tf
@@ -3,7 +3,7 @@
 ##############################################################################
 
 terraform {
-  required_version = ">= 1.3"
+  required_version = ">= 1.9.0"
 }
 
 ##############################################################################
diff --git a/dynamic_values/versions.tf b/dynamic_values/versions.tf
@@ -3,7 +3,7 @@
 ##############################################################################
 
 terraform {
-  required_version = ">= 1.3"
+  required_version = ">= 1.9.0"
 }
 
 ##############################################################################
diff --git a/examples/one-vpc-one-vsi/version.tf b/examples/one-vpc-one-vsi/version.tf
@@ -1,5 +1,5 @@
 terraform {
-  required_version = ">= 1.3"
+  required_version = ">= 1.9.0"
   required_providers {
     ibm = {
       source  = "IBM-Cloud/ibm"
diff --git a/examples/override-example/version.tf b/examples/override-example/version.tf
@@ -1,5 +1,5 @@
 terraform {
-  required_version = ">= 1.3"
+  required_version = ">= 1.9.0"
   required_providers {
     ibm = {
       source  = "IBM-Cloud/ibm"
diff --git a/f5_config/versions.tf b/f5_config/versions.tf
@@ -3,7 +3,7 @@
 ##############################################################################
 
 terraform {
-  required_version = ">= 1.3"
+  required_version = ">= 1.9.0"
 }
 
 ##############################################################################
diff --git a/kms/dynamic_values/versions.tf b/kms/dynamic_values/versions.tf
@@ -3,7 +3,7 @@
 ##############################################################################
 
 terraform {
-  required_version = ">= 1.3"
+  required_version = ">= 1.9.0"
 }
 
 ##############################################################################
diff --git a/kms/versions.tf b/kms/versions.tf
@@ -3,13 +3,13 @@
 ##############################################################################
 
 terraform {
+  required_version = ">= 1.9.0"
   required_providers {
     ibm = {
       source  = "IBM-Cloud/ibm"
       version = ">= 1.60.0, < 2.0.0"
     }
   }
-  required_version = ">= 1.3"
 }
 
 ##############################################################################
diff --git a/patterns/dynamic_values/config_modules/acl_rules/versions.tf b/patterns/dynamic_values/config_modules/acl_rules/versions.tf
@@ -3,7 +3,7 @@
 ##############################################################################
 
 terraform {
-  required_version = ">= 1.3"
+  required_version = ">= 1.9.0"
 }
 
 ##############################################################################
diff --git a/patterns/dynamic_values/config_modules/bastion_gateways/versions.tf b/patterns/dynamic_values/config_modules/bastion_gateways/versions.tf
@@ -3,7 +3,7 @@
 ##############################################################################
 
 terraform {
-  required_version = ">= 1.3"
+  required_version = ">= 1.9.0"
 }
 
 ##############################################################################
diff --git a/patterns/dynamic_values/config_modules/bastion_vsi/versions.tf b/patterns/dynamic_values/config_modules/bastion_vsi/versions.tf
@@ -3,7 +3,7 @@
 ##############################################################################
 
 terraform {
-  required_version = ">= 1.3"
+  required_version = ">= 1.9.0"
 }
 
 ##############################################################################
diff --git a/patterns/dynamic_values/config_modules/bastion_zone_list/versions.tf b/patterns/dynamic_values/config_modules/bastion_zone_list/versions.tf
@@ -3,7 +3,7 @@
 ##############################################################################
 
 terraform {
-  required_version = ">= 1.3"
+  required_version = ">= 1.9.0"
 }
 
 ##############################################################################
diff --git a/patterns/dynamic_values/config_modules/cloud_object_storage/versions.tf b/patterns/dynamic_values/config_modules/cloud_object_storage/versions.tf
@@ -3,7 +3,7 @@
 ##############################################################################
 
 terraform {
-  required_version = ">= 1.3"
+  required_version = ">= 1.9.0"
 }
 
 ##############################################################################
diff --git a/patterns/dynamic_values/config_modules/default_security_group_rules/versions.tf b/patterns/dynamic_values/config_modules/default_security_group_rules/versions.tf
@@ -3,7 +3,7 @@
 ##############################################################################
 
 terraform {
-  required_version = ">= 1.3"
+  required_version = ">= 1.9.0"
 }
 
 ##############################################################################
diff --git a/patterns/dynamic_values/config_modules/f5_deployments/versions.tf b/patterns/dynamic_values/config_modules/f5_deployments/versions.tf
@@ -3,7 +3,7 @@
 ##############################################################################
 
 terraform {
-  required_version = ">= 1.3"
+  required_version = ">= 1.9.0"
 }
 
 ##############################################################################
diff --git a/patterns/dynamic_values/config_modules/f5_security_group_rules/versions.tf b/patterns/dynamic_values/config_modules/f5_security_group_rules/versions.tf
@@ -3,7 +3,7 @@
 ##############################################################################
 
 terraform {
-  required_version = ">= 1.3"
+  required_version = ">= 1.9.0"
 }
 
 ##############################################################################
diff --git a/patterns/dynamic_values/config_modules/f5_tiers/versions.tf b/patterns/dynamic_values/config_modules/f5_tiers/versions.tf
@@ -3,7 +3,7 @@
 ##############################################################################
 
 terraform {
-  required_version = ">= 1.3"
+  required_version = ">= 1.9.0"
 }
 
 ##############################################################################
diff --git a/patterns/dynamic_values/config_modules/key_management/versions.tf b/patterns/dynamic_values/config_modules/key_management/versions.tf
@@ -3,7 +3,7 @@
 ##############################################################################
 
 terraform {
-  required_version = ">= 1.3"
+  required_version = ">= 1.9.0"
 }
 
 ##############################################################################
diff --git a/patterns/dynamic_values/config_modules/network_acls/versions.tf b/patterns/dynamic_values/config_modules/network_acls/versions.tf
@@ -3,7 +3,7 @@
 ##############################################################################
 
 terraform {
-  required_version = ">= 1.3"
+  required_version = ">= 1.9.0"
 }
 
 ##############################################################################
diff --git a/patterns/dynamic_values/config_modules/resource_groups/versions.tf b/patterns/dynamic_values/config_modules/resource_groups/versions.tf
@@ -3,7 +3,7 @@
 ##############################################################################
 
 terraform {
-  required_version = ">= 1.3"
+  required_version = ">= 1.9.0"
 }
 
 ##############################################################################
diff --git a/patterns/dynamic_values/config_modules/security_groups/versions.tf b/patterns/dynamic_values/config_modules/security_groups/versions.tf
@@ -3,7 +3,7 @@
 ##############################################################################
 
 terraform {
-  required_version = ">= 1.3"
+  required_version = ">= 1.9.0"
 }
 
 ##############################################################################
diff --git a/patterns/dynamic_values/config_modules/subnet_cidr/versions.tf b/patterns/dynamic_values/config_modules/subnet_cidr/versions.tf
@@ -3,7 +3,7 @@
 ##############################################################################
 
 terraform {
-  required_version = ">= 1.3"
+  required_version = ">= 1.9.0"
 }
 
 ##############################################################################
diff --git a/patterns/dynamic_values/config_modules/vpc/versions.tf b/patterns/dynamic_values/config_modules/vpc/versions.tf
@@ -3,7 +3,7 @@
 ##############################################################################
 
 terraform {
-  required_version = ">= 1.3"
+  required_version = ">= 1.9.0"
 }
 
 ##############################################################################
diff --git a/patterns/dynamic_values/config_modules/vpc_address_prefixes/versions.tf b/patterns/dynamic_values/config_modules/vpc_address_prefixes/versions.tf
@@ -3,7 +3,7 @@
 ##############################################################################
 
 terraform {
-  required_version = ">= 1.3"
+  required_version = ">= 1.9.0"
 }
 
 ##############################################################################
diff --git a/patterns/dynamic_values/config_modules/vpc_subnet_tiers/versions.tf b/patterns/dynamic_values/config_modules/vpc_subnet_tiers/versions.tf
@@ -3,7 +3,7 @@
 ##############################################################################
 
 terraform {
-  required_version = ">= 1.3"
+  required_version = ">= 1.9.0"
 }
 
 ##############################################################################
diff --git a/patterns/dynamic_values/versions.tf b/patterns/dynamic_values/versions.tf
@@ -3,7 +3,7 @@
 ##############################################################################
 
 terraform {
-  required_version = ">= 1.3"
+  required_version = ">= 1.9.0"
 }
 
 ##############################################################################
diff --git a/patterns/mixed/config.tf b/patterns/mixed/config.tf
@@ -45,16 +45,6 @@ locals {
   }
   override_type = var.override_json_string == "" ? "override" : "override_json_string"
 
-  ##############################################################################
-  # VALIDATION FOR SSH_KEY
-  ##############################################################################
-
-  override_validation   = (var.override == false && length(var.override_json_string) == 0) ? true : false
-  sshkey_var_validation = (var.ssh_public_key == null && var.existing_ssh_key_name == null) ? true : false
-
-  # tflint-ignore: terraform_unused_declarations
-  validate_ssh = local.override_validation && local.sshkey_var_validation ? tobool("Invalid input: both ssh_public_key and existing_ssh_key_name variables cannot be null together. Please provide a value for at least one of them.") : true
-
   ##############################################################################
   # Default SSH key
   ##############################################################################
diff --git a/patterns/mixed/variables.tf b/patterns/mixed/variables.tf
@@ -589,6 +589,14 @@ variable "override_json_string" {
   description = "Override default values with a JSON object. Any JSON other than an empty string overrides other configuration changes. You can use the [landing zone configuration tool](https://terraform-ibm-modules.github.io/landing-zone-config-tool/#/home) to create the JSON."
   type        = string
   default     = ""
+
+  validation {
+    condition = !(
+      var.override == false && length(var.override_json_string) == 0 &&
+      var.ssh_public_key == null && var.existing_ssh_key_name == null
+    )
+    error_message = "The ssh_public_key and existing_ssh_key_name cannot both be null when override is false and override_json_string is empty."
+  }
 }
 
 ##############################################################################
diff --git a/patterns/mixed/versions.tf b/patterns/mixed/versions.tf
diff --git a/patterns/roks-quickstart/version.tf b/patterns/roks-quickstart/version.tf
diff --git a/patterns/roks/module/versions.tf b/patterns/roks/module/versions.tf
diff --git a/patterns/roks/versions.tf b/patterns/roks/versions.tf
diff --git a/patterns/vpc/module/version.tf b/patterns/vpc/module/version.tf
diff --git a/patterns/vpc/version.tf b/patterns/vpc/version.tf
diff --git a/patterns/vsi-extension/config.tf b/patterns/vsi-extension/config.tf
diff --git a/patterns/vsi-extension/variables.tf b/patterns/vsi-extension/variables.tf
diff --git a/patterns/vsi-extension/version.tf b/patterns/vsi-extension/version.tf
diff --git a/patterns/vsi-quickstart/version.tf b/patterns/vsi-quickstart/version.tf
diff --git a/patterns/vsi/module/config.tf b/patterns/vsi/module/config.tf
diff --git a/patterns/vsi/module/variables.tf b/patterns/vsi/module/variables.tf
diff --git a/patterns/vsi/module/versions.tf b/patterns/vsi/module/versions.tf
diff --git a/patterns/vsi/versions.tf b/patterns/vsi/versions.tf
diff --git a/ssh_key/versions.tf b/ssh_key/versions.tf
diff --git a/teleport_config/versions.tf b/teleport_config/versions.tf
diff --git a/tests/resources/slz-vpc/version.tf b/tests/resources/slz-vpc/version.tf
diff --git a/version.tf b/version.tf

Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@`
`3`	`3`	`##############################################################################`
`4`	`4`
`5`	`5`	`terraform {`
`6`		`- required_version = ">= 1.3"`
	`6`	`+ required_version = ">= 1.9.0"`
`7`	`7`	`}`
`8`	`8`
`9`	`9`	`##############################################################################`