fix variable descriptions, add bucket suffix

Author: whoffler

ibm_catalog.json

@@ -529,6 +529,9 @@
             {
               "key": "cos_bucket_name"
             },
+            {
+              "key": "add_bucket_name_suffix"
+            },
             {
               "key": "kms_encryption_enabled_bucket"
             },

solutions/fully-configurable/main.tf

@@ -215,9 +215,10 @@ locals {
   # If a bucket name is passed, or an existing EN CRN is passed; do not create COS resources
   create_cos_bucket = var.enable_collecting_failed_events == false || var.existing_event_notifications_instance_crn != null ? false : true
   # determine COS details
-  cos_bucket_name   = var.enable_collecting_failed_events == false ? null : local.create_cos_bucket ? try("${local.prefix}-${var.cos_bucket_name}", var.cos_bucket_name) : null
-  cos_bucket_region = var.cos_bucket_region != null ? var.cos_bucket_region : var.cross_region_location != null ? null : var.region
-  cos_instance_guid = var.existing_event_notifications_instance_crn == null ? (var.existing_cos_instance_crn == null ? (length(module.cos_buckets) > 0 ? module.cos_buckets.bucket_configs.cos_instance_guid : null) : module.existing_cos_crn_parser[0].service_instance) : null
+  cos_bucket_name             = var.enable_collecting_failed_events == false ? null : local.create_cos_bucket ? try("${local.prefix}-${var.cos_bucket_name}", var.cos_bucket_name) : null
+  cos_bucket_name_with_suffix = try(module.cos_buckets[0].buckets[local.cos_bucket_name].bucket_name, null)
+  cos_bucket_region           = var.cos_bucket_region != null ? var.cos_bucket_region : var.cross_region_location != null ? null : var.region
+  cos_instance_guid           = var.existing_event_notifications_instance_crn == null ? (var.existing_cos_instance_crn == null ? (length(module.cos_buckets) > 0 ? module.cos_buckets.bucket_configs.cos_instance_guid : null) : module.existing_cos_crn_parser[0].service_instance) : null
 
   # If not using existing EN instance, parse the COS account ID from the CRN
   cos_account_id = var.existing_event_notifications_instance_crn == null ? var.existing_cos_instance_crn != null ? split("/", module.existing_cos_crn_parser[0].scope)[1] : null : null
@@ -227,6 +228,7 @@ locals {
   bucket_config = [{
     access_tags                   = var.cos_bucket_access_tags
     bucket_name                   = local.cos_bucket_name
+    add_bucket_name_suffix        = var.add_bucket_name_suffix
     kms_encryption_enabled        = var.kms_encryption_enabled_bucket
     kms_guid                      = var.kms_encryption_enabled_bucket ? local.kms_instance_guid : null
     kms_key_crn                   = var.kms_encryption_enabled_bucket ? var.existing_kms_instance_crn : null
@@ -294,7 +296,7 @@ module "event_notifications" {
   skip_en_kms_auth_policy   = local.create_cross_account_en_kms_auth_policy || var.skip_event_notifications_kms_auth_policy
   # COS Related
   cos_integration_enabled = var.enable_collecting_failed_events
-  cos_bucket_name         = local.cos_bucket_name
+  cos_bucket_name         = local.cos_bucket_name_with_suffix
   cos_instance_id         = var.existing_cos_instance_crn
   skip_en_cos_auth_policy = var.skip_event_notifications_cos_auth_policy || local.create_cross_account_cos_kms_auth_policy
   cos_endpoint            = var.existing_cos_endpoint

solutions/fully-configurable/variables.tf

@@ -143,7 +143,7 @@ variable "kms_endpoint_url" {
 
 variable "existing_kms_root_key_crn" {
   type        = string
-  description = "The key CRN of a root key, existing in the KMS instance passed in the `existing_kms_instance_crn` input, which will be used to encrypt the data. To use an existing key you must also provide a value for 'existing_event_notification_kms_key_name' and 'kms_endpoint_url'. If no value passed, a new key will be created in the instance provided in the `existing_kms_instance_crn` input."
+  description = "The key CRN of a root key, existing in the KMS instance passed in the `existing_kms_instance_crn` input, which will be used to encrypt the data. To use an existing key you must also provide a value for 'existing_kms_key_name' and 'kms_endpoint_url'. If no value passed, a new key will be created in the instance provided in the `existing_kms_instance_crn` input."
   default     = null
   validation {
     condition     = !(var.kms_encryption_enabled == false && var.existing_kms_root_key_crn != null)
@@ -186,7 +186,7 @@ variable "event_notifications_key_ring_name" {
 variable "cos_key_ring_name" {
   type        = string
   default     = "en-cos-key-ring"
-  description = "The name of the key ring which will be created for Object Storage. Not used if supplying an existing key or if `existing_cloud_object_storage_bucket_name` is specified. If a `prefix` input variable is specified, it is added to this name in the `<prefix>-value` format."
+  description = "The name of the key ring which will be created for Object Storage. Not used if supplying an existing key. If a `prefix` input variable is specified, it is added to this name in the `<prefix>-value` format."
 }
 
 variable "cos_key_name" {
@@ -203,7 +203,7 @@ variable "skip_event_notifications_kms_auth_policy" {
 
 variable "ibmcloud_kms_api_key" {
   type        = string
-  description = "The IBM Cloud API key that can create a root key and key ring in the key management service (KMS) instance. If not specified, the 'ibmcloud_api_key' variable is used. Specify this key if the instance in `existing_key_management_service_instance_crn` is in an account that's different from the Event Notifications instance. Leave this input empty if the same account owns both instances."
+  description = "The IBM Cloud API key that can create a root key and key ring in the key management service (KMS) instance. If not specified, the 'ibmcloud_api_key' variable is used. Specify this key if the instance in `existing_kms_instance_crn` is in an account that's different from the Event Notifications instance. Leave this input empty if the same account owns both instances."
   sensitive   = true
   default     = null
 }
@@ -245,9 +245,15 @@ variable "cos_bucket_name" {
   default     = "base-event-notifications-bucket"
 }
 
+variable "add_bucket_name_suffix" {
+  type        = bool
+  description = "Whether to add a randomly generated 4-character suffix to the newly provisioned Object Storage bucket name. Used only if not using an existing bucket. Set to `false` if you want full control over bucket naming by using the `cos_bucket_name` variable."
+  default     = true
+}
+
 variable "kms_encryption_enabled_bucket" {
   type        = bool
-  description = "Set to true to enable Key Protect encryption on Cloud Object Storage bucket."
+  description = "Set to true to enable key management service encryption on Cloud Object Storage bucket."
   default     = false
 }