fix: Implement standard solution in preparation for deployable architecture. This is an incubating module and hence no clean upgrade path supported from the previous version (#49)

Author: shemau

.catalog-onboard-pipeline.yaml

@@ -0,0 +1,14 @@
+---
+apiVersion: v1
+offerings:
+  - name: deploy-arch-ibm-mq-cloud
+    kind: solution
+    catalog_id: 7df1e4ca-d54c-4fd0-82ce-3d13247308cd
+    offering_id: 30a698d4-ab56-4668-bc01-03cd2135d7e4
+    variations:
+      - name: standard
+        mark_ready: true
+        install_type: fullstack
+        scc:
+          instance_id: 1c7d5f78-9262-44c3-b779-b28fe4d88c37
+          region: us-south

.github/settings.yml

@@ -25,4 +25,4 @@ repository:
   description: "Provisions and configures IBM Cloud MQ on Cloud."
 
   # Use a comma-separated list of topics to set on the repo (ensure not to use any caps in the topic string).
-  topics: terraform, ibm-cloud, terraform-module, mq, core-team, supported
+  topics: terraform, ibm-cloud, terraform-module, mq, core-team, supported, deployable-architecture

.releaserc

@@ -10,6 +10,9 @@
     }],
     ["@semantic-release/exec", {
       "successCmd": "echo \"SEMVER_VERSION=${nextRelease.version}\" >> $GITHUB_ENV"
+    }],
+    ["@semantic-release/exec",{
+      "publishCmd": "./ci/trigger-catalog-onboarding-pipeline.sh --version=v${nextRelease.version}"
     }]
   ]
 }

README.md

@@ -45,7 +45,6 @@ are incomplete, may not be in final form and may generate unpredicatable failure
 * [Examples](./examples)
     * [Advanced example](./examples/advanced)
     * [Basic example](./examples/basic)
