Skip to content

Commit 5b34bef

Browse files
Khuzaima05Khuzaima-Shakeel
andauthored
fix: improved DA for better user experience (#1009)
* feat: improve DA user experience * updated support_details * minor fix * resolve review comments --------- Co-authored-by: Khuzaima-Shakeel <[email protected]>
1 parent bf22973 commit 5b34bef

File tree

5 files changed

+93
-174
lines changed

5 files changed

+93
-174
lines changed

ibm_catalog.json

Lines changed: 65 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@
1919
"infrastructure as code",
2020
"solution"
2121
],
22-
"short_description": "Automates VPC deployment on IBM Cloud, offering full configurability and flexibility for diverse workloads.",
23-
"long_description": "The Cloud automation for VPC sets up a foundational IBM Cloud [Virtual Private Cloud (VPC)](https://www.ibm.com/cloud/vpc) environment. It lays the groundwork for adding Virtual Servers Instances (VSI) or Red Hat OpenShift clusters and other advanced resources. This can be used as a base deployable architecture for many others deployable architectures like [Cloud automation for Red Hat OpenShift Container Platform on VPC](https://cloud.ibm.com/catalog/7a4d68b4-cf8b-40cd-a3d1-f49aff526eb3/architecture/deploy-arch-ibm-ocp-vpc-1728a4fd-f561-4cf9-82ef-2b1eeb5da1a8-global), [Cloud automation for Red Hat OpenShift AI](https://cloud.ibm.com/catalog/7a4d68b4-cf8b-40cd-a3d1-f49aff526eb3/architecture/deploy-arch-ibm-ocp-ai-ba708aed-bb8a-4ac0-83a7-53a066701db5-global), [Cloud automation for Virtual Servers for Virtual Private Cloud](https://cloud.ibm.com/catalog/7a4d68b4-cf8b-40cd-a3d1-f49aff526eb3/architecture/deploy-arch-ibm-vsi-vpc-28e2b12c-858f-4ae8-8717-60db8cec2e6e-global).<br>",
22+
"short_description": "Deploy a Virtual Private Cloud (VPC) on IBM Cloud, offering full configurability and flexibility for diverse workloads.",
23+
"long_description": "The Cloud automation for VPC sets up a foundational IBM Cloud [Virtual Private Cloud (VPC)](https://www.ibm.com/cloud/vpc) environment. It lays the groundwork for adding Virtual Servers Instances (VSI) or Red Hat OpenShift clusters and other advanced resources. This can be used as a base deployable architecture for many others deployable architectures like [Cloud automation for Red Hat OpenShift Container Platform on VPC](https://cloud.ibm.com/catalog/7a4d68b4-cf8b-40cd-a3d1-f49aff526eb3/architecture/deploy-arch-ibm-ocp-vpc-1728a4fd-f561-4cf9-82ef-2b1eeb5da1a8-global), [Cloud automation for Red Hat OpenShift AI](https://cloud.ibm.com/catalog/7a4d68b4-cf8b-40cd-a3d1-f49aff526eb3/architecture/deploy-arch-ibm-ocp-ai-ba708aed-bb8a-4ac0-83a7-53a066701db5-global), [Cloud automation for Virtual Servers for Virtual Private Cloud](https://cloud.ibm.com/catalog/7a4d68b4-cf8b-40cd-a3d1-f49aff526eb3/architecture/deploy-arch-ibm-vsi-vpc-28e2b12c-858f-4ae8-8717-60db8cec2e6e-global).\n\nℹ️ This Terraform-based automation is part of a broader suite of IBM-maintained Infrastructure as Code (IaC) assets, each following the naming pattern \"Cloud automation for *servicename*\" and focusing on single IBM Cloud service. These single-service deployable architectures can be used on their own to streamline and automate service deployments through an [IaC approach](https://cloud.ibm.com/docs/secure-enterprise?topic=secure-enterprise-understanding-projects), or assembled together into a broader [automated IaC stack](https://cloud.ibm.com/docs/secure-enterprise?topic=secure-enterprise-config-stack) to automate the deployment of an end-to-end solution architecture.",
2424
"offering_docs_url": "https://github.com/terraform-ibm-modules/terraform-ibm-landing-zone-vpc/blob/main/solutions/fully-configurable/README.md",
2525
"offering_icon_url": "https://raw.githubusercontent.com/terraform-ibm-modules/terraform-ibm-landing-zone-vpc/main/images/vpc_icon.svg",
2626
"provider_name": "IBM",
@@ -74,11 +74,12 @@
7474
"description": "This solution can be integrated with [Cloud automation for Observability](https://cloud.ibm.com/catalog/7a4d68b4-cf8b-40cd-a3d1-f49aff526eb3/architecture/deploy-arch-ibm-observability-a3137d28-79e0-479d-8a24-758ebd5a0eab-global) that supports configuring resources for logging, monitoring and activity tracker event routing."
7575
}
7676
],
77-
"support_details": "This product is in the community registry, as such support is handled through the originated repository. If you experience issues, kindly open an issue [here](https://github.com/terraform-ibm-modules/terraform-ibm-landing-zone-vpc/issues). Please note that this product is not currently supported through the IBM Cloud Support Center.",
77+
"support_details": "This product is in the community registry, support is handled through the [original repo](https://github.com/terraform-ibm-modules/terraform-ibm-landing-zone-vpc). If you experience issues, please open an issue in the repository [here](https://github.com/terraform-ibm-modules/terraform-ibm-landing-zone-vpc/issues). Please note this product is not supported via the IBM Cloud Support Center.",
7878
"flavors": [
7979
{
8080
"label": "Fully configurable",
8181
"name": "fully-configurable",
82+
"index": 1,
8283
"install_type": "fullstack",
8384
"working_directory": "solutions/fully-configurable",
8485
"compliance": {
@@ -93,12 +94,8 @@
9394
"architecture": {
9495
"features": [
9596
{
96-
"title": "VPC instance",
97-
"description": "Sets up nd configures a VPC with subnets across three zones and implements ACLs. The predefined ACLs allows traffic on ports 443, 80 and 22."
98-
},
99-
{
100-
"title": "Public Gateway",
101-
"description": "Configures a public gateway with one of the subnets."
97+
"title": " ",
98+
"description": "Configured to use IBM secure by default standards, but can be edited to fit your use case."
10299
}
103100
],
104101
"diagrams": [
@@ -113,6 +110,11 @@
113110
]
114111
},
115112
"iam_permissions": [
113+
{
114+
"role_crns": ["crn:v1:bluemix:public:iam::::role:Viewer"],
115+
"service_name": "Resource group only",
116+
"notes": "Viewer access is required in the resource group you want to provision in."
117+
},
116118
{
117119
"role_crns": ["crn:v1:bluemix:public:iam::::role:Administrator"],
118120
"service_name": "iam-identity",
@@ -121,7 +123,7 @@
121123
{
122124
"role_crns": ["crn:v1:bluemix:public:iam::::role:Administrator"],
123125
"service_name": "is.vpc",
124-
"notes": "Required for creating Virtual Private Cloud(VPC)."
126+
"notes": "Required for creating Virtual Private Cloud(VPC)."
125127
},
126128
{
127129
"service_name": "cloud-object-storage",
@@ -145,15 +147,15 @@
145147
"crn:v1:bluemix:public:iam::::role:Editor"
146148
],
147149
"service_name": "sysdig-monitor",
148-
"notes": "[Optional] Required if you are consuming Observability deployable architecture which sets up Cloud monitoring."
150+
"notes": "[Optional] Required for consuming Observability deployable architecture which sets up Cloud monitoring."
149151
},
150152
{
151153
"role_crns": [
152154
"crn:v1:bluemix:public:iam::::serviceRole:Manager",
153155
"crn:v1:bluemix:public:iam::::role:Editor"
154156
],
155157
"service_name": "logs",
156-
"notes": "[Optional] Required if you are consuming Observability deployable architecture which sets up Cloud logs."
158+
"notes": "[Optional] Required for consuming Observability deployable architecture which sets up Cloud logs."
157159
}
158160
],
159161
"configuration": [
@@ -226,34 +228,73 @@
226228
}
227229
},
228230
{
229-
"key": "subnets"
231+
"key": "subnets",
232+
"type": "array",
233+
"custom_config": {
234+
"type": "textarea",
235+
"grouping": "deployment",
236+
"original_grouping": "deployment"
237+
}
230238
},
231239
{
232-
"key": "network_acls"
240+
"key": "network_acls",
241+
"type": "array",
242+
"custom_config": {
243+
"type": "textarea",
244+
"grouping": "deployment",
245+
"original_grouping": "deployment"
246+
}
233247
},
234248
{
235249
"key": "address_prefixes"
236250
},
237251
{
238-
"key": "security_group_rules"
252+
"key": "security_group_rules",
253+
"type": "array",
254+
"custom_config": {
255+
"type": "textarea",
256+
"grouping": "deployment",
257+
"original_grouping": "deployment"
258+
}
239259
},
240260
{
241261
"key": "clean_default_security_group_acl"
242262
},
243263
{
244-
"key": "vpn_gateways"
264+
"key": "vpn_gateways",
265+
"type": "array",
266+
"custom_config": {
267+
"type": "textarea",
268+
"grouping": "deployment",
269+
"original_grouping": "deployment"
270+
}
245271
},
246272
{
247-
"key": "routes"
273+
"key": "routes",
274+
"type": "array",
275+
"custom_config": {
276+
"type": "textarea",
277+
"grouping": "deployment",
278+
"original_grouping": "deployment"
279+
}
248280
},
249281
{
250-
"key": "vpe_gateway_cloud_services"
282+
"key": "vpe_gateway_cloud_services",
283+
"type": "array"
251284
},
252285
{
253-
"key": "vpe_gateway_cloud_service_by_crn"
286+
"key": "vpe_gateway_cloud_service_by_crn",
287+
"type": "array"
254288
},
255289
{
256-
"key": "vpe_gateway_security_group_ids"
290+
"key": "vpe_gateway_security_group_ids",
291+
"custom_config": {
292+
"grouping": "deployment",
293+
"original_grouping": "deployment",
294+
"config_constraints": {
295+
"type": "string"
296+
}
297+
}
257298
},
258299
{
259300
"key": "vpe_gateway_service_endpoints",
@@ -283,6 +324,7 @@
283324
{
284325
"key": "resource_tags",
285326
"custom_config": {
327+
"type": "array",
286328
"grouping": "deployment",
287329
"original_grouping": "deployment",
288330
"config_constraints": {
@@ -292,7 +334,8 @@
292334
},
293335
{
294336
"key": "access_tags",
295-
"custom_config": {
337+
"custom_config": {
338+
"type": "array",
296339
"grouping": "deployment",
297340
"original_grouping": "deployment",
298341
"config_constraints": {
@@ -548,9 +591,7 @@
548591
"description": "Configure IBM Cloud Logs, Cloud Monitoring and Activity Tracker event routing for analysing logs and metrics generated by the VPC instance.",
549592
"id": "a3137d28-79e0-479d-8a24-758ebd5a0eab-global",
550593
"version": "v3.0.3",
551-
"flavors": [
552-
"instances"
553-
],
594+
"flavors": ["instances"],
554595
"catalog_id": "7a4d68b4-cf8b-40cd-a3d1-f49aff526eb3",
555596
"optional": true,
556597
"on_by_default": true,

0 commit comments

Comments
 (0)