feat: ocp fully-configurable DA

.catalog-onboard-pipeline.yaml

@@ -2,19 +2,13 @@
 apiVersion: v1
 offerings:
   - name: terraform-ibm-base-ocp-vpc
-    kind: module
+    kind: solution
     catalog_id: 7df1e4ca-d54c-4fd0-82ce-3d13247308cd
     offering_id: 8531b562-91d5-4974-a195-5dff72ef2a5d
-    examples:
-      - name: basic
-        mark_ready: true
-      - name: advanced
-        mark_ready: true
-      - name: fscloud
-        mark_ready: true
-      - name: multiple_mzr_clusters
-        mark_ready: true
-      - name: add_rules_to_sg
-        mark_ready: true
-      - name: cross_kms_support
+    variations:
+      - name: quickstart-vpc
         mark_ready: true
+        install_type: fullstack
+        scc:
+          instance_id: 1c7d5f78-9262-44c3-b779-b28fe4d88c37
+          region: us-south

.secrets.baseline

@@ -3,7 +3,7 @@
     "files": "go.sum|^.secrets.baseline$",
     "lines": null
   },
-  "generated_at": "2024-07-12T12:56:42Z",
+  "generated_at": "2025-02-09T12:58:26Z",
   "plugins_used": [
     {
       "name": "AWSKeyDetector"
@@ -76,18 +76,7 @@
       "name": "TwilioKeyDetector"
     }
   ],
-  "results": {
-    "ibm_catalog.json": [
-      {
-        "hashed_secret": "a03815a5700107eb9f0d1a9608d2fcbdc48b7f5d",
-        "is_secret": false,
-        "is_verified": false,
-        "line_number": 20,
-        "type": "Secret Keyword",
-        "verified_result": null
-      }
-    ]
-  },
+  "results": {},
   "version": "0.13.1+ibm.62.dss",
   "word_list": {
     "file": null,

ibm_catalog.json

@@ -17,138 +17,124 @@
                 "cluster"
             ],
             "short_description": "Provisions a Red Hat OpenShift VPC cluster on IBM Cloud",
