From 52366ab85ed84e441e2a6f60e1069547d5e36b08 Mon Sep 17 00:00:00 2001 From: Jason Gerlowski Date: Thu, 12 Dec 2024 12:47:04 -0500 Subject: [PATCH] Clarify lack of 'standalone' Solr support 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. --- README.md | 2 +- docs/solr-cloud/README.md | 5 +++-- docs/solr-cloud/solr-cloud-crd.md | 4 ++-- 3 files changed, 6 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index a4702d79..e7d6103e 100644 --- a/README.md +++ b/README.md @@ -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. diff --git a/docs/solr-cloud/README.md b/docs/solr-cloud/README.md index 9d13bb8f..d8478836 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 c1053cd1..5eaf6e9d 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)