Skip to content

Commit b8e0266

Browse files
aatreyee257shemau
andauthored
fix: improve deployable architecture catalog configuration (#137) <br> - various improvements to verbage within the catalog configuration
* DA improvement --------- Co-authored-by: shemau <shemau@gmail.com>
1 parent d774f20 commit b8e0266

File tree

2 files changed

+42
-13
lines changed

2 files changed

+42
-13
lines changed

ibm_catalog.json

Lines changed: 41 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -24,25 +24,30 @@
2424
"application_modernization"
2525
],
2626
"short_description": "Cloud architecture including instance of IBM Cloud MQ on Cloud with essential security and observability cloud services",
27-
"long_description": "IBM Cloud MQ on Cloud is an end-to-end solution to building and running secure queue managers.<br/>This architecture supports deploying an instance of MQ on Cloud on cloud together with optional security and observability cloud services.<br/><br/>ℹ️ 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.",
27+
"long_description": "[IBM Cloud MQ](https://cloud.ibm.com/docs/mqcloud/index.html), on Cloud is an end-to-end solution to building and running secure queue managers.<br/>This architecture supports deploying an instance of MQ on Cloud on cloud together with optional security and observability cloud services.<br/><br/>ℹ️ 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.",
2828
"offering_docs_url": "https://github.com/terraform-ibm-modules/terraform-ibm-mq-cloud/blob/main/solutions/fully-configurable/README.md",
2929
"offering_icon_url": "https://raw.githubusercontent.com/terraform-ibm-modules/terraform-ibm-mq-cloud/main/images/MQ.svg",
3030
"provider_name": "IBM",
3131
"features": [
3232
{
33-
"title": "Supports building, deploying and running IBM Cloud MQ on Cloud",
34-
"description": "Supports building, deploying and running IBM Cloud MQ on Cloud"
33+
"title": "IBM Cloud MQ instance",
34+
"description": "Supports building, deploying and running IBM Cloud MQ on Cloud. [Learn more](https://cloud.ibm.com/apidocs/mq-on-cloud)."
3535
},
3636
{
37-
"title": "Supports deploying of optional essential security and observability cloud services",
38-
"description": "Supports deploying an instance of IBM Cloud MQ on Cloud together with optional security and observability cloud services"
37+
"title": "Secrets Manager",
38+
"description": "Optional integration with [Cloud automation for Secrets Manager](https://cloud.ibm.com/catalog/7a4d68b4-cf8b-40cd-a3d1-f49aff526eb3/architecture/deploy-arch-ibm-secrets-manager-6d6ebc76-7bbd-42f5-8bc7-78f4fabd5944-global) for centrally managing TLS certificates required by IBM MQ."
39+
},
40+
{
41+
"title": "Observability",
42+
"description": "Optional integration 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) services such as Log Analysis and Monitoring to support IBM MQ instance monitoring and logging."
3943
}
4044
],
41-
"support_details": "This product is in the community registry, as such support is handled through the originated repo. If you experience issues please open an issue in that repository [https://github.com/terraform-ibm-modules/terraform-ibm-mq-cloud/issues](https://github.com/terraform-ibm-modules/terraform-ibm-mq-cloud/issues). Please note this product is not supported via the IBM Cloud Support Center.",
45+
"support_details": "This product is in the community registry, as such support is handled through the [original repo](https://github.com/terraform-ibm-modules/terraform-ibm-mq-cloud). If you experience issues kindly open an issue in that repository [https://github.com/terraform-ibm-modules/terraform-ibm-mq-cloud/issues](https://github.com/terraform-ibm-modules/terraform-ibm-mq-cloud/issues). Please note that this product is not currently supported through the IBM Cloud Support Center.",
4246
"flavors": [
4347
{
4448
"label": "Fully configurable",
4549
"name": "fully-configurable",
50+
"index": 1,
4651
"install_type": "fullstack",
4752
"working_directory": "solutions/fully-configurable",
4853
"iam_permissions": [
@@ -51,7 +56,30 @@
5156
"crn:v1:bluemix:public:iam::::serviceRole:Manager",
5257
"crn:v1:bluemix:public:iam::::role:Editor"
5358
],
54-
"service_name": "mqcloud"
59+
"service_name": "mqcloud",
60+
"notes": "Required to provision and manage IBM MQ resources."
61+
},
62+
{
63+
"role_crns": [
64+
"crn:v1:bluemix:public:iam::::role:Administrator",
65+
"crn:v1:bluemix:public:iam::::serviceRole:Manager"
66+
],
67+
"service_name": "secrets-manager",
68+
"notes": "Required for creating an Secrets Manager instance. 'Manager' access required to create new secret groups."
69+
},
70+
{
71+
"role_crns": [
72+
"crn:v1:bluemix:public:iam::::role:Administrator"
73+
],
74+
"service_name": "All Account Management services",
75+
"notes": "Administrator access is required for resource group creation and deletion."
76+
},
77+
{
78+
"role_crns": [
79+
"crn:v1:bluemix:public:iam::::role:Administrator"
80+
],
81+
"service_name": "All Identity and Access enabled services",
82+
"notes": "(Optional) Only required if creating context-based restrictions which can be toggled using the `provision_cbr` input."
5583
}
5684
],
5785
"dependencies": [
@@ -204,26 +232,27 @@
204232
},
205233
{
206234
"key": "enable_platform_metrics",
207-
"type": "string",
208-
"default_value": "true",
235+
"type": "boolean",
236+
"default_value": false,
209237
"description": "When set to `true`, the IBM Cloud Monitoring instance will be configured to collect platform metrics from the provided region. You can configure 1 instance only of the IBM Cloud Monitoring service per region to collect platform metrics in that location. Check with the account or service administrator if another monitoring instance has already been configured. You may not have permissions to see all monitoring instances in the region. [Learn more](https://cloud.ibm.com/docs/monitoring?topic=monitoring-platform_metrics_enabling).",
210238
"required": true,
211239
"virtual": true
212240
},
213241
{
214242
"key": "logs_routing_tenant_regions",
215-
"type": "list(string)",
243+
"type": "array",
216244
"default_value": "[]",
217245
"description": "To manage platform logs that are generated by IBM Cloud services in a region of IBM Cloud, you must create a tenant in each region that you operate. Pass a list of regions to create a tenant in. [Learn more](https://cloud.ibm.com/docs/logs-router?topic=logs-router-about-platform-logs).",
218246
"required": true,
219-
"virtual": true,
220247
"custom_config": {
248+
"type": "array",
221249
"grouping": "deployment",
222250
"original_grouping": "deployment",
223251
"config_constraints": {
224252
"type": "string"
225253
}
226-
}
254+
},
255+
"virtual": true
227256
},
228257
{
229258
"key": "resource_tags",

solutions/fully-configurable/variables.tf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ variable "existing_mq_capacity_crn" {
9090

9191
variable "deployment_name" {
9292
type = string
93-
description = "The name to be given to the MQ on Cloud deployment instance."
93+
description = "The name to be given to the MQ on Cloud deployment instance. If a prefix is specified, it will be prepended in the format `<prefix>-<deployment_name>`."
9494
default = "mqcloud"
9595
}
9696

0 commit comments

Comments
 (0)