Skip to content

Commit 50717f9

Browse files
maheshwarishikhaShikha Maheshwari
andauthored
fix: name change, code cleanup and set on_by_default (#241)
* fix: code cleanup and set on_by_default * fix: name change and code clean up --------- Co-authored-by: Shikha Maheshwari <[email protected]>
1 parent 0bbf2e9 commit 50717f9

File tree

1 file changed

+5
-120
lines changed

1 file changed

+5
-120
lines changed

ibm_catalog.json

Lines changed: 5 additions & 120 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"products": [
33
{
44
"name": "testing-deploy-arch-ibm-secrets-manager",
5-
"label": "[Add-ons Beta] Cloud automation for Secrets Manager",
5+
"label": "Testing - Cloud automation for Secrets Manager",
66
"product_kind": "solution",
77
"tags": [
88
"ibm_created",
@@ -61,29 +61,18 @@
6161
"configuration": [
6262
{
6363
"key": "ibmcloud_api_key",
64-
"type": "password",
65-
"description": "The API Key to use for IBM Cloud.",
6664
"required": true
6765
},
6866
{
6967
"key": "use_existing_resource_group",
70-
"type": "boolean",
71-
"default_value": false,
72-
"description": "Whether to use an existing resource group.",
7368
"required": false
7469
},
7570
{
7671
"key": "resource_group_name",
77-
"type": "string",
78-
"default_value": "__NULL__",
79-
"description": "The name of a new or existing resource group to provision resources to. If a prefix input variable is specified, it's added to the value in the `<prefix>-value` format. Optional if `existing_secrets_manager_crn` is not specified.",
8072
"required": true
8173
},
8274
{
8375
"key": "region",
84-
"type": "string",
85-
"default_value": "us-south",
86-
"description": "The region to provision resources to.",
8776
"required": true,
8877
"custom_config": {
8978
"type": "region",
@@ -96,23 +85,14 @@
9685
},
9786
{
9887
"key": "prefix",
99-
"type": "string",
100-
"default_value": "__NULL__",
101-
"description": "The prefix to apply to all resources created by this solution.",
10288
"required": false
10389
},
10490
{
10591
"key": "secrets_manager_instance_name",
106-
"type": "string",
107-
"default_value": "base-security-services-sm",
108-
"description": "The name to give the Secrets Manager instance provisioned by this solution. If a prefix input variable is specified, it is added to the value in the `<prefix>-value` format.",
10992
"required": false
11093
},
11194
{
11295
"key": "service_plan",
113-
"type": "string",
114-
"default_value": "standard",
115-
"description": "The pricing plan to use when provisioning a Secrets Manager instance. Possible values: `standard`, `trial`. Applies only if `provision_sm_instance` is set to `true`.",
11696
"required": false,
11797
"options": [
11898
{
@@ -127,9 +107,6 @@
127107
},
128108
{
129109
"key": "allowed_network",
130-
"type": "string",
131-
"default_value": "private-only",
132-
"description": "The types of service endpoints to set on the Secrets Manager instance. Possible values: `private-only`, `public-and-private`.",
133110
"required": false,
134111
"options": [
135112
{
@@ -144,141 +121,82 @@
144121
},
145122
{
146123
"key": "secret_manager_tags",
147-
"type": "array",
148-
"default_value": "[]",
149-
"description": "The list of resource tags you want to associate with your Secrets Manager instance.",
150124
"required": false
151125
},
152126
{
153127
"key": "iam_engine_enabled",
154-
"type": "boolean",
155-
"default_value": false,
156-
"description": "Set this to true to to configure a Secrets Manager IAM credentials engine. If set to false, no IAM engine will be configured for your instance.",
157128
"required": false
158129
},
159130
{
160131
"key": "iam_engine_name",
161-
"type": "string",
162-
"default_value": "base-sm-iam-engine",
163-
"description": "The name of the IAM engine used to configure a Secrets Manager IAM credentials engine. If the prefix input variable is passed it is attached before the value in the format of '<prefix>-value'.",
164132
"required": false
165133
},
166134
{
167135
"key": "public_engine_enabled",
168-
"type": "boolean",
169-
"default_value": false,
170-
"description": "Set this to true to configure a Secrets Manager public certificate engine for an existing Secrets Manager instance. If set to false, no public certificate engine will be configured for your instance.",
171136
"required": false
172137
},
173138
{
174139
"key": "public_engine_name",
175-
"type": "string",
176-
"default_value": "public-engine-sm",
177-
"description": "The name of the IAM engine used to configure a Secrets Manager public certificate engine for an existing instance.",
178140
"required": false
179141
},
180142
{
181143
"key": "cis_id",
182-
"type": "string",
183-
"default_value": "__NULL__",
184-
"description": "Cloud Internet Service ID.",
185144
"required": false
186145
},
187146
{
188147
"key": "dns_provider_name",
189-
"type": "string",
190-
"default_value": "certificate-dns",
191-
"description": "The name of the DNS provider for the public certificate secrets engine configuration.",
192148
"required": false
193149
},
194150
{
195151
"key": "ca_name",
196-
"type": "string",
197-
"default_value": "cert-auth",
198-
"description": "The name of the certificate authority for Secrets Manager.",
199152
"required": false
200153
},
201154
{
202155
"key": "acme_letsencrypt_private_key",
203-
"type": "password",
204-
"description": "The private key generated by the ACME account creation tool.",
205156
"required": false
206157
},
207158
{
208159
"key": "private_engine_enabled",
209-
"type": "boolean",
210-
"default_value": false,
211-
"description": "Set this to true to configure a Secrets Manager private certificate engine for an existing instance. If set to false, no private certificate engine will be configured for your instance.",
212160
"required": false
213161
},
214162
{
215163
"key": "private_engine_name",
216-
"type": "string",
217-
"default_value": "private-engine-sm",
218-
"description": "The name of the IAM Engine used to configure a Secrets Manager private certificate engine for an existing instance.",
219164
"required": false
220165
},
221166
{
222167
"key": "root_ca_name",
223-
"type": "string",
224-
"default_value": "root-ca",
225-
"description": "The name of the root certificate authority associated with the private_cert secret engine.",
226168
"required": false
227169
},
228170
{
229171
"key": "root_ca_common_name",
230-
"type": "string",
231-
"default_value": "terraform-modules.ibm.com",
232-
"description": "The fully qualified domain name or host domain name for the certificate that will be created.",
233172
"required": false
234173
},
235174
{
236175
"key": "root_ca_max_ttl",
237-
"type": "string",
238-
"default_value": "87600h",
239-
"description": "The maximum time-to-live value for the root certificate authority.",
240176
"required": false
241177
},
242178
{
243179
"key": "intermediate_ca_name",
244-
"type": "string",
245-
"default_value": "intermediate-ca",
246-
"description": "A human-readable unique name to assign to the intermediate certificate authority configuration.",
247180
"required": false
248181
},
249182
{
250183
"key": "certificate_template_name",
251-
"type": "string",
252-
"default_value": "default-cert-template",
253-
"description": "The name of the certificate template.",
254184
"required": false
255185
},
256186
{
257187
"key": "skip_kms_iam_authorization_policy",
258-
"type": "boolean",
259-
"default_value": false,
260-
"description": "Set to true to skip the creation of an IAM authorization policy that permits all Secrets Manager instances in the resource group to read the encryption key from the KMS instance. If set to false, pass in a value for the KMS instance in the `existing_kms_instance_crn` variable. If a value is specified for `ibmcloud_kms_api_key`, the policy is created in the KMS account.",
261188
"required": false
262189
},
263190
{
264191
"key": "existing_secrets_manager_kms_key_crn",
265-
"type": "string",
266-
"default_value": "__NULL__",
267-
"description": "The CRN of a Key Protect or Hyper Protect Crypto Services key to use for Secrets Manager. If not specified, a key ring and key are created.",
268192
"required": false
269193
},
270194
{
271195
"key": "existing_kms_instance_crn",
272-
"type": "string",
273-
"default_value": "__NULL__",
274-
"description": "The CRN of the KMS instance (Hyper Protect Crypto Services or Key Protect). Required only if `existing_secrets_manager_crn` or `existing_secrets_manager_kms_key_crn` is not specified. If the KMS instance is in different account you must also provide a value for `ibmcloud_kms_api_key`.",
275196
"required": false
276197
},
277198
{
278199
"key": "kms_endpoint_type",
279-
"type": "string",
280-
"default_value": "private",
281-
"description": "The type of endpoint to use for communicating with the Key Protect or Hyper Protect Crypto Services instance. Possible values: `public`, `private`. Applies only if `existing_secrets_manager_kms_key_crn` is not specified.",
282200
"required": false,
283201
"options": [
284202
{
@@ -293,78 +211,46 @@
293211
},
294212
{
295213
"key": "kms_key_ring_name",
296-
"type": "string",
297-
"default_value": "sm-cos-key-ring",
298-
"description": "The name for the new key ring to store the key. Applies only if `existing_secrets_manager_kms_key_crn` is not specified. If a prefix input variable is passed, it is added to the value in the `<prefix>-value` format. .",
299214
"required": false
300215
},
301216
{
302217
"key": "kms_key_name",
303-
"type": "string",
304-
"default_value": "sm-cos-key",
305-
"description": "The name for the new root key. Applies only if `existing_secrets_manager_kms_key_crn` is not specified. If a prefix input variable is passed, it is added to the value in the `<prefix>-value` format.",
306218
"required": false
307219
},
308220
{
309221
"key": "existing_event_notification_instance_crn",
310-
"type": "string",
311-
"default_value": "__NULL__",
312-
"description": "The CRN of the Event Notifications service used to enable lifecycle notifications for your Secrets Manager instance.",
313222
"required": false
314223
},
315224
{
316225
"key": "skip_event_notification_iam_authorization_policy",
317-
"type": "boolean",
318-
"default_value": false,
319-
"description": "If set to true, this skips the creation of a service to service authorization from Secrets Manager to Event Notifications. If false, the service to service authorization is created.",
320226
"required": false
321227
},
322228
{
323229
"key": "enable_event_notification",
324-
"type": "boolean",
325-
"default_value": false,
326-
"description": "Set this to true to enable lifecycle notifications for your Secrets Manager instance by connecting an Event Notifications service. When setting this to true, a value must be passed for `existing_en_instance_crn` and `existing_sm_instance_crn` must be null.",
327230
"required": false
328231
},
329232
{
330233
"key": "existing_secrets_endpoint_type",
331-
"type": "string",
332-
"default_value": "private",
333-
"description": "The endpoint type to use if existing_secrets_manager_crn is specified. Possible values: public, private.",
334234
"required": false
335235
},
336236
{
337237
"key": "existing_secrets_manager_crn",
338-
"type": "string",
339-
"default_value": "__NULL__",
340-
"description": "The CRN of an existing Secrets Manager instance. If not supplied, a new instance is created.",
341238
"required": false
342239
},
343240
{
344241
"key": "ibmcloud_kms_api_key",
345-
"type": "password",
346-
"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 Secrets Manager instance. Leave this input empty if the same account owns both instances.",
347242
"required": false
348243
},
349244
{
350245
"key": "sm_en_email_list",
351-
"type": "array",
352-
"default_value": "[]",
353-
"description": "The list of email address to target out when Secrets Manager triggers an event",
354246
"required": false
355247
},
356248
{
357249
"key": "sm_en_from_email",
358-
"type": "string",
359-
"default_value": "[email protected]",
360-
"description": "The email address in the used in the 'from' of any Secret Manager event coming from Event Notifications",
361250
"required": false
362251
},
363252
{
364253
"key": "sm_en_reply_to_email",
365-
"type": "string",
366-
"default_value": "[email protected]",
367-
"description": "The email address used in the 'reply_to' of any Secret Manager event coming from Event Notifications",
368254
"required": false
369255
}
370256
],
@@ -435,7 +321,7 @@
435321
}
436322
],
437323
"optional": true,
438-
"on_by_default": true,
324+
"on_by_default": false,
439325
"version": "^1.11.6"
440326
},
441327
{
@@ -462,10 +348,9 @@
462348
"instances"
463349
],
464350
"id": "b773b1d4-69bb-48db-a657-2307015eb9c1",
465-
"input_mapping": [
466-
],
351+
"input_mapping": [],
467352
"optional": true,
468-
"on_by_default": true,
353+
"on_by_default": false,
469354
"version": "^1.0.1"
470355
}
471356
],
@@ -474,4 +359,4 @@
474359
]
475360
}
476361
]
477-
}
362+
}

0 commit comments

Comments
 (0)