fix: use_manual_address_prefixes input variable has been removed (#507)

mounika-nalla · web-flow · commit 0699a66193f2 · 2023-04-18T13:08:57.000+01:00
BREAKING CHANGE

Removed the input variable `use_manual_address_prefixes`.  The value of this variable is now computed by the module based on the `address_prefixes` input variable. If `address_prefixes` variable is set, then the modules determine that manual address prefix are used.

Note: in the event that `use_manual_address_prefix=false` (the default value) AND `address_prefixes` was specified, the VPC and everything deployed into it will be destroyed and it will be recreated when moving up to this version. To avoid this - BEFORE upgrading to this version of the module - set `use_manual_address_prefix` to true, and apply the change (`terraform apply`). You are now ready to upgrade to the new version without ending up in a VPC deletion.
diff --git a/README.md b/README.md
@@ -77,7 +77,7 @@ You need the following permissions to run this module.
 | Name | Version |
 |------|---------|
 | <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.3.0 |
-| <a name="requirement_ibm"></a> [ibm](#requirement\_ibm) | >= 1.49.0 |
+| <a name="requirement_ibm"></a> [ibm](#requirement\_ibm) | >= 1.52.0 |
 
 ## Modules
 
@@ -127,7 +127,6 @@ You need the following permissions to run this module.
 | <a name="input_security_group_rules"></a> [security\_group\_rules](#input\_security\_group\_rules) | A list of security group rules to be added to the default vpc security group | <pre>list(<br>    object({<br>      name      = string<br>      direction = string<br>      remote    = string<br>      tcp = optional(<br>        object({<br>          port_max = optional(number)<br>          port_min = optional(number)<br>        })<br>      )<br>      udp = optional(<br>        object({<br>          port_max = optional(number)<br>          port_min = optional(number)<br>        })<br>      )<br>      icmp = optional(<br>        object({<br>          type = optional(number)<br>          code = optional(number)<br>        })<br>      )<br>    })<br>  )</pre> | <pre>[<br>  {<br>    "direction": "inbound",<br>    "name": "default-sgr",<br>    "remote": "10.0.0.0/8"<br>  }<br>]</pre> | no |
 | <a name="input_subnets"></a> [subnets](#input\_subnets) | List of subnets for the vpc. For each item in each array, a subnet will be created. Items can be either CIDR blocks or total ipv4 addressess. Public gateways will be enabled only in zones where a gateway has been created | <pre>object({<br>    zone-1 = list(object({<br>      name           = string<br>      cidr           = string<br>      public_gateway = optional(bool)<br>      acl_name       = string<br>    }))<br>    zone-2 = list(object({<br>      name           = string<br>      cidr           = string<br>      public_gateway = optional(bool)<br>      acl_name       = string<br>    }))<br>    zone-3 = list(object({<br>      name           = string<br>      cidr           = string<br>      public_gateway = optional(bool)<br>      acl_name       = string<br>    }))<br>  })</pre> | <pre>{<br>  "zone-1": [<br>    {<br>      "acl_name": "vpc-acl",<br>      "cidr": "10.10.10.0/24",<br>      "name": "subnet-a",<br>      "public_gateway": true<br>    }<br>  ],<br>  "zone-2": [<br>    {<br>      "acl_name": "vpc-acl",<br>      "cidr": "10.20.10.0/24",<br>      "name": "subnet-b",<br>      "public_gateway": true<br>    }<br>  ],<br>  "zone-3": [<br>    {<br>      "acl_name": "vpc-acl",<br>      "cidr": "10.30.10.0/24",<br>      "name": "subnet-c",<br>      "public_gateway": false<br>    }<br>  ]<br>}</pre> | no |
 | <a name="input_tags"></a> [tags](#input\_tags) | List of Tags for the resource created | `list(string)` | `null` | no |
-| <a name="input_use_manual_address_prefixes"></a> [use\_manual\_address\_prefixes](#input\_use\_manual\_address\_prefixes) | OPTIONAL - Use manual address prefixes for VPC | `bool` | `false` | no |
 | <a name="input_use_public_gateways"></a> [use\_public\_gateways](#input\_use\_public\_gateways) | Create a public gateway in any of the three zones with `true`. | <pre>object({<br>    zone-1 = optional(bool)<br>    zone-2 = optional(bool)<br>    zone-3 = optional(bool)<br>  })</pre> | <pre>{<br>  "zone-1": true,<br>  "zone-2": false,<br>  "zone-3": false<br>}</pre> | no |
 
 ## Outputs
diff --git a/examples/default/version.tf b/examples/default/version.tf
@@ -4,7 +4,7 @@ terraform {
     # Pin to the lowest provider version of the range defined in the main module's version.tf to ensure lowest version still works
     ibm = {
       source  = "IBM-Cloud/ibm"
-      version = "1.49.0"
+      version = "1.52.0"
     }
   }
 }
diff --git a/examples/landing_zone/version.tf b/examples/landing_zone/version.tf
@@ -4,7 +4,7 @@ terraform {
     # Pin to the lowest provider version of the range defined in the main module's version.tf to ensure lowest version still works
     ibm = {
       source  = "IBM-Cloud/ibm"
-      version = "1.51.0"
+      version = "1.52.0"
     }
   }
 }
diff --git a/landing-zone-submodule/management-vpc/README.md b/landing-zone-submodule/management-vpc/README.md
@@ -44,7 +44,6 @@ No resources.
 | <a name="input_resource_group_id"></a> [resource\_group\_id](#input\_resource\_group\_id) | The resource group ID where the VPC to be created | `string` | n/a | yes |
 | <a name="input_subnets"></a> [subnets](#input\_subnets) | Object for subnets to be created in each zone, each zone can have any number of subnets | <pre>object({<br>    zone-1 = list(object({<br>      name           = string<br>      cidr           = string<br>      public_gateway = optional(bool)<br>      acl_name       = string<br>    }))<br>    zone-2 = list(object({<br>      name           = string<br>      cidr           = string<br>      public_gateway = optional(bool)<br>      acl_name       = string<br>    }))<br>    zone-3 = list(object({<br>      name           = string<br>      cidr           = string<br>      public_gateway = optional(bool)<br>      acl_name       = string<br>    }))<br>  })</pre> | <pre>{<br>  "zone-1": [<br>    {<br>      "acl_name": "management-acl",<br>      "cidr": "10.10.10.0/24",<br>      "name": "vsi-zone-1",<br>      "public_gateway": false<br>    },<br>    {<br>      "acl_name": "management-acl",<br>      "cidr": "10.10.20.0/24",<br>      "name": "vpe-zone-1",<br>      "public_gateway": false<br>    },<br>    {<br>      "acl_name": "management-acl",<br>      "cidr": "10.10.30.0/24",<br>      "name": "vpn-zone-1",<br>      "public_gateway": false<br>    }<br>  ],<br>  "zone-2": [<br>    {<br>      "acl_name": "management-acl",<br>      "cidr": "10.20.10.0/24",<br>      "name": "vsi-zone-2",<br>      "public_gateway": false<br>    },<br>    {<br>      "acl_name": "management-acl",<br>      "cidr": "10.20.20.0/24",<br>      "name": "vpe-zone-2",<br>      "public_gateway": false<br>    }<br>  ],<br>  "zone-3": [<br>    {<br>      "acl_name": "management-acl",<br>      "cidr": "10.30.10.0/24",<br>      "name": "vsi-zone-3",<br>      "public_gateway": false<br>    },<br>    {<br>      "acl_name": "management-acl",<br>      "cidr": "10.30.20.0/24",<br>      "name": "vpe-zone-3",<br>      "public_gateway": false<br>    }<br>  ]<br>}</pre> | no |
 | <a name="input_tags"></a> [tags](#input\_tags) | List of tags to apply to resources created by this module. | `list(string)` | `[]` | no |
-| <a name="input_use_manual_address_prefixes"></a> [use\_manual\_address\_prefixes](#input\_use\_manual\_address\_prefixes) | Optionally assign prefixes to VPC manually. By default this is false, and prefixes will be created along with subnets | `bool` | `true` | no |
 | <a name="input_use_public_gateways"></a> [use\_public\_gateways](#input\_use\_public\_gateways) | For each `zone` that is set to `true`, a public gateway will be created in that zone | <pre>object({<br>    zone-1 = optional(bool)<br>    zone-2 = optional(bool)<br>    zone-3 = optional(bool)<br>  })</pre> | <pre>{<br>  "zone-1": false,<br>  "zone-2": false,<br>  "zone-3": false<br>}</pre> | no |
 
 ## Outputs
diff --git a/landing-zone-submodule/management-vpc/main.tf b/landing-zone-submodule/management-vpc/main.tf
@@ -11,7 +11,6 @@ module "management_vpc" {
   prefix                                 = var.prefix
   network_cidr                           = var.network_cidr
   classic_access                         = var.classic_access
-  use_manual_address_prefixes            = var.use_manual_address_prefixes
   default_network_acl_name               = var.default_network_acl_name
   default_security_group_name            = var.default_security_group_name
   security_group_rules                   = var.default_security_group_rules == null ? [] : var.default_security_group_rules
diff --git a/landing-zone-submodule/management-vpc/variables.tf b/landing-zone-submodule/management-vpc/variables.tf
@@ -38,12 +38,6 @@ variable "classic_access" {
   default     = null
 }
 
-variable "use_manual_address_prefixes" {
-  description = "Optionally assign prefixes to VPC manually. By default this is false, and prefixes will be created along with subnets"
-  type        = bool
-  default     = true
-}
-
 variable "default_network_acl_name" {
   description = "Override default ACL name"
   type        = string
diff --git a/landing-zone-submodule/workload-vpc/README.md b/landing-zone-submodule/workload-vpc/README.md
@@ -45,7 +45,6 @@ No resources.
 | <a name="input_resource_group_id"></a> [resource\_group\_id](#input\_resource\_group\_id) | The resource group ID where the VPC to be created | `string` | n/a | yes |
 | <a name="input_subnets"></a> [subnets](#input\_subnets) | Object for subnets to be created in each zone, each zone can have any number of subnets | <pre>object({<br>    zone-1 = list(object({<br>      name           = string<br>      cidr           = string<br>      public_gateway = optional(bool)<br>      acl_name       = string<br>    }))<br>    zone-2 = list(object({<br>      name           = string<br>      cidr           = string<br>      public_gateway = optional(bool)<br>      acl_name       = string<br>    }))<br>    zone-3 = list(object({<br>      name           = string<br>      cidr           = string<br>      public_gateway = optional(bool)<br>      acl_name       = string<br>    }))<br>  })</pre> | <pre>{<br>  "zone-1": [<br>    {<br>      "acl_name": "workload-acl",<br>      "cidr": "10.40.10.0/24",<br>      "name": "vsi-zone-1",<br>      "public_gateway": false<br>    },<br>    {<br>      "acl_name": "workload-acl",<br>      "cidr": "10.40.20.0/24",<br>      "name": "vpe-zone-1",<br>      "public_gateway": false<br>    }<br>  ],<br>  "zone-2": [<br>    {<br>      "acl_name": "workload-acl",<br>      "cidr": "10.50.10.0/24",<br>      "name": "vsi-zone-2",<br>      "public_gateway": false<br>    },<br>    {<br>      "acl_name": "workload-acl",<br>      "cidr": "10.50.20.0/24",<br>      "name": "vpe-zone-2",<br>      "public_gateway": false<br>    }<br>  ],<br>  "zone-3": [<br>    {<br>      "acl_name": "workload-acl",<br>      "cidr": "10.60.10.0/24",<br>      "name": "vsi-zone-3",<br>      "public_gateway": false<br>    },<br>    {<br>      "acl_name": "workload-acl",<br>      "cidr": "10.60.20.0/24",<br>      "name": "vpe-zone-3",<br>      "public_gateway": false<br>    }<br>  ]<br>}</pre> | no |
 | <a name="input_tags"></a> [tags](#input\_tags) | List of tags to apply to resources created by this module. | `list(string)` | `[]` | no |
-| <a name="input_use_manual_address_prefixes"></a> [use\_manual\_address\_prefixes](#input\_use\_manual\_address\_prefixes) | Optionally assign prefixes to VPC manually. By default this is false, and prefixes will be created along with subnets | `bool` | `null` | no |
 | <a name="input_use_public_gateways"></a> [use\_public\_gateways](#input\_use\_public\_gateways) | For each `zone` that is set to `true`, a public gateway will be created in that zone | <pre>object({<br>    zone-1 = optional(bool)<br>    zone-2 = optional(bool)<br>    zone-3 = optional(bool)<br>  })</pre> | <pre>{<br>  "zone-1": false,<br>  "zone-2": false,<br>  "zone-3": false<br>}</pre> | no |
 
 ## Outputs
diff --git a/landing-zone-submodule/workload-vpc/main.tf b/landing-zone-submodule/workload-vpc/main.tf
@@ -11,7 +11,6 @@ module "workload_vpc" {
   prefix                                 = var.prefix
   network_cidr                           = var.network_cidr
   classic_access                         = var.classic_access
-  use_manual_address_prefixes            = var.use_manual_address_prefixes
   default_network_acl_name               = var.default_network_acl_name
   default_security_group_name            = var.default_security_group_name
   security_group_rules                   = var.default_security_group_rules == null ? [] : var.default_security_group_rules
diff --git a/landing-zone-submodule/workload-vpc/variables.tf b/landing-zone-submodule/workload-vpc/variables.tf
@@ -37,11 +37,6 @@ variable "classic_access" {
   default     = null
 }
 
-variable "use_manual_address_prefixes" {
-  description = "Optionally assign prefixes to VPC manually. By default this is false, and prefixes will be created along with subnets"
-  type        = bool
-  default     = null
-}
 
 variable "default_network_acl_name" {
   description = "Override default ACL name"
diff --git a/main.tf b/main.tf
@@ -6,7 +6,7 @@ resource "ibm_is_vpc" "vpc" {
   name                        = var.prefix != null ? "${var.prefix}-${var.name}-vpc" : "${var.name}-vpc"
   resource_group              = var.resource_group_id
   classic_access              = var.classic_access
-  address_prefix_management   = var.use_manual_address_prefixes == false ? null : "manual"
+  address_prefix_management   = length([for prefix in values(coalesce(var.address_prefixes, {})) : prefix if prefix != null]) != 0 ? "manual" : null
   default_network_acl_name    = var.default_network_acl_name
   default_security_group_name = var.default_security_group_name
   default_routing_table_name  = var.default_routing_table_name
diff --git a/module-metadata.json b/module-metadata.json
@@ -11,11 +11,12 @@
         "zone-3": null
       },
       "source": [
+        "ibm_is_vpc.vpc.address_prefix_management",
         "module.dynamic_values"
       ],
       "pos": {
         "filename": "variables.tf",
-        "line": 73
+        "line": 67
       }
     },
     "classic_access": {
@@ -39,7 +40,7 @@
       "default": false,
       "pos": {
         "filename": "variables.tf",
-        "line": 414
+        "line": 408
       }
     },
     "default_network_acl_name": {
@@ -51,7 +52,7 @@
       ],
       "pos": {
         "filename": "variables.tf",
-        "line": 55
+        "line": 49
       },
       "min_length": 1,
       "max_length": 63,
@@ -67,7 +68,7 @@
       ],
       "pos": {
         "filename": "variables.tf",
-        "line": 67
+        "line": 61
       },
       "min_length": 1,
       "max_length": 63,
@@ -83,7 +84,7 @@
       ],
       "pos": {
         "filename": "variables.tf",
-        "line": 61
+        "line": 55
       },
       "min_length": 1,
       "max_length": 63,
@@ -101,7 +102,7 @@
       ],
       "pos": {
         "filename": "variables.tf",
-        "line": 408
+        "line": 402
       }
     },
     "existing_cos_instance_guid": {
@@ -113,7 +114,7 @@
       ],
       "pos": {
         "filename": "variables.tf",
-        "line": 420
+        "line": 414
       },
       "immutable": true,
       "computed": true
@@ -128,7 +129,7 @@
       ],
       "pos": {
         "filename": "variables.tf",
-        "line": 426
+        "line": 420
       },
       "immutable": true
     },
@@ -142,7 +143,7 @@
       ],
       "pos": {
         "filename": "variables.tf",
-        "line": 432
+        "line": 426
       }
     },
     "name": {
@@ -173,7 +174,7 @@
       ],
       "pos": {
         "filename": "variables.tf",
-        "line": 98
+        "line": 92
       }
     },
     "network_cidr": {
@@ -256,7 +257,7 @@
       ],
       "pos": {
         "filename": "variables.tf",
-        "line": 380
+        "line": 374
       }
     },
     "security_group_rules": {
@@ -275,7 +276,7 @@
       ],
       "pos": {
         "filename": "variables.tf",
-        "line": 314
+        "line": 308
       }
     },
     "subnets": {
@@ -313,7 +314,7 @@
       ],
       "pos": {
         "filename": "variables.tf",
-        "line": 251
+        "line": 245
       }
     },
     "tags": {
@@ -338,21 +339,6 @@
         "type": "TypeString"
       }
     },
-    "use_manual_address_prefixes": {
-      "name": "use_manual_address_prefixes",
-      "type": "bool",
-      "description": "OPTIONAL - Use manual address prefixes for VPC",
-      "default": false,
-      "source": [
-        "ibm_is_vpc.vpc.address_prefix_management"
-      ],
-      "pos": {
-        "filename": "variables.tf",
-        "line": 49
-      },
-      "immutable": true,
-      "options": "auto, manual"
-    },
     "use_public_gateways": {
       "name": "use_public_gateways",
       "type": "object({\n    zone-1 = optional(bool)\n    zone-2 = optional(bool)\n    zone-3 = optional(bool)\n  })",
@@ -367,7 +353,7 @@
       ],
       "pos": {
         "filename": "variables.tf",
-        "line": 225
+        "line": 219
       }
     }
   },
@@ -480,7 +466,7 @@
     "ibm": {
       "source": "IBM-Cloud/ibm",
       "version_constraints": [
-        "\u003e= 1.49.0"
+        "\u003e= 1.52.0"
       ]
     }
   },
@@ -587,7 +573,7 @@
       "type": "ibm_is_vpc",
       "name": "vpc",
       "attributes": {
-        "address_prefix_management": "use_manual_address_prefixes",
+        "address_prefix_management": "address_prefixes",
         "classic_access": "classic_access",
         "default_network_acl_name": "default_network_acl_name",
         "default_routing_table_name": "default_routing_table_name",
diff --git a/tests/pr_test.go b/tests/pr_test.go
@@ -11,18 +11,12 @@ const defaultExampleTerraformDir = "examples/default"
 const landingZoneExampleTerraformDir = "examples/landing_zone"
 const resourceGroup = "geretain-test-resources"
 
-// The ACL ignores can be removed once we merge this PR (https://github.com/terraform-ibm-modules/terraform-ibm-landing-zone-vpc/pull/471)
-var ignoreUpdates = []string{"module.slz_vpc.ibm_is_network_acl.network_acl[\"vpc-acl\"]"}
-
 func setupOptions(t *testing.T, prefix string, terraformDir string) *testhelper.TestOptions {
 	options := testhelper.TestOptionsDefaultWithVars(&testhelper.TestOptions{
 		Testing:       t,
 		TerraformDir:  terraformDir,
 		Prefix:        prefix,
 		ResourceGroup: resourceGroup,
-		IgnoreUpdates: testhelper.Exemptions{
-			List: ignoreUpdates,
-		},
 	})
 
 	return options
diff --git a/variables.tf b/variables.tf
@@ -46,12 +46,6 @@ variable "classic_access" {
   default     = false
 }
 
-variable "use_manual_address_prefixes" {
-  description = "OPTIONAL - Use manual address prefixes for VPC"
-  type        = bool
-  default     = false
-}
-
 variable "default_network_acl_name" {
   description = "OPTIONAL - Name of the Default ACL. If null, a name will be automatically generated"
   type        = string
diff --git a/version.tf b/version.tf
@@ -4,7 +4,7 @@ terraform {
     # Use "greater than or equal to" range in modules
     ibm = {
       source  = "IBM-Cloud/ibm"
-      version = ">= 1.49.0"
+      version = ">= 1.52.0"
     }
   }
 }

Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@ terraform {`
`4`	`4`	`# Pin to the lowest provider version of the range defined in the main module's version.tf to ensure lowest version still works`
`5`	`5`	`ibm = {`
`6`	`6`	`source = "IBM-Cloud/ibm"`
`7`		`- version = "1.49.0"`
	`7`	`+ version = "1.52.0"`
`8`	`8`	`}`
`9`	`9`	`}`
`10`	`10`	`}`