feat: added new input metrics_router_settings to the instances DA. If not set, metrcis routing settings will be configured so that the primary meatadata region matches the region of region input in the DA, and backup region is eu-de (#290)

Author: iamar7

ibm_catalog.json

@@ -476,6 +476,9 @@
             },
             {
               "key": "metrics_router_routes"
+            },
+            {
+              "key": "metrics_router_settings"
             }
           ],
           "architecture": {

solutions/instances/main.tf

@@ -69,6 +69,13 @@ locals {
       inclusion_filters = []
     }]
   }] : []
+  metrics_router_settings = {
+    default_targets           = []
+    primary_metadata_region   = var.region
+    backup_metadata_region    = "eu-de"
+    permitted_target_regions  = []
+    private_api_endpoint_only = false
+  }
 
   archive_bucket_config = var.manage_log_archive_cos_bucket ? {
     class = var.log_archive_cos_bucket_class
@@ -325,6 +332,8 @@ module "observability_instance" {
   ] : []
 
   metrics_router_routes = var.enable_metrics_routing_to_cloud_monitoring ? (length(var.metrics_router_routes) != 0 ? var.metrics_router_routes : local.default_metrics_router_route) : []
+
+  metrics_router_settings = var.enable_metrics_routing_to_cloud_monitoring ? (var.metrics_router_settings != null ? var.metrics_router_settings : local.metrics_router_settings) : null
 }
 
 resource "time_sleep" "wait_for_atracker_cos_authorization_policy" {

solutions/instances/variables.tf

@@ -229,6 +229,20 @@ variable "enable_metrics_routing_to_cloud_monitoring" {
   default     = true
 }
 
+variable "metrics_router_settings" {
+  type = object({
+    permitted_target_regions  = optional(list(string))
+    primary_metadata_region   = optional(string)
+    backup_metadata_region    = optional(string)
+    private_api_endpoint_only = optional(bool, false)
+    default_targets = optional(list(object({
+      id = string
+    })))
+  })
+  description = "Global settings for Metrics Routing"
+  default     = null
+}
+
 ##############################################################################
 # Cloud Monitoring Variables
 ##############################################################################

tests/pr_test.go

@@ -72,6 +72,12 @@ func TestInstancesInSchematics(t *testing.T) {
 		Tags:                   []string{"test-schematic"},
 		DeleteWorkspaceOnFail:  false,
 		WaitJobCompleteMinutes: 60,
+		IgnoreUpdates: testhelper.Exemptions{
+			List: []string{
+				// Need to ignore this since primary_metadata_region might be updating in the dev account due to tests using different regions
+				"module.observability_instance.module.metric_routing.ibm_metrics_router_settings.metrics_router_settings[0]",
+			},
+		},
 	})
 
 	options.TerraformVars = []testschematic.TestSchematicTerraformVar{
@@ -103,6 +109,12 @@ func TestRunUpgradeSolutionInstances(t *testing.T) {
 		TerraformDir: solutionInstanceDADir,
 		Region:       region,
 		Prefix:       "obs-ins-upg",
+		IgnoreUpdates: testhelper.Exemptions{
+			List: []string{
+				// Need to ignore this since primary_metadata_region might be updating in the dev account due to tests using different regions
+				"module.observability_instance.module.metric_routing.ibm_metrics_router_settings.metrics_router_settings[0]",
+			},
+		},
 	})
 
 	options.TerraformVars = map[string]interface{}{
@@ -290,6 +302,12 @@ func TestRunExistingResourcesInstancesSchematics(t *testing.T) {
 			DeleteWorkspaceOnFail:  false,
 			WaitJobCompleteMinutes: 60,
 			Region:                 region,
+			IgnoreUpdates: testhelper.Exemptions{
+				List: []string{
+					// Need to ignore this since primary_metadata_region might be updating in the dev account due to tests using different regions
+					"module.observability_instance.module.metric_routing.ibm_metrics_router_settings.metrics_router_settings[0]",
+				},
+			},
 		})
 
 		options.TerraformVars = []testschematic.TestSchematicTerraformVar{
@@ -331,6 +349,12 @@ func TestRunExistingResourcesInstancesSchematics(t *testing.T) {
 			DeleteWorkspaceOnFail:  false,
 			WaitJobCompleteMinutes: 60,
 			Region:                 region,
+			IgnoreUpdates: testhelper.Exemptions{
+				List: []string{
+					// Need to ignore this since primary_metadata_region might be updating in the dev account due to tests using different regions
+					"module.observability_instance.module.metric_routing.ibm_metrics_router_settings.metrics_router_settings[0]",
+				},
+			},
 		})
 
 		options2.TerraformVars = []testschematic.TestSchematicTerraformVar{