ibm_catalog.json

{
  "products": [
    {
      "name": "deploy-arch-ibm-mq-cloud",
      "label": "Cloud automation for MQ on Cloud",
      "product_kind": "solution",
      "tags": [
        "ibm_created",
        "target_terraform",
        "terraform",
        "solution",
        "integration",
        "application_modernization",
        "platform_engineering",
        "enterprise_app"
      ],
      "keywords": [
        "MQ",
        "MQ on Cloud",
        "IaC",
        "infrastructure as code",
        "terraform",
        "solution",
        "application_modernization"
      ],
      "short_description": "Deploys MQ on Cloud instance with optional security, logging, and notification services",
      "long_description": "[IBM MQ on Cloud](https://cloud.ibm.com/docs/mqcloud/index.html) is an end-to-end solution for building and running secure queue managers. It connects applications dynamically, securely, and reliably across your messaging network, so your business can build message-driven and event-driven applications at scale.<br/>This deployable architecture creates an instance of IBM MQ on Cloud along 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. \n\nLeverage [Terraform IBM Modules](https://github.com/terraform-ibm-modules) to shape and scale your solutions. You can integrate Terraform IBM Modules (TIM) to extend functionality and design a solution tailored to your environment and operations needs. These modules offer reusable, customizable elements that follow IBM Cloud's recommended practices. You can access the [source code and documentation](https://github.com/terraform-ibm-modules/terraform-ibm-mq-cloud) and use it to extend your current architecture or create new solutions.",
      "offering_docs_url": "https://cloud.ibm.com/docs/ibm-cloud-provider-for-terraform?topic=ibm-cloud-provider-for-terraform-about-tim",
      "offering_icon_url": "https://raw.githubusercontent.com/terraform-ibm-modules/terraform-ibm-mq-cloud/main/images/MQ.svg",
      "provider_name": "IBM",
      "features": [
        {
          "title": "IBM MQ on Cloud instance",
          "description": "Get started with IBM MQ on Cloud by creating an instance. [Learn more](https://cloud.ibm.com/apidocs/mq-on-cloud)."
        },
        {
          "title": "Securely manage secrets",
          "description": "You can optionally deploy [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) to centrally manage TLS certificates that are required by IBM MQ on Cloud."
        },
        {
          "title": "Sets up logging for the IBM MQ on Cloud instance",
          "description": "Optionally, you can deploy Cloud automation for Cloud Logs to route, alert, and visualize platform logs that are generated by your IBM MQ on Cloud instance.[Learn more](https://cloud.ibm.com/docs/mqcloud?topic=mqcloud-logging)"
        },
        {
          "title": "Sets up monitoring operational metrics for the IBM MQ on Cloud instance",
          "description": "Optionally, you can deploy Cloud automation for Cloud Monitoring to measure how users and applications interact with your IBM MQ on Cloud instance. [Learn more](https://cloud.ibm.com/docs/mqcloud?topic=mqcloud-monitor_sysdig)"
        },
        {
          "title": "Sets up activity tracking for the IBM MQ on Cloud instance",
          "description": "Optionally, you can deploy Cloud automation for Activity Tracker Event Routing to route and securely store auditing events that are related to your IBM MQ on Cloud instance. [Learn more](https://cloud.ibm.com/docs/mqcloud?topic=mqcloud-at_events)"
        },
        {
          "title": "Composable and Extensible Architecture",
          "description": "This architecture illustrates how Terraform IBM Modules(TIM) can be integrated to deliver a complete solution on IBM Cloud. Each module is a reusable, and validated component for security, compliance, and operational IBM best practices. You can deploy this architecture as-is or configure it as code by leveraging the underlying modules to fit your specific requirements. Explore the [source code and documentation](https://github.com/terraform-ibm-modules/terraform-ibm-mq-cloud) to adapt, extend, or create entirely new solutions using these building blocks."
        }
      ],
      "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 [here](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.",
      "flavors": [
        {
          "label": "Fully configurable",
          "name": "fully-configurable",
          "short_description": "Ideal for users who want flexibility with a reliable starting point.",
          "index": 1,
          "install_type": "fullstack",
          "working_directory": "solutions/fully-configurable",
          "release_notes_url": "https://github.com/terraform-ibm-modules/terraform-ibm-mq-cloud/releases",
          "iam_permissions": [
            {
              "role_crns": [
                "crn:v1:bluemix:public:iam::::serviceRole:Manager",
                "crn:v1:bluemix:public:iam::::role:Editor"
              ],
              "service_name": "mqcloud",
              "notes": "Required to provision and manage IBM MQ on Cloud."
            },
            {
              "role_crns": [
                "crn:v1:bluemix:public:iam::::role:Administrator",
                "crn:v1:bluemix:public:iam::::serviceRole:Manager"
              ],
              "service_name": "secrets-manager",
              "notes": "[Optional] Required to create a Secrets Manager instance."
            },
            {
              "role_crns": [
                "crn:v1:bluemix:public:iam::::serviceRole:Manager",
                "crn:v1:bluemix:public:iam::::role:Editor"
              ],
              "service_name": "event-notifications",
              "notes": "[Optional] Required to create an Event Notifications instance."
            },
            {
              "role_crns": [
                "crn:v1:bluemix:public:iam::::serviceRole:Manager",
                "crn:v1:bluemix:public:iam::::role:Editor"
              ],
              "service_name": "sysdig-monitor",
              "notes": "[Optional] Required to create an instance of Cloud Monitoring."
            },
            {
              "role_crns": [
                "crn:v1:bluemix:public:iam::::serviceRole:Manager",
                "crn:v1:bluemix:public:iam::::role:Editor"
              ],
              "service_name": "logs",
              "notes": "[Optional] Required to create an instance of Cloud Logs."
            },
            {
              "role_crns": [
                "crn:v1:bluemix:public:iam::::serviceRole:Manager",
                "crn:v1:bluemix:public:iam::::role:Editor"
              ],
              "service_name": "hs-crypto",
              "notes": "[Optional] Required if IBM Hyper Protect Crypto Services is used for key encryption."
            },
            {
              "role_crns": [
                "crn:v1:bluemix:public:iam::::serviceRole:Manager",
                "crn:v1:bluemix:public:iam::::role:Editor"
              ],
              "service_name": "kms",
              "notes": "[Optional] Required if Key Protect is used for key encryption."
            },
            {
              "role_crns": [
                "crn:v1:bluemix:public:iam::::serviceRole:Writer",
                "crn:v1:bluemix:public:iam::::role:Editor"
              ],
              "service_name": "atracker",
              "notes": "[Optional] Required when enabling the Activity Tracker Event Routing."
            },
            {
              "role_crns": [
                "crn:v1:bluemix:public:iam::::role:Administrator"
              ],
              "service_name": "All Identity and Access enabled services",
              "notes": "[Optional] Required to to create trusted profile for App Configuration aggregator which is used for compliance scanning."
            },
            {
              "role_crns": [
                "crn:v1:bluemix:public:iam::::role:Viewer"
              ],
              "service_name": "Resource group only",
              "notes": "Viewer access is required in the resource group you want to provision in."
            },
            {
              "role_crns": [
                "crn:v1:bluemix:public:iam::::serviceRole:Manager",
                "crn:v1:bluemix:public:iam::::role:Editor"
              ],
              "service_name": "cloud-object-storage",
              "notes": "[Optional] Required to create an Object Storage instance."
            },
            {
              "service_name": "sysdig-secure",
              "role_crns": [
                "crn:v1:bluemix:public:iam::::serviceRole:Manager",
                "crn:v1:bluemix:public:iam::::role:Editor"
              ],
              "notes": "[Optional] Required to create and manage an SCC Workload Protection instance."
            },
            {
              "role_crns": [
                "crn:v1:bluemix:public:iam::::role:Administrator",
                "crn:v1:bluemix:public:iam::::serviceRole:Manager"
              ],
              "service_name": "apprapp",
              "notes": "[Optional] Required for provisioning the App Configuration instance."
            }
          ],
          "dependencies": [
            {
              "name": "deploy-arch-ibm-secrets-manager",
              "description": "Configure Secrets Manager to centrally manage TLS certificates.",
              "id": "6d6ebc76-7bbd-42f5-8bc7-78f4fabd5944-global",
              "flavors": [
                "fully-configurable"
              ],
              "catalog_id": "7a4d68b4-cf8b-40cd-a3d1-f49aff526eb3",
              "version": "v2.13.3",
              "optional": true,
              "on_by_default": true,
              "default_flavor": "fully-configurable",
              "input_mapping": [
                {
                  "reference_version": true,
                  "dependency_input": "prefix",
                  "version_input": "prefix"
                },
                {
                  "dependency_input": "service_plan",
                  "version_input": "secrets_manager_service_plan",
                  "reference_version": true
                },
                {
                  "dependency_input": "region",
                  "version_input": "region",
                  "reference_version": true
                },
                {
                  "dependency_input": "secrets_manager_endpoint_type",
                  "version_input": "secrets_manager_endpoint_type",
                  "reference_version": true
                },
                {
                  "dependency_output": "secrets_manager_crn",
                  "version_input": "existing_secrets_manager_instance_crn"
                },
                {
                  "dependency_input": "existing_resource_group_name",
                  "version_input": "existing_resource_group_name",
                  "reference_version": true
                }
              ]
            },
            {
              "name": "deploy-arch-ibm-cloud-logs",
              "description": "Configure an IBM Cloud Logs instance to analyze platform logs.",
              "flavors": [
                "fully-configurable"
              ],
              "id": "63d8ae58-fbf3-41ce-b844-0fb5b85882ab-global",
              "catalog_id": "7a4d68b4-cf8b-40cd-a3d1-f49aff526eb3",
              "input_mapping": [
                {
                  "dependency_input": "prefix",
                  "version_input": "prefix",
                  "reference_version": true
                },
                {
                  "dependency_input": "region",
                  "version_input": "region",
                  "reference_version": true
                },
                {
                  "dependency_input": "logs_routing_tenant_regions",
                  "version_input": "logs_routing_tenant_regions",
                  "reference_version": true
                },
                {
                  "dependency_input": "existing_resource_group_name",
                  "version_input": "existing_resource_group_name",
                  "reference_version": true
                }
              ],
              "optional": true,
              "on_by_default": true,
              "version": "v1.11.3"
            },
            {
              "name": "deploy-arch-ibm-cloud-monitoring",
              "description": "Configure IBM Cloud Monitoring to collect platform metrics.",
              "flavors": [
                "fully-configurable"
              ],
              "id": "73debdbf-894f-4c14-81c7-5ece3a70b67d-global",
              "catalog_id": "7a4d68b4-cf8b-40cd-a3d1-f49aff526eb3",
              "input_mapping": [
                {
                  "dependency_input": "prefix",
                  "version_input": "prefix",
                  "reference_version": true
                },
                {
                  "dependency_input": "region",
                  "version_input": "region",
                  "reference_version": true
                },
                {
                  "dependency_input": "enable_platform_metrics",
                  "version_input": "enable_platform_metrics",
                  "reference_version": true
                },
                {
                  "dependency_input": "existing_resource_group_name",
                  "version_input": "existing_resource_group_name",
                  "reference_version": true
                }
              ],
              "optional": true,
              "on_by_default": true,
              "version": "v1.13.3"
            },
            {
              "name": "deploy-arch-ibm-activity-tracker",
              "description": "Configure Activity Tracker Event Routing to route auditing events.",
              "flavors": [
                "fully-configurable"
              ],
              "id": "918453c3-4f97-4583-8c4a-83ef12fc7916-global",
              "catalog_id": "7a4d68b4-cf8b-40cd-a3d1-f49aff526eb3",
              "input_mapping": [
                {
                  "dependency_input": "prefix",
                  "version_input": "prefix",
                  "reference_version": true
                },
                {
                  "dependency_input": "region",
                  "version_input": "region",
                  "reference_version": true
                },
                {
                  "dependency_input": "existing_resource_group_name",
                  "version_input": "existing_resource_group_name",
                  "reference_version": true
                }
              ],
              "optional": true,
              "on_by_default": true,
              "version": "v1.6.13"
            },
            {
              "name": "deploy-arch-ibm-scc-workload-protection",
              "description": "Configure an IBM Cloud Security and Compliance Center Workload Protection instance to help you manage security and compliance for your organization.",
              "id": "4322cf44-2289-49aa-a719-dd79e39b14dc-global",
              "version": "v1.17.4",
              "flavors": [
                "fully-configurable"
              ],
              "catalog_id": "7a4d68b4-cf8b-40cd-a3d1-f49aff526eb3",
              "optional": true,
              "on_by_default": true,
              "input_mapping": [
                {
                  "dependency_input": "prefix",
                  "version_input": "prefix",
                  "reference_version": true
                },
                {
                  "dependency_input": "region",
                  "version_input": "region",
                  "reference_version": true
                },
                {
                  "dependency_input": "existing_resource_group_name",
                  "version_input": "existing_resource_group_name",
                  "reference_version": true
                }
              ]
            }
          ],
          "dependency_version_2": true,
          "configuration": [
            {
              "key": "ibmcloud_api_key"
            },
            {
              "key": "provider_visibility",
              "hidden": true,
              "options": [
                {
                  "displayname": "Private",
                  "value": "private"
                },
                {
                  "displayname": "Public",
                  "value": "public"
                },
                {
                  "displayname": "Public-and-Private",
                  "value": "public-and-private"
                }
              ]
            },
            {
              "key": "existing_resource_group_name",
              "display_name": "resource_group",
              "custom_config": {
                "type": "resource_group",
                "grouping": "deployment",
                "original_grouping": "deployment",
                "config_constraints": {
                  "identifier": "rg_name"
                }
              }
            },
            {
              "key": "region",
              "required": true,
              "options": [
                {
                  "displayname": "Washington (us-east)",
                  "value": "us-east"
                },
                {
                  "displayname": "London (eu-gb)",
                  "value": "eu-gb"
                }
              ]
            },
            {
              "key": "prefix",
              "required": true,
              "default_value": "dev",
              "random_string": {
                "length": 4
              },
              "value_constraints": [
                {
                  "type": "regex",
                  "description": "Prefix must begin with a lowercase letter and may contain only lowercase letters, digits, and hyphens '-'. It must not end with a hyphen('-'), and cannot contain consecutive hyphens ('--'). It should not exceed 16 characters.",
                  "value": "^$|^__NULL__$|^[a-z](?!.*--)(?:[a-z0-9-]{0,14}[a-z0-9])?$"
                }
              ]
            },
            {
              "key": "enable_platform_metrics",
              "type": "boolean",
              "default_value": false,
              "description": "When set to `true`, the IBM Cloud Monitoring instance is configured to collect platform metrics from the specified region. You can configure only one instance 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 is already configured. You might not have permissions to see all monitoring instances in the region. [Learn more](https://cloud.ibm.com/docs/monitoring?topic=monitoring-platform_metrics_enabling).",
              "required": true,
              "virtual": true,
              "options": [
                {
                  "displayname": "true",
                  "value": true
                },
                {
                  "displayname": "false",
                  "value": false
                }
              ]
            },
            {
              "key": "logs_routing_tenant_regions",
              "type": "array",
              "default_value": [],
              "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).",
              "required": true,
              "custom_config": {
                "type": "array",
                "grouping": "deployment",
                "original_grouping": "deployment",
                "config_constraints": {
                  "type": "string"
                }
              },
              "virtual": true
            },
            {
              "key": "resource_tags",
              "custom_config": {
                "grouping": "deployment",
                "original_grouping": "deployment",
                "config_constraints": {
                  "type": "string"
                }
              }
            },
            {
              "key": "existing_mq_capacity_crn",
              "required": true,
              "value_constraints": [
                {
                  "type": "regex",
                  "description": "The value provided for 'existing_mq_capacity_crn' is not valid.",
                  "value": "^__NULL__$|^crn:v\\d:(.*:){2}(mqcloud):(.*:)([aos]\\/[\\w_\\-]+):[0-9a-fA-F]{8}(?:-[0-9a-fA-F]{4}){3}-[0-9a-fA-F]{12}::$"
                }
              ]
            },
            {
              "key": "secrets_manager_service_plan",
              "required": true,
              "virtual": true,
              "type": "string",
              "options": [
                {
                  "displayname": "Standard",
                  "value": "standard"
                },
                {
                  "displayname": "Trial",
                  "value": "trial"
                }
              ],
              "default_value": "__NOT_SET__",
              "description": "The pricing plan to use to provision a Secrets Manager instance. Possible values are `standard` or `trial`. You can create only one Trial instance of Secrets Manager per account. Before you can create a Trial instance, you must delete the existing Trial instance and its reclamation. [Learn more](https://cloud.ibm.com/docs/secrets-manager?topic=secrets-manager-create-instance&interface=ui#upgrade-instance-standard)."
            },
            {
              "key": "deployment_name"
            },
            {
              "key": "existing_mq_deployment_crn",
              "value_constraints": [
                {
                  "type": "regex",
                  "description": "The value provided for 'existing_mq_deployment_crn' is not valid.",
                  "value": "^__NULL__$|^crn:v\\d:(.*:){2}(mqcloud):(.*:)([aos]\\/[\\w_\\-]+):[0-9a-fA-F]{8}(?:-[0-9a-fA-F]{4}){3}-[0-9a-fA-F]{12}::$"
                }
              ]
            },
            {
              "key": "queue_manager_name",
              "required": true,
              "value_constraints": [
                {
                  "type": "regex",
                  "description": "The value provided for ‘queue_manager_name’ must contain only alphanumeric characters and underscores (_), matching the pattern ^([\\w_]+)\\w$",
                  "value": "^__NULL__$|^([\\w_]+)\\w$"
                }
              ]
            },
            {
              "key": "queue_manager_display_name"
            },
            {
              "key": "queue_manager_size",
              "options": [
                {
                  "displayname": "xsmall",
                  "value": "xsmall"
                },
                {
                  "displayname": "small",
                  "value": "small"
                },
                {
                  "displayname": "medium",
                  "value": "medium"
                },
                {
                  "displayname": "large",
                  "value": "large"
                }
              ]
            },
            {
              "key": "existing_queue_manager_name"
            },
            {
              "key": "application_name"
            },
            {
              "key": "existing_application_name"
            },
            {
              "key": "user_name"
            },
            {
              "key": "user_email"
            },
            {
              "key": "existing_secrets_manager_instance_crn",
              "display_name": "existing_secrets_manager_instance",
              "value_constraints": [
                {
                  "type": "regex",
                  "description": "The value provided for 'existing_secrets_manager_instance_crn' is not valid.",
                  "value": "^__NULL__$|^crn:v\\d:(.*:){2}secrets-manager:(.*:)([aos]\\/[\\w_\\-]+):[0-9a-fA-F]{8}(?:-[0-9a-fA-F]{4}){3}-[0-9a-fA-F]{12}::$"
                }
              ],
              "custom_config": {
                "type": "platform_resource",
                "grouping": "deployment",
                "original_grouping": "deployment",
                "config_constraints": {
                  "resourceType": "secrets-manager",
                  "selection": "single_select",
                  "valueType": "crn"
                }
              }
            },
            {
              "key": "secrets_manager_ibmcloud_api_key"
            },
            {
              "key": "secrets_manager_endpoint_type",
              "hidden": true,
              "options": [
                {
                  "displayname": "Public",
                  "value": "public"
                },
                {
                  "displayname": "Private",
                  "value": "private"
                }
              ]
            },
            {
              "key": "existing_secret_group_id"
            },
            {
              "key": "secret_group_name"
            }
          ],
          "architecture": {
            "features": [
              {
                "title": " ",
                "description": "Configured to use IBM secure-by-default standards, but you can edit it to fit your use case."
              }
            ],
            "diagrams": [
              {
                "diagram": {
                  "caption": "IBM MQ on Cloud",
                  "url": "https://raw.githubusercontent.com/terraform-ibm-modules/terraform-ibm-mq-cloud/main/reference-architectures/deployable-architecture-mqcloud.svg",
                  "type": "image/svg+xml"
                },
                "description": "This deployable architecture creates an instance of <b>IBM MQ on Cloud</b>, providing a secure, scalable, and fully managed messaging service for applications. After you deploy this solution, you can access the IBM MQ on Cloud dashboard to create and configure queue managers, manage message queues, and integrate them into your applications by using industry-standard messaging protocols.<br><br>Optionally, you can deploy Secrets Manager to securely store and manage TLS certificates and other sensitive credentials that IBM MQ on Cloud requires. By doing so, you help ensure secure connectivity and compliance.<br><br>You can also enable observability services such as Cloud Monitoring, Cloud Logs, and Activity Tracker Event Routing to gain operational visibility into your IBM MQ on Cloud workloads. These capabilities allow you to collect and analyze metrics such as CPU and memory usage, track user and application interactions, and monitor platform logs for troubleshooting and audit purposes."
              }
            ]
          },
          "terraform_version": "1.12.2",
          "ignore_readme": true
        }
      ]
    }
  ]
}