feat: add support for the user_data variable

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 |
 | <a name="requirement_ibm"></a> [ibm](#requirement\_ibm) | >= 1.68.1, < 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 |
@@ -934,6 +934,7 @@ module "cluster_pattern" {
 | <a name="input_transit_gateway_connections"></a> [transit\_gateway\_connections](#input\_transit\_gateway\_connections) | Transit gateway vpc connections. Will only be used if transit gateway is enabled. | `list(string)` | n/a | yes |
 | <a name="input_transit_gateway_global"></a> [transit\_gateway\_global](#input\_transit\_gateway\_global) | Connect to the networks outside the associated region. Will only be used if transit gateway is enabled. | `bool` | `false` | no |
 | <a name="input_transit_gateway_resource_group"></a> [transit\_gateway\_resource\_group](#input\_transit\_gateway\_resource\_group) | Name of resource group to use for transit gateway. Must be included in `var.resource_group` | `string` | n/a | yes |
+| <a name="input_user_data"></a> [user\_data](#input\_user\_data) | User data that automatically performs common configuration tasks or runs scripts. For more information, see https://cloud.ibm.com/docs/vpc?topic=vpc-user-data. | <pre>map(object({<br/>    user_data = string<br/>  }))</pre> | `{}` | no |
 | <a name="input_virtual_private_endpoints"></a> [virtual\_private\_endpoints](#input\_virtual\_private\_endpoints) | Object describing VPE to be created | <pre>list(<br/>    object({<br/>      service_name   = string<br/>      service_type   = string<br/>      resource_group = optional(string)<br/>      access_tags    = optional(list(string), [])<br/>      vpcs = list(<br/>        object({<br/>          name                = string<br/>          subnets             = list(string)<br/>          security_group_name = optional(string)<br/>        })<br/>      )<br/>    })<br/>  )</pre> | n/a | yes |
 | <a name="input_vpc_placement_groups"></a> [vpc\_placement\_groups](#input\_vpc\_placement\_groups) | List of VPC placement groups to create | <pre>list(<br/>    object({<br/>      access_tags    = optional(list(string), [])<br/>      name           = string<br/>      resource_group = optional(string)<br/>      strategy       = string<br/>    })<br/>  )</pre> | `[]` | no |
 | <a name="input_vpcs"></a> [vpcs](#input\_vpcs) | A map describing VPCs to be created in this repo. | <pre>list(<br/>    object({<br/>      prefix          = string # VPC prefix<br/>      existing_vpc_id = optional(string)<br/>      existing_subnets = optional(<br/>        list(<br/>          object({<br/>            id             = string<br/>            public_gateway = optional(bool, false)<br/>          })<br/>        )<br/>      )<br/>      resource_group                    = optional(string) # Name of the group where VPC will be created<br/>      access_tags                       = optional(list(string), [])<br/>      classic_access                    = optional(bool)<br/>      default_network_acl_name          = optional(string)<br/>      default_security_group_name       = optional(string)<br/>      clean_default_sg_acl              = optional(bool, false)<br/>      dns_binding_name                  = optional(string, null)<br/>      dns_instance_name                 = optional(string, null)<br/>      dns_custom_resolver_name          = optional(string, null)<br/>      dns_location                      = optional(string, "global")<br/>      dns_plan                          = optional(string, "standard-dns")<br/>      existing_dns_instance_id          = optional(string, null)<br/>      use_existing_dns_instance         = optional(bool, false)<br/>      enable_hub                        = optional(bool, false)<br/>      skip_spoke_auth_policy            = optional(bool, false)<br/>      hub_account_id                    = optional(string, null)<br/>      enable_hub_vpc_id                 = optional(bool, false)<br/>      hub_vpc_id                        = optional(string, null)<br/>      enable_hub_vpc_crn                = optional(bool, false)<br/>      hub_vpc_crn                       = optional(string, null)<br/>      update_delegated_resolver         = optional(bool, false)<br/>      skip_custom_resolver_hub_creation = optional(bool, false)<br/>      resolver_type                     = optional(string, null)<br/>      manual_servers = optional(list(object({<br/>        address       = string<br/>        zone_affinity = optional(string)<br/>      })), [])<br/>      default_security_group_rules = optional(<br/>        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/>        )<br/>      )<br/>      default_routing_table_name = optional(string)<br/>      flow_logs_bucket_name      = optional(string)<br/>      address_prefixes = optional(<br/>        object({<br/>          zone-1 = optional(list(string))<br/>          zone-2 = optional(list(string))<br/>          zone-3 = optional(list(string))<br/>        })<br/>      )<br/>      network_acls = list(<br/>        object({<br/>          name                         = string<br/>          add_ibm_cloud_internal_rules = optional(bool)<br/>          add_vpc_connectivity_rules   = optional(bool)<br/>          prepend_ibm_rules            = optional(bool)<br/>          rules = list(<br/>            object({<br/>              name        = string<br/>              action      = string<br/>              destination = string<br/>              direction   = string<br/>              source      = string<br/>              tcp = optional(<br/>                object({<br/>                  port_max        = optional(number)<br/>                  port_min        = optional(number)<br/>                  source_port_max = optional(number)<br/>                  source_port_min = optional(number)<br/>                })<br/>              )<br/>              udp = optional(<br/>                object({<br/>                  port_max        = optional(number)<br/>                  port_min        = optional(number)<br/>                  source_port_max = optional(number)<br/>                  source_port_min = optional(number)<br/>                })<br/>              )<br/>              icmp = optional(<br/>                object({<br/>                  type = optional(number)<br/>                  code = optional(number)<br/>                })<br/>              )<br/>            })<br/>          )<br/>        })<br/>      )<br/>      use_public_gateways = object({<br/>        zone-1 = optional(bool)<br/>        zone-2 = optional(bool)<br/>        zone-3 = optional(bool)<br/>      })<br/>      subnets = optional(object({<br/>        zone-1 = list(object({<br/>          name           = string<br/>          cidr           = string<br/>          public_gateway = optional(bool)<br/>          acl_name       = string<br/>          no_addr_prefix = optional(bool, false)<br/>        }))<br/>        zone-2 = list(object({<br/>          name           = string<br/>          cidr           = string<br/>          public_gateway = optional(bool)<br/>          acl_name       = string<br/>          no_addr_prefix = optional(bool, false)<br/>        }))<br/>        zone-3 = list(object({<br/>          name           = string<br/>          cidr           = string<br/>          public_gateway = optional(bool)<br/>          acl_name       = string<br/>          no_addr_prefix = optional(bool, false)<br/>        }))<br/>      }))<br/>    })<br/>  )</pre> | n/a | yes |

dynamic_values.tf

@@ -33,6 +33,7 @@ module "dynamic_values" {
   skip_kms_kube_s2s_auth_policy          = var.skip_kms_kube_s2s_auth_policy
   skip_all_s2s_auth_policies             = var.skip_all_s2s_auth_policies
   atracker_cos_bucket                    = var.atracker.add_route == true ? var.atracker.collector_bucket_name : null
+  user_data                              = var.user_data
 }
 
 ##############################################################################

dynamic_values/config_modules/appid/versions.tf

@@ -3,7 +3,7 @@
 ##############################################################################
 
 terraform {
-  required_version = ">= 1.3"
+  required_version = ">= 1.9"
 }
 
 ##############################################################################

dynamic_values/config_modules/bastion_vsi_list_to_map/versions.tf

@@ -3,7 +3,7 @@
 ##############################################################################
 
 terraform {
-  required_version = ">= 1.3"
+  required_version = ">= 1.9"
 }
 
 ##############################################################################

dynamic_values/config_modules/cluster_worker_pools/versions.tf

@@ -3,7 +3,7 @@
 ##############################################################################
 
 terraform {
-  required_version = ">= 1.3"
+  required_version = ">= 1.9"
 }
 
 ##############################################################################

dynamic_values/config_modules/clusters/versions.tf

@@ -3,7 +3,7 @@
 ##############################################################################
 
 terraform {
-  required_version = ">= 1.3"
+  required_version = ">= 1.9"
 }
 
 ##############################################################################

dynamic_values/config_modules/cos/versions.tf

@@ -3,7 +3,7 @@
 ##############################################################################
 
 terraform {
-  required_version = ">= 1.3"
+  required_version = ">= 1.9"
 }
 
 ##############################################################################

dynamic_values/config_modules/f5/versions.tf

@@ -3,7 +3,7 @@
 ##############################################################################
 
 terraform {
-  required_version = ">= 1.3"
+  required_version = ">= 1.9"
 }
 
 ##############################################################################

dynamic_values/config_modules/flow_logs/versions.tf

@@ -3,7 +3,7 @@
 ##############################################################################
 
 terraform {
-  required_version = ">= 1.3"
+  required_version = ">= 1.9"
 }
 
 ##############################################################################

dynamic_values/config_modules/get_subnets/versions.tf

@@ -3,7 +3,7 @@
 ##############################################################################
 
 terraform {
-  required_version = ">= 1.3"
+  required_version = ">= 1.9"
 }
 
 ##############################################################################

dynamic_values/config_modules/list_to_map/versions.tf

@@ -3,7 +3,7 @@
 ##############################################################################
 
 terraform {
-  required_version = ">= 1.3"
+  required_version = ">= 1.9"
 }
 
 ##############################################################################

dynamic_values/config_modules/list_to_map_value/versions.tf

@@ -3,7 +3,7 @@
 ##############################################################################
 
 terraform {
-  required_version = ">= 1.3"
+  required_version = ">= 1.9"
 }
 
 ##############################################################################

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"
 }
 
 ##############################################################################

dynamic_values/config_modules/service_authorizations/versions.tf

@@ -3,7 +3,7 @@
 ##############################################################################
 
 terraform {
-  required_version = ">= 1.3"
+  required_version = ">= 1.9"
 }
 
 ##############################################################################

dynamic_values/config_modules/vpe/versions.tf

@@ -3,7 +3,7 @@
 ##############################################################################
 
 terraform {
-  required_version = ">= 1.3"
+  required_version = ">= 1.9"
 }
 
 ##############################################################################

dynamic_values/config_modules/vpn/versions.tf

@@ -3,7 +3,7 @@
 ##############################################################################
 
 terraform {
-  required_version = ">= 1.3"
+  required_version = ">= 1.9"
 }
 
 ##############################################################################

dynamic_values/config_modules/vsi/variables.tf

@@ -45,3 +45,13 @@ variable "bastion_vsi" {
 }
 
 ##############################################################################
+
+##############################################################################
+# User Data
+##############################################################################
+
+variable "user_data" {
+  description = "Direct reference to user_data"
+}
+
+##############################################################################

dynamic_values/config_modules/vsi/versions.tf

@@ -3,7 +3,7 @@
 ##############################################################################
 
 terraform {
-  required_version = ">= 1.3"
+  required_version = ">= 1.9"
 }
 
 ##############################################################################

dynamic_values/config_modules/vsi/vsi.tf

@@ -33,8 +33,9 @@ module "composed_vsi_map" {
   list = [
     for vsi_group in var.vsi :
     merge(vsi_group, {
-      vpc_id  = var.vpc_modules[vsi_group.vpc_name].vpc_id
-      subnets = module.vsi_subnets["${var.prefix}-${vsi_group.name}"].subnets
+      vpc_id    = var.vpc_modules[vsi_group.vpc_name].vpc_id
+      subnets   = module.vsi_subnets["${var.prefix}-${vsi_group.name}"].subnets
+      user_data = lookup(var.user_data, vsi_group.vpc_name, null) != null ? var.user_data[vsi_group.vpc_name].user_data : null
     })
   ]
 }

dynamic_values/variables.tf

@@ -32,6 +32,10 @@ variable "ssh_keys" {
   description = "Direct reference to SSH keys"
 }
 
+variable "user_data" {
+  description = "Direct reference to user_data"
+}
+
 ##############################################################################
 
 ##############################################################################

dynamic_values/versions.tf

@@ -3,7 +3,7 @@
 ##############################################################################
 
 terraform {
-  required_version = ">= 1.3"
+  required_version = ">= 1.9"
 }
 
 ##############################################################################

dynamic_values/vsi.tf

@@ -13,6 +13,7 @@ module "vsi" {
   vpc_modules     = var.vpc_modules
   vsi             = var.vsi
   bastion_vsi     = var.bastion_vsi
+  user_data       = var.user_data
 }
 
 ##############################################################################
@@ -42,6 +43,7 @@ module "ut_ssh_key" {
     }
   ]
   vpc_modules = {}
+  user_data   = {}
   vsi         = []
   bastion_vsi = []
 }
@@ -63,6 +65,7 @@ module "ut_vsi_images" {
   prefix          = "ut"
   resource_groups = {}
   ssh_keys        = []
+  user_data       = {}
   vpc_modules = {
     test = {
       vpc_id = "1234"

examples/one-vpc-one-vsi/version.tf

@@ -1,5 +1,5 @@
 terraform {
-  required_version = ">= 1.3"
+  required_version = ">= 1.9"
   required_providers {
     ibm = {
       source  = "IBM-Cloud/ibm"

examples/override-example/version.tf

@@ -1,5 +1,5 @@
 terraform {
-  required_version = ">= 1.3"
+  required_version = ">= 1.9"
   required_providers {
     ibm = {
       source  = "IBM-Cloud/ibm"

f5_config/versions.tf

@@ -3,7 +3,7 @@
 ##############################################################################
 
 terraform {
-  required_version = ">= 1.3"
+  required_version = ">= 1.9"
 }
 
 ##############################################################################

ibm_catalog.json

@@ -66,6 +66,14 @@
               },
               "key": "override_json_string"
             },
+            {
+              "custom_config": {
+                "grouping": "deployment",
+                "original_grouping": "deployment",
+                "type": "textarea"
+              },
+              "key": "user_data"
+            },
             {
               "custom_config": {
                 "config_constraints": {
@@ -327,6 +335,14 @@
               },
               "key": "override_json_string"
             },
+            {
+              "custom_config": {
+                "grouping": "deployment",
+                "original_grouping": "deployment",
+                "type": "textarea"
+              },
+              "key": "user_data"
+            },
             {
               "hidden": true,
               "key": "tmos_admin_password",

kms/dynamic_values/versions.tf

@@ -3,7 +3,7 @@
 ##############################################################################
 
 terraform {
-  required_version = ">= 1.3"
+  required_version = ">= 1.9"
 }
 
 ##############################################################################

kms/versions.tf

@@ -9,7 +9,7 @@ terraform {
       version = ">= 1.60.0, < 2.0.0"
     }
   }
-  required_version = ">= 1.3"
+  required_version = ">= 1.9"
 }
 
 ##############################################################################

patterns/dynamic_values/config_modules/acl_rules/versions.tf

@@ -3,7 +3,7 @@
 ##############################################################################
 
 terraform {
-  required_version = ">= 1.3"
+  required_version = ">= 1.9"
 }
 
 ##############################################################################

patterns/dynamic_values/config_modules/bastion_gateways/versions.tf

@@ -3,7 +3,7 @@
 ##############################################################################
 
 terraform {
-  required_version = ">= 1.3"
+  required_version = ">= 1.9"
 }
 
 ##############################################################################

patterns/dynamic_values/config_modules/bastion_vsi/versions.tf

@@ -3,7 +3,7 @@
 ##############################################################################
 
 terraform {
-  required_version = ">= 1.3"
+  required_version = ">= 1.9"
 }
 
 ##############################################################################

patterns/dynamic_values/config_modules/bastion_zone_list/versions.tf

@@ -3,7 +3,7 @@
 ##############################################################################
 
 terraform {
-  required_version = ">= 1.3"
+  required_version = ">= 1.9"
 }
 
 ##############################################################################

patterns/dynamic_values/config_modules/cloud_object_storage/versions.tf

@@ -3,7 +3,7 @@
 ##############################################################################
 
 terraform {
-  required_version = ">= 1.3"
+  required_version = ">= 1.9"
 }
 
 ##############################################################################

patterns/dynamic_values/config_modules/default_security_group_rules/versions.tf

@@ -3,7 +3,7 @@
 ##############################################################################
 
 terraform {
-  required_version = ">= 1.3"
+  required_version = ">= 1.9"
 }
 
 ##############################################################################

patterns/dynamic_values/config_modules/f5_deployments/versions.tf

@@ -3,7 +3,7 @@
 ##############################################################################
 
 terraform {
-  required_version = ">= 1.3"
+  required_version = ">= 1.9"
 }
 
 ##############################################################################

patterns/dynamic_values/config_modules/f5_security_group_rules/versions.tf

@@ -3,7 +3,7 @@
 ##############################################################################
 
 terraform {
-  required_version = ">= 1.3"
+  required_version = ">= 1.9"
 }
 
 ##############################################################################

patterns/dynamic_values/config_modules/f5_tiers/versions.tf

@@ -3,7 +3,7 @@
 ##############################################################################
 
 terraform {
-  required_version = ">= 1.3"
+  required_version = ">= 1.9"
 }
 
 ##############################################################################

patterns/dynamic_values/config_modules/key_management/versions.tf

@@ -3,7 +3,7 @@
 ##############################################################################
 
 terraform {
-  required_version = ">= 1.3"
+  required_version = ">= 1.9"
 }
 
 ##############################################################################

patterns/dynamic_values/config_modules/network_acls/versions.tf

@@ -3,7 +3,7 @@
 ##############################################################################
 
 terraform {
-  required_version = ">= 1.3"
+  required_version = ">= 1.9"
 }
 
 ##############################################################################