Skip to content

Commit 4d3cab2

Browse files
whofflerwhoffler
committed
variable name updates, catalog display names, remove dup docs
1 parent 1b823c2 commit 4d3cab2

File tree

12 files changed

+172
-268
lines changed

12 files changed

+172
-268
lines changed

‎ibm_catalog.json‎

Lines changed: 62 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,9 @@
128128
{
129129
"key": "tags"
130130
},
131+
{
132+
"key": "access_tags"
133+
},
131134
{
132135
"key": "existing_kms_instance_crn",
133136
"required": true
@@ -154,9 +157,11 @@
154157
]
155158
},
156159
{
160+
"displayname": "Existing Key Management Service root key CRN",
157161
"key": "existing_kms_root_key_crn"
158162
},
159163
{
164+
"displayname": "Key Management Service endpoint type",
160165
"key": "kms_endpoint_type",
161166
"options": [
162167
{
@@ -176,45 +181,58 @@
176181
"key": "en_key_name"
177182
},
178183
{
184+
"displayname": "Cloud Object Storage key ring name",
179185
"key": "cos_key_ring_name"
180186
},
181187
{
188+
"displayname": "Cloud Object Storage key name",
182189
"key": "cos_key_name"
183190
},
184191
{
192+
"displayname": "Skip Event Notification Key Management Service auth policy",
185193
"key": "skip_en_kms_auth_policy"
186194
},
187195
{
196+
"displayname": "IBM Cloud Key Management Service apikey",
188197
"key": "ibmcloud_kms_api_key"
189198
},
190199
{
200+
"displayname": "Existing Cloud Object Storage instance CRN",
191201
"key": "existing_cos_instance_crn"
192202
},
193203
{
204+
"displayname": "Existing Cloud Object Storage bucket name",
194205
"key": "existing_cos_bucket_name"
195206
},
196207
{
208+
"displayname": "Cloud Object Storage bucket name",
197209
"key": "cos_bucket_name"
198210
},
199211
{
212+
"displayname": "Skip Event Notifications Cloud Object Storage auth policy",
200213
"key": "skip_en_cos_auth_policy"
201214
},
202215
{
216+
"displayname": "Skip Cloud Object Storage Key Management Service auth policy",
203217
"key": "skip_cos_kms_auth_policy"
204218
},
205219
{
220+
"displayname": "Cloud Object Storage instance name",
206221
"key": "cos_instance_name"
207222
},
208223
{
224+
"displayname": "Cloud Object Storage instance tags",
209225
"key": "cos_instance_tags"
210226
},
211227
{
228+
"displayname": "Cloud Object Storage instance access tags",
212229
"key": "cos_instance_access_tags"
213230
},
214231
{
215232
"key": "add_bucket_name_suffix"
216233
},
217234
{
235+
"displayname": "Cloud Object Storage plan",
218236
"key": "cos_plan",
219237
"options": [
220238
{
@@ -235,6 +253,7 @@
235253
"key": "cross_region_location"
236254
},
237255
{
256+
"displayname": "Cloud Object Storage bucket region",
238257
"key": "cos_bucket_region"
239258
},
240259
{
@@ -261,6 +280,7 @@
261280
]
262281
},
263282
{
283+
"displayname": "Existing Cloud Object Storage endpoint",
264284
"key": "existing_cos_endpoint"
265285
},
266286
{
@@ -280,6 +300,7 @@
280300
]
281301
},
282302
{
303+
"displayname": "Skip Event Notification Secrets Manager auth policy",
283304
"key": "skip_en_sm_auth_policy"
284305
},
285306
{
@@ -292,6 +313,7 @@
292313
"key": "existing_monitoring_crn"
293314
},
294315
{
316+
"displayname": "Existing Event Notifications instance CRN",
295317
"key": "existing_en_instance_crn"
296318
},
297319
{
@@ -444,27 +466,33 @@
444466
"description": "CRN of existing Event Notifications instance, set if using an existing Event Notifications instance"
445467
},
446468
{
447-
"key": "key_management_service_encryption_enabled",
469+
"displayname": "Key Management Service encryption enabled",
470+
"key": "kms_encryption_enabled",
448471
"description": "Set to true to enable encryption on Event Notifications instance and Cloud Object Storage bucket."
449472
},
450473
{
451-
"key": "existing_key_management_service_instance_crn",
474+
"displayname": "Existing Key Management Service instance CRN",
475+
"key": "existing_kms_instance_crn",
452476
"description": "CRN of existing Key Management Service instance. Required if setting 'key_management_service_encryption_enabled' to 'true'."
453477
},
454478
{
455-
"key": "key_management_service_endpoint_url",
479+
"displayname": "Key Management Service endpoint url",
480+
"key": "kms_endpoint_url",
456481
"description": "Endpoint URL of existing Key Management Service instance. Required if setting 'key_management_service_encryption_enabled' to 'true'."
457482
},
458483
{
459-
"key": "existing_key_management_service_root_key_crn",
484+
"displayname": "Existing Key Management Service root key CRN",
485+
"key": "existing_kms_root_key_crn",
460486
"description": "CRN of existing root key to be used in existing Key Management Service instance. To use 'key_management_service_encryption_enabled' must be enabled."
461487
},
462488
{
463-
"key": "existing_key_management_service_key_name",
489+
"displayname": "Exsiting Key Management Service key name",
490+
"key": "existing_kms_key_name",
464491
"description": "Name of existing root key to be used in existing Key Management Service instance. To use 'existing_key_management_service_root_key_crn' must be set."
465492
},
466493
{
467-
"key": "key_management_service_endpoint_type",
494+
"displayname": "Key Management Service endpoint type",
495+
"key": "kms_endpoint_type",
468496
"description": "The type of the endpoint that is used for communicating with the KMS instance. Possible values: `public` or `private` (default). Only used if not supplying an existing root key.",
469497
"options": [
470498
{
@@ -501,57 +529,71 @@
501529
"key": "event_notifications_key_ring_name"
502530
},
503531
{
504-
"key": "cloud_object_storage_key_ring_name"
532+
"displayname": "Cloud Object Storage key ring name",
533+
"key": "cos_key_ring_name"
505534
},
506535
{
507-
"key": "cloud_object_storage_key_name"
536+
"displayname": "Cloud Object Storage key name",
537+
"key": "cos_key_name"
508538
},
509539
{
510-
"key": "skip_event_notifications_key_management_service_auth_policy"
540+
"displayname": "Skip Event Notifications Key Management Service auth policy",
541+
"key": "skip_event_notifications_kms_auth_policy"
511542
},
512543
{
513-
"key": "ibmcloud_key_management_service_api_key"
544+
"displayname": "IBM Cloud Key Management Service apikey",
545+
"key": "ibmcloud_kms_api_key"
514546
},
515547
{
516-
"key" : "cloud_object_storage_integration_enabled",
548+
"displayname": "Cloud Object Storage integration enabled",
549+
"key" : "cos_integration_enabled",
517550
"description" : "Set to 'true' to enable Cloud Object Storage integration with the Event Notification instance."
518551
},
519552
{
520-
"key": "existing_cloud_object_storage_instance_crn",
553+
"displayname": "Existing Cloud Object Storage instance CRN",
554+
"key": "existing_cos_instance_crn",
521555
"description" : "Existing Cloud Object Storage instance CRN. Required if 'cloud_object_storage_integration_enabled' is set to 'true'."
522556
},
523557
{
524-
"key": "existing_cloud_object_storage_bucket_name",
558+
"displayname": "Existing Cloud Object Storage bucket name",
559+
"key": "existing_cos_bucket_name",
525560
"description" : "Existing bucket in an existing Cloud Object Storage instance."
526561
},
527562
{
528-
"key": "existing_cloud_object_storage_endpoint",
563+
"displayname": "Existing Cloud Object Storage endpoint",
564+
"key": "existing_cos_endpoint",
529565
"description" : "The endpoint URL for your bucket region. [Learn more](https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-endpoints). Only required if using an existing bucket with the `existing_cloud_object_storage_bucket_name` variable."
530566
},
531567
{
532-
"key": "cloud_object_storage_bucket_name",
568+
"displayname": "Cloud Object Storage bucket name",
569+
"key": "cos_bucket_name",
533570
"description" : "Name of Cloud Object Storage bucket to be created."
534571
},
535572
{
536-
"key": "key_management_service_encryption_enabled_bucket",
573+
"displayname": "Key Management Service encryption enabled bucket",
574+
"key": "kms_encryption_enabled_bucket",
537575
"description" : "Set to true to enable Key Protect encryption on Cloud Object Storage bucket."
538576
},
539577
{
540-
"key": "cloud_object_storage_bucket_class",
578+
"displayname": "Cloud Object Storage bucket class",
579+
"key": "cos_bucket_class",
541580
"description" : "The storage class of the newly provisioned Cloud Object Storage bucket. Specify one of the following values for the storage class: `standard` (default), `vault`, `cold`, `smart`, or `onerate_active`."
542581
},
543582
{
544-
"key": "skip_event_notifications_cloud_object_storage_auth_policy"
583+
"displayname": "Skip Event Notifications Cloud Object Storage auth policy",
584+
"key": "skip_event_notifications_cos_auth_policy"
545585
},
546586
{
547-
"key": "skip_cloud_object_storage_key_protect_auth_policy"
587+
"displayname": "Skip Cloud Object Storage Key Management Service auth policy",
588+
"key": "skip_cos_kms_auth_policy"
548589
},
549590

550591
{
551592
"key": "cross_region_location"
552593
},
553594
{
554-
"key": "cloud_object_storage_bucket_region"
595+
"displayname": "Cloud Object Storage region",
596+
"key": "cos_bucket_region"
555597
},
556598
{
557599
"key": "management_endpoint_type_for_bucket",

‎solutions/fully-configurable/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Event Notifications solution
1+
# Cloud automation for Event Notifications
22

33
When `existing_en_instance_crn` is not passed, this solution configures the following infrastructure:
44

‎solutions/fully-configurable/catalogValidationValues.json.template‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
{
22
"ibmcloud_api_key": $VALIDATION_APIKEY,
3-
"existing_resource_group_name": $PREFIX,
3+
"existing_resource_group_name": "geretain-test-event-notifications",
44
"event_notifications_tags": $TAGS,
5-
"key_management_service_encryption_enabled": true,
6-
"existing_key_management_service_instance_crn": $HPCS_US_SOUTH_CRN,
7-
"key_management_service_endpoint_url": "https://api.private.us-south.hs-crypto.cloud.ibm.com:8992"
5+
"kms_encryption_enabled": true,
6+
"existing_kms_instance_crn": $HPCS_US_SOUTH_CRN,
7+
"kms_endpoint_url": $HPCS_US_SOUTH_PRIVATE_ENDPOINT
88
}

0 commit comments

Comments
 (0)