-            "long_description": "Use this module to provision an [IBM Cloud Red Hat OpenShift cluster](https:\/\/cloud.ibm.com\/docs\/openshift?topic=openshift-getting-started) on VPC Gen2. The module either creates the required Cloud Object Storage instance or uses an existing instance. The module also supports optionally passing a key management configuration for secret encryption and boot volume encryption.\r\n\r\n### Before you begin\r\n\r\n- Make sure that you have a recent version of the [IBM Cloud CLI](https:\/\/cloud.ibm.com\/docs\/cli?topic=cli-getting-started)\r\n- Make sure that you have a recent version of the [IBM Cloud Kubernetes service CLI](https:\/\/cloud.ibm.com\/docs\/containers?topic=containers-kubernetes-service-cli)\r\n\r\n### Usage\r\n```hcl\r\nmodule \"ocp_base\" {\r\n  # Replace \"X.X.X\" with a release version to lock into a specific release\r\n  source               = \"https:\/\/cm.globalcatalog.cloud.ibm.com\/api\/v1-beta\/offering\/source?archive=tgz&kind=terraform&name=terraform-ibm-base-ocp-vpc&version=X.X.X\"\r\n  ibmcloud_api_key     = \"XXXXXXXXXXXXXXXXXXX\"\r\n  cluster_name         = \"example-cluster-name\"\r\n  resource_group_id    = \"xxXXxxXXxXxXXXXxxXxxxXXXXxXXXXX\"\r\n  region               = \"us-south\"\r\n  force_delete_storage = true\r\n  vpc_id               = \"79cxxxx-xxxx-xxxx-xxxx-xxxxxXX8667\"\r\n  # obtain the below values from the targeted VPC and adjust to the number of zones, subnets, subnet name, cidr_block, id, zone\r\n  vpc_subnets          = {\r\n    zone-1    = [\r\n        {\r\n            cidr_block = \"192.168.32.0\/22\"\r\n            id         = \"0717-afc29fbb-0dbe-493a-a5b9-f3c5899cb8b9\"\r\n            zone       = \"us-south-1\"\r\n        },\r\n        {\r\n            cidr_block = \"192.168.36.0\/22\"\r\n            id         = \"0727-d65c1eda-9e38-4200-8452-cb8ff5bb3140\"\r\n            zone       = \"us-south-2\"\r\n        },\r\n        {\r\n            cidr_block = \"192.168.40.0\/22\"\r\n            id         = \"0737-9a823cd3-16bf-4ba4-a429-9e1fc7db74b8\"\r\n            zone       = \"us-south-3\"\r\n        }\r\n    ]\r\n    zone-2 = [\r\n        {\r\n            cidr_block = \"192.168.0.0\/22\"\r\n            id         = \"0717-846b9490-34ae-4a6c-8288-28112dca1ba3\"\r\n            zone       = \"us-south-1\"\r\n        },\r\n        {\r\n            cidr_block = \"192.168.4.0\/22\"\r\n            id         = \"0727-ef8db7f6-ffa5-4d8b-a317-4631741a45ee\"\r\n            zone       = \"us-south-2\"\r\n        },\r\n        {\r\n            cidr_block = \"192.168.8.0\/22\"\r\n            id         = \"0737-c9a6d871-d95b-4914-abf5-82c22f4161d1\"\r\n            zone       = \"us-south-3\"\r\n        }\r\n    ]\r\n    zone-3 = [\r\n        {\r\n            cidr_block = \"192.168.16.0\/22\"\r\n            id         = \"0717-d46e227c-89d4-4b02-9008-d03907a275b6\"\r\n            zone       = \"us-south-1\"\r\n        },\r\n        {\r\n            cidr_block = \"192.168.20.0\/22\"\r\n            id         = \"0727-93b1edcb-966c-4517-a7af-6ac63cd93adf\"\r\n            zone       = \"us-south-2\"\r\n        },\r\n        {\r\n            cidr_block = \"192.168.24.0\/22\"\r\n            id         = \"0737-807ec4f1-4d84-484e-b2f4-62dd5e431065\"\r\n            zone       = \"us-south-3\"\r\n        }\r\n    ]\r\n  }\r\n}\r\n```",
+            "long_description": "This architecture supports creation and configuration of IBM Cloud Red Hat OpenShift cluster.",
             "offering_docs_url": "https://github.com/terraform-ibm-modules/terraform-ibm-base-ocp-vpc/blob/main/README.md",
             "offering_icon_url": "https://raw.githubusercontent.com/terraform-ibm-modules/documentation/main/icons/RH_OpenShift.svg",
             "provider_name": "IBM",
             "features": [
                 {
                     "title": "Create a Red Hat OpenShift VPC cluster on IBM Cloud",
                     "description": "Create a Red Hat OpenShift VPC cluster on IBM Cloud."
-                },
-                {
-                    "title": "Autoscaling",
-                    "description": "Configure worker autoscaling."
-                },
-                {
-                    "title": "Optionally create a Cloud Object Storage instance",
-                    "description": "Optionally create a Cloud Object Storage instance which is required by OCP VPC clusters. Also supports using existing instance."
-                },
-                {
-                    "title": "Attach access tags",
-                    "description": "Attach access tags to the cluster resources."
-                },
-                {
-                    "title": "Enable cluster managed add-ons",
-                    "description": "Enable any of the supported [managed cluster addons](https://cloud.ibm.com/docs/containers?topic=containers-managed-addons)."
-                },
-                {
-                    "title": "Encrypt data with key management services",
-                    "description": "Supports key management encryption (BYOK and KYOK) for boot volumes and cluster data."
                 }
             ],
             "flavors": [
                 {
-                    "label": "Basic",
-                    "name": "basic",
-                    "working_directory": "examples/basic",
-                    "architecture": {
-                        "diagrams": [
-                            {
-                                "diagram": {
-                                    "caption": "Basic example",
-                                    "url": "https://raw.githubusercontent.com/terraform-ibm-modules/documentation/main/icons/ModuleExampleDiagram.svg",
-                                    "type": "image/svg+xml"
-                                },
-                                "description": "A simple example that shows how to provision a basic single zone OCP VPC cluster."
-                            }
-                        ]
-                    }
-                },
-                {
-                    "label": "Advanced",
-                    "name": "advanced",
-                    "working_directory": "examples/advanced",
-                    "architecture": {
-                        "diagrams": [
-                            {
-                                "diagram": {
-                                    "caption": "Advanced example",
-                                    "url": "https://raw.githubusercontent.com/terraform-ibm-modules/documentation/main/icons/ModuleExampleDiagram.svg",
-                                    "type": "image/svg+xml"
-                                },
-                                "description": "An advanced example which shows how to create a multi-zone KMS encrypted OCP VPC cluster with custom worker node taints."
-                            }
-                        ]
-                    }
-                },
-                {
-                    "label": "Financial Services compliant",
-                    "name": "fscloud",
-                    "working_directory": "examples/fscloud",
-                    "architecture": {
-                        "diagrams": [
-                            {
-                                "diagram": {
-                                    "caption": "Financial Services compliant example",
-                                    "url": "https://raw.githubusercontent.com/terraform-ibm-modules/documentation/main/icons/ModuleExampleDiagram.svg",
-                                    "type": "image/svg+xml"
-                                },
-                                "description": "This example uses the Profile for IBM Cloud Framework for Financial Services to provision an instance of the base OCP VPC module in a compliant manner."
-                            }
-                        ]
-                    }
-                },
-                {
-                    "label": "2 MZR clusters in same VPC",
-                    "name": "multiple_mzr_clusters",
-                    "working_directory": "examples/multiple_mzr_clusters",
-                    "architecture": {
-                        "diagrams": [
-                            {
-                                "diagram": {
-                                    "caption": "2 MZR clusters in same VPC example",
-                                    "url": "https://raw.githubusercontent.com/terraform-ibm-modules/documentation/main/icons/ModuleExampleDiagram.svg",
-                                    "type": "image/svg+xml"
-                                },
-                                "description": "This is an example of creating 2 MZR clusters in same VPC, and deploying the observability agents in the clusters."
-                            }
-                        ]
-                    }
-                },
-                {
-                    "label": "Cluster security group rules",
-                    "name": "add_rules_to_sg",
-                    "working_directory": "examples/add_rules_to_sg",
-                    "architecture": {
-                        "diagrams": [
-                            {
-                                "diagram": {
-                                    "caption": "Cluster security group rules example",
-                                    "url": "https://raw.githubusercontent.com/terraform-ibm-modules/documentation/main/icons/ModuleExampleDiagram.svg",
-                                    "type": "image/svg+xml"
-                                },
-                                "description": "This example will add security rules to the `kube-<vpcid>` and `kube-<clusterId>` security groups."
-                            }
-                        ]
-                    }
-                },
-                {
-                    "label": "Cross account KMS encryption",
-                    "name": "cross_kms_support",
-                    "working_directory": "examples/cross_kms_support",
-                    "architecture": {
-                        "diagrams": [
-                            {
-                                "diagram": {
-                                    "caption": "Cross account KMS encryption example",
-                                    "url": "https://raw.githubusercontent.com/terraform-ibm-modules/documentation/main/icons/ModuleExampleDiagram.svg",
-                                    "type": "image/svg+xml"
-                                },
-                                "description": "A single zone OCP VPC cluster configured with KMS encryption for cluster data and worker block storage using a KMS encryption key from another account."
-                            }
-                        ]
+                  "label": "quickstart",
+                  "name": "quickstart",
+                  "install_type": "fullstack",
+                  "working_directory": "solutions/quickstart-vpc",
+                  "configuration": [
+                    {
+                      "key": "ibmcloud_api_key"
+                    },
+                    {
+                      "key": "prefix",
+                      "required": true
+                    },
+                    {
+                      "key": "use_existing_resource_group"
+                    },
+                    {
+                      "key": "resource_group_name"
+                    },
+                    {
+                      "key": "cluster_name"
+                    },
+                    {
+                      "key": "ocp_version"
+                    },
+                    {
+                      "key": "number_worker_nodes"
+                    },
+                    {
+                      "key": "machine_type"
+                    },
+                    {
+                      "key": "vpc_id"
+                    },
+                    {
+                      "key": "existing_cos_id"
+                    },
+                    {
+                      "key": "region",
+                      "required": true,
+                      "options": [
+                        {
+                          "displayname": "Dallas (us-south)",
+                          "value": "us-south"
+                        },
+                        {
+                          "displayname": "Frankfurt (eu-de)",
+                          "value": "eu-de"
+                        },
+                        {
+                          "displayname": "London (eu-gb)",
+                          "value": "eu-gb"
+                        },
+                        {
+                          "displayname": "Madrid (eu-es)",
+                          "value": "eu-es"
+                        },
+                        {
+                          "displayname": "Osaka (jp-osa)",
+                          "value": "jp-osa"
+                        },
+                        {
+                          "displayname": "Sydney (au-syd)",
+                          "value": "au-syd"
+                        },
+                        {
+                          "displayname": "Tokyo (jp-tok)",
+                          "value": "jp-tok"
+                        },
+                        {
+                          "displayname": "Osaka (jp-osa)",
+                          "value": "jp-osa"
+                        },
+                        {
+                          "displayname": "Sao Paulo (br-sao)",
+                          "value": "br-sao"
+                        },
+                        {
+                          "displayname": "Toronto (ca-tor)",
+                          "value": "ca-tor"
+                        },
+                        {
+                          "displayname": "Washington (us-east)",
+                          "value": "us-east"
+                        }
+                      ]
                     }
+                  ],
+                  "architecture": {
+                    "descriptions": "This architecture creates a basic single zone OCP VPC cluster.",
+                    "features": [
+                      {
+                        "title": "Creates an OCP VPC cluster",
+                        "description": "Creates an OCP VPC cluster"
+                      }
+                    ],
+                    "diagrams": [
+                      {
+                        "diagram": {
+                          "caption": "Red Hat OpenShift VPC cluster for IBM Cloud.",
+                          "url": "https://raw.githubusercontent.com/terraform-ibm-modules/terraform-ibm-base-ocp-vpc/main/reference-architecture/deployable-architecture-ocp-cluster-qs.svg",
+                          "type": "image/svg+xml"
+                        },
+                        "description": "This architecture creates a basic single zone OCP VPC cluster."
+                      }
+                    ]
+                  }
                 }
             ]
         }

