Skip to content

Replace gh-pages Helm install instructions with Artifactory OCI - #110

Draft
kk640244 wants to merge 2 commits into
mainfrom
kk640244-docs-oci-install
Draft

kk640244 wants to merge 2 commits into
mainfrom
kk640244-docs-oci-install

Conversation

@kk640244

@kk640244 kk640244 commented Oct 7, 2026

Copy link
Copy Markdown

Summary

  • The chart-publish pipeline now pushes the layer7-operator chart to Broadcom Artifactory as an OCI artifact instead of the classic gh-pages/index.yaml flow.
  • Updates charts/layer7-operator/README.md's Getting Started section from helm repo add .../caapim.github.io/... to helm registry login + helm upgrade -i ... oci://layer7.packages.broadcom.com/layer7-operator.
  • Updates example/Makefile and example/portal-integration/readme.md, which install apim-charts' Portal chart as part of the example flow, to the same OCI pattern (oci://layer7-portal.packages.broadcom.com/portal).

Merge readiness

Do not merge yet — pending end-to-end validation that helm pull/helm install against these OCI paths works without --version once the team has pushed the target number of chart releases to packages.broadcom.com.

Test plan

  • Confirm target releases are live on layer7.packages.broadcom.com / layer7-portal.packages.broadcom.com
  • helm registry login layer7.packages.broadcom.com -u <email> -p <token> succeeds
  • helm pull oci://layer7.packages.broadcom.com/layer7-operator succeeds without --version
  • helm upgrade -i layer7-operator oci://layer7.packages.broadcom.com/layer7-operator -n layer7-operator-system --create-namespace succeeds end-to-end

The chart-publish pipeline now pushes to Broadcom Artifactory as an OCI
artifact instead of the classic gh-pages index, so the documented install
flow needs to use helm registry login + oci:// install/upgrade instead of
helm repo add/update against caapim.github.io. Also updates the
example flow that installs apim-charts' Portal chart the same way, since
it moved to the same OCI-based distribution.

@Gazza7205 Gazza7205 left a comment

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.

Looks good to me.

The Makefile should take in environment variables and setting those should be a pre-req in the readme which also includes details of how to obtain a registry token.

We can address that now or in a later PR.

Addresses PR review feedback: the Makefile should take credentials from
environment variables instead of hardcoded placeholders, documented as a
prerequisite in the readme alongside how to obtain a registry token.

This branch has not been deployed

No deployments
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.

2 participants