Skip to content

Commit 90f10f3

Browse files
Better messaging around supported Solr images. (#373)
1 parent f3075c0 commit 90f10f3

File tree

2 files changed

+18
-3
lines changed

2 files changed

+18
-3
lines changed

docs/solr-cloud/README.md

+12-3
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ This page outlines how to create, update and delete a SolrCloud in Kubernetes.
3232

3333
## Creating an example SolrCloud
3434

35-
Make sure that the solr-operator and a zookeeper-operator are running.
35+
Make sure that the Solr Operator and a Zookeeper Operator are running.
3636

3737
Create an example Solr cloud, with the following configuration.
3838

@@ -98,11 +98,20 @@ $ kubectl delete solrcloud example
9898

9999
### Official Solr Images
100100

101-
The solr-operator will work with any of the [official Solr images](https://hub.docker.com/_/solr) currently available.
101+
The Solr Operator is only guaranteed to work with [official Solr images](https://hub.docker.com/_/solr).
102+
However, as long as your custom image is built to be compatible with the official image, things should go smoothly.
103+
This is especially true starting with Solr 9, where the docker image creation is bundled within Solr.
104+
Run `./gradlew docker` in the Solr repository, and your custom Solr additions will be packaged into an officially compliant Solr Docker image.
105+
106+
Please refer to the [Version Compatibility Matrix](../upgrade-notes.md#solr-versions) for more information on what Solr Versions are compatible with the Solr Operator.
107+
108+
Also note that certain features available within the Solr Operator are only supported in newer Solr Versions.
109+
The version compatibility matrix shows the minimum Solr version supported for **most** options.
110+
Please refer to the Solr Reference guide to see what features are enabled for the Solr version you are running.
102111

103112
### Build Your Own Private Solr Images
104113

105-
The solr-operator supports private Docker repo access for Solr images you may want to store in a private Docker repo. It is recommended to source your image from the official Solr images.
114+
The Solr Operator supports private Docker repo access for Solr images you may want to store in a private Docker repo. It is recommended to source your image from the official Solr images.
106115

107116
Using a private image requires you have a K8s secret preconfigured with appropriate access to the image. (type: kubernetes.io/dockerconfigjson)
108117

docs/upgrade-notes.md

+6
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,12 @@ If you want to skip versions when upgrading, be sure to check out the [upgrading
4747
| `v0.4.0` | :grey_question: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
4848
| `v0.5.0` | :grey_question: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
4949

50+
Please note that this represents basic compatibility with the Solr Operator.
51+
There may be options and features that require newer versions of Solr.
52+
(e.g. S3/GCS Backup Support)
53+
54+
Please test to make sure the features you plan to use are compatible with the version of Solr you choose to run.
55+
5056

5157
### Upgrading from `v0.2.x` to `v0.3.x`
5258
If you are upgrading from `v0.2.x` to `v0.3.x`, please follow the [Upgrading to Apache guide](upgrading-to-apache.md).

0 commit comments

Comments
 (0)