Skip to content

Commit

Permalink
Clarify lack of 'standalone' Solr support (#733)
Browse files Browse the repository at this point in the history
The Solr-operator only has support for running Solr in "cloud" mode, as
evidenced by the required ZK coordinates and even the name of the
'solrcloud' custom resource.  But there are few explicit mentions of
this in the README or project docs.

This commit tweaks the docs to make this slightly more explicit.
  • Loading branch information
gerlowskija authored Jan 7, 2025
1 parent cbf5578 commit b2f1e8d
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 5 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
[![Docker Pulls](https://img.shields.io/docker/pulls/apache/solr-operator)](https://hub.docker.com/r/apache/solr-operator/)
[![Slack](https://img.shields.io/badge/slack-join_chat-white.svg?logo=slack&style=social)](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.

Expand Down
5 changes: 3 additions & 2 deletions docs/solr-cloud/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -131,4 +132,4 @@ spec:
repository: myprivate-repo.jfrog.io/solr
tag: 8.2.0
imagePullSecret: "k8s-docker-registry-secret"
```
```
4 changes: 2 additions & 2 deletions docs/solr-cloud/solr-cloud-crd.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down

0 comments on commit b2f1e8d

Please sign in to comment.