Skip to content

Commit 29995b7

Browse files
committed
fix variable descriptions
1 parent dcf9464 commit 29995b7

File tree

3 files changed

+14
-4
lines changed

3 files changed

+14
-4
lines changed

ibm_catalog.json

+3
Original file line numberDiff line numberDiff line change
@@ -529,6 +529,9 @@
529529
{
530530
"key": "cos_bucket_name"
531531
},
532+
{
533+
"key": "add_bucket_name_suffix"
534+
},
532535
{
533536
"key": "kms_encryption_enabled_bucket"
534537
},

solutions/fully-configurable/main.tf

+1
Original file line numberDiff line numberDiff line change
@@ -227,6 +227,7 @@ locals {
227227
bucket_config = [{
228228
access_tags = var.cos_bucket_access_tags
229229
bucket_name = local.cos_bucket_name
230+
add_bucket_name_suffix = var.add_bucket_name_suffix
230231
kms_encryption_enabled = var.kms_encryption_enabled_bucket
231232
kms_guid = var.kms_encryption_enabled_bucket ? local.kms_instance_guid : null
232233
kms_key_crn = var.kms_encryption_enabled_bucket ? var.existing_kms_instance_crn : null

solutions/fully-configurable/variables.tf

+10-4
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@ variable "kms_endpoint_url" {
143143

144144
variable "existing_kms_root_key_crn" {
145145
type = string
146-
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."
146+
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."
147147
default = null
148148
validation {
149149
condition = !(var.kms_encryption_enabled == false && var.existing_kms_root_key_crn != null)
@@ -186,7 +186,7 @@ variable "event_notifications_key_ring_name" {
186186
variable "cos_key_ring_name" {
187187
type = string
188188
default = "en-cos-key-ring"
189-
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."
189+
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."
190190
}
191191

192192
variable "cos_key_name" {
@@ -203,7 +203,7 @@ variable "skip_event_notifications_kms_auth_policy" {
203203

204204
variable "ibmcloud_kms_api_key" {
205205
type = string
206-
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."
206+
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."
207207
sensitive = true
208208
default = null
209209
}
@@ -245,9 +245,15 @@ variable "cos_bucket_name" {
245245
default = "base-event-notifications-bucket"
246246
}
247247

248+
variable "add_bucket_name_suffix" {
249+
type = bool
250+
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."
251+
default = true
252+
}
253+
248254
variable "kms_encryption_enabled_bucket" {
249255
type = bool
250-
description = "Set to true to enable Key Protect encryption on Cloud Object Storage bucket."
256+
description = "Set to true to enable key management service encryption on Cloud Object Storage bucket."
251257
default = false
252258
}
253259

0 commit comments

Comments
 (0)