feat: added new variables: enable_at_event_routing_to_cos_bucket (defaulting to true) and enable_at_event_routing_to_log_analysis (defaulting to false) (#56)

Soaib024 · web-flow · commit 446bab3cee55 · 2024-05-13T12:49:17.000+01:00
diff --git a/ibm_catalog.json b/ibm_catalog.json
@@ -39,8 +39,8 @@
           "title": "Configures Cloud Monitoring. instance and agents."
         },
         {
-          "description": "Configures Activity Tracker routing",
-          "title": "Configures an Activity Tracker route with a COS bucket target."
+          "description": "Configures Activity Tracker event routing to a COS bucket and Log Analysis instance.",
+          "title": "Configures an Activity Tracker event routing"
         }
       ],
       "flavors": [
@@ -211,6 +211,12 @@
             {
               "key": "enable_platform_logs"
             },
+            {
+              "key": "enable_at_event_routing_to_log_analysis"
+            },
+            {
+              "key": "enable_at_event_routing_to_cos_bucket"
+            },
             {
               "key": "cloud_monitoring_instance_name"
             },
@@ -387,7 +393,7 @@
             }
           ],
           "architecture": {
-            "descriptions": "This architecture supports deployment of Log Analysis and Cloud Monitoring instances on IBM Cloud and Activity Tracker event routing to a COS bucket target.",
+            "descriptions": "This architecture supports the deployment of Log Analysis and Cloud Monitoring instances on IBM Cloud. It also supports configuring the Activity Tracker event routing.",
             "features": [
               {
                 "title": "Creates the Log Analysis instance.",
@@ -406,8 +412,8 @@
                 "description": "Creates and configures the COS bucket with archiving and expiration enabled."
               },
               {
-                "title": "Creates an Activity Tracker event route and COS target.",
-                "description": "Creates and configures the Activity Tracker event routing and COS target."
+                "title": "Support Configuring the Activity Tracker event routing.",
+                "description": "Supports configuring the Activity Tracker event routing to a COS bucket and to a Log Analysis instance."
               }
             ],
             "diagrams": [
@@ -417,7 +423,7 @@
                   "url": "https://raw.githubusercontent.com/terraform-ibm-modules/terraform-ibm-observability-da/main/reference-architecture/deployable-architecture-observability-instances.svg",
                   "type": "image/svg+xml"
                 },
-                "description": "This architecture supports creating and configuring IBM Cloud Observability instances and Activity Tracker event routing to a COS target."
+                "description": "This architecture supports creating and configuring IBM Cloud Observability instances and Activity Tracker event routing to a COS bucket and to a Log Analysis instance."
               }
             ]
           }
diff --git a/reference-architecture/deployable-architecture-observability-instances.svg b/reference-architecture/deployable-architecture-observability-instances.svg
diff --git a/solutions/instances/README.md b/solutions/instances/README.md
@@ -9,7 +9,7 @@ This architecture creates the observability instances on IBM Cloud and supports
 - Supports creating KMS root keys in an existing KMS instance or using existing keys if creating new buckets.
 - Creates a KMS encrypted COS bucket that is required to store archived logs or using an existing bucket.
 - Creates a KMS encrypted COS bucket for setting up Activity Tracker event routing or using an existing bucket.
-- Creates the Activity Tracker event route to a COS target.
+- Supports configuring the Activity Tracker event routing to the Cloud Object Storage (COS) bucket and to the Log Analysis instance .
 
 ![observability-instances-deployable-architecture](../../reference-architecture/deployable-architecture-observability-instances.svg)
 
diff --git a/solutions/instances/main.tf b/solutions/instances/main.tf
@@ -57,6 +57,20 @@ locals {
   ) : null
 
   kms_region = (length(local.bucket_config_map) != 0) ? (var.existing_cos_kms_key_crn == null ? element(split(":", var.existing_kms_instance_crn), length(split(":", var.existing_kms_instance_crn)) - 5) : null) : null
+  at_cos_route = var.enable_at_event_routing_to_cos_bucket ? [{
+    route_name = "at-cos-route"
+    locations  = ["*", "global"]
+    target_ids = [module.observability_instance.activity_tracker_targets["cos-target"].id]
+  }] : []
+
+  at_log_analysis_route = var.enable_at_event_routing_to_log_analysis ? [{
+    route_name = "at-log-analysis-route"
+    locations  = ["*", "global"]
+    target_ids = [module.observability_instance.activity_tracker_targets["log-analysis-target"].id]
+  }] : []
+
+  at_routes = concat(local.at_cos_route, local.at_log_analysis_route)
+
 }
 
 #######################################################################################################################
