This is an automated email from the ASF dual-hosted git repository.
gerlowskija 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 94fe518 Upgrade documentation for v0.9.0 release
94fe518 is described below
commit 94fe518a671273a28bd14305911f12aa2c4b8ea7
Author: Jason Gerlowski <[email protected]>
AuthorDate: Wed Jan 22 22:34:16 2025 -0500
Upgrade documentation for v0.9.0 release
---
README.md | 2 +-
docs/development.md | 5 +++++
docs/local_tutorial.md | 14 +++++++-------
docs/running-the-operator.md | 4 ++--
docs/solr-cloud/README.md | 5 +++--
docs/solr-cloud/solr-cloud-crd.md | 4 ++--
docs/upgrade-notes.md | 4 ++--
7 files changed, 22 insertions(+), 16 deletions(-)
diff --git a/README.md b/README.md
index a4702d7..e7d6103 100644
--- a/README.md
+++ b/README.md
@@ -23,7 +23,7 @@
[](https://hub.docker.com/r/apache/solr-operator/)
[](https://kubernetes.slack.com/messages/solr-operator)
-The __[Solr Operator](https://solr.apache.org/operator/)__ is the official way
of managing an Apache Solr ecosystem within Kubernetes.
+The __[Solr Operator](https://solr.apache.org/operator/)__ is the official way
of managing Apache SolrCloud deployments within Kubernetes.
It is built on top of the [Kube
Builder](https://github.com/kubernetes-sigs/kubebuilder) framework.
Please visit the [official site](https://solr.apache.org/operator/) for more
information.
diff --git a/docs/development.md b/docs/development.md
index f8d005a..cf9907c 100644
--- a/docs/development.md
+++ b/docs/development.md
@@ -55,6 +55,11 @@ export PATH="$PATH:$GOPATH/bin" # You likely want to add
this line to your ~/.ba
make install-dependencies
```
+Note: if you have previously installed/older versions of dependencies, you can
first clear these dependencies with:
+```bash
+make clean
+```
+
## Build the Solr CRDs
If you have changed anything in the [APIs directory](/api/v1beta1), you will
need to run the following command to regenerate all Solr CRDs.
diff --git a/docs/local_tutorial.md b/docs/local_tutorial.md
index 3574105..f292373 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.8.1/all-with-dependencies.yaml
+$ kubectl create -f
https://solr.apache.org/operator/downloads/crds/v0.9.0/all-with-dependencies.yaml
# Install the Solr operator and Zookeeper Operator
-$ helm install solr-operator apache-solr/solr-operator --version 0.8.1
+$ helm install solr-operator apache-solr/solr-operator --version 0.9.0
```
_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._
@@ -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.2 with 300m Heap each:
-helm install example-solr apache-solr/solr --version 0.8.1 \
- --set image.tag=8.11.2 \
+# Create a 3-node cluster v8.11 with 300m Heap each:
+helm install example-solr apache-solr/solr --version 0.9.0 \
+ --set image.tag=8.11 \
--set solrOptions.javaMemory="-Xms300m -Xmx300m" \
--set addressability.external.method=Ingress \
--set addressability.external.domainName="ing.local.domain" \
@@ -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.1 \
+helm upgrade example-solr apache-solr/solr --version 0.9.0 \
--reuse-values \
- --set image.tag=8.11.3
+ --set image.tag=8.7
# 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
diff --git a/docs/running-the-operator.md b/docs/running-the-operator.md
index 4a063f4..8dc591b 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.8.1/all-with-dependencies.yaml
-$ helm install solr-operator apache-solr/solr-operator --version 0.8.1
+$ kubectl create -f
https://solr.apache.org/operator/downloads/crds/v0.9.0/all-with-dependencies.yaml
+$ helm install solr-operator apache-solr/solr-operator --version 0.9.0
```
_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/README.md b/docs/solr-cloud/README.md
index 9d13bb8..d847883 100644
--- a/docs/solr-cloud/README.md
+++ b/docs/solr-cloud/README.md
@@ -22,7 +22,8 @@ Child Pages:
- [Managed Updates](managed-updates.md)
- [Scaling](scaling.md)
-The Solr Operator supports creating and managing Solr Clouds.
+The Solr Operator supports creating and managing Solr Clouds clusters via its
'solrcloud' resource.
+(Note: running Solr in "standalone" mode is not supported.)
This page outlines how to create, update and delete a SolrCloud in Kubernetes.
@@ -131,4 +132,4 @@ spec:
repository: myprivate-repo.jfrog.io/solr
tag: 8.2.0
imagePullSecret: "k8s-docker-registry-secret"
-```
\ No newline at end of file
+```
diff --git a/docs/solr-cloud/solr-cloud-crd.md
b/docs/solr-cloud/solr-cloud-crd.md
index c1053cd..5eaf6e9 100644
--- a/docs/solr-cloud/solr-cloud-crd.md
+++ b/docs/solr-cloud/solr-cloud-crd.md
@@ -171,9 +171,9 @@ Please refer to the [SolrBackup
documentation](../solr-backup) for more informat
## Zookeeper Reference
-Solr Clouds require an Apache Zookeeper to connect to.
+All SolrCloud resources run Solr in "cloud" mode, and require access to an
Apache ZooKeeper cluster for state-management.
-The Solr operator gives a few options.
+The Solr operator gives a few options for ZooKeeper access:
- Connecting to an already running zookeeper ensemble via [connection
strings](#zk-connection-info)
- [Spinning up a provided](#provided-instance) Zookeeper Ensemble in the same
namespace via the [Zookeeper
Operator](https://github.com/pravega/zookeeper-operator)
diff --git a/docs/upgrade-notes.md b/docs/upgrade-notes.md
index a117bc4..b9b4282 100644
--- a/docs/upgrade-notes.md
+++ b/docs/upgrade-notes.md
@@ -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.1/all-with-dependencies.yaml";
-helm upgrade solr-operator apache-solr/solr-operator --version 0.8.1
+kubectl replace -f
"http://solr.apache.org/operator/downloads/crds/v0.9.0/all-with-dependencies.yaml";
+helm upgrade solr-operator apache-solr/solr-operator --version 0.9.0
```
_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._