-    * [Demo example](./examples/demo)
 * [Contributing](#contributing)
 <!-- END OVERVIEW HOOK -->
 
@@ -79,7 +78,7 @@ module "mq_on_cloud" {
 
   name   = "${var.prefix}-mq-instance"
   region = "us-east"
-  existing_mq_capacity_guid = "11111111-1111-1111-1111-111111111111"
+  existing_mq_capacity_crn = "crn:<...>" # MQ on Cloud capacity instance crn
 
   queue_manager_display_name = "queue-manager"
   queue_manager_name         = "qm"
@@ -171,7 +170,7 @@ No resources.
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:--------:|
 | <a name="input_applications"></a> [applications](#input\_applications) | A map of IBM MQ on Cloud applications to be created. | <pre>map(object({<br>    name = string<br>  }))</pre> | `{}` | no |
-| <a name="input_existing_mq_capacity_guid"></a> [existing\_mq\_capacity\_guid](#input\_existing\_mq\_capacity\_guid) | The GUID of an existing capacity service instance, if not specifed, a new capacity plan will be created | `string` | `null` | no |
+| <a name="input_existing_mq_capacity_crn"></a> [existing\_mq\_capacity\_crn](#input\_existing\_mq\_capacity\_crn) | The CRN of an existing capacity service instance, if not specifed, a new capacity plan will be created | `string` | `null` | no |
 | <a name="input_keystore_certificates"></a> [keystore\_certificates](#input\_keystore\_certificates) | A map of IBM MQ on Cloud keystore certificates to be created. | <pre>map(object({<br>    certificate = string<br>    label       = string<br>  }))</pre> | `{}` | no |
 | <a name="input_name"></a> [name](#input\_name) | The name to give the MQ on Cloud instance. | `string` | n/a | yes |
 | <a name="input_queue_manager_display_name"></a> [queue\_manager\_display\_name](#input\_queue\_manager\_display\_name) | A displayable name for the queue manager. | `string` | n/a | yes |
@@ -189,10 +188,12 @@ No resources.
 
 | Name | Description |
 |------|-------------|
-| <a name="output_queue_manager_id"></a> [queue\_manager\_id](#output\_queue\_manager\_id) | Description of my output |
-| <a name="output_queue_manager_options"></a> [queue\_manager\_options](#output\_queue\_manager\_options) | Queue manager options for the MQ on Cloud deployment |
-| <a name="output_service_instance_capacity_guid"></a> [service\_instance\_capacity\_guid](#output\_service\_instance\_capacity\_guid) | Description of my output |
-| <a name="output_service_instance_deployment_guid"></a> [service\_instance\_deployment\_guid](#output\_service\_instance\_deployment\_guid) | Description of my output |
+| <a name="output_queue_manager_id"></a> [queue\_manager\_id](#output\_queue\_manager\_id) | The ID of the MQ on Cloud queue manager |
+| <a name="output_queue_manager_options"></a> [queue\_manager\_options](#output\_queue\_manager\_options) | Queue manager options for the MQ on Cloud deployment service instance |
+| <a name="output_service_instance_capacity_crn"></a> [service\_instance\_capacity\_crn](#output\_service\_instance\_capacity\_crn) | The CRN of the MQ on Cloud capacity service instance |
+| <a name="output_service_instance_capacity_guid"></a> [service\_instance\_capacity\_guid](#output\_service\_instance\_capacity\_guid) | The GUID of the MQ on Cloud capacity service instance |
+| <a name="output_service_instance_deployment_crn"></a> [service\_instance\_deployment\_crn](#output\_service\_instance\_deployment\_crn) | The CRN of the MQ on Cloud deployment service instance |
+| <a name="output_service_instance_deployment_guid"></a> [service\_instance\_deployment\_guid](#output\_service\_instance\_deployment\_guid) | The GUID of the MQ on Cloud deployment service instance |
 <!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
 
 <!-- Leave this section as is so that your module has a link to local development environment set-up steps for contributors to follow -->

cra-config.yaml

@@ -7,4 +7,4 @@ CRA_TARGETS:
     # SCC_INSTANCE_ID: "" # The SCC instance ID to use to download profile for CRA scan. If not provided, a default global value will be used.
     # SCC_REGION: "" # The IBM Cloud region that the SCC instance is in. If not provided, a default global value will be used.
     CRA_ENVIRONMENT_VARIABLES:  # An optional map of environment variables for CRA, where the key is the variable name and value is the value. Useful for providing TF_VARs.
-      TF_VAR_existing_mq_capacity_guid:  "9d9a3c00-2097-4da4-a5e4-78e06514b342"
+      TF_VAR_existing_mq_capacity_crn:  "crn:v1:bluemix:public:mqcloud:us-east:a/abac0df06b644a9cabc6e44f55b3880e:9d9a3c00-2097-4da4-a5e4-78e06514b342::"

examples/advanced/main.tf

@@ -24,10 +24,10 @@ module "mq_on_cloud" {
   source            = "../.."
   resource_group_id = module.resource_group.resource_group_id
 
-  name                      = "${var.prefix}-mq-instance"
-  region                    = var.region
-  tags                      = var.resource_tags
-  existing_mq_capacity_guid = var.existing_mq_capacity_guid
+  name                     = "${var.prefix}-mq-instance"
+  region                   = var.region
+  tags                     = var.resource_tags
+  existing_mq_capacity_crn = var.existing_mq_capacity_crn
 
   queue_manager_display_name = "${var.prefix}-qm-display"
   queue_manager_name         = "${local.prefix}_qm"
@@ -51,32 +51,32 @@ module "mq_on_cloud" {
 }
 
 module "application" {
-  service_instance_guid = module.mq_on_cloud.service_instance_deployment_guid
-  source                = "../../modules/application"
-  name                  = "app-ext"
+  service_instance_crn = module.mq_on_cloud.service_instance_deployment_crn
+  source               = "../../modules/application"
+  name                 = "app-ext"
 }
 
 module "user" {
-  service_instance_guid = module.mq_on_cloud.service_instance_deployment_guid
-  source                = "../../modules/user"
-  name                  = "another-user"
-  email                 = "another@example.com"
+  service_instance_crn = module.mq_on_cloud.service_instance_deployment_crn
+  source               = "../../modules/user"
+  name                 = "another-user"
+  email                = "another@example.com"
 }
 
 module "keystore" {
-  count                 = var.keystore_certificate == null ? 0 : 1
-  service_instance_guid = module.mq_on_cloud.service_instance_deployment_guid
-  queue_manager_id      = module.mq_on_cloud.queue_manager_id
-  source                = "../../modules/keystore-certificate"
-  certificate           = var.keystore_certificate
-  label                 = "ks_extension"
+  count                = var.keystore_certificate == null ? 0 : 1
+  service_instance_crn = module.mq_on_cloud.service_instance_deployment_crn
+  queue_manager_id     = module.mq_on_cloud.queue_manager_id
+  source               = "../../modules/keystore-certificate"
+  certificate          = var.keystore_certificate
+  label                = "ks_extension"
 }
 
 module "truststore" {
-  count                 = var.truststore_certificate == null ? 0 : 1
-  service_instance_guid = module.mq_on_cloud.service_instance_deployment_guid
-  queue_manager_id      = module.mq_on_cloud.queue_manager_id
-  source                = "../../modules/truststore-certificate"
-  certificate           = var.truststore_certificate
-  label                 = "ts_extension"
+  count                = var.truststore_certificate == null ? 0 : 1
+  service_instance_crn = module.mq_on_cloud.service_instance_deployment_crn
+  queue_manager_id     = module.mq_on_cloud.queue_manager_id
+  source               = "../../modules/truststore-certificate"
+  certificate          = var.truststore_certificate
+  label                = "ts_extension"
 }

examples/advanced/variables.tf

@@ -32,9 +32,9 @@ variable "resource_tags" {
   default     = []
 }
 
-variable "existing_mq_capacity_guid" {
+variable "existing_mq_capacity_crn" {
   type        = string
-  description = "The GUID of an existing capacity service instance, if not specifed, a new capacity plan will be created"
+  description = "The CRN of an existing capacity service instance, if not specifed, a new capacity plan will be created"
 }
 
 variable "keystore_certificate" {

examples/basic/main.tf

@@ -24,10 +24,10 @@ module "mq_on_cloud" {
   source            = "../.."
   resource_group_id = module.resource_group.resource_group_id
 
-  name                      = "${var.prefix}-mq-instance"
-  region                    = var.region
-  tags                      = var.resource_tags
-  existing_mq_capacity_guid = var.existing_mq_capacity_guid
+  name                     = "${var.prefix}-mq-instance"
+  region                   = var.region
+  tags                     = var.resource_tags
+  existing_mq_capacity_crn = var.existing_mq_capacity_crn
 
   queue_manager_display_name = "${var.prefix}-qm-display"
   queue_manager_name         = "${local.prefix}_qm"

examples/basic/variables.tf

@@ -32,9 +32,9 @@ variable "resource_tags" {
   default     = []
 }
 
-variable "existing_mq_capacity_guid" {
+variable "existing_mq_capacity_crn" {
   type        = string
-  description = "The GUID of an existing capacity service instance, if not specifed, a new capacity plan will be created"
+  description = "The CRN of an existing capacity service instance, if not specifed, a new capacity plan will be created"
 }
 
 variable "keystore_certificate" {