feat: the default value of ocp_entitlement has been removed as not everyone will have an entitlement that can be used (#454)

Author: Khuzaima05

README.md

@@ -258,7 +258,7 @@ Optionally, you need the following permissions to attach Access Management tags
 | <a name="input_kms_config"></a> [kms\_config](#input\_kms\_config) | Use to attach a KMS instance to the cluster. If account\_id is not provided, defaults to the account in use. | <pre>object({<br>    crk_id           = string<br>    instance_id      = string<br>    private_endpoint = optional(bool, true) # defaults to true<br>    account_id       = optional(string)     # To attach KMS instance from another account<br>    wait_for_apply   = optional(bool, true) # defaults to true so terraform will wait until the KMS is applied to the master, ready and deployed<br>  })</pre> | `null` | no |
 | <a name="input_manage_all_addons"></a> [manage\_all\_addons](#input\_manage\_all\_addons) | Instructs Terraform to manage all cluster addons, even if addons were installed outside of the module. If set to 'true' this module will destroy any addons that were installed by other sources. | `bool` | `false` | no |
 | <a name="input_number_of_lbs"></a> [number\_of\_lbs](#input\_number\_of\_lbs) | The number of LBs to associated the additional\_lb\_security\_group\_names security group with. | `number` | `1` | no |
-| <a name="input_ocp_entitlement"></a> [ocp\_entitlement](#input\_ocp\_entitlement) | Value that is applied to the entitlements for OCP cluster provisioning | `string` | `"cloud_pak"` | no |
+| <a name="input_ocp_entitlement"></a> [ocp\_entitlement](#input\_ocp\_entitlement) | Value that is applied to the entitlements for OCP cluster provisioning | `string` | `null` | no |
 | <a name="input_ocp_version"></a> [ocp\_version](#input\_ocp\_version) | The version of the OpenShift cluster that should be provisioned (format 4.x). If no value is specified, the current default version is used. You can also specify `default`. This input is used only during initial cluster provisioning and is ignored for updates. To prevent possible destructive changes, update the cluster version outside of Terraform. | `string` | `null` | no |
 | <a name="input_operating_system"></a> [operating\_system](#input\_operating\_system) | 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 . | `string` | `null` | no |
 | <a name="input_region"></a> [region](#input\_region) | The IBM Cloud region where the cluster will be provisioned. | `string` | n/a | yes |

examples/add_rules_to_sg/main.tf

@@ -111,6 +111,7 @@ resource "ibm_is_security_group_rule" "kube_cluster_rules" {
   direction = each.value.direction
   remote    = each.value.remote
 
+
   dynamic "tcp" {
     for_each = each.value.tcp == null ? [] : [each.value]
     content {
@@ -174,4 +175,5 @@ module "ocp_base" {
   worker_pools         = local.worker_pools
   ocp_version          = var.ocp_version
   tags                 = var.resource_tags
+  ocp_entitlement      = var.ocp_entitlement
 }

examples/add_rules_to_sg/variables.tf

@@ -39,3 +39,9 @@ variable "ocp_version" {
   description = "Version of the OCP cluster to provision"
   default     = null
 }
+
+variable "ocp_entitlement" {
+  type        = string
+  description = "Value that is applied to the entitlements for OCP cluster provisioning"
+  default     = null
+}

examples/advanced/main.tf

@@ -160,6 +160,7 @@ module "ocp_base" {
   tags                 = var.resource_tags
   access_tags          = var.access_tags
   worker_pools_taints  = local.worker_pools_taints
+  ocp_entitlement      = var.ocp_entitlement
   # Enable if using worker autoscaling. Stops Terraform managing worker count.
   ignore_worker_pool_size_changes = true
   addons = {

examples/advanced/variables.tf

@@ -45,3 +45,9 @@ variable "access_tags" {
   description = "A list of access tags to apply"
   default     = []
 }
+
+variable "ocp_entitlement" {
+  type        = string
+  description = "Value that is applied to the entitlements for OCP cluster provisioning"
+  default     = null
+}

examples/basic/main.tf

@@ -79,4 +79,5 @@ module "ocp_base" {
   ocp_version          = var.ocp_version
   worker_pools         = local.worker_pools
   access_tags          = var.access_tags
+  ocp_entitlement      = var.ocp_entitlement
 }

examples/basic/variables.tf

@@ -45,3 +45,9 @@ variable "access_tags" {
   description = "A list of access tags to apply to the resources created by the module."
   default     = []
 }
+
+variable "ocp_entitlement" {
+  type        = string
+  description = "Value that is applied to the entitlements for OCP cluster provisioning"
+  default     = null
+}

examples/basic/version.tf

@@ -1,5 +1,5 @@
 terraform {
-  required_version = ">= 1.3.0"
+  required_version = ">=1.3.0"
 
   # Ensure that there is always 1 example locked into the lowest provider version of the range defined in the main
   # module's version.tf (basic and add_rules_to_sg), and 1 example that will always use the latest provider version (advanced, fscloud and multiple mzr).

examples/cross_kms_support/main.tf

@@ -85,6 +85,7 @@ module "ocp_base" {
   ocp_version          = var.ocp_version
   worker_pools         = local.worker_pools
   access_tags          = var.access_tags
+  ocp_entitlement      = var.ocp_entitlement
 
   kms_config = {
     instance_id = var.kms_instance_guid

examples/cross_kms_support/variables.tf

@@ -60,3 +60,9 @@ variable "kms_cross_account_id" {
   type        = string
   description = "Id of the account that owns the KMS instance to encrypt the cluster"
 }
+
+variable "ocp_entitlement" {
+  type        = string
+  description = "Value that is applied to the entitlements for OCP cluster provisioning"
+  default     = null
+}