Skip to content

Commit aa5aea2

Browse files
authored
fix: update variable descrptions (#20)
1 parent dc334f1 commit aa5aea2

File tree

1 file changed

+34
-26
lines changed

1 file changed

+34
-26
lines changed

ibm_catalog.json

Lines changed: 34 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -26,30 +26,34 @@
2626
"key protect",
2727
"compliance"
2828
],
29-
"short_description": "This architecture supports deploying core security services - Key Protect, Secrets Manager, Security and Compliance Center. It will deploy Event Notifications and Observability.",
30-
"long_description": "This architecture supports deploying core security services like Key Protect, Secrets Manager, Security and Compliance Center.",
29+
"short_description": "Deploys core security services and some related services.",
30+
"long_description": "This architecture deploys the following core security services: Key Protect, Secrets Manager, Security and Compliance Center, and Security and Compliance Center Workload Protection. It also deploys Event Notifications and Observability.",
3131
"provider_name": "IBM",
3232
"offering_icon_url": "https://globalcatalog.cloud.ibm.com/api/v1/1082e7d2-5e2f-0a11-a3bc-f88a8e1931fc/artifacts/terraform.svg",
3333
"features": [
3434
{
3535
"title": "Creates an IBM Key Protect instance",
36-
"description": "Creates and configures IBM Key Protect instance and creates root keys for Cloud Object Storage and Secrets Manager."
36+
"description": "Creates and configures an IBM Key Protect instance and creates root keys for IBM Cloud Object Storage, Event Notifications, and Secrets Manager."
3737
},
3838
{
39-
"title": "Creates an IBM Secrets Manager Instance ",
40-
"description": "Creates and configures an IBM Secrets Manager Instance."
39+
"title": "Creates an IBM Secrets Manager instance",
40+
"description": "Creates and configures an IBM Secrets Manager instance."
4141
},
4242
{
43-
"title": "Creates an IBM Security and Compliance Center Instance",
44-
"description": "Creates and configures an IBM Security Compliance Center Instance."
43+
"title": "Creates an IBM Security and Compliance Center instance",
44+
"description": "Creates and configures an IBM Security Compliance Center instance."
4545
},
4646
{
47-
"title": "Creates an IBM Cloud Object Storage Instance",
48-
"description": "Creates and configures an IBM Cloud Object Storage Instance and multiple COS buckets that is encrypted by Key Protect"
47+
"title": "Creates an Security and Compliance Center Workload Protection instance",
48+
"description": "Creates and configures an Security and Compliance Center Workload Protection instance."
4949
},
5050
{
51-
"title": "Creates Service to Service Authorizations.",
52-
"description": "Creates and configures service-to-service authorizations for the following: KMS, COS, Secrets Manager, and SCC"
51+
"title": "Creates an IBM Cloud Object Storage instance",
52+
"description": "Creates and configures an IBM Cloud Object Storage instance and multiple Object Storage buckets that is encrypted by Key Protect."
53+
},
54+
{
55+
"title": "Creates service-to-service authorizations",
56+
"description": "Creates and configures service-to-service authorizations for the following services: KMS, Event Notifications, Object Storage, Secrets Manager, and Security and Compliance Center."
5357
}
5458
],
5559
"flavors": [
@@ -98,24 +102,28 @@
98102
"architecture": {
99103
"features": [
100104
{
101-
"title": "Creates IBM Cloud Core Security Services in a resource group.",
102-
"description": "Creates a resource group called core-security-services or uses a preexisting one"
105+
"title": "Creates IBM Cloud core security services in a resource group.",
106+
"description": "Creates a resource group called `core-security-services` or uses an existing group."
103107
},
104108
{
105-
"title": "Creates an IBM Key Protect Instance",
106-
"description": "Creates and configures an IBM Key Protect Instance and creates root keys for Secret Manager and COS."
109+
"title": "Creates an IBM Key Protect instance",
110+
"description": "Creates and configures an IBM Key Protect instance and creates root keys for IBM Cloud Object Storage, Event Notifications, and Secrets Manager."
107111
},
108112
{
109-
"title": "Creates an IBM Secrets Manager Instance ",
110-
"description": "Creates and configures an IBM Secrets Manager Instance"
113+
"title": "Creates an IBM Secrets Manager instance ",
114+
"description": "Creates and configures an IBM Secrets Manager instance."
111115
},
112116
{
113-
"title": "Creates an IBM Security and Compliance Center Instance",
114-
"description": "Creates and configures an IBM Security Compliance Center Instance"
117+
"title": "Creates an IBM Security and Compliance Center instance",
118+
"description": "Creates and configures an IBM Security Compliance Center instance."
115119
},
120+
{
121+
"title": "Creates an Security and Compliance Center Workload Protection instance",
122+
"description": "Creates and configures an Security and Compliance Center Workload Protection instance."
123+
},
116124
{
117-
"title": "Creates an IBM Event Notification Instance",
118-
"description": "Creates and configures an Event Notifications Instance"
125+
"title": "Creates an IBM Event Notification instance",
126+
"description": "Creates and configures an Event Notifications instance."
119127
}
120128
],
121129
"diagrams": [
@@ -171,21 +179,21 @@
171179
"key": "prefix",
172180
"type": "string",
173181
"default_value": "",
174-
"description": "The prefix to use for all resources deployed.",
182+
"description": "An identifier prepended to resources that are provisioned. Must begin with a lowercase letter and end with a lowercase letter or number.",
175183
"required": true
176184
},
177185
{
178186
"key": "use_existing_resource_group",
179187
"type": "boolean",
180188
"default_value": false,
181-
"description": "Whether to use an existing resource group.",
189+
"description": "Whether to use an existing resource group. If set to `false, a resource group is created.",
182190
"required": true
183191
},
184192
{
185193
"key": "region",
186194
"type": "string",
187195
"default_value": "us-south",
188-
"description": "The region to deploy the Deployable Architecture",
196+
"description": "The region where the resources are created.",
189197
"required": true,
190198
"options": [
191199
{
@@ -212,7 +220,7 @@
212220
"key": "sm_service_plan",
213221
"type": "string",
214222
"default_value": "standard",
215-
"description": "The pricing plan to use when deploying the Secrets Manager Deployable Architecture",
223+
"description": "The pricing plan to use for Secrets Manager.",
216224
"required": false,
217225
"options": [
218226
{
@@ -229,7 +237,7 @@
229237
"key": "scc_service_plan",
230238
"type": "string",
231239
"default_value": "security-compliance-center-standard-plan",
232-
"description": "The pricing plan to use when deploying IBM Cloud Security Compliance Center",
240+
"description": "The pricing plan to use for the IBM Cloud Security and Compliance Center.",
233241
"required": false,
234242
"options": [
235243
{

0 commit comments

Comments
 (0)