Skip to content

Support CPD 5.3.1 - Helm-based install for WML, WSL, Spark, Cognos Analytics and SPSS - #555

Open
Sakshi-Singhroha1 wants to merge 72 commits into
mainfrom
MASCORE-15507
Open

Support CPD 5.3.1 - Helm-based install for WML, WSL, Spark, Cognos Analytics and SPSS#555
Sakshi-Singhroha1 wants to merge 72 commits into
mainfrom
MASCORE-15507

Conversation

@Sakshi-Singhroha1

Copy link
Copy Markdown
Contributor

Issue

https://jsw.ibm.com/browse/MASCORE-15507
https://jsw.ibm.com/browse/MASCORE-15752
https://jsw.ibm.com/browse/MASCORE-16163

Description

Updates GitOps automation to support CPD 5.3.1 in addition to existing CPD 5.2 and 5.3 support. For CPD 5.3.1+, OLM-based installation is replaced with Helm-based installation using IBM Helm charts.

Summary of changes

CPD 5.3.1 OLM bootstrap (101-ibm-sync-jobs-cp4d, 110-ibm-cp4d)

  • Added 00-ibm-cp4d-olm-531.yaml with full OLM bootstrap for CPD 5.3.1
  • Added CPD 5.3.1 catalog sources (cpd-platform, opencloud-operators, ibm-zen-operator-catalog)
  • Added ClusterRole + ClusterRoleBinding for cpd-sa to allow Helm cluster-scoped chart installs (CRDs, ClusterRoles) at CPD 5.3.1+
  • Gated OLM-only resources behind < 5.3.1 version check

WML (120-ibm-wml)

  • Added Helm-based install job for CPD 5.3.1+ using ibm-redis-cp (v1.3.1, dependency) and wml (v12.1.0) Helm charts
  • Fixed CRD poll name: redicps.redis.ibm.com → rediscps.redis.ibm.com
  • Gated OLM Subscription behind < 5.3.1 version check
  • Added cpd_product_version to values.yaml

WSL (120-ibm-wsl)

  • Added Helm-based install job for CPD 5.3.1+ installing opensearch (v1.2.0), ccs (v12.1.0), datarefinery (v12.1.0), ws-runtimes (v12.1.0) and ws (v12.1.0) in dependency order
  • Gated OLM Subscription and WS CR behind < 5.3.1 version check
  • Added cpd_product_version to 120-ibm-wsl-app.yaml

Spark (120-ibm-spark)

  • Added Helm-based install job for CPD 5.3.1+ using analyticsengine (v12.1.0) Helm chart
  • Gated OLM Subscription, AnalyticsEngine CR, and control-plane job behind < 5.3.1 version check
  • Added cpd_product_version to values.yaml and 120-ibm-spark-app.yaml

Cognos Analytics (120-ibm-cognos-analytics)

  • Added missing Chart.yaml (was causing helm dependency update failure)
  • Added Helm-based install job for CPD 5.3.1+ using cognos-analytics (v29.1.0) Helm charts
  • Fixed CRD poll name: cognosanalytics.cognosanalytics.cpd.ibm.com → caservices.ca.cpd.ibm.com
  • Fixed parse error from escaped quotes in default values inside YAML block scalar
  • Renamed ArgoCD Application template from 120-ibm-spss-app.yaml → 120-ibm-cognos-analytics-app.yaml

SPSS Modeler (120-ibm-spss) — re-added with CPD 5.3.1 support

Re-added chart with OLM Subscription + SPSSModeler CR for CPD < 5.3.1
Added Helm-based install job for CPD 5.3.1+ installing canvasbase (v12.1.0, dependency) then spss (v12.1.0)
Added ArgoCD Application template 120-ibm-spss-app.yaml

Post-sync job (121-ibm-post-sync-job-cp4d-services)

Skip OLM-specific CCS/OpenSearch post-sync patching for CPD 5.3.1+
Bumped $_job_version to v2

RBAC

  • Added aicfgs resource to application-admin-role.yaml and per-namespace-rbac.yaml

Test Results

Tested on noble8 cluster with CPD 5.3.1 (inst02):

wml.noble8.inst02 → WmlBase/wml-cr Completed 100%
wsl.noble8.inst02 → Synced Healthy
spark.noble8.inst02 → Synced Healthy
cognos.noble8.inst02 → CAService/ca-addon-cr Completed 100%
spss.noble8.inst02 → canvasbase + spss Helm charts installed, canvasbase Completed 100%

image image

Sakshi-Singhroha1 and others added 30 commits July 21, 2026 11:22
- Gate OperandRegistry/OperandConfig to < 5.3.1 to prevent OLM
  resource drift when services are installed via Helm
- Gate spark-hb-control-plane patch job to < 5.3.1; OLM-managed
  deployment does not exist in Helm install model
- Add CRD establishment wait inside WSL install_component() between
  cluster-scoped apply and namespace-scoped helm upgrade to prevent
  race condition
- Extend Helm Job --wait timeout from 30m to 60m for WML, SPSS and
  Spark to match WSL and avoid premature timeout on loaded clusters
* Added CPD 5.3.1 gitops support

* [minor] Fix CatalogSources template - add CPD 5.3.1 block (MASCORE-15507)

* For CPD 5.3.1 services are installed via Helm

* MASCORE-15507: Fix WSL Helm Job - install deps in sequence; add Helm Jobs for WML, Spark, SPSS

* MASCORE-15507: Pass cpd_product_version to WSL, Spark, SPSS ArgoCD Applications

* MASCORE-15507: Fix heredoc in WSL Helm Job - use printf to avoid YAML/shell conflict

* Fix semver comparison - use toString to handle unquoted cpd_product_version value

* MASCORE-15507: skip OLM CCS/OpenSearch post-sync patching for CPD 5.3.1+

* MASCORE-15507: bump job version to v2 to force new job name after script change

* minor update

* changes undo

* MASCORE-15507: gate CCS/datarefinery/ws-runtimes OLM subscriptions behind < 5.3.1

* MASCORE-15507: fix semver comparison syntax - use .Compare pattern instead of lt(semver,semver)

* MASCORE-15507: install cluster-scoped chart first to register CRDs before namespace-scoped helm install

* MASCORE-15507: grant cpd-sa cluster-level CRD/ClusterRole permissions for Helm 5.3.1+ installs

* MASCORE-15507: expand cpd-sa ClusterRole with escalate, roles, CPD API groups for Helm install

* MASCORE-15507: pin cli image to digest instead of :latest in Helm install jobs

* adding temp changes for facilities

* undone postbackflow.sh script

* MASCORE-15507: fix CPD 5.3.1 Helm service install correctness

- Gate OperandRegistry/OperandConfig to < 5.3.1 to prevent OLM
  resource drift when services are installed via Helm
- Gate spark-hb-control-plane patch job to < 5.3.1; OLM-managed
  deployment does not exist in Helm install model
- Add CRD establishment wait inside WSL install_component() between
  cluster-scoped apply and namespace-scoped helm upgrade to prevent
  race condition
- Extend Helm Job --wait timeout from 30m to 60m for WML, SPSS and
  Spark to match WSL and avoid premature timeout on loaded clusters

---------

Co-authored-by: Sakshi Singhroha <Sakshi.Singhroha@ibm.com>
Co-authored-by: Nikita Kumble <nikitakumble@gmail.com>
… Jobs

Static-named ArgoCD sync hook Jobs (install-wsl-helm, install-wml-helm,
install-spss-helm, install-spark-helm) were failing with:
  'spec.template: Invalid value ... field is immutable'

This happens when an old Job with the same name exists from a prior sync
and ArgoCD tries to patch it. Since Job spec.template is immutable,
the patch is rejected.

Fix: add HookFailed to hook-delete-policy on all four Jobs so ArgoCD
deletes the Job on both success AND failure, ensuring no stale Job
exists when the next sync runs.
The wait loop was polling for:
  opensearchclusters.opensearch.cloudpackopen.ibm.com  (does not exist)

The actual CRD name registered by the IBM OpenSearch Helm chart is:
  clusters.opensearch.cloudpackopen.ibm.com

This caused the WSL Helm Job to always timeout after 5 minutes at
the OpenSearch step, blocking CCS, DataRefinery, WS-Runtimes and
WSL from ever installing.
…f oc wait

oc wait exits immediately with error if the resource does not exist.
The CCS CR (ccs-cr) is created by the CCS operator after Helm installs
it, so it is not immediately present. Replace oc wait with a polling
loop using --ignore-not-found, same pattern used for all other CRD
waits in this script. Polls every 30s up to 60 minutes.
@@ -0,0 +1,19 @@
{{- if lt (semver "5.3.1" | (semver (.Values.cpd_product_version | default "0.0.0" | toString)).Compare) 0 }}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

cognos analytics is required for cpd version >= 5.3.1 right? Can you check the condition if that is the case? Verify in all cognos related resource

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Cognos Analytics was not deployed via this GitOps repo before this story. It was newly added as part of MASCORE-15507 for CPD 5.3.1+ only via Helm. The OLM Subscription and CognosAnalytics CR have been removed. No version gate is needed — the Helm install always applies.

- -c
- |
set -e
helm repo add ibm-charts https://raw.githubusercontent.com/IBM/charts/master/repo/ibm-helm

@mnivedithaa mnivedithaa Aug 12, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

helm charts are installed using k8s job. Is there any particular reason to use this way instead of using helm chart as source directly? How does this behave whenever the job re-runs due to cli image update?

@mnivedithaa
mnivedithaa requested a review from rbinns August 12, 2026 16:42
Cognos Analytics is only available on CPD >= 5.3.1 and is installed
via Helm only. There is no OLM path for Cognos - it was never
available on CPD < 5.3.1. The Subscription file was incorrect.
Cognos Analytics is only available on CPD >= 5.3.1 via Helm.
There is no OLM/CR path for older versions. Removed the incorrect
version gate and the CognosAnalytics CR block that was gating on
CPD < 5.3.1.
Cognos Analytics was never deployed via this GitOps repo before this
story. It was newly added as part of MASCORE-15507 for CPD 5.3.1+
only via Helm. No OLM path is needed.

- Remove 00-ibm-cognos-analytics_Subscription.yaml entirely
- Remove version gate and CognosAnalytics CR block from
  01-ibm-cognos-analytics-cr.yaml — Helm install job always applies
The Ibmcpd CR spec.imagePullSecret was set to 'ibm_entitlement_key'
(underscores) instead of the actual Kubernetes Secret name
'ibm-entitlement-key' (dashes). This caused the CP4D operator's
Ansible playbook to fail to pull Common Services images, resulting in:
  'Fail to wait for commonservice CR to reach Succeeded status'

Fixes MASCORE-15507
… OutOfSync loop

When only an ArgoCD Hook Job exists in a chart (no non-hook resources),
ArgoCD enters an OutOfSync/Progressing loop after the job deletes itself
(HookSucceeded,HookFailed delete policy). The app shows OutOfSync because
ArgoCD sees zero managed resources.

Add a stable ConfigMap (sync-wave 091, before the hook job at 092) to
WML, Spark, SPSS, Cognos Analytics and WSL 5.3.1 Helm branches so
ArgoCD always has a persistent resource to track.

Fixes: wml.noble8.inst02, spark.noble8.inst02, spss.noble8.inst02
       cognos.noble8.inst02, wsl.noble8.inst02 OutOfSync/Progressing
… WSL

CI verify_chart_readme_tables.py requires every resource kind in a chart
to be documented in the README. The persistent ConfigMap added to the
CPD 5.3.1 Helm branches was not yet listed.

Fixes CI lint failure: 'resource kind not documented in README table: ConfigMap'
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants