Repository navigation
Serve a Helm repository index that points at the OCI charts - #900
Merged
Merged
Conversation
Makes oci://ghcr.io/apache/solr-operator/helm the documented way to install both charts, and marks the HTTPS Helm repository at https://solr.apache.org/charts as deprecated. Installing from an OCI registry needs no 'helm repo add' and no credentials. Charts are published to both the OCI registry and the HTTPS repository throughout the 0.x releases, so nobody has to change anything on a patch upgrade. Starting with v1.0.0, charts will be published to the OCI registry only. A major version is the natural place to drop the old channel, and it gives users a version-anchored deadline rather than a date that slips with the release schedule. Artifact Hub still indexes the HTTPS repository. Migrating it would need one repo entry per chart and would change every existing artifacthub.io/packages/helm/apache-solr/... URL, so it is better done as part of the v1.0.0 cutover. Dual publishing keeps the current Artifact Hub entry accurate in the meantime. Requires the publishing tooling to be in place and the ghcr.io packages to be public first. Fixes apache#813
… for install docs Both charts gain 'added' and 'deprecated' artifacthub.io/changes entries for the OCI switch, so the change shows up in the Artifact Hub changelog for v0.10.0. running-the-operator.adoc called Artifact Hub "the official documentation for installing the Solr Operator Helm chart" a few lines above the text deprecating the HTTPS repository. Artifact Hub generates its install snippet from how the repository is registered, which is still the HTTPS Helm repo, so it contradicted the page it was on. Artifact Hub is now referenced once, as the place the chart's values and changelog are listed, with a note that its install command still uses the deprecated repository.
Update Helm repository instructions for Apache Solr. Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
The step only appeared in the OCI block, so following the HTTPS alternative left the ZookeeperCluster CRD missing.
The HTTPS alternative skipped the step its own introduction calls for.
The docs said charts would be published to the OCI registry only "starting with v1.0.0". We are not ready to commit to when the HTTPS repository stops being updated, so the wording is now open-ended: charts go to both locations for now, and the HTTPS repository will be retired in a future release. The deprecation itself is unchanged, and the upgrade notes promise the retirement will be announced in advance rather than naming a version. Removing the deadline also drops the "update your automation before upgrading to v1.0.0" instruction, which is now phrased as a recommendation.
The deprecation notice was repeated on five pages: the top-level README, the local-tutorial and running-the-operator docs, and both chart READMEs. That is five places to keep in sync, and they had already started to drift. The upgrade notes are now the single place that explains it, under the existing "Where the Helm charts are published" anchor. Everywhere else that needs to mention the old repository links there instead: the Antora pages with an xref, and the Markdown READMEs with an absolute link to the published page, since they are also rendered on Artifact Hub where a relative link would not resolve. The HTTPS install snippet in running-the-operator.adoc is kept, since it is still a working alternative; only the repeated explanation is gone.
Installing via OCI never registers apache-solr, so each HTTPS alternative has to add it to stand on its own.
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.
janhoy
approved these changes
Nov 18, 2026
Contributor
Author
|
Yeah I didn't mean for this to be the default way. We should still advertise the OCI way first and merge #863. Maybe we can have Antora tabs to differentiate the two methods like we do for v1 and v2 apis in Solr. |
… source Brings in apache#863, adjusted for the Helm repository now listing the OCI charts, so both chart sources are supported rather than the HTTPS repository being deprecated. - The Antora pages show both sources as tabs, "OCI Charts" (the default) and "Charts Repo". The tutorial's tabs are synced, so the choice carries through every step. - The chart READMEs, which are Markdown, use matching "OCI Charts" and "Charts Repo" subsections. - The deprecation notes and changelog entries are replaced by entries for the OCI charts and for the repository listing them. Changes made on main since apache#863 branched (changelog entries, the 9.11.0 image tag, the logging note) are kept.
The charts are signed, but the docs never said how to verify them. Add a "Verifying the Helm charts" section to the upgrade notes, with both chart sources as tabs, and link it from the install docs and the chart READMEs. --verify is not added to every install command, since it needs the Solr KEYS exported to a legacy-format keyring first: Helm reads ~/.gnupg/pubring.gpg by default, which GnuPG 2.1 and later no longer write.
Contributor
Author
|
This now incorporates the changes from #863, merged in with all of its commits, so that the docs present both chart sources:
Once this is merged, #863 can be closed as superseded. |
# Conflicts: # docs/modules/upgrade-notes/pages/upgrade-notes.adoc # helm/solr-operator/Chart.yaml # helm/solr/Chart.yaml
janhoy
approved these changes
Nov 19, 2026
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.
Part of #813, and supersedes #863.
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,local-tutorial,upgrade-notes) show both sources as tabs, OCI Charts (default) and Charts Repo. The tutorial's tabs are synced, so the choice carries through every step.addedentry for the OCI charts and achangedentry for the repository listing them (Helm 3.8+), in place of Document the OCI registry as the default Helm chart source #863'sdeprecatedentry.dev-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.