solutions/quickstart-vpc/README.md

@@ -0,0 +1,11 @@
+# Single zone OCP VPC cluster (Quickstart)
+
+This architecture creates a basic single zone OCP VPC cluster. Also the outbound traffic is allowed, which is required for accessing the Operator Hub.
+
+The following resources are provisioned by this example:
+
+- A new resource group, if an existing one is not passed in.
+- A single zone OCP VPC cluster.
+
+
+![single-zone-ocp-cluster](../../reference-architecture/deployable-architecture-ocp-cluster-qs.svg)

solutions/quickstart-vpc/catalogValidationValues.json.template

@@ -0,0 +1,6 @@
+{
+  "ibmcloud_api_key": $VALIDATION_APIKEY,
+  "region": "au-syd",
+  "resource_tags": $TAGS,
+  "prefix": $PREFIX
+}

solutions/quickstart-vpc/main.tf

@@ -0,0 +1,61 @@
+#######################################################################################################################
+# Resource Group
+#######################################################################################################################
+module "resource_group" {
+  source                       = "terraform-ibm-modules/resource-group/ibm"
+  version                      = "1.1.6"
+  resource_group_name          = var.use_existing_resource_group == false ? ((var.prefix != null && var.prefix != "") ? "${var.prefix}-${var.resource_group_name}" : var.resource_group_name) : null
+  existing_resource_group_name = var.use_existing_resource_group == true ? var.resource_group_name : null
+}
+
+########################################################################################################################
+# OCP VPC cluster (single zone)
+########################################################################################################################
+
+locals {
+  prefix = var.prefix != null ? (var.prefix != "" ? var.prefix : null) : null
+}
+
+data "ibm_is_subnets" "vpc_subnets" {
+  vpc = var.vpc_id
+}
+
+locals {
+  cluster_vpc_subnets = {
+    for subnet in data.ibm_is_subnets.vpc_subnets.subnets :
+    "default" => [{
+      id         = subnet.id
+      zone       = subnet.zone
+      cidr_block = subnet.ipv4_cidr_block
+    }]
+  }
+
+  worker_pools = [
+    {
+      subnet_prefix    = "default"
+      pool_name        = "default"
+      machine_type     = var.machine_type
+      workers_per_zone = var.number_worker_nodes
+      operating_system = var.operating_system
+    }
+  ]
+}
+
+module "ocp_base" {
+  source                               = "../.."
+  resource_group_id                    = module.resource_group.resource_group_id
+  region                               = var.region
+  tags                                 = var.resource_tags
+  cluster_name                         = try("${local.prefix}-${var.cluster_name}", var.cluster_name)
+  force_delete_storage                 = true
+  use_existing_cos                     = true
+  existing_cos_id                      = var.existing_cos_id
+  vpc_id                               = var.vpc_id
+  vpc_subnets                          = local.cluster_vpc_subnets
+  ocp_version                          = var.ocp_version
+  worker_pools                         = local.worker_pools
+  access_tags                          = var.access_tags
+  ocp_entitlement                      = var.ocp_entitlement
+  disable_outbound_traffic_protection  = true
+  import_default_worker_pool_on_create = false
+}

solutions/quickstart-vpc/outputs.tf

@@ -0,0 +1,8 @@
+########################################################################################################################
+# Outputs
+########################################################################################################################
+
+output "cluster_name" {
+  value       = module.ocp_base.cluster_name
+  description = "The name of the provisioned cluster."
+}