@@ -105,7 +119,7 @@ module "observability_instance" {
 
   # Activity Tracker
   activity_tracker_provision = false
-  cos_targets = [
+  cos_targets = var.enable_at_event_routing_to_cos_bucket ? [
     {
       bucket_name                       = local.cos_target_bucket_name
       endpoint                          = local.cos_target_bucket_endpoint
@@ -115,18 +129,20 @@ module "observability_instance" {
       skip_atracker_cos_iam_auth_policy = false
       service_to_service_enabled        = true
     }
-  ]
+  ] : []
 
-  # Routes
-  activity_tracker_routes = [
+  log_analysis_targets = var.enable_at_event_routing_to_log_analysis ? [
     {
-      route_name = "at-route"
-      locations  = ["*", "global"]
-      target_ids = [
-        module.observability_instance.activity_tracker_targets["cos-target"].id
-      ]
+      instance_id   = module.observability_instance.log_analysis_crn
+      ingestion_key = module.observability_instance.log_analysis_ingestion_key
+      target_region = var.region
+      target_name   = "log-analysis-target"
     }
-  ]
+  ] : []
+
+  # Routes
+  activity_tracker_routes = local.at_routes
+
 }
 
 #######################################################################################################################
diff --git a/solutions/instances/outputs.tf b/solutions/instances/outputs.tf
@@ -79,7 +79,7 @@ output "at_cos_target_bucket_name" {
 }
 
 ## Activity Tracker
-output "at_cos_targets" {
+output "at_targets" {
   value       = module.observability_instance.activity_tracker_targets
   description = "The map of created activity_tracker targets"
 }
diff --git a/solutions/instances/variables.tf b/solutions/instances/variables.tf
@@ -91,6 +91,21 @@ variable "enable_platform_logs" {
   description = "Receive platform logs in the provisioned IBM Cloud Logging instance."
   default     = true
 }
+##############################################################################
+# Activity Tracker Event Routing Variables
+##############################################################################
+
+variable "enable_at_event_routing_to_cos_bucket" {
+  type        = bool
+  description = "Set to true to enable activity tracker event routing to the Cloud Object Storage (COS) bucket."
+  default     = true
+}
+
+variable "enable_at_event_routing_to_log_analysis" {
+  type        = bool
+  description = "Set to true to enable activity tracker event routing to the provisioned IBM Cloud Logging instance."
+  default     = false
+}
 
 ##############################################################################
 # Cloud Monitoring Variables
diff --git a/tests/pr_test.go b/tests/pr_test.go
@@ -90,6 +90,7 @@ func TestInstancesInSchematics(t *testing.T) {
 		{Name: "archive_bucket_access_tags", Value: permanentResources["accessTags"], DataType: "list(string)"},
 		{Name: "at_cos_bucket_access_tags", Value: permanentResources["accessTags"], DataType: "list(string)"},
 		{Name: "prefix", Value: options.Prefix, DataType: "string"},
+		{Name: "enable_at_event_routing_to_log_analysis", Value: true, DataType: "bool"},
 	}
 
 	err := options.RunSchematicTest()
@@ -107,15 +108,16 @@ func TestRunUpgradeSolutionInstances(t *testing.T) {
 	})
 
 	options.TerraformVars = map[string]interface{}{
-		"resource_group_name":                 options.Prefix,
-		"cos_instance_access_tags":            permanentResources["accessTags"],
-		"existing_kms_instance_crn":           permanentResources["hpcs_south_crn"],
-		"kms_endpoint_type":                   "public",
-		"management_endpoint_type_for_bucket": "public",
-		"log_analysis_service_endpoints":      "public-and-private",
-		"cloud_monitoring_service_endpoints":  "public",
-		"enable_platform_logs":                "false",
-		"enable_platform_metrics":             "false",
+		"resource_group_name":                     options.Prefix,
+		"cos_instance_access_tags":                permanentResources["accessTags"],
+		"existing_kms_instance_crn":               permanentResources["hpcs_south_crn"],
+		"kms_endpoint_type":                       "public",
+		"management_endpoint_type_for_bucket":     "public",
+		"log_analysis_service_endpoints":          "public-and-private",
+		"cloud_monitoring_service_endpoints":      "public",
+		"enable_platform_logs":                    "false",
+		"enable_platform_metrics":                 "false",
+		"enable_at_event_routing_to_log_analysis": "true",
 	}
 
 	output, err := options.RunTestUpgrade()

Original file line number	Diff line number	Diff line change
`@@ -39,8 +39,8 @@`
`39`	`39`	`"title": "Configures Cloud Monitoring. instance and agents."`
`40`	`40`	`},`
`41`	`41`	`{`
`42`		`- "description": "Configures Activity Tracker routing",`
`43`		`- "title": "Configures an Activity Tracker route with a COS bucket target."`
	`42`	`+ "description": "Configures Activity Tracker event routing to a COS bucket and Log Analysis instance.",`
	`43`	`+ "title": "Configures an Activity Tracker event routing"`
`44`	`44`	`}`
`45`	`45`	`],`
`46`	`46`	`"flavors": [`
`@@ -211,6 +211,12 @@`
`211`	`211`	`{`
`212`	`212`	`"key": "enable_platform_logs"`
`213`	`213`	`},`
	`214`	`+ {`
	`215`	`+ "key": "enable_at_event_routing_to_log_analysis"`
	`216`	`+ },`
	`217`	`+ {`
	`218`	`+ "key": "enable_at_event_routing_to_cos_bucket"`
	`219`	`+ },`
`214`	`220`	`{`
`215`	`221`	`"key": "cloud_monitoring_instance_name"`
`216`	`222`	`},`
`@@ -387,7 +393,7 @@`
`387`	`393`	`}`
`388`	`394`	`],`
`389`	`395`	`"architecture": {`
`390`		`- "descriptions": "This architecture supports deployment of Log Analysis and Cloud Monitoring instances on IBM Cloud and Activity Tracker event routing to a COS bucket target.",`
	`396`	`+ "descriptions": "This architecture supports the deployment of Log Analysis and Cloud Monitoring instances on IBM Cloud. It also supports configuring the Activity Tracker event routing.",`
`391`	`397`	`"features": [`
`392`	`398`	`{`
`393`	`399`	`"title": "Creates the Log Analysis instance.",`
`@@ -406,8 +412,8 @@`
`406`	`412`	`"description": "Creates and configures the COS bucket with archiving and expiration enabled."`
`407`	`413`	`},`
`408`	`414`	`{`
`409`		`- "title": "Creates an Activity Tracker event route and COS target.",`
`410`		`- "description": "Creates and configures the Activity Tracker event routing and COS target."`
	`415`	`+ "title": "Support Configuring the Activity Tracker event routing.",`
	`416`	`+ "description": "Supports configuring the Activity Tracker event routing to a COS bucket and to a Log Analysis instance."`
`411`	`417`	`}`
`412`	`418`	`],`
`413`	`419`	`"diagrams": [`
`@@ -417,7 +423,7 @@`
`417`	`423`	`"url": "https://raw.githubusercontent.com/terraform-ibm-modules/terraform-ibm-observability-da/main/reference-architecture/deployable-architecture-observability-instances.svg",`
`418`	`424`	`"type": "image/svg+xml"`
`419`	`425`	`},`
`420`		`- "description": "This architecture supports creating and configuring IBM Cloud Observability instances and Activity Tracker event routing to a COS target."`
	`426`	`+ "description": "This architecture supports creating and configuring IBM Cloud Observability instances and Activity Tracker event routing to a COS bucket and to a Log Analysis instance."`
`421`	`427`	`}`
`422`	`428`	`]`
`423`	`429`	`}`
Original file line number	Diff line number	Diff line change
`@@ -79,7 +79,7 @@ output "at_cos_target_bucket_name" {`
`79`	`79`	`}`
`80`	`80`
`81`	`81`	`## Activity Tracker`
`82`		`-output "at_cos_targets" {`
	`82`	`+output "at_targets" {`
`83`	`83`	`value = module.observability_instance.activity_tracker_targets`
`84`	`84`	`description = "The map of created activity_tracker targets"`
`85`	`85`	`}`