Skip to content

Commit 039c2ff

Browse files
huayuenhhuayuenh
authored
fix: re-order/add and update variable descriptions. (#38)
1 parent 4e95946 commit 039c2ff

File tree

3 files changed

+83
-67
lines changed

3 files changed

+83
-67
lines changed

‎ibm_catalog.json‎

Lines changed: 31 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -79,14 +79,14 @@
7979
{
8080
"key": "ibmcloud_api_key",
8181
"type": "password",
82-
"description": "The API Key used to provision all resources created in this solution.",
82+
"description": "The API Key used to provision all the resources created in this solution.",
8383
"required": true
8484
},
8585
{
8686
"key": "region",
8787
"type": "string",
8888
"default_value": "eu-gb",
89-
"description": "The region in which all resources are deployed except SCC and Event Notifications that default to us-south but can be changed in optional properties.",
89+
"description": "The region in which all resources are deployed except for SCC and Event Notifications. Those resources should be individually set and by default are set to `us-south`.",
9090
"display_name": "Region",
9191
"required": true,
9292
"custom_config": {
@@ -108,70 +108,70 @@
108108
"key": "prefix",
109109
"type": "string",
110110
"default_value": "devsecops",
111-
"description": "Default prefix for repos and resources",
111+
"description": "The value set in this variable when set acts as a prefix for the various resources that get created. A hyphen `-` will automatically be inserted as a separator between the prefix and resource names.",
112112
"required": false
113113
},
114114
{
115115
"key": "resource_group_name",
116116
"type": "string",
117117
"default_value": "devsecops",
118-
"description": "The name of the resource group",
118+
"description": "The name of the resource group in which all the resources are created.",
119119
"required": false
120120
},
121121
{
122122
"key": "bucket_name",
123123
"type": "string",
124124
"default_value": "devsecops",
125-
"description": "The name of the COS bucket that is created.",
125+
"description": "The name of the Cloud Object Storage bucket created as evidence storage for the DevSecOps toolchains.",
126126
"required": false
127127
},
128128
{
129129
"key": "registry_namespace",
130130
"type": "string",
131131
"default_value": "devsecops",
132-
"description": "The name of the registry namespace.",
132+
"description": "The name of the registry namespace where images are stored.",
133133
"required": false
134134
},
135135
{
136136
"key": "create_cd_instance",
137137
"type": "boolean",
138-
"default_value": false,
139-
"description": "Set to `true` to create Continuous Delivery Service. ",
138+
"default_value": true,
139+
"description": "Set to `true` to create a Continuous Delivery Service. This is required for running the DevSecOps toolchain pipelines and to successfuly interact with a DevOps Insights integration.",
140140
"required": false
141141
},
142142
{
143143
"key": "pipeline_ibmcloud_api_key_secret_name",
144144
"type": "string",
145145
"default_value": "ibmcloud-api-key",
146-
"description": "The name of the IBMcloud api key for running the pipelines.",
146+
"description": "The name of the IBM Cloud api key used for running the pipelines.",
147147
"required": false
148148
},
149149
{
150150
"key": "ci_signing_key_secret_name",
151151
"type": "string",
152152
"default_value": "signing_key",
153-
"description": "The name of the signing key.",
153+
"description": "The name of the signing key in Secrets Manager that is required for signing the images.",
154154
"required": false
155155
},
156156
{
157157
"key": "cd_code_signing_cert_secret_name",
158158
"type": "string",
159159
"default_value": "signing-certificate",
160-
"description": "The name of the signing certificate.",
160+
"description": "The name of the signing certificate in Secrets Manager that is used for validating the integrity of signed images.",
161161
"required": false
162162
},
163163
{
164164
"key": "cos_api_key_secret_name",
165165
"type": "string",
166166
"default_value": "cos-api-key",
167-
"description": "The name of the COS api key.",
167+
"description": "The name of the Cloud Object Storage api key in Secrets Manager that is used for reading/writing to the evidence bucket.",
168168
"required": false
169169
},
170170
{
171171
"key": "sm_secret_group",
172172
"type": "string",
173173
"default_value": "devsecops",
174-
"description": "The secrets group created in Secrets Manager",
174+
"description": "The secrets group created in Secrets Manager containing the secrets required by the DevSecOps toolchains.",
175175
"required": false
176176
},
177177
{
@@ -212,7 +212,7 @@
212212
"key": "scc_region",
213213
"type": "string",
214214
"default_value": "us-south",
215-
"description": "The region in which all resources are deployed except SCC and Event Notifications which default to us-south but can do change in optional properties.",
215+
"description": "The region in which the Security and Compliance Center instance is provisioned.",
216216
"display_name": "Region",
217217
"required": false,
218218
"custom_config": {
@@ -234,7 +234,7 @@
234234
"key": "en_region",
235235
"type": "string",
236236
"default_value": "us-south",
237-
"description": "The region in which all resources are deployed except SCC and Event Notifications which default to us-south but can do change in optional properties.",
237+
"description": "The region in which the Events Notification instance is created.",
238238
"display_name": "Region",
239239
"required": false,
240240
"custom_config": {
@@ -256,7 +256,7 @@
256256
"key": "use_existing_resource_group",
257257
"type": "boolean",
258258
"default_value": true,
259-
"description": "Set to `true` to create and add a `cos-api-key` to the Secrets Provider.",
259+
"description": "Setting to `true` will treat the `resource_group_name` as an existing resource group. Setting `false` will provision a new resource group based on the value in `resource_group_name`.",
260260
"required": true
261261
}
262262
],
@@ -312,14 +312,14 @@
312312
{
313313
"key": "ibmcloud_api_key",
314314
"type": "password",
315-
"description": "The API Key used to provision all resources created in this solution.",
315+
"description": "The API Key used to provision all the resources created in this solution.",
316316
"required": true
317317
},
318318
{
319319
"key": "region",
320320
"type": "string",
321321
"default_value": "eu-gb",
322-
"description": "The region in which all resources are deployed except SCC and Event Notifications that default to us-south but can be changed in optional properties.",
322+
"description": "The region in which all resources are deployed except for SCC and Event Notifications. Those resources should be individually set and by default are set to `us-south`.",
323323
"display_name": "Region",
324324
"required": true,
325325
"custom_config": {
@@ -348,35 +348,35 @@
348348
"key": "prefix",
349349
"type": "string",
350350
"default_value": "devsecops",
351-
"description": "Default prefix for repos and resources",
351+
"description": "The value set in this variable when set acts as a prefix for the various resources that get created. A hyphen `-` will automatically be inserted as a separator between the prefix and resource names.",
352352
"required": false
353353
},
354354
{
355355
"key": "resource_group_name",
356356
"type": "string",
357357
"default_value": "devsecops",
358-
"description": "The name of the resource group",
358+
"description": "The name of the resource group in which all the resources are created.",
359359
"required": false
360360
},
361361
{
362362
"key": "bucket_name",
363363
"type": "string",
364364
"default_value": "devsecops",
365-
"description": "The name of the COS bucket that is created.",
365+
"description": "The name of the Cloud Object Storage bucket created as evidence storage for the DevSecOps toolchains.",
366366
"required": false
367367
},
368368
{
369369
"key": "registry_namespace",
370370
"type": "string",
371371
"default_value": "devsecops",
372-
"description": "The name of the registry namespace.",
372+
"description": "The name of the registry namespace where images are stored.",
373373
"required": false
374374
},
375375
{
376376
"key": "create_cd_instance",
377377
"type": "boolean",
378378
"default_value": false,
379-
"description": "Set to `true` to create Continuous Delivery Service. ",
379+
"description": "Set to `true` to create a Continuous Delivery Service. This is required for running the DevSecOps toolchain pipelines and to successfuly interact with a DevOps Insights integration.",
380380
"required": false
381381
},
382382
{
@@ -425,35 +425,35 @@
425425
"key": "pipeline_ibmcloud_api_key_secret_name",
426426
"type": "string",
427427
"default_value": "ibmcloud-api-key",
428-
"description": "The name of the IBMcloud api key for running the pipelines.",
428+
"description": "The name of the IBM Cloud api key used for running the pipelines.",
429429
"required": false
430430
},
431431
{
432432
"key": "ci_signing_key_secret_name",
433433
"type": "string",
434434
"default_value": "signing_key",
435-
"description": "The name of the signing key.",
435+
"description": "The name of the signing key in Secrets Manager that is required for signing the images.",
436436
"required": false
437437
},
438438
{
439439
"key": "cd_code_signing_cert_secret_name",
440440
"type": "string",
441441
"default_value": "signing-certificate",
442-
"description": "The name of the signing certificate.",
442+
"description": "The name of the signing certificate in Secrets Manager that is used for validating the integrity of signed images.",
443443
"required": false
444444
},
445445
{
446446
"key": "cos_api_key_secret_name",
447447
"type": "string",
448448
"default_value": "cos-api-key",
449-
"description": "The name of the COS api key.",
449+
"description": "The name of the Cloud Object Storage api key in Secrets Manager that is used for reading/writing to the evidence bucket.",
450450
"required": false
451451
},
452452
{
453453
"key": "sm_secret_group",
454454
"type": "string",
455455
"default_value": "devsecops",
456-
"description": "The secrets group created in Secrets Manager",
456+
"description": "The secrets group created in Secrets Manager containing the secrets required by the DevSecOps toolchains.",
457457
"required": false
458458
},
459459
{
@@ -494,7 +494,7 @@
494494
"key": "scc_region",
495495
"type": "string",
496496
"default_value": "us-south",
497-
"description": "The region in which all resources are deployed except SCC and Event Notifications which default to us-south but can do change in optional properties.",
497+
"description": "The region in which the Security and Compliance Center instance is provisioned.",
498498
"display_name": "Region",
499499
"required": false,
500500
"custom_config": {
@@ -516,7 +516,7 @@
516516
"key": "en_region",
517517
"type": "string",
518518
"default_value": "us-south",
519-
"description": "The region in which all resources are deployed except SCC and Event Notifications which default to us-south but can do change in optional properties.",
519+
"description": "The region in which the Events Notification instance is created.",
520520
"display_name": "Region",
521521
"required": false,
522522
"custom_config": {
@@ -538,7 +538,7 @@
538538
"key": "use_existing_resource_group",
539539
"type": "boolean",
540540
"default_value": true,
541-
"description": "Set to `true` to create and add a `cos-api-key` to the Secrets Provider.",
541+
"description": "Setting to `true` will treat the `resource_group_name` as an existing resource group. Setting `false` will provision a new resource group based on the value in `resource_group_name`.",
542542
"required": true
543543
}
544544
],

‎kubernetes/stack_definition.json‎

Lines changed: 26 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
11
{
22
"inputs": [
3+
{
4+
"name": "resource_group_name",
5+
"required": true,
6+
"type": "string",
7+
"hidden": false,
8+
"default": "__NULL__",
9+
"custom_config": {}
10+
},
311
{
412
"name": "region",
513
"required": true,
@@ -8,11 +16,19 @@
816
"default": "us-south"
917
},
1018
{
11-
"name": "resource_group_name",
19+
"name": "en_region",
1220
"required": true,
1321
"type": "string",
1422
"hidden": false,
15-
"default": "__NULL__",
23+
"default": "us-south",
24+
"custom_config": {}
25+
},
26+
{
27+
"name": "scc_region",
28+
"required": true,
29+
"type": "string",
30+
"hidden": false,
31+
"default": "us-south",
1632
"custom_config": {}
1733
},
1834
{
@@ -154,29 +170,13 @@
154170
"default": "signing-certificate",
155171
"custom_config": {}
156172
},
157-
{
158-
"name": "en_region",
159-
"required": false,
160-
"type": "string",
161-
"hidden": false,
162-
"default": "us-south",
163-
"custom_config": {}
164-
},
165173
{
166174
"name": "scc_service_plan",
167175
"required": false,
168176
"type": "string",
169177
"hidden": false,
170178
"default": "security-compliance-center-standard-plan",
171179
"custom_config": {}
172-
},
173-
{
174-
"name": "scc_region",
175-
"required": false,
176-
"type": "string",
177-
"hidden": false,
178-
"default": "us-south",
179-
"custom_config": {}
180180
}
181181
],
182182
"members": [
@@ -503,6 +503,14 @@
503503
{
504504
"name" : "ci_cluster_resource_group",
505505
"value" : "ref:../../inputs/ci_cluster_resource_group"
506+
},
507+
{
508+
"name" : "cc_opt_in_cra_auto_remediation",
509+
"value" : true
510+
},
511+
{
512+
"name" : "cc_opt_in_cra_auto_remediation_force",
513+
"value" : true
506514
}
507515

508516
]

0 commit comments

Comments
 (0)