feat: add prefix to atracker resource name (#131)<br>The AT event routing target and routes names were updated to add a prefix(if provided) for consistency with other resource. Also, the new targets and routes with prefix are created before the destroy of old ones which ensures the consumers does not lose event data. Additionally, updated the variable descriptions.

* fix: atracker resource name and variable descriptions

* SKIP Upgrade Test

---------

Co-authored-by: Md Anam Raihan <[email protected]>
Co-authored-by: Allen Dean <[email protected]>

Author: 3 people

solutions/instances/main.tf

@@ -26,6 +26,10 @@ locals {
 
   cos_target_bucket_name     = var.existing_at_cos_target_bucket_name != null ? var.existing_at_cos_target_bucket_name : module.cos_bucket[0].buckets[local.at_cos_target_bucket_name].bucket_name
   cos_target_bucket_endpoint = var.existing_at_cos_target_bucket_endpoint != null ? var.existing_at_cos_target_bucket_endpoint : module.cos_bucket[0].buckets[local.at_cos_target_bucket_name].s3_endpoint_private
+  cos_target_name            = var.prefix != null ? "${var.prefix}-cos-target" : "cos-target"
+  log_analysis_target_name   = var.prefix != null ? "${var.prefix}-log-analysis-target" : "log-analysis-target"
+  at_cos_route_name          = var.prefix != null ? "${var.prefix}-at-cos-route" : "at-cos-route"
+  at_log_analysis_route_name = var.prefix != null ? "${var.prefix}-at-log-analysis-route" : "at-log-analysis-route"
 
   bucket_config_1 = var.existing_log_archive_cos_bucket_name == null && var.log_analysis_provision == true ? {
     class = var.log_archive_cos_bucket_class
@@ -64,15 +68,15 @@ locals {
 
   kms_region = (length(coalesce(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"
+    route_name = local.at_cos_route_name
     locations  = ["*", "global"]
-    target_ids = [module.observability_instance.activity_tracker_targets["cos-target"].id]
+    target_ids = [module.observability_instance.activity_tracker_targets[local.cos_target_name].id]
   }] : []
 
   at_log_analysis_route = var.enable_at_event_routing_to_log_analysis ? [{
-    route_name = "at-log-analysis-route"
+    route_name = local.at_log_analysis_route_name
     locations  = ["*", "global"]
-    target_ids = [module.observability_instance.activity_tracker_targets["log-analysis-target"].id]
+    target_ids = [module.observability_instance.activity_tracker_targets[local.log_analysis_target_name].id]
   }] : []
 
   at_routes = concat(local.at_cos_route, local.at_log_analysis_route)
@@ -134,7 +138,7 @@ module "observability_instance" {
       endpoint                          = local.cos_target_bucket_endpoint
       instance_id                       = local.cos_instance_crn
       target_region                     = local.default_cos_region
-      target_name                       = "cos-target"
+      target_name                       = local.cos_target_name
       skip_atracker_cos_iam_auth_policy = false
       service_to_service_enabled        = true
     }
@@ -145,7 +149,7 @@ module "observability_instance" {
       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"
+      target_name   = local.log_analysis_target_name
     }
   ] : []
 

solutions/instances/variables.tf

@@ -23,7 +23,7 @@ variable "use_existing_resource_group" {
 
 variable "resource_group_name" {
   type        = string
-  description = "The name of a new or existing resource group to provision resources to. If a prefix input variable is passed, it is prefixed to the value in the `<prefix>-value` format."
+  description = "The name of a new or existing resource group to provision resources in."
 }
 
 variable "region" {
@@ -39,7 +39,7 @@ variable "region" {
 
 variable "prefix" {
   type        = string
-  description = "Optional. The prefix to append to all resources that this solution creates."
+  description = "The prefix to add to all resources that this solution creates."
   default     = null
 }
 
@@ -55,13 +55,13 @@ variable "log_analysis_provision" {
 
 variable "log_analysis_instance_name" {
   type        = string
-  description = "The name of the IBM Cloud Logging instance to create. If a prefix input variable is passed, it is prefixed to the value in the `<prefix>-value` format."
+  description = "The name of the IBM Cloud Log Analysis instance to create. If a prefix input variable is specified, it's added to the value in the <prefix>-value format."
   default     = "log-analysis"
 }
 
 variable "log_analysis_plan" {
   type        = string
-  description = "The IBM Cloud Logging plan to provision. Available values are `7-day`, `14-day`, `30-day`, and `hipaa-30-day`."
+  description = "The Log Analysis plan to provision. Possible values: `7-day`, `14-day`, `30-day`, and `hipaa-30-day`."
   default     = "7-day"
 
   validation {
@@ -71,7 +71,7 @@ variable "log_analysis_plan" {
 }
 
 variable "log_analysis_service_endpoints" {
-  description = "The type of the service endpoint that will be set for the IBM Log Analysis instance."
+  description = "The type of endpoint for the Log Analysis instance. Possible values: `public`, `private`, `public-and-private`."
   type        = string
   default     = "private"
   validation {
@@ -88,26 +88,26 @@ variable "log_analysis_tags" {
 
 variable "log_analysis_enable_archive" {
   type        = bool
-  description = "Enable archive on log analysis instances"
+  description = "Whether to enable archiving on Log Analysis instances."
   default     = true
 }
 
 variable "activity_tracker_enable_archive" {
   type        = bool
-  description = "Enable archive on activity tracker instances"
+  description = "Whether to enable archiving on Activity Tracker."
   default     = true
 }
 
 variable "log_archive_api_key" {
   type        = string
-  description = "Optional. The API key to use to configure log analysis archiving with Cloud Object Storage. If no value is passed, the API key value that was passed in the `ibmcloud_api_key` variable is used."
+  description = "The API key to use to configure archiving from Log Analysis to Object Storage. If not specified, the API key value in ibmcloud_api_key is used."
   sensitive   = true
   default     = null
 }
 
 variable "enable_platform_logs" {
   type        = bool
-  description = "When set to `true`, the IBM Cloud Logging instance collects the platform log files."
+  description = "Whether Log Analysis collects platform log files."
   default     = true
 }
 ##############################################################################
@@ -116,13 +116,13 @@ variable "enable_platform_logs" {
 
 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."
+  description = "Whether to enable event routing from Activity Tracker to the Object Storage 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."
+  description = "Whether to enable event from Activity Tracker to Log Analysis."
   default     = false
 }
 

tests/pr_test.go

@@ -108,6 +108,7 @@ func TestRunUpgradeSolutionInstances(t *testing.T) {
 	})
 
 	options.TerraformVars = map[string]interface{}{
+		"prefix":                                  options.Prefix,
 		"resource_group_name":                     options.Prefix,
 		"cos_instance_access_tags":                permanentResources["accessTags"],
 		"existing_kms_instance_crn":               permanentResources["hpcs_south_crn"],