feat: Removed the enable_platform_logs input. Platform logging should be controlled using the logs_routing_tenant_regions input (#274)

Author: kierramarie

.secrets.baseline

@@ -3,7 +3,7 @@
     "files": "go.sum|^.secrets.baseline$",
     "lines": null
   },
-  "generated_at": "2023-12-12T06:39:44Z",
+  "generated_at": "2023-12-13T06:39:44Z",
   "plugins_used": [
     {
       "name": "AWSKeyDetector"

ibm_catalog.json

@@ -191,9 +191,6 @@
                 }
               ]
             },
-            {
-              "key": "enable_platform_logs"
-            },
             {
               "key": "logs_routing_tenant_regions"
             },

solutions/instances/catalogValidationValues.json.template

@@ -3,7 +3,6 @@
   "resource_group_name": $PREFIX,
   "existing_kms_instance_crn": $HPCS_US_SOUTH_CRN,
   "region": "us-south",
-  "enable_platform_logs": false,
   "enable_platform_metrics": false,
   "prefix": $PREFIX
 }

solutions/instances/main.tf

@@ -245,7 +245,7 @@ module "cloud_monitoring_crn_parser" {
 module "observability_instance" {
   depends_on        = [time_sleep.wait_for_atracker_cos_authorization_policy]
   source            = "terraform-ibm-modules/observability-instances/ibm"
-  version           = "3.4.2"
+  version           = "3.4.3"
   region            = var.region
   resource_group_id = module.resource_group.resource_group_id
 
@@ -261,7 +261,6 @@ module "observability_instance" {
   cloud_logs_provision         = var.cloud_logs_provision
   cloud_logs_instance_name     = local.cloud_logs_instance_name
   cloud_logs_plan              = "standard"
-  enable_platform_logs         = var.enable_platform_logs
   cloud_logs_access_tags       = var.cloud_logs_access_tags
   cloud_logs_tags              = var.cloud_logs_tags
   cloud_logs_service_endpoints = "public-and-private"

solutions/instances/variables.tf

@@ -143,12 +143,6 @@ variable "skip_logs_routing_auth_policy" {
   default     = false
 }
 
-variable "enable_platform_logs" {
-  type        = bool
-  description = "Setting this to true will create a tenant in the same region that the Cloud Logs instance is provisioned to enable platform logs for that region. To send platform logs from other regions, you can explicitially specify a list of regions using the `logs_routing_tenant_regions` input. NOTE: You can only have 1 tenant per region in an account."
-  default     = true
-}
-
 variable "logs_routing_tenant_regions" {
   type        = list(any)
   default     = []

tests/pr_test.go

@@ -81,7 +81,6 @@ func TestInstancesInSchematics(t *testing.T) {
 		{Name: "cos_region", Value: region, DataType: "string"},
 		{Name: "cos_instance_tags", Value: options.Tags, DataType: "list(string)"},
 		{Name: "cloud_logs_tags", Value: options.Tags, DataType: "list(string)"},
-		{Name: "enable_platform_logs", Value: false, DataType: "bool"},
 		{Name: "cloud_monitoring_tags", Value: options.Tags, DataType: "list(string)"},
 		{Name: "enable_platform_metrics", Value: false, DataType: "bool"},
 		{Name: "cos_instance_access_tags", Value: permanentResources["accessTags"], DataType: "list(string)"},
@@ -114,7 +113,6 @@ func TestRunUpgradeSolutionInstances(t *testing.T) {
 		"kms_endpoint_type":                   "public",
 		"provider_visibility":                 "public",
 		"management_endpoint_type_for_bucket": "public",
-		"enable_platform_logs":                "false",
 		"enable_platform_metrics":             "false",
 		"region":                              options.Region,
 		"cloud_logs_policies": []map[string]interface{}{
@@ -311,7 +309,6 @@ func TestRunExistingResourcesInstancesSchematics(t *testing.T) {
 			{Name: "management_endpoint_type_for_bucket", Value: "private", DataType: "string"},
 			{Name: "provider_visibility", Value: "public", DataType: "string"},
 			{Name: "enable_platform_metrics", Value: false, DataType: "bool"},
-			{Name: "enable_platform_logs", Value: false, DataType: "bool"},
 			{Name: "cloud_logs_existing_en_instances", Value: cloud_logs_existing_en_instances, DataType: "list(object)"},
 			{Name: "cloud_logs_policies", Value: cloud_logs_policies, DataType: "list(object)"},
 			{Name: "existing_cos_instance_crn", Value: terraform.Output(t, existingTerraformOptions, "cos_crn"), DataType: "string"},
@@ -346,7 +343,6 @@ func TestRunExistingResourcesInstancesSchematics(t *testing.T) {
 			{Name: "existing_cos_instance_crn", Value: terraform.Output(t, existingTerraformOptions, "cos_crn"), DataType: "string"},
 			{Name: "management_endpoint_type_for_bucket", Value: "private", DataType: "string"},
 			{Name: "enable_platform_metrics", Value: false, DataType: "bool"},
-			{Name: "enable_platform_logs", Value: false, DataType: "bool"},
 			{Name: "existing_kms_instance_crn", Value: permanentResources["hpcs_south_crn"], DataType: "string"},
 			{Name: "existing_cos_kms_key_crn", Value: permanentResources["hpcs_south_root_key_crn"], DataType: "string"},
 		}

tests/resources/main.tf

@@ -89,7 +89,6 @@ module "observability_instances" {
   cloud_monitoring_instance_name     = "${var.prefix}-cloud-monitoring"
   cloud_logs_instance_name           = "${var.prefix}-cloud-logs"
   enable_platform_metrics            = false
-  enable_platform_logs               = false
   cloud_logs_tags                    = var.resource_tags
   cloud_logs_data_storage = {
     # logs and metrics buckets must be different