feat: add fully-configurable DA variation (#18)

* initial commit

* updates

* test

* update code owner

* test

* test

* create new quickstart DA

* update

* update

* update

* update

* test

* update catalog

* test

* test

* changes

* update

* pre-commit

* skip rule

* SKIP UPGRADE TEST

* improve

* update rg module

* update

* update test

* update

* update

* Update ibm_catalog.json

* test

* test

* test

* revert test

* update permissions

* review comments

* feat: add support for Fully configurable DA

* update

* test

* test

* fix

* update variable

* update json

* update

* test

* precommit

* update json

* update ocp version

* update inputs

* update ocp version

* SKIP UPGRADE TEST

* update json

* update json

* update json

* add addon test

* add parallel

* update test

* update

* update

* update

* update diagram

* update common-dev-assets

* update catalog json

* update

* update

Author: Aashiq-J

.catalog-onboard-pipeline.yaml

@@ -9,3 +9,8 @@ offerings:
       - name: quickstart
         mark_ready: true
         install_type: fullstack
+      - name: fully-configurable
+        mark_ready: true
+        install_type: fullstack
+        pre_validation: "tests/scripts/pre-validation-deploy-ocp.sh"
+        post_validation: "tests/scripts/post-validation-destroy-ocp.sh"

common-dev-assets

@@ -0,0 +1,158 @@
+# Configuring complex inputs for OpenShift in IBM Cloud projects
+
+Several optional input variables in the Red Hat OpenShift cluster [Deployable Architecture](https://cloud.ibm.com/catalog#deployable_architecture) use complex object types. You can specify these inputs when you configure your deployable architecture.
+
+- [Additional Worker Pools](#options-with-additional-worker-pools) (`additional_worker_pools`)
+- [Add-ons](#options-with-addons) (`addons`)
+- [Infra node selectors](#options-with-infra) (`infra_node_selectors`)
+- [Workloads node selectors](#options-with-workload) (`workloads_node_selectors`)
+
+
+## Options with additional_worker_pools <a name="options-with-additional-worker-pools"></a>
+
+This variable defines the worker node pools for the Red Hat OpenShift cluster, with each pool having its own configuration settings.
+
+- Variable name: `additional_worker_pools`.
+- Type: A list of objects. Each object represents a `worker_pool` configuration.
+- Default value: An empty list (`[]`).
+
+### Options for additional_worker_pools
+
+- `vpc_subnets` (optional): (List) A list of object which specify which all subnets the worker pool should deploy its nodes.
+  - `id` (required): A unique identifier for the VPC subnet.
+  - `zone` (required): The zone where the subnet is located.
+  - `cidr_block` (required): This defines the IP address range for the subnet in CIDR notation.
+- `pool_name` (required): The name of the worker pool.
+- `machine_type` (required): The machine type for worker nodes.
+- `workers_per_zone` (required): Number of worker nodes in each zone of the cluster.
+- `operating_system` (required): The operating system installed on the worker nodes.
+- `labels` (optional): A set of key-value labels assigned to the worker pool for identification.
+- `minSize` (optional): The minimum number of worker nodes allowed in the pool.
+- `maxSize` (optional): The maximum number of worker nodes allowed in the pool.
+- `secondary_storage` (optional): The secondary storage attached to the worker nodes. Secondary storage is immutable and can't be changed after provisioning.
+- `enableAutoscaling` (optional): Set `true` to enable automatic scaling of worker based on workload demand.
+- `additional_security_group_ids` (optional): A list of security group IDs that are attached to the worker nodes for additional network security controls.
+
+### Example for additional_worker_pools configuration
+
+```hcl
+[
+  {
+    pool_name                         = "infra"
+    machine_type                      = "gx3.16x80.l4"
+    workers_per_zone                  = 2
+    secondary_storage                 = "300gb.5iops-tier"
+    operating_system                  = "RHCOS"
+  }
+]
+```
+
+## Options with `addons` <a name="options-with-addons"></a>
+
+This variable configuration allows you to specify which Red Hat OpenShift add-ons to install on your cluster and the version of each add-on to use.
+
+- Variable name: `addons`
+- Type: An object representing Red Hat OpenShift cluster add-ons.
+- Default value: An empty object (`{}`).
+
+### Supported Add-ons
+
+- `debug-tool` (optional): (Object) The Debug Tool add-on helps diagnose and troubleshoot cluster issues by running tests and gathering information, accessible through the Red Hat OpenShift console.
+  - `version` (optional): The add-on version. Omit the version that you want to use as the default version.This is required when you want to update the add-on to specified version.
+  - `parameters_json` (optional): Add-On parameters to pass in a JSON string format.
+
+- `image-key-synchronizer` (optional): (Object) The Image Key Synchronizer add-on enables the deployment of containers using encrypted images by synchronizing image keys, ensuring only authorized users can access and run them.
+  - `version` (optional): The add-on version. Omit the version that you want to use as the default version.This is required when you want to update the add-on to specified version.
+  - `parameters_json` (optional): Add-On parameters to pass in a JSON string format.
+
+- `openshift-data-foundation` (optional): (Object) The Red Hat OpenShift Data Foundation (ODF) add-on manages persistent storage for containerized applications with a highly available storage solution.
+  - `version` (optional): The add-on version. Omit the version that you want to use as the default version.This is required when you want to update the add-on to specified version.
+  - `parameters_json` (optional): Add-On parameters to pass in a JSON string format.
+
+- `vpc-file-csi-driver` (optional): (Object) The Virtual Private Cloud File Container Storage Interface Driver add-on enables the creation of persistent volume claims for fast, flexible, network-attached, Network File System-based file storage for Virtual Private Cloud.
+  - `version` (optional): The add-on version. Omit the version that you want to use as the default version.This is required when you want to update the add-on to specified version.
+  - `parameters_json` (optional): Add-On parameters to pass in a JSON string format.
+
+- `static-route` (optional): (Object) The Static Route add-on allows worker nodes to re-route response packets through a virtual private network or gateway to an Internet Protocol (IP) address in an on-premises data center.
+  - `version` (optional): The add-on version. Omit the version that you want to use as the default version.This is required when you want to update the add-on to specified version.
+  - `parameters_json` (optional): Add-On parameters to pass in a JSON string format.
+
+- `cluster-autoscaler` (optional): (Object) The Cluster Autoscaler add-on automatically scales worker pools based on the resource demands of scheduled workloads.
+  - `version` (optional): The add-on version. Omit the version that you want to use as the default version.This is required when you want to update the add-on to specified version.
+  - `parameters_json` (optional): Add-On parameters to pass in a JSON string format.
+
+- `vpc-block-csi-driver` (optional): (Object) The Virtual Private Cloud (VPC) Block Container Storage Interface (CSI) Driver add-on enables snapshotting of storage volumes, allowing users to restore data from specific points in time without duplicating the volume.
+  - `version` (optional): The add-on version. Omit the version that you want to use as the default version.This is required when you want to update the add-on to specified version.
+  - `parameters_json` (optional): Add-On parameters to pass in a JSON string format.
+
+- `ibm-storage-operator` (optional): (Object) The IBM Storage Operator add-on streamlines the management of storage configuration maps and resources in your cluster.
+  - `version` (optional): The add-on version. Omit the version that you want to use as the default version.This is required when you want to update the add-on to specified version.
+  - `parameters_json` (optional): Add-On parameters to pass in a JSON string format.
+
+- `openshift-ai` (optional): (Object) The Red Hat OpenShift AI add-on enables quick deployment of Red Hat OpenShift AI on a Red Hat OpenShift Cluster in IBM Cloud.
+  - `version` (optional): The add-on version. Omit the version that you want to use as the default version.This is required when you want to update the add-on to specified version.
+  - `parameters_json` (optional): Add-On parameters to pass in a JSON string format.
+
+Please refer to [this](https://cloud.ibm.com/docs/containers?topic=containers-supported-cluster-addon-versions) page for information on supported add-ons and their versions.
+
+### Example for addons configuration
+
+```hcl
+{
+  openshift-data-foundation = {
+    version         = "4.17.0"
+    parameters_json = <<PARAMETERS_JSON
+        {
+            "osdStorageClassName":"localblock",
+            "odfDeploy":"true",
+            "autoDiscoverDevices":"true"
+        }
+        PARAMETERS_JSON
+  }
+  vpc-file-csi-driver = {
+    version = "2.0"
+  }
+}
+```
+
+## Options with `infra_node_selectors` <a name="options-with-infra"></a>
+
+This variable configuration allows you to specify a list of key-value pairs that define the node affinity for the Virtualization Operator resources within the cluster.
+
+- Variable name: `infra_node_selectors`
+- Type: A List objects representing infra node selectors.
+
+### Options for infra_node_selectors
+
+- `key` : The label key to match against on the node.
+- `values` : (List) The list of allowed values for the name label.
+
+### Example for infra_node_selectors configuration
+
+```hcl
+[{
+    key  = "ibm-cloud.kubernetes.io/server-type"
+    values = ["virtual", "physical"]
+}]
+```
+
+## Options with `workloads_node_selectors` <a name="options-with-workload"></a>
+
+This variable configuration allows you to specify a list of key-value pairs that define the node affinity for the Virtualization VM workloads resources within the cluster.
+
+- Variable name: `workloads_node_selectors`
+- Type: A List objects representing workload node selectors.
+
+### Options for workloads_node_selectors
+
+- `key` : The label key to match against on the node.
+- `values` : (List) The list of allowed values for the name label.
+
+### Example for workloads_node_selectors configuration
+
+```hcl
+[{
+    key  = "ibm-cloud.kubernetes.io/server-type"
+    values = ["physical"]
+}]
+```

ibm_catalog.json

@@ -0,0 +1,3 @@
+# Cloud automation for OpenShift Virtualization (Fully configurable)
+
+:exclamation: **Important:** This solution is not intended to be called by other modules because it contains a provider configuration and is not compatible with the `for_each`, `count`, and `depends_on` arguments. For more information, see [Providers Within Modules](https://developer.hashicorp.com/terraform/language/modules/develop/providers).

reference-architecture/deployable-architecture-ocp-virtualization-cluster.svg

@@ -0,0 +1,3 @@
+{
+  "ibmcloud_api_key": $VALIDATION_APIKEY
+}

reference-architecture/deployable-architecture-ocp-virtualization-fully-configurable.svg

@@ -0,0 +1,6 @@
+# Ignore everything
+*
+
+# But not these files...
+!.gitignore
+!README.md