Skip to content

Commit

Permalink
Upgrade documentation for v0.8.1 release
Browse files Browse the repository at this point in the history
  • Loading branch information
gerlowskija committed Apr 12, 2024
1 parent c91d9d1 commit 80d3e4f
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 12 deletions.
14 changes: 7 additions & 7 deletions docs/local_tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.8.0/all-with-dependencies.yaml
$ kubectl create -f https://solr.apache.org/operator/downloads/crds/v0.8.1/all-with-dependencies.yaml
# Install the Solr operator and Zookeeper Operator
$ helm install solr-operator apache-solr/solr-operator --version 0.8.0
$ helm install solr-operator apache-solr/solr-operator --version 0.8.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._
Expand Down Expand Up @@ -122,9 +122,9 @@ After inspecting the status of you Kube cluster, you should see a deployment for
To start a Solr Cloud cluster, we will create a yaml that will tell the Solr Operator what version of Solr Cloud to run, and how many nodes, with how much memory etc.

```bash
# Create a 3-node cluster v8.11 with 300m Heap each:
helm install example-solr apache-solr/solr --version 0.8.0 \
--set image.tag=8.11 \
# Create a 3-node cluster v8.11.2 with 300m Heap each:
helm install example-solr apache-solr/solr --version 0.8.1 \
--set image.tag=8.11.2 \
--set solrOptions.javaMemory="-Xms300m -Xmx300m" \
--set addressability.external.method=Ingress \
--set addressability.external.domainName="ing.local.domain" \
Expand Down Expand Up @@ -211,9 +211,9 @@ 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.8.0 \
helm upgrade example-solr apache-solr/solr --version 0.8.1 \
--reuse-values \
--set image.tag=8.7
--set image.tag=8.11.3
# Click the 'Show all details" button in Admin UI and start hitting the "Refresh" button
# See how the operator upgrades one pod at a time. Solr version is in the 'node' column
Expand Down
4 changes: 2 additions & 2 deletions docs/running-the-operator.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.8.0/all-with-dependencies.yaml
$ helm install solr-operator apache-solr/solr-operator --version 0.8.0
$ kubectl create -f https://solr.apache.org/operator/downloads/crds/v0.8.1/all-with-dependencies.yaml
$ helm install solr-operator apache-solr/solr-operator --version 0.8.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._
Expand Down
9 changes: 8 additions & 1 deletion docs/solr-cloud/solr-cloud-crd.md
Original file line number Diff line number Diff line change
Expand Up @@ -1000,6 +1000,12 @@ Take a moment to review these authorization rules so that you're aware of the ro
"name": "k8s-probe-0",
"role": null,
"collection": null,
"path": "/admin/info/system"
},
{
"name": "k8s-probe-1",
"role": null,
"collection": null,
"path": "/admin/info/health"
},
{
Expand Down Expand Up @@ -1057,7 +1063,7 @@ A few aspects of the default `security.json` configuration warrant a closer look
"name": "k8s-probe-0",
"role": null,
"collection": null,
"path": "/admin/info/health"
"path": "/admin/info/system"
}
```
In this case, the `"role":null` indicates this endpoint allows anonymous access by unknown users.
Expand Down Expand Up @@ -1153,6 +1159,7 @@ _Note: be sure to use a stronger password for real deployments_

Users need to ensure their `security.json` contains the user supplied in the `basicAuthSecret` has read access to the following endpoints:
```
/admin/info/system
/admin/info/health
/admin/collections
/admin/metrics
Expand Down
4 changes: 2 additions & 2 deletions docs/upgrade-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,8 +113,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.8.0/all-with-dependencies.yaml"
helm upgrade solr-operator apache-solr/solr-operator --version 0.8.0
kubectl replace -f "http://solr.apache.org/operator/downloads/crds/v0.8.1/all-with-dependencies.yaml"
helm upgrade solr-operator apache-solr/solr-operator --version 0.8.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._
Expand Down

0 comments on commit 80d3e4f

Please sign in to comment.