feat: Graduated the module to Stable<br>- added support for bx2.1x4 node type.<br>- added validation to the region input.<br>- The Standard DA variation has been deprecated in favour of a new Fully configurable variation. (#37)

BREAKING CHANGE: There is no upgrade path from the `Standard` DA variation to the new `Fully configurable` variation

Author: MatthewLemmond

.catalog-onboard-pipeline.yaml

@@ -6,9 +6,10 @@ offerings:
     catalog_id: 7df1e4ca-d54c-4fd0-82ce-3d13247308cd
     offering_id: 90a14f92-4b86-4b27-acc1-dd6eefe0bfe9
     variations:
-      - name: standard
+      - name: fully-configurable
         mark_ready: true
         install_type: fullstack
         scc:
           instance_id: 1c7d5f78-9262-44c3-b779-b28fe4d88c37
           region: us-south
+          scope_resource_group_var_name: existing_resource_group_name

README.md

@@ -6,7 +6,7 @@ Update status and "latest release" badges:
   1. For the status options, see https://terraform-ibm-modules.github.io/documentation/#/badge-status
   2. Update the "latest release" badge to point to the correct module's repo. Replace "terraform-ibm-module-template" in two places.
 -->
-[![Incubating (Not yet consumable)](https://img.shields.io/badge/status-Incubating%20(Not%20yet%20consumable)-red)](https://terraform-ibm-modules.github.io/documentation/#/badge-status)
+[![Stable (With quality checks)](https://img.shields.io/badge/Status-Stable%20(With%20quality%20checks)-green)](https://terraform-ibm-modules.github.io/documentation/#/badge-status)
 [![latest release](https://img.shields.io/github/v/release/terraform-ibm-modules/terraform-ibm-db2-cloud?logo=GitHub&sort=semver)](https://github.com/terraform-ibm-modules/terraform-ibm-db2-cloud/releases/latest)
 [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)
 [![Renovate enabled](https://img.shields.io/badge/renovate-enabled-brightgreen.svg)](https://renovatebot.com/)
@@ -39,8 +39,8 @@ If this repo contains any reference architectures, uncomment the heading below a
 See "Reference architecture" in the public documentation at
 https://terraform-ibm-modules.github.io/documentation/#/implementation-guidelines?id=reference-architecture
 -->
-<!-- ## Reference architectures -->
-
+## Reference architectures
+![db2-cloud](https://raw.githubusercontent.com/terraform-ibm-modules/terraform-ibm-db2-cloud/000066a70c717a4e443d8508ca723b73c0c5361f/reference-architectures/deployable-architecture-db2cloud.svg)
 
 <!-- Replace this heading with the name of the root level module (the repo name) -->
 ## terraform-ibm-db2-cloud
@@ -55,7 +55,17 @@ unless real values don't help users know what to change.
 -->
 
 ```hcl
-
+module "db2" {
+  source                      = "terraform-ibm-modules/db2-cloud/ibm"
+  version                     = "X.Y.Z" # Replace "X.Y.Z" with a release version to lock into a specific release
+  db2_instance_name           = "my-db2-instance"
+  resource_group_id           = "asdf1234"
+  service_endpoints           = "public-and-private"
+  enable_high_availability    = true
+  enable_oracle_compatibility = false
+  node_type                   = "bx2.4x16"
+  tags                        = ["tag1", "tag2"]
+}
 ```
 
 ### Required access policies
@@ -71,24 +81,12 @@ console at Manage > Access (IAM) > Access groups and click into an existing grou
 (or create a new one) and in the 'Access' tab click 'Assign access'.
 -->
 
-<!--
 You need the following permissions to run this module:
 
 - Service
-    - **Resource group only**
-        - `Viewer` access on the specific resource group
-    - **Sample IBM Cloud** service
+    - **dashdb-for-transactions** service
         - `Editor` platform access
         - `Manager` service access
--->
-
-<!-- NO PERMISSIONS FOR MODULE
-If no permissions are required for the module, uncomment the following
-statement instead the previous block.
--->
-
-<!-- No permissions are needed to run this module.-->
-
 
 <!-- The following content is automatically populated by the pre-commit hook -->
 <!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
@@ -97,7 +95,7 @@ statement instead the previous block.
 | Name | Version |
 |------|---------|
 | <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.3.0 |
-| <a name="requirement_ibm"></a> [ibm](#requirement\_ibm) | >= 1.72.1, < 2.0.0 |
+| <a name="requirement_ibm"></a> [ibm](#requirement\_ibm) | >= 1.73.0, < 2.0.0 |
 
 ### Modules
 
@@ -108,7 +106,6 @@ No modules.
 | Name | Type |
 |------|------|
 | [ibm_db2.db2](https://registry.terraform.io/providers/IBM-Cloud/ibm/latest/docs/resources/db2) | resource |
-| [ibm_resource_tag.tags](https://registry.terraform.io/providers/IBM-Cloud/ibm/latest/docs/resources/resource_tag) | resource |
 
 ### Inputs
 
@@ -117,7 +114,7 @@ No modules.
 | <a name="input_db2_instance_name"></a> [db2\_instance\_name](#input\_db2\_instance\_name) | Name to give to the DB2 instance being provisioned | `string` | n/a | yes |
 | <a name="input_enable_high_availability"></a> [enable\_high\_availability](#input\_enable\_high\_availability) | Whether to enable high availability on the DB2 instance | `bool` | `false` | no |
 | <a name="input_enable_oracle_compatibility"></a> [enable\_oracle\_compatibility](#input\_enable\_oracle\_compatibility) | Whether to enable Oracle compatibility on the DB2 instance | `bool` | `false` | no |
-| <a name="input_node_type"></a> [node\_type](#input\_node\_type) | The node type of the DB2 instance, supported values are `bx2.4x16`, `bx2.8x32`, `bx2.16x64`, `bx2.32.128`, `bx2.48x192`, `mx2.4x32`, `mx2.16x128`, or `mx2.128x1024` | `string` | `"bx2.4x16"` | no |
+| <a name="input_node_type"></a> [node\_type](#input\_node\_type) | The node type of the DB2 instance, supported values are `bx2.1x4`, `bx2.4x16`, `bx2.8x32`, `bx2.16x64`, `bx2.32.128`, `bx2.48x192`, `mx2.4x32`, `mx2.16x128`, or `mx2.128x1024` | `string` | `"bx2.4x16"` | no |
 | <a name="input_region"></a> [region](#input\_region) | Region to provision the DB2 instance | `string` | `"us-south"` | no |
 | <a name="input_resource_group_id"></a> [resource\_group\_id](#input\_resource\_group\_id) | ID of resource group to provision DB2 instance in | `string` | n/a | yes |
 | <a name="input_service_endpoints"></a> [service\_endpoints](#input\_service\_endpoints) | Service endpoints for the DB2 instance, valid values are `public`, `private`, or `public-and-private` | `string` | `"public"` | no |

cra-config.yaml

@@ -1,10 +1,11 @@
 # More info about this file at https://github.com/terraform-ibm-modules/common-pipeline-assets/blob/main/.github/workflows/terraform-test-pipeline.md#cra-config-yaml
 version: "v1"
 CRA_TARGETS:
-  - CRA_TARGET: "solutions/standard" # Target directory for CRA scan. If not provided, the CRA Scan will not be run.
+  - CRA_TARGET: "solutions/fully-configurable" # Target directory for CRA scan. If not provided, the CRA Scan will not be run.
     CRA_IGNORE_RULES_FILE: "cra-tf-validate-ignore-rules.json" # CRA Ignore file to use. If not provided, it checks the repo root directory for `cra-tf-validate-ignore-rules.json`
     PROFILE_ID: "fe96bd4d-9b37-40f2-b39f-a62760e326a3"         # SCC profile ID (currently set to 'IBM Cloud Framework for Financial Services' '1.7.0' profile).
     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_prefix: "prefix"
       TF_VAR_db2_instance_name: "db2-da"
-      TF_VAR_resource_group_name: "db2-rg"
+      TF_VAR_existing_resource_group_name: "geretain-test-resources"
       TF_VAR_provider_visibility: "public"

examples/advanced/main.tf

@@ -21,6 +21,6 @@ module "db2_instance" {
   service_endpoints           = var.service_endpoints
   enable_high_availability    = true
   enable_oracle_compatibility = var.oracle_compatibility
-  node_type                   = "nil"
+  node_type                   = "bx2.1x4"
   tags                        = var.resource_tags
 }

examples/advanced/variables.tf

@@ -17,7 +17,7 @@ variable "region" {
 variable "prefix" {
   type        = string
   description = "Prefix to append to all resources created by this example"
-  default     = "basic"
+  default     = "advanced"
 }
 
 variable "resource_group" {

examples/basic/main.tf

@@ -21,6 +21,6 @@ module "db2_instance" {
   service_endpoints           = "public-and-private"
   enable_high_availability    = false
   enable_oracle_compatibility = false
-  node_type                   = "nil"
+  node_type                   = "bx2.1x4"
   tags                        = var.resource_tags
 }

examples/basic/version.tf

@@ -6,7 +6,7 @@ terraform {
   required_providers {
     ibm = {
       source  = "IBM-Cloud/ibm"
-      version = "1.72.1"
+      version = "1.73.0"
     }
   }
 }

ibm_catalog.json

@@ -21,7 +21,7 @@
         ],
         "short_description": "Creates and configures IBM Cloud DB2 on Cloud resources",
         "long_description": "This architecture supports creating and configuring an IBM DB2 on Cloud service instance.",
-        "offering_docs_url": "https://github.com/terraform-ibm-modules/terraform-ibm-db2-cloud/blob/main/solutions/standard/README.md",
+        "offering_docs_url": "https://github.com/terraform-ibm-modules/terraform-ibm-db2-cloud/blob/main/solutions/fully-configurable/README.md",
         "offering_icon_url": "https://raw.githubusercontent.com/terraform-ibm-modules/terraform-ibm-db2-cloud/main/images/DB2.svg",
         "provider_name": "IBM",
         "features": [
@@ -33,10 +33,10 @@
         "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-db2-cloud/issues](https://github.com/terraform-ibm-modules/terraform-ibm-db2-cloud/issues). Please note this product is not supported via the IBM Cloud Support Center.",
         "flavors": [
           {
-            "label": "Standard",
-            "name": "standard",
+            "label": "Fully configurable",
+            "name": "fully-configurable",
             "install_type": "fullstack",
-            "working_directory": "solutions/standard",
+            "working_directory": "solutions/fully-configurable",
             "iam_permissions": [
               {
                 "role_crns": [
@@ -69,17 +69,58 @@
                 ]
               },
               {
-                "key": "resource_group_name",
-                "required": true
-              },
-              {
-                "key": "use_existing_resource_group",
-                "required": true
+                "key": "existing_resource_group_name",
+                "required": true,
+                "custom_config": {
+                  "type": "resource_group",
+                  "grouping": "deployment",
+                  "original_grouping": "deployment",
+                  "config_constraints": {
+                    "identifier": "rg_name"
+                  }
+                }
               },
               {
                 "key": "region",
                 "required": true,
-                "default_value": "us-east"
+                "options": [
+                  {
+                    "displayname": "Sydney (au-syd)",
+                    "value": "au-syd"
+                  },
+                  {
+                    "displayname": "Tokyo (jp-tok)",
+                    "value": "jp-tok"
+                  },
+                  {
+                    "displayname": "Frankfurt (eu-de)",
+                    "value": "eu-de"
+                  },
+                  {
+                    "displayname": "London (eu-gb)",
+                    "value": "eu-gb"
+                  },
+                  {
+                    "displayname": "Madrid (eu-es)",
+                    "value": "eu-es"
+                  },
+                  {
+                    "displayname": "Dallas (us-south)",
+                    "value": "us-south"
+                  },
+                  {
+                    "displayname": "Toronto (ca-tor)",
+                    "value": "ca-tor"
+                  },
+                  {
+                    "displayname": "Washington DC (us-east)",
+                    "value": "us-east"
+                  },
+                  {
+                    "displayname": "Sao Paolo (br-sao)",
+                    "value": "br-sao"
+                  }
+                ]
               },
               {
                 "key": "prefix",
@@ -97,7 +138,65 @@
                 "key": "subscription_id_secret_crn"
               },
               {
-                "key": "node_type"
+                "key": "node_type",
+                "options": [
+                  {
+                    "displayname": "bx2.1x4",
+                    "value": "bx2.1x4"
+                  },
+                  {
+                    "displayname": "bx2.4x16",
+                    "value": "bx2.4x16"
+                  },
+                  {
+                    "displayname": "bx2.8x32",
+                    "value": "bx2.8x32"
+                  },
+                  {
+                    "displayname": "bx2.16x64",
+                    "value": "bx2.16x64"
+                  },
+                  {
+                    "displayname": "bx2.32x128",
+                    "value": "bx2.32x128"
+                  },
+                  {
+                    "displayname": "bx2.48x192",
+                    "value": "bx2.48x192"
+                  },
+                  {
+                    "displayname": "mx2.4x32",
+                    "value": "mx2.4x32"
+                  },
+                  {
+                    "displayname": "mx2.16x128",
+                    "value": "mx2.16x128"
+                  },
+                  {
+                    "displayname": "mx2.128x1024",
+                    "value": "mx2.128x1024"
+                  }
+                ]
+              },
+              {
+                "key": "service_endpoints",
+                "options": [
+                  {
+                    "displayname": "Public",
+                    "value": "public"
+                  },
+                  {
+                    "displayname": "Private",
+                    "value": "private"
+                  },
+                  {
+                    "displayname": "Public and Private",
+                    "value": "public-and-private"
+                  }
+                ]
+              },
+              {
+                "key": "enable_high_availability"
               },
               {
                 "key": "enable_oracle_compatibility"

main.tf

@@ -3,29 +3,21 @@ This file is used to implement the ROOT module.
 *********************************************************************/
 
 resource "ibm_db2" "db2" {
-  name              = var.db2_instance_name
-  resource_group_id = var.resource_group_id
-  location          = var.region
-  plan              = var.subscription_id == null ? "performance" : "PerformanceSubscription"
-  service           = "dashdb-for-transactions"
-  high_availability = var.enable_high_availability ? "yes" : "no"
-  service_endpoints = var.service_endpoints
-
-  parameters = {
-    "oracle_compatibility" : var.enable_oracle_compatibility ? "yes" : "no",
-    "version" : "12",
-    "node_type" : var.node_type,
-    "subscription_id" : var.subscription_id == null ? "" : var.subscription_id
-  }
+  name                 = var.db2_instance_name
+  service              = "dashdb-for-transactions"
+  plan                 = var.subscription_id == null ? "performance" : "PerformanceSubscription"
+  location             = var.region
+  resource_group_id    = var.resource_group_id
+  service_endpoints    = var.service_endpoints
+  instance_type        = var.node_type == "bx2.1x4" ? null : var.node_type
+  high_availability    = var.enable_high_availability ? "yes" : "no"
+  oracle_compatibility = var.enable_oracle_compatibility ? "yes" : "no"
+  subscription_id      = var.subscription_id
+  tags                 = var.tags
 
   timeouts {
     create = "720m"
     update = "60m"
     delete = "30m"
   }
 }
-
-resource "ibm_resource_tag" "tags" {
-  resource_id = ibm_db2.db2.crn
-  tags        = var.tags
-}