feat: ocp-quick-start-DA #591

Ak-sky · 2025-02-06T08:21:09Z

Description

OCP Quickstart variation.

Release required?

No release
Patch release (x.x.X)
Minor release (x.X.x)
Major release (X.x.x)

Release notes content

Run the pipeline

If the CI pipeline doesn't run when you create the PR, the PR requires a user with GitHub collaborators access to run the pipeline.

Run the CI pipeline when the PR is ready for review and you expect tests to pass. Add a comment to the PR with the following text:

/run pipeline

Checklist for reviewers

If relevant, a test for the change is included or updated with this PR.
If relevant, documentation for the change is included or updated with this PR.

For mergers

Use a conventional commit message to set the release level. Follow the guidelines.
Include information that users need to know about the PR in the commit message. The commit message becomes part of the GitHub release notes.
Use the Squash and merge option.

Ak-sky · 2025-02-06T08:38:10Z

/run pipeline

Ak-sky · 2025-02-06T08:55:04Z

/run pipeline

Ak-sky · 2025-02-06T08:57:22Z

/run pipeline

Ak-sky · 2025-02-06T08:58:32Z

/run pipeline

Ak-sky · 2025-02-09T13:15:13Z

/run pipeline

ocofaigh · 2025-02-10T18:13:11Z

.catalog-onboard-pipeline.yaml

-        mark_ready: true
-      - name: cross_kms_support
+    variations:
+      - name: quickstart-vpc


this needs to match the name you gave in the ibm_catalog.json

ocofaigh · 2025-02-10T18:14:27Z

ibm_catalog.json

+                      "required": true
+                    },
+                    {
+                      "key": "use_existing_resource_group"


force this to true so it lives beside the resource_group_name inputs in the UI (see internal issue)

ocofaigh · 2025-02-10T18:14:49Z

ibm_catalog.json

+                      "key": "cluster_name"
+                    },
+                    {
+                      "key": "ocp_version"


add a custom dropdown box with the supported versions

ocofaigh · 2025-02-10T18:15:01Z

ibm_catalog.json

+                      "key": "machine_type"
+                    },
+                    {
+                      "key": "vpc_id"


use the VPC picker drodown

ocofaigh · 2025-02-10T18:15:32Z

ibm_catalog.json

+                    {
+                      "key": "region",
+                      "required": true,
+                      "options": [


you dont need to use a custom dropdown here. You can use the out of the box VPC region picker since we only support VPC clusters

ocofaigh · 2025-02-10T18:16:21Z

solutions/quickstart-vpc/provider.tf

+
+provider "ibm" {
+  ibmcloud_api_key = var.ibmcloud_api_key
+  region           = var.region


expose provider visability

ocofaigh · 2025-02-10T18:17:37Z

solutions/quickstart-vpc/variables.tf

+
+variable "operating_system" {
+  type        = string
+  description = "Allowed OS values are RHEL 8 (REDHAT_8_64) or Red Hat Enterprise Linux CoreOS (RHCOS). RHCOS requires VPC clusters created from 4.15 onwards. Upgraded clusters from 4.14 cannot use RHCOS."


RHEL 9 was recently added, please add support for that too

ocofaigh · 2025-02-10T18:19:04Z

solutions/quickstart-vpc/variables.tf

+  default     = "bx2.4x16"
+}
+
+variable "operating_system" {


This is missing from the ibm_catalog.json? If you pull in the latest common-dev-assets and run pre-commit hooks, it will tell you all the missing vars from ibm_catalog.json.
You can add a dropdown box with the supported values then

ocofaigh · 2025-02-10T18:20:08Z

solutions/quickstart-vpc/variables.tf

+variable "cluster_name" {
+  type        = string
+  description = "The name of the new IBM Cloud OpenShift Cluster. If a `prefix` input variable is specified, it is added to this name in the `<prefix>-value` format."
+  default     = "base-ocp"


hmm, not sure about adding a default value here - every cluster will end up getting called dev-base-ocp and you will get conflicts. Perhaps we make this required?

ocofaigh · 2025-02-10T18:20:32Z

solutions/quickstart-vpc/variables.tf

+variable "existing_cos_id" {
+  type        = string
+  description = "The COS id of an already existing COS instance to use for OpenShift internal registry storage."
+  default     = null


This should be required input, with no default value. We don't want the DA to create COS. It should define COS as a dependency in the ibm_catalog.json so we make use of the addons UI

ocofaigh · 2025-02-10T18:21:39Z

tests/existing-resources/main.tf

+#############################################################################
+
+module "slz_vpc" {
+  source            = "terraform-ibm-modules/landing-zone-vpc/ibm"


I wouldn't use SLZ for the quickstart pattern since quickstart is not going to be locked down

ocofaigh · 2025-02-10T18:24:23Z

tests/pr_test.go

@@ -156,3 +162,76 @@ func TestFSCloudInSchematic(t *testing.T) {
 	err := options.RunSchematicTest()
 	assert.Nil(t, err, "This should not have errored")
 }
+


We need an upgrade test for every DA variation too. You should be able to just replace the current upgrade test using the example with a DA upgrade test - we don't need both

ocofaigh · 2025-02-10T18:25:13Z

ibm_catalog.json

+                  "name": "quickstart",
+                  "install_type": "fullstack",
+                  "working_directory": "solutions/quickstart-vpc",
+                  "configuration": [


you need to define dependencies (COS and VPC) and wire the inputs to make it work with the addons UI

ocofaigh

Left an initial few comments

ocofaigh · 2025-02-10T18:26:59Z

solutions/quickstart-vpc/version.tf

@@ -0,0 +1,12 @@
+terraform {
+  required_version = ">=1.3.0"


The module was just updated to require >=1.9.0 so please also update here. It means you can use cross variable validation now too if you find an applicable use case in the DA inputs

ocofaigh · 2025-02-10T18:27:58Z

solutions/quickstart-vpc/version.tf

+  required_version = ">=1.3.0"
+
+  # Ensure that there is always 1 example locked into the lowest provider version of the range defined in the main
+  # module's version.tf (basic and add_rules_to_sg), and 1 example that will always use the latest provider version (advanced, fscloud and multiple mzr).


Remove the above comments, they are valid for an example, not a DA. For the DA just leave this comment:

# Lock DA into an exact provider version - renovate automation will keep it updated

ocofaigh · 2025-02-10T18:28:07Z

solutions/quickstart-vpc/version.tf

+  required_providers {
+    ibm = {
+      source  = "IBM-Cloud/ibm"
+      version = "1.70.0"


bump to latest

Ak-sky and others added 3 commits February 6, 2025 13:47

feat: ocp-quick-start-DA

184d003

Merge branch 'main' into qs

95d3d0b

test

5731815

test

f69464e

Ak-sky marked this pull request as ready for review February 6, 2025 08:58

Ak-sky requested review from toddgiguere and Aashiq-J as code owners February 6, 2025 08:58

Ak-sky changed the title ~~feat: ocp-quick-start-DA~~ [WIP]feat: ocp-quick-start-DA Feb 6, 2025

Ak-sky added 2 commits February 9, 2025 18:39

Merge remote-tracking branch 'origin/main' into qs

6c39d3d

ocp quickstart

74ed109

Ak-sky changed the title ~~[WIP]feat: ocp-quick-start-DA~~ feat: ocp-quick-start-DA Feb 9, 2025

Ak-sky and others added 5 commits February 10, 2025 00:18

pr-test fixes

50b6263

Merge branch 'main' into qs

59139d9

minor fixes

4a1d166

pr-test fixes

9c8db31

pr-test fixes

82f8483

ocofaigh reviewed Feb 10, 2025

View reviewed changes

ibm_catalog.json

"key": "cluster_name"

},

{

"key": "ocp_version"

Copy link

Member

ocofaigh Feb 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

add a custom dropdown box with the supported versions

ocofaigh reviewed Feb 10, 2025

View reviewed changes

ibm_catalog.json

"key": "machine_type"

},

{

"key": "vpc_id"

Copy link

Member

ocofaigh Feb 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

use the VPC picker drodown

ocofaigh reviewed Feb 10, 2025

View reviewed changes

ocofaigh requested changes Feb 10, 2025

View reviewed changes

ocofaigh reviewed Feb 10, 2025

View reviewed changes

solutions/quickstart-vpc/version.tf

required_providers {

ibm = {

source = "IBM-Cloud/ibm"

version = "1.70.0"

Copy link

Member

ocofaigh Feb 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

bump to latest

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: ocp-quick-start-DA #591

feat: ocp-quick-start-DA #591

Ak-sky commented Feb 6, 2025

Ak-sky commented Feb 6, 2025

Ak-sky commented Feb 6, 2025

Ak-sky commented Feb 6, 2025

Ak-sky commented Feb 6, 2025

Ak-sky commented Feb 9, 2025

ocofaigh Feb 10, 2025

ocofaigh Feb 10, 2025

ocofaigh Feb 10, 2025

ocofaigh Feb 10, 2025

ocofaigh Feb 10, 2025

ocofaigh Feb 10, 2025

ocofaigh Feb 10, 2025

ocofaigh Feb 10, 2025

ocofaigh Feb 10, 2025

ocofaigh Feb 10, 2025 •

edited

Loading

ocofaigh Feb 10, 2025

ocofaigh Feb 10, 2025

ocofaigh Feb 10, 2025

ocofaigh left a comment

ocofaigh Feb 10, 2025

ocofaigh Feb 10, 2025

ocofaigh Feb 10, 2025

feat: ocp-quick-start-DA #591

Are you sure you want to change the base?

feat: ocp-quick-start-DA #591

Conversation

Ak-sky commented Feb 6, 2025

Description

Release required?

Release notes content

Run the pipeline

Checklist for reviewers

For mergers

Ak-sky commented Feb 6, 2025

Ak-sky commented Feb 6, 2025

Ak-sky commented Feb 6, 2025

Ak-sky commented Feb 6, 2025

Ak-sky commented Feb 9, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ocofaigh Feb 10, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ocofaigh left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ocofaigh Feb 10, 2025 •

edited

Loading