feat: added support to set a schema global compatibility rule using new input schema_global_rule. Feature is only valid for enterpirse plan instances. Allowed values are NONE, FULL, FULL_TRANSITIVE, FORWARD, FORWARD_TRANSITIVE, BACKWARD, BACKWARD_TRANSITIVE. (#342)

kccox · web-flow · commit ffa36e78d086 · 2024-11-20T13:29:07.000Z
diff --git a/README.md b/README.md
@@ -121,6 +121,7 @@ You need the following permissions to run this module.
 |------|------|
 | [ibm_event_streams_quota.eventstreams_quotas](https://registry.terraform.io/providers/IBM-Cloud/ibm/latest/docs/resources/event_streams_quota) | resource |
 | [ibm_event_streams_schema.es_schema](https://registry.terraform.io/providers/IBM-Cloud/ibm/latest/docs/resources/event_streams_schema) | resource |
+| [ibm_event_streams_schema_global_rule.es_globalrule](https://registry.terraform.io/providers/IBM-Cloud/ibm/latest/docs/resources/event_streams_schema_global_rule) | resource |
 | [ibm_event_streams_topic.es_topic](https://registry.terraform.io/providers/IBM-Cloud/ibm/latest/docs/resources/event_streams_topic) | resource |
 | [ibm_iam_authorization_policy.kms_policy](https://registry.terraform.io/providers/IBM-Cloud/ibm/latest/docs/resources/iam_authorization_policy) | resource |
 | [ibm_resource_instance.es_instance](https://registry.terraform.io/providers/IBM-Cloud/ibm/latest/docs/resources/resource_instance) | resource |
@@ -145,6 +146,7 @@ You need the following permissions to run this module.
 | <a name="input_quotas"></a> [quotas](#input\_quotas) | Quotas to be applied to the Event Streams instance. Entity may be 'default' to apply to all users, or an IAM ServiceID for a specific user. Rates are bytes/second, with -1 meaning no quota. | <pre>list(object({<br/>    entity             = string<br/>    producer_byte_rate = optional(number, -1)<br/>    consumer_byte_rate = optional(number, -1)<br/>  }))</pre> | `[]` | no |
 | <a name="input_region"></a> [region](#input\_region) | The region where the Event Streams are created. | `string` | `"us-south"` | no |
 | <a name="input_resource_group_id"></a> [resource\_group\_id](#input\_resource\_group\_id) | The resource group ID where the Event Streams instance is created. | `string` | n/a | yes |
+| <a name="input_schema_global_rule"></a> [schema\_global\_rule](#input\_schema\_global\_rule) | Schema global compatibility rule. Allowed values are 'NONE', 'FULL', 'FULL\_TRANSITIVE', 'FORWARD', 'FORWARD\_TRANSITIVE', 'BACKWARD', 'BACKWARD\_TRANSITIVE'. | `string` | `null` | no |
 | <a name="input_schemas"></a> [schemas](#input\_schemas) | The list of schema objects. Include the `schema_id` and the `type` and `name` of the schema in the `schema` object. | <pre>list(object(<br/>    {<br/>      schema_id = string<br/>      schema = object({<br/>        type = string<br/>        name = string<br/>        fields = optional(list(object({<br/>          name = string<br/>          type = string<br/>        })))<br/>      })<br/>    }<br/>  ))</pre> | `[]` | no |
 | <a name="input_service_credential_names"></a> [service\_credential\_names](#input\_service\_credential\_names) | The mapping of names and roles for service credentials that you want to create for the Event streams. | `map(string)` | `{}` | no |
 | <a name="input_service_endpoints"></a> [service\_endpoints](#input\_service\_endpoints) | The type of service endpoints. Possible values: 'public', 'private', 'public-and-private'. | `string` | `"public"` | no |
diff --git a/examples/fscloud/main.tf b/examples/fscloud/main.tf
@@ -70,6 +70,7 @@ module "event_streams" {
       "consumer_byte_rate" = 200000
     }
   ]
+  schema_global_rule = "FORWARD"
   service_credential_names = {
     "es_writer" : "Writer",
     "es_reader" : "Reader",
diff --git a/main.tf b/main.tf
@@ -28,6 +28,8 @@ locals {
   validate_metrics = var.plan != "enterprise-3nodes-2tb" && length(var.metrics) > 0 ? tobool("metrics are only supported for enterprise plan") : true
   # tflint-ignore: terraform_unused_declarations
   validate_quotas = var.plan != "enterprise-3nodes-2tb" && length(var.quotas) > 0 ? tobool("quotas are only supported for enterprise plan") : true
+  # tflint-ignore: terraform_unused_declarations
+  validate_schema_global_rule = var.plan != "enterprise-3nodes-2tb" && var.schema_global_rule != null ? tobool("schema global rule is only supported for enterprise plan") : true
 }
 
 # workaround for https://github.com/IBM-Cloud/terraform-provider-ibm/issues/4478
@@ -70,7 +72,7 @@ resource "ibm_resource_instance" "es_instance" {
 }
 
 ##############################################################################
-# SCHEMA
+# SCHEMA AND COMPATIBILITY RULE
 ##############################################################################
 
 resource "ibm_event_streams_schema" "es_schema" {
@@ -80,6 +82,12 @@ resource "ibm_event_streams_schema" "es_schema" {
   schema               = jsonencode(var.schemas[count.index].schema)
 }
 
+resource "ibm_event_streams_schema_global_rule" "es_globalrule" {
+  count                = var.schema_global_rule != null ? 1 : 0
+  resource_instance_id = ibm_resource_instance.es_instance.id
+  config               = var.schema_global_rule
+}
+
 ##############################################################################
 # TOPIC
 ##############################################################################
diff --git a/modules/fscloud/README.md b/modules/fscloud/README.md
@@ -35,6 +35,7 @@ No resources.
 | <a name="input_quotas"></a> [quotas](#input\_quotas) | Quotas to be applied to the Event Streams instance. Entity may be 'default' to apply to all users, or an IAM ServiceID for a specific user. Rates are bytes/second, with -1 meaning no quota. | <pre>list(object({<br/>    entity             = string<br/>    producer_byte_rate = optional(number, -1)<br/>    consumer_byte_rate = optional(number, -1)<br/>  }))</pre> | `[]` | no |
 | <a name="input_region"></a> [region](#input\_region) | The region where the Event Streams are created. | `string` | `"us-south"` | no |
 | <a name="input_resource_group_id"></a> [resource\_group\_id](#input\_resource\_group\_id) | The resource group ID where the Event Streams instance is created. | `string` | n/a | yes |
+| <a name="input_schema_global_rule"></a> [schema\_global\_rule](#input\_schema\_global\_rule) | Schema global compatibility rule. Allowed values are 'NONE', 'FULL', 'FULL\_TRANSITIVE', 'FORWARD', 'FORWARD\_TRANSITIVE', 'BACKWARD', 'BACKWARD\_TRANSITIVE'. | `string` | `null` | no |
 | <a name="input_schemas"></a> [schemas](#input\_schemas) | The list of schema objects. Include the `schema_id` and the `type` and `name` of the schema in the `schema` object. | <pre>list(object(<br/>    {<br/>      schema_id = string<br/>      schema = object({<br/>        type = string<br/>        name = string<br/>        fields = optional(list(object({<br/>          name = string<br/>          type = string<br/>        })))<br/>      })<br/>    }<br/>  ))</pre> | `[]` | no |
 | <a name="input_service_credential_names"></a> [service\_credential\_names](#input\_service\_credential\_names) | The mapping of names and roles for service credentials that you want to create for the Event streams. | `map(string)` | `{}` | no |
 | <a name="input_tags"></a> [tags](#input\_tags) | The list of tags associated with the Event Steams instance. | `list(string)` | `[]` | no |
diff --git a/modules/fscloud/main.tf b/modules/fscloud/main.tf
@@ -7,6 +7,7 @@ module "event_streams" {
   kms_key_crn                = var.kms_key_crn
   existing_kms_instance_guid = var.existing_kms_instance_guid
   schemas                    = var.schemas
+  schema_global_rule         = var.schema_global_rule
   tags                       = var.tags
   access_tags                = var.access_tags
   topics                     = var.topics
diff --git a/modules/fscloud/variables.tf b/modules/fscloud/variables.tf
@@ -46,6 +46,12 @@ variable "schemas" {
   default     = []
 }
 
+variable "schema_global_rule" {
+  type        = string
+  description = "Schema global compatibility rule. Allowed values are 'NONE', 'FULL', 'FULL_TRANSITIVE', 'FORWARD', 'FORWARD_TRANSITIVE', 'BACKWARD', 'BACKWARD_TRANSITIVE'."
+  default     = null
+}
+
 variable "topics" {
   type = list(object(
     {
diff --git a/variables.tf b/variables.tf
@@ -105,6 +105,16 @@ variable "schemas" {
   default     = []
 }
 
+variable "schema_global_rule" {
+  type        = string
+  description = "Schema global compatibility rule. Allowed values are 'NONE', 'FULL', 'FULL_TRANSITIVE', 'FORWARD', 'FORWARD_TRANSITIVE', 'BACKWARD', 'BACKWARD_TRANSITIVE'."
+  default     = null
+  validation {
+    condition     = var.schema_global_rule == null || contains(["NONE", "FULL", "FULL_TRANSITIVE", "FORWARD", "FORWARD_TRANSITIVE", "BACKWARD", "BACKWARD_TRANSITIVE"], coalesce(var.schema_global_rule, "NONE"))
+    error_message = "The schema_global_rule must be null or one of 'NONE', 'FULL', 'FULL_TRANSITIVE', 'FORWARD', 'FORWARD_TRANSITIVE', 'BACKWARD', 'BACKWARD_TRANSITIVE'."
+  }
+}
+
 variable "topics" {
   type = list(object(
     {

Original file line number	Diff line number	Diff line change
`@@ -70,6 +70,7 @@ module "event_streams" {`
`70`	`70`	`"consumer_byte_rate" = 200000`
`71`	`71`	`}`
`72`	`72`	`]`
	`73`	`+ schema_global_rule = "FORWARD"`
`73`	`74`	`service_credential_names = {`
`74`	`75`	`"es_writer" : "Writer",`
`75`	`76`	`"es_reader" : "Reader",`
Original file line number	Diff line number	Diff line change
`@@ -46,6 +46,12 @@ variable "schemas" {`
`46`	`46`	`default = []`
`47`	`47`	`}`
`48`	`48`
	`49`	`+variable "schema_global_rule" {`
	`50`	`+ type = string`
	`51`	`+ description = "Schema global compatibility rule. Allowed values are 'NONE', 'FULL', 'FULL_TRANSITIVE', 'FORWARD', 'FORWARD_TRANSITIVE', 'BACKWARD', 'BACKWARD_TRANSITIVE'."`
	`52`	`+ default = null`
	`53`	`+}`
	`54`	`+`
`49`	`55`	`variable "topics" {`
`50`	`56`	`type = list(object(`
`51`	`57`	`{`