Skip to content

Commit

Permalink
Better messaging around supported Solr images. (#373)
Browse files Browse the repository at this point in the history
  • Loading branch information
HoustonPutman authored Nov 10, 2021
1 parent f3075c0 commit 90f10f3
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 3 deletions.
15 changes: 12 additions & 3 deletions docs/solr-cloud/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ This page outlines how to create, update and delete a SolrCloud in Kubernetes.

## Creating an example SolrCloud

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

Create an example Solr cloud, with the following configuration.

Expand Down Expand Up @@ -98,11 +98,20 @@ $ kubectl delete solrcloud example

### Official Solr Images

The solr-operator will work with any of the [official Solr images](https://hub.docker.com/_/solr) currently available.
The Solr Operator is only guaranteed to work with [official Solr images](https://hub.docker.com/_/solr).
However, as long as your custom image is built to be compatible with the official image, things should go smoothly.
This is especially true starting with Solr 9, where the docker image creation is bundled within Solr.
Run `./gradlew docker` in the Solr repository, and your custom Solr additions will be packaged into an officially compliant Solr Docker image.

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.

Also note that certain features available within the Solr Operator are only supported in newer Solr Versions.
The version compatibility matrix shows the minimum Solr version supported for **most** options.
Please refer to the Solr Reference guide to see what features are enabled for the Solr version you are running.

### Build Your Own Private Solr Images

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.
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.

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

Expand Down
6 changes: 6 additions & 0 deletions docs/upgrade-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,12 @@ If you want to skip versions when upgrading, be sure to check out the [upgrading
| `v0.4.0` | :grey_question: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
| `v0.5.0` | :grey_question: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |

Please note that this represents basic compatibility with the Solr Operator.
There may be options and features that require newer versions of Solr.
(e.g. S3/GCS Backup Support)

Please test to make sure the features you plan to use are compatible with the version of Solr you choose to run.


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

0 comments on commit 90f10f3

Please sign in to comment.