Copilot commented on code in PR #863: URL: https://github.com/apache/solr-operator/pull/863#discussion_r4367447747
########## helm/solr/README.md: ########## @@ -33,7 +33,19 @@ There may be breaking changes between the version you are using and the version ### Installing the Chart -To install a SolrCloud for the first time in your cluster, you can use the latest version or a specific version, run with the following commands: +The Solr Helm chart can be installed either from the OCI registry (recommended) or from the deprecated HTTPS helm repository. + +> **Note:** The HTTPS Helm repository at `https://solr.apache.org/charts` is deprecated. +> Charts are published to both locations throughout the 0.x releases. +> Starting with `v1.0.0`, charts will be published to the OCI registry only. + +To install a SolrCloud for the first time in your cluster, you can use the latest version or a specific version: + +```bash +helm install example oci://ghcr.io/apache/solr-operator/helm/solr --version 0.10.0-prerelease --set image.tag=9.10.0 +``` + +Or, from the deprecated HTTPS Helm repository: ```bash helm install example apache-solr/solr --version 0.10.0-prerelease --set image.tag=9.10.0 Review Comment: Installing the operator through the newly recommended OCI path no longer registers the `apache-solr` Helm repository. A user who then chooses this HTTPS alternative gets `repo apache-solr not found`. Add `helm repo add apache-solr https://solr.apache.org/charts` to this installation block so the alternative also works after an OCI operator installation. ########## helm/solr-operator/README.md: ########## @@ -57,7 +77,14 @@ _Note that the Helm chart version does not contain a `v` prefix, which the downl If you are upgrading your Solr Operator deployment, you should always use a specific version of the chart and pre-install the Solr CRDS: ```bash +# Upgrade the CRDs first, then the chart kubectl replace -f https://solr.apache.org/operator/downloads/crds/v0.10.0-prerelease/all-with-dependencies.yaml +helm upgrade solr-operator oci://ghcr.io/apache/solr-operator/helm/solr-operator --version 0.10.0-prerelease +``` + +Or, from the deprecated HTTPS repository: + +```bash helm upgrade solr-operator apache-solr/solr-operator --version 0.10.0-prerelease Review Comment: The HTTPS upgrade alternative omits the CRD replacement that is now inside the OCI-only block. Following this alternative upgrades the operator while leaving existing CRDs at the old version, since Helm does not update installed CRDs. Include the same `kubectl replace` command here, or move it into a shared prerequisite before the two chart upgrade alternatives. ########## docs/modules/getting-started/pages/running-the-operator.adoc: ########## @@ -18,31 +18,41 @@ == Using the Solr Operator Helm Chart -The easiest way to run the Solr Operator is via the https://artifacthub.io/packages/helm/apache-solr/solr-operator[provided Helm Chart]. +The easiest way to run the Solr Operator is via the provided Helm Chart. The helm chart provides abstractions over the Input Arguments described below, and should work with any official images in docker hub. === How to install via Helm -The official documentation for installing the Solr Operator Helm chart can be found on https://artifacthub.io/packages/helm/apache-solr/solr-operator[Artifact Hub]. +The chart's values and changelog are listed on https://artifacthub.io/packages/helm/apache-solr/solr-operator[Artifact Hub]. -The first step is to add the Solr Operator helm repository. +The chart is published to the GitHub Container Registry as an OCI artifact. +Nothing needs to be added or configured first, and no credentials are required. -[source,bash] +Install the Solr Operator chart with the command below. +This will install the https://github.com/pravega/zookeeper-operator[Zookeeper Operator] by default. + +[source,bash,subs="verbatim,attributes"] ---- -$ helm repo add apache-solr https://solr.apache.org/charts -$ helm repo update +$ kubectl create -f https://solr.apache.org/operator/downloads/crds/v{operator-version}/all-with-dependencies.yaml +$ helm install solr-operator oci://ghcr.io/apache/solr-operator/helm/solr-operator --version {operator-version} ---- -Next, install the Solr Operator chart. Note this is using Helm v3, use the official Helm chart documentation linked to above. -This will install the https://github.com/pravega/zookeeper-operator[Zookeeper Operator] by default. +[NOTE] +==== +The chart is also still served from the HTTPS Helm repository at `https://solr.apache.org/charts`, which is deprecated: [source,bash,subs="verbatim,attributes"] ---- -$ kubectl create -f https://solr.apache.org/operator/downloads/crds/v{operator-version}/all-with-dependencies.yaml +$ helm repo add apache-solr https://solr.apache.org/charts +$ helm repo update Review Comment: The HTTPS alternative no longer creates the dependency CRDs: that command now appears only in the OCI installation block. On a fresh cluster, the default chart disables ZooKeeper CRD creation (`zookeeper-operator.crd.create: false`), so following only this alternative leaves the required `ZookeeperCluster` CRD missing. Include the CRD creation command in this block as well, or make it a shared prerequisite before both alternatives. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
