feat: support to pass multiple Event Notifications instances to Observability DA. [Learn more](https://github.com/terraform-ibm-modules/terraform-ibm-observability-da/blob/main/solutions/instances/DA-types.md) (#177)

Author: Soaib024

ibm_catalog.json

@@ -210,6 +210,9 @@
             {
               "key": "logs_routing_tenant_regions"
             },
+            {
+              "key": "cloud_logs_existing_en_instances"
+            },
             {
               "key": "existing_en_instance_crn"
             },

solutions/instances/DA-types.md

@@ -0,0 +1,37 @@
+# Configuring Event Notification (EN) Instances for Cloud Logging
+
+An optional input variables in the IBM Cloud [Observability instances deployable architecture](https://cloud.ibm.com/catalog#deployable_architecture) use complex object types. You specify these inputs when you configure deployable architecture.
+
+- [Cloud Logs Event Notification Instances](#cloud_logs_existing_en_instances) (`cloud_logs_existing_en_instances`)
+
+## Cloud Logs Event Notification Instances <a name="cloud_logs_existing_en_instances"></a>
+
+The `cloud_logs_existing_en_instances` input variable allows you to provide a list of existing Event Notification (EN) instances that will be integrated with the Cloud Logging service. For each EN instance, you need to specify its CRN (Cloud Resource Name). You can also optionally configure a integration name and control whether to skip the creation of an authentication policy for the instance.
+
+- Variable name: `cloud_logs_existing_en_instances`.
+- Type: A list of objects. Each object represents an EN instance with the following attributes:
+  - `instance_crn` (required): The Cloud Resource Name (CRN) of the Event Notification instance.
+  - `integration_name` (optional): The name of the Event Notification integration that gets created. If a prefix input variable is passed, it is prefixed to the value in the `<prefix>-value` format. Defaults to `"cloud-logs-en-integration"`.
+  - `skip_en_auth_policy` (optional): A boolean flag to determine whether to skip the creation of an authentication policy that allows Cloud Logs 'Event Source Manager' role access in the existing event notification instance. Defaults to `false`.
+- Default value: An empty list (`[]`).
+
+
+### Example Event Notification Instance Configuration
+
+```hcl
+cloud_logs_existing_en_instances = [
+  {
+    instance_crn        = "crn:v1:bluemix:public:...:event-notifications:instance"
+    integration_name    = "custom-logging-en-integration"
+    skip_en_auth_policy = true
+  },
+  {
+    instance_crn        = "crn:v1:bluemix:public:...:event-notifications:instance"
+    skip_en_auth_policy = false
+  }
+]
+```
+
+In this example:
+- The first EN instance has a integration name `"custom-logging-en-integration"` and skips the authentication policy.
+- The second EN instance uses the default integration name and includes the authentication policy.

solutions/instances/main.tf

@@ -119,12 +119,12 @@ locals {
   parsed_log_metrics_bucket_name         = var.existing_cloud_logs_metrics_bucket_crn != null ? split(":", var.existing_cloud_logs_metrics_bucket_crn) : []
   existing_cloud_log_metrics_bucket_name = length(local.parsed_log_metrics_bucket_name) > 0 ? local.parsed_log_metrics_bucket_name[1] : null
 
-  # Event Notifications
-  parsed_existing_en_instance_crn = var.existing_en_instance_crn != null ? split(":", var.existing_en_instance_crn) : []
-  existing_en_guid                = length(local.parsed_existing_en_instance_crn) > 0 ? local.parsed_existing_en_instance_crn[7] : null
-  en_region                       = length(local.parsed_existing_en_instance_crn) > 0 ? local.parsed_existing_en_instance_crn[5] : null
-  en_integration_name             = var.prefix != null ? "${var.prefix}-${var.en_integration_name}" : var.en_integration_name
-
+  # https://github.ibm.com/GoldenEye/issues/issues/10928#issuecomment-93550079
+  cloud_logs_existing_en_instances = concat(var.cloud_logs_existing_en_instances, var.existing_en_instance_crn != null ? [{
+    instance_crn        = var.existing_en_instance_crn
+    integration_name    = var.en_integration_name
+    skip_en_auth_policy = var.skip_en_auth_policy
+  }] : [])
 }
 
 #######################################################################################################################
@@ -206,6 +206,13 @@ resource "ibm_iam_authorization_policy" "cos_policy" {
   }
 }
 
+module "en_crn_parser" {
+  count   = length(local.cloud_logs_existing_en_instances)
+  source  = "terraform-ibm-modules/common-utilities/ibm//modules/crn-parser"
+  version = "1.0.0"
+  crn     = local.cloud_logs_existing_en_instances[count.index]["instance_crn"]
+}
+
 module "observability_instance" {
   depends_on = [time_sleep.wait_for_atracker_cos_authorization_policy]
   source     = "terraform-ibm-modules/observability-instances/ibm"
@@ -258,12 +265,12 @@ module "observability_instance" {
       skip_cos_auth_policy = var.ibmcloud_cos_api_key != null ? true : var.skip_cloud_logs_cos_auth_policy
     }
   } : null
-  cloud_logs_existing_en_instances = var.existing_en_instance_crn != null ? [{
-    en_instance_id      = local.existing_en_guid
-    en_region           = local.en_region
-    en_instance_name    = local.en_integration_name
-    skip_en_auth_policy = var.skip_en_auth_policy
-  }] : []
+  cloud_logs_existing_en_instances = [for index, _ in local.cloud_logs_existing_en_instances : {
+    en_instance_id      = module.en_crn_parser[index]["service_instance"]
+    en_region           = module.en_crn_parser[index]["region"]
+    en_integration_name = var.prefix != null ? "${var.prefix}-${local.cloud_logs_existing_en_instances[index]["integration_name"]}" : local.cloud_logs_existing_en_instances[index]["integration_name"]
+    skip_en_auth_policy = local.cloud_logs_existing_en_instances[index]["skip_en_auth_policy"]
+  }]
   skip_logs_routing_auth_policy = var.skip_logs_routing_auth_policy
   logs_routing_tenant_regions   = var.logs_routing_tenant_regions
 

solutions/instances/variables.tf

@@ -91,22 +91,32 @@ variable "cloud_logs_access_tags" {
     error_message = "Tags must match the regular expression \"[\\w\\-_\\.]+:[\\w\\-_\\.]+\". For more information, see https://cloud.ibm.com/docs/account?topic=account-tag&interface=ui#limits."
   }
 }
+# https://github.ibm.com/GoldenEye/issues/issues/10928#issuecomment-93550079
+variable "cloud_logs_existing_en_instances" {
+  description = "A list of existing Event Notification instances to be integrated with the Cloud Logging service. Each object in the list represents an Event Notification instance, including its CRN, an optional name for the integration, and an optional flag to skip the authentication policy creation for the  Event Notification instance [Learn more](https://github.com/terraform-ibm-modules/terraform-ibm-observability-da/tree/main/solutions/standard/DA-types.md#cloud_logs_existing_en_instances). This variable is intended for integrating a multiple Event Notifications instance to Cloud Logs. If you need to integrate only one instance, you may also use the `existing_en_instance_crn`, `en_integration_name` and `skip_en_auth_policy` variables instead."
+  type = list(object({
+    instance_crn        = string
+    integration_name    = optional(string, "cloud-logs-en-integration")
+    skip_en_auth_policy = optional(bool, false)
+  }))
+  default = []
+}
 
 variable "existing_en_instance_crn" {
   type        = string
-  description = "The CRN of the existing event notification instance. If a value is provided here, `enable_en_cloud_logs_integration` must be set to true in order to enable the integration."
+  description = "The CRN of the existing event notification instance. This variable is intended for integrating a single Event Notifications instance to Cloud Logs. If you need to integrate multiple instances, use the `cloud_logs_existing_en_instances` variable instead."
   default     = null
 }
 
 variable "en_integration_name" {
   type        = string
-  description = "The name of the event notification integration that gets created. If a prefix input variable is passed, it is prefixed to the value in the `<prefix>-value` format."
+  description = "The name of the event notification integration that gets created. If a prefix input variable is passed, it is prefixed to the value in the `<prefix>-value` format. This variable is intended for integrating a single Event Notifications instance  to Cloud Logs. If you need to integrate multiple instances, use the `cloud_logs_existing_en_instances` variable instead."
   default     = "cloud-logs-en-integration"
 }
 
 variable "skip_en_auth_policy" {
   type        = bool
-  description = "To skip creating auth policy that allows Cloud Logs 'Event Source Manager' role access in the existing event notification instance."
+  description = "To skip creating auth policy that allows Cloud Logs 'Event Source Manager' role access in the existing event notification instance. This variable is intended for integrating a single Event Notifications instance  to Cloud Logs. If you need to integrate multiple instances, use the `cloud_logs_existing_en_instances` variable instead."
   default     = false
 }
 

tests/pr_test.go

@@ -274,12 +274,17 @@ func TestRunExistingResourcesInstances(t *testing.T) {
 				"existing_cloud_logs_data_bucket_endpoint":    terraform.Output(t, existingTerraformOptions, "data_bucket_endpoint"),
 				"existing_cloud_logs_metrics_bucket_crn":      terraform.Output(t, existingTerraformOptions, "metrics_bucket_crn"),
 				"existing_cloud_logs_metrics_bucket_endpoint": terraform.Output(t, existingTerraformOptions, "metrics_bucket_endpoint"),
-				"existing_en_instance_crn":                    terraform.Output(t, existingTerraformOptions, "en_crn"),
-				"management_endpoint_type_for_bucket":         "public",
-				"log_analysis_service_endpoints":              "public",
-				"enable_platform_metrics":                     "false",
-				"enable_platform_logs":                        "false",
-				"enable_at_event_routing_to_log_analysis":     "true",
+				"existing_en_instance_crn":                    terraform.Output(t, existingTerraformOptions, "en_crn_1"),
+				"cloud_logs_existing_en_instances": []map[string]interface{}{
+					{
+						"instance_crn": terraform.Output(t, existingTerraformOptions, "en_crn_2"),
+					},
+				},
+				"management_endpoint_type_for_bucket":     "public",
+				"log_analysis_service_endpoints":          "public",
+				"enable_platform_metrics":                 "false",
+				"enable_at_event_routing_to_log_analysis": "true",
+				"enable_platform_logs":                    "false",
 			},
 		})
 

tests/resources/existing-resources/main.tf

@@ -63,11 +63,22 @@ module "cloud_log_buckets" {
 # Event Notification
 ##############################################################################
 
-module "event_notification" {
+module "event_notification_1" {
   source            = "terraform-ibm-modules/event-notifications/ibm"
   version           = "1.6.5"
   resource_group_id = module.resource_group.resource_group_id
-  name              = "${var.prefix}-en"
+  name              = "${var.prefix}-en-1"
+  tags              = var.resource_tags
+  plan              = "standard"
+  service_endpoints = "public"
+  region            = var.region
+}
+
+module "event_notification_2" {
+  source            = "terraform-ibm-modules/event-notifications/ibm"
+  version           = "1.6.5"
+  resource_group_id = module.resource_group.resource_group_id
+  name              = "${var.prefix}-en-2"
   tags              = var.resource_tags
   plan              = "standard"
   service_endpoints = "public"

tests/resources/existing-resources/outputs.tf

@@ -57,7 +57,12 @@ output "metrics_bucket_endpoint" {
   value       = module.cloud_log_buckets.buckets["${var.prefix}-metrics-bucket"].s3_endpoint_public
 }
 
-output "en_crn" {
+output "en_crn_1" {
   description = "Event Notification CRN"
-  value       = module.event_notification.crn
+  value       = module.event_notification_1.crn
+}
+
+output "en_crn_2" {
+  description = "Event Notification CRN"
+  value       = module.event_notification_2.crn
 }