Repository navigation
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.
3 of 6 tasks
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
The standalone HTTPS alternatives omit prerequisite commands needed for reliable installation and upgrades.
3 open issues
What changed in this PR
Makes OCI the recommended Helm chart source for Solr Operator and SolrCloud, following the publishing tooling work. Documents dual publishing throughout 0.x and the OCI-only transition at v1.0.0.
Changes:
- Updates installation and upgrade examples to use OCI URLs.
- Marks the HTTPS repository as deprecated while retaining alternative instructions.
- Adds publishing guidance and Artifact Hub changelog entries.
| File | Description |
|---|---|
| README.md | Introduces OCI installation commands and the deprecation timeline. |
| helm/solr/README.md | Adds OCI installation and upgrade examples alongside HTTPS alternatives. |
| helm/solr/Chart.yaml | Records OCI availability and HTTPS deprecation in the changelog. |
| helm/solr-operator/README.md | Makes OCI the primary installation and upgrade path. |
| helm/solr-operator/Chart.yaml | Adds chart distribution and deprecation changelog entries. |
| docs/modules/upgrade-notes/pages/upgrade-notes.adoc | Explains publishing channels and updates upgrade guidance. |
| docs/modules/getting-started/pages/running-the-operator.adoc | Leads with OCI installation and retains an HTTPS alternative. |
| docs/modules/getting-started/pages/local-tutorial.adoc | Switches tutorial installation and upgrade commands to OCI. |
Review effort: Balanced
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.
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.
Part of the overall epic #813
Follows #814, which added the publishing tooling without changing anything users see. This one makes the switch.
Makes
oci://ghcr.io/apache/solr-operator/helmthe documented way to install both charts, and markshttps://solr.apache.org/chartsas deprecated. Installing from OCI needs nohelm repo addand no credentials.Deprecation plan
Charts go to both channels throughout the 0.x releases, so no patch upgrade breaks. From
v1.0.0, the OCI registry only — a major version gives a version-anchored deadline instead of a date that slips.What changed
README.mdand therunning-the-operator,local-tutorialandupgrade-notesAntora pages lead with OCI.upgrade-notes.adocgains a "Where the Helm charts are published" section and a v0.10.0 entry pointing at it.Chart.yamlfiles gainartifacthub.io/changesentries, so the switch shows up in the Artifact Hub changelog.Verified before opening
v0.8.1 and v0.9.1 are published and anonymously pullable from the OCI registry with
helm pull --verify, no credentials and nohelm registry login.Not in this PR
Re-configuring Artifact Hub to list the OCI charts is manual work in their control panel and is tracked in #862.