Repository navigation
Serve a Helm repository index that points at the OCI charts - #900
Open
HoustonPutman wants to merge 2 commits into
Open
HoustonPutman wants to merge 2 commits into
HoustonPutman wants to merge 2 commits into
Conversation
Starting with v0.10.0 the Helm charts are only distributed as OCI artifacts on ghcr.io. Keep 'helm repo add apache-solr https://solr.apache.org/charts' working by serving an index.yaml from solr-site whose entries point at the OCI copies (oci://ghcr.io/apache/solr-operator/helm/<chart>:<version>), instead of at tarballs uploaded to nightlies.apache.org. - hack/release/upload/update_helm_index.sh adds a release to that index. It verifies the released charts, replaces existing entries in place (for backfilling older releases), refuses digest changes, and signs the index. - hack/release/smoke_test/test_oci_index.sh checks that Helm 3.8.2, 3.19.0 and 4.3.1 can consume such an index: repo add/update, search, show, pull, --verify, install-style resolution and dependency update. It runs in the new "Helm OCI Index" workflow. - The release wizard drops the nightlies upload, and adds a website step that updates the index after the charts are published to the OCI registry. - Docs, upgrade notes and the chart changelogs note the Helm 3.8 minimum.
3 tasks
The test script is meant to be run locally when the index tooling changes.
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Starting with v0.10.0 the Helm charts are only distributed as OCI artifacts on
ghcr.io/apache/solr-operator/helm. This keepshelm repo add apache-solr https://solr.apache.org/chartsworking, by serving anindex.yamlfrom solr-site whose entries point at the OCI copies instead of at tarballs on nightlies.apache.org:The companion solr-site change serves this index: apache/solr-site#260 (draft).
Changes
hack/release/upload/update_helm_index.shadds a release to the index. It downloads the released charts, verifies their checksums and signatures, and writesoci://entries fromhelm repo indexmetadata. It also signs the index and writes its checksum.createddate. This is the path for backfilling older releases.-cbefore it will create a new index.hack/release/smoke_test/test_oci_index.shpackages and signs the charts and pushes them to a TLSregistry:2. It generates the index with the script above and serves it, then checks each Helm version. The registry, the index server and each Helm version all run in containers. It is meant to be run locally when changing the index tooling, and is not run in CI.publish_helm_charts).website_update_helm_index, which updates the index in the solr-site checkout afterpublish_helm_charts_oci.publish_websitenow ends with ahelm repo add/helm show chartcheck against the live site, and the ArtifactHub check now waits for the site to be published.running-the-operator, the chart README and both chart changelogs note the Helm 3.8 minimum and the directoci://install. Newdev-docs/helm-repository.mdcovers maintaining the index and backfilling.Testing
./hack/release/smoke_test/test_oci_index.sh, run locally: 36/36 checks passed across Helm 3.8.2, 3.19.0 and 4.3.1.oci://pullrepo add/repo update/search repo/show chartpull(byte-identical to the released tgz) andpull --verifyhelm template, with and without--verify)dependency updatewith both a repository url and an@aliasStill to do (not in this PR)
content/charts/index.yamlin solr-site from the current nightlies index before the site change merges, or/chartsbreaks.publish-helm-oci.yaml, then rewrite their entries withupdate_helm_index.sh. Older releases without.provfiles will fail in that workflow.oci://urls in a classic index after the first publish. This has not been tested.upload_helm.shonce the backfill is done.