You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@solr.apache.org by ho...@apache.org on 2022/03/21 18:46:09 UTC

[solr-operator] branch gh-pages updated: Upgrade documentation for v0.5.1 release

This is an automated email from the ASF dual-hosted git repository.

houston pushed a commit to branch gh-pages
in repository https://gitbox.apache.org/repos/asf/solr-operator.git


The following commit(s) were added to refs/heads/gh-pages by this push:
     new b8eee5e  Upgrade documentation for v0.5.1 release
b8eee5e is described below

commit b8eee5e458b26bbf37164cf94835c8c662b2d032
Author: Houston Putman <ho...@apache.org>
AuthorDate: Mon Mar 21 14:46:06 2022 -0400

    Upgrade documentation for v0.5.1 release
---
 docs/local_tutorial.md                     |  8 ++++----
 docs/running-the-operator.md               |  4 ++--
 docs/solr-cloud/solr-cloud-crd.md          |  2 +-
 docs/solr-prometheus-exporter/README.md    |  2 +-
 docs/upgrade-notes.md                      | 32 +++++++++++++++---------------
 example/test_solrcloud_addressability.yaml |  2 +-
 6 files changed, 25 insertions(+), 25 deletions(-)

diff --git a/docs/local_tutorial.md b/docs/local_tutorial.md
index 7ff80cb..2816c0f 100644
--- a/docs/local_tutorial.md
+++ b/docs/local_tutorial.md
@@ -90,9 +90,9 @@ This will install the [Zookeeper Operator](https://github.com/pravega/zookeeper-
 
 ```bash
 # Install the Solr & Zookeeper CRDs
-$ kubectl create -f https://solr.apache.org/operator/downloads/crds/v0.5.0/all-with-dependencies.yaml
+$ kubectl create -f https://solr.apache.org/operator/downloads/crds/v0.5.1/all-with-dependencies.yaml
 # Install the Solr operator and Zookeeper Operator
-$ helm install solr-operator apache-solr/solr-operator --version 0.5.0
+$ helm install solr-operator apache-solr/solr-operator --version 0.5.1
 ```
 
 _Note that the Helm chart version does not contain a `v` prefix, which the downloads version does. The Helm chart version is the only part of the Solr Operator release that does not use the `v` prefix._
@@ -123,7 +123,7 @@ To start a Solr Cloud cluster, we will create a yaml that will tell the Solr Ope
 
 ```bash
 # Create a 3-node cluster v8.3 with 300m Heap each:
-helm install example-solr apache-solr/solr --version 0.5.0 \
+helm install example-solr apache-solr/solr --version 0.5.1 \
   --set image.tag=8.3 \
   --set solrOptions.javaMemory="-Xms300m -Xmx300m" \
   --set addressability.external.method=Ingress \
@@ -210,7 +210,7 @@ So we wish to upgrade to a newer Solr version:
 curl -s http://default-example-solrcloud.ing.local.domain/solr/admin/info/system | grep solr-i
 
 # Update the solrCloud configuration with the new version, keeping all previous settings and the number of nodes set by the autoscaler.
-helm upgrade example-solr apache-solr/solr --version 0.5.0 \
+helm upgrade example-solr apache-solr/solr --version 0.5.1 \
   --reuse-values \
   --set image.tag=8.7
 
diff --git a/docs/running-the-operator.md b/docs/running-the-operator.md
index cd9e489..de3f925 100644
--- a/docs/running-the-operator.md
+++ b/docs/running-the-operator.md
@@ -38,8 +38,8 @@ Next, install the Solr Operator chart. Note this is using Helm v3, use the offic
 This will install the [Zookeeper Operator](https://github.com/pravega/zookeeper-operator) by default.
 
 ```bash
-$ kubectl create -f https://solr.apache.org/operator/downloads/crds/v0.5.0/all-with-dependencies.yaml
-$ helm install solr-operator apache-solr/solr-operator --version 0.5.0
+$ kubectl create -f https://solr.apache.org/operator/downloads/crds/v0.5.1/all-with-dependencies.yaml
+$ helm install solr-operator apache-solr/solr-operator --version 0.5.1
 ```
 
 _Note that the Helm chart version does not contain a `v` prefix, which the downloads version does. The Helm chart version is the only part of the Solr Operator release that does not use the `v` prefix._
diff --git a/docs/solr-cloud/solr-cloud-crd.md b/docs/solr-cloud/solr-cloud-crd.md
index 2e28f36..3c8892d 100644
--- a/docs/solr-cloud/solr-cloud-crd.md
+++ b/docs/solr-cloud/solr-cloud-crd.md
@@ -118,7 +118,7 @@ Under `SolrCloud.Spec.solrAddressability`:
   Currently available options are [`Ingress`](https://kubernetes.io/docs/concepts/services-networking/ingress/) and [`ExternalDNS`](https://github.com/kubernetes-sigs/external-dns).
   The goal is to support more methods in the future, such as LoadBalanced Services.
   - **`domainName`** - (Required) The primary domain name to open your cloud endpoints on. If `useExternalAddress` is set to `true`, then this is the domain that will be used in Solr Node names.
-  - **`additionalDomainNames`** - You can choose to listen on additional domains for each endpoint, however Solr will not register itself under these names.
+  - **`additionalDomains`** - You can choose to listen on additional domains for each endpoint, however Solr will not register itself under these names.
   - **`useExternalAddress`** - Use the external address to advertise the SolrNode. If a domain name is required for the chosen external `method`, then the one provided in `domainName` will be used.
   - **`hideCommon`** - Do not externally expose the common service (one endpoint for all solr nodes).
   - **`hideNodes`** - Do not externally expose each node. (This cannot be set to `true` if the cloud is running across multiple kubernetes clusters)
diff --git a/docs/solr-prometheus-exporter/README.md b/docs/solr-prometheus-exporter/README.md
index b00d0bf..c607c51 100644
--- a/docs/solr-prometheus-exporter/README.md
+++ b/docs/solr-prometheus-exporter/README.md
@@ -60,7 +60,7 @@ All ACL fields are **required** if an ACL is used.
 
 - **`secret`** - The name of the secret, in the same namespace as the SolrCloud, that contains the admin ACL username and password.
 - **`usernameKey`** - The name of the key in the provided secret that stores the admin ACL username.
-- **`usernameKey`** - The name of the key in the provided secret that stores the admin ACL password.
+- **`passwordKey`** - The name of the key in the provided secret that stores the admin ACL password.
 
 ### Standalone
 
diff --git a/docs/upgrade-notes.md b/docs/upgrade-notes.md
index eadd685..2b9e0a7 100644
--- a/docs/upgrade-notes.md
+++ b/docs/upgrade-notes.md
@@ -28,24 +28,24 @@ If you want to skip versions when upgrading, be sure to check out the [upgrading
 ### Kubernetes Versions
 
 | Solr Operator Version | `1.15` | `1.16` - `1.18` |  `1.19` - `1.21` | `1.22`+ |
-| :---: | :---: | :---: | :---: | :---: |
-| `v0.2.6` | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :x: |
-| `v0.2.7` | :x: | :heavy_check_mark: | :heavy_check_mark: | :x: |
-| `v0.2.8` | :x: | :heavy_check_mark: | :heavy_check_mark: | :x: |
-| `v0.3.0` | :x: | :heavy_check_mark: | :heavy_check_mark: | :x: |
-| `v0.4.0` | :x: | :heavy_check_mark: | :heavy_check_mark: | :x: |
-| `v0.5.0` | :x: | :x: | :heavy_check_mark: | :heavy_check_mark: |
+|:---------------------:| :---: | :---: | :---: | :---: |
+|       `v0.2.6`        | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :x: |
+|       `v0.2.7`        | :x: | :heavy_check_mark: | :heavy_check_mark: | :x: |
+|       `v0.2.8`        | :x: | :heavy_check_mark: | :heavy_check_mark: | :x: |
+|       `v0.3.x`        | :x: | :heavy_check_mark: | :heavy_check_mark: | :x: |
+|       `v0.4.x`        | :x: | :heavy_check_mark: | :heavy_check_mark: | :x: |
+|       `v0.5.x`        | :x: | :x: | :heavy_check_mark: | :heavy_check_mark: |
 
 ### Solr Versions
 
 | Solr Operator Version | `6.6` | `7.7` | `8.0` - `8.5` | `8.6`+ |
-| :---: | :---: | :---: | :---: | :---: | 
-| `v0.2.6` | :grey_question: | :heavy_check_mark: | :heavy_check_mark: | :x: |
-| `v0.2.7` | :grey_question: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
-| `v0.2.8` | :grey_question: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
-| `v0.3.0` | :grey_question: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
-| `v0.4.0` | :grey_question: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
-| `v0.5.0` | :grey_question: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
+|:---------------------:| :---: | :---: | :---: | :---: |
+|       `v0.2.6`        | :grey_question: | :heavy_check_mark: | :heavy_check_mark: | :x: |
+|       `v0.2.7`        | :grey_question: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
+|       `v0.2.8`        | :grey_question: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
+|       `v0.3.x`        | :grey_question: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
+|       `v0.4.x`        | :grey_question: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
+|       `v0.5.x`        | :grey_question: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
 
 Please note that this represents basic compatibility with the Solr Operator.
 There may be options and features that require newer versions of Solr.
@@ -97,8 +97,8 @@ If you are using the Solr Helm chart to deploy the Zookeeper operator, then you
 
 ```bash
 # Just replace the Solr CRDs and all CRDs it might depend on (e.g. ZookeeperCluster)
-kubectl replace -f "http://solr.apache.org/operator/downloads/crds/v0.5.0/all-with-dependencies.yaml"
-helm upgrade solr-operator apache-solr/solr-operator --version 0.5.0
+kubectl replace -f "http://solr.apache.org/operator/downloads/crds/v0.5.1/all-with-dependencies.yaml"
+helm upgrade solr-operator apache-solr/solr-operator --version 0.5.1
 ```
 
 _Note that the Helm chart version does not contain a `v` prefix, which the downloads version does. The Helm chart version is the only part of the Solr Operator release that does not use the `v` prefix._
diff --git a/example/test_solrcloud_addressability.yaml b/example/test_solrcloud_addressability.yaml
index 51193b6..24251fd 100644
--- a/example/test_solrcloud_addressability.yaml
+++ b/example/test_solrcloud_addressability.yaml
@@ -28,7 +28,7 @@ spec:
       method: Ingress
       useExternalAddress: false
       domainName: "kube.example.com"
-      additionalDomainNames:
+      additionalDomains:
         - "another.kube.example.com"
         - "another.kube.other.com"
       nodePortOverride: 80