Solr Operator Documentation

Solr Operator

Latest Version License Artifact HUB Commit since last release Docker Pulls Slack

The Solr Operator manages Apache Solr Clouds within Kubernetes. It is built on top of the Kube Builder framework. Please visit the official site for more information.

The project is currently in beta (v1beta1), and while we do not anticipate changing the API in backwards-incompatible ways there is no such guarantee yet.

If you run into issues using the Solr Operator, please:

Join us on the #solr-operator channel in the official Kubernetes slack workspace.

Documentation

Please visit the following pages for documentation on using and developing the Solr Operator:

Examples

Example uses of each CRD have been provided.

Version Compatibility & Upgrade Notes

Make sure to check the Solr Operator Upgrade notes, before upgrading the Solr Operator or CRDs in your Kubernetes cluster.

This page also contains Version Compatibility Matrixes, which detail the compatible Solr versions and Kubernetes versions for each release of the Solr Operator.

Contributions

We :heart: contributions.

Have you had a good experience with the Solr Operator? Why not share some love and contribute code, or just let us know about any issues you had with it?

We welcome issue reports here; be sure to choose the proper issue template for your issue, so that we can be sure you’re providing the necessary information.

Before submitting a PR, please be sure to run make prepare before committing. Otherwise the GitHub checks are likely to fail.

License

Please read the LICENSE file here.

Docker Image Licenses

The Solr Operator docker image contains NOTICE and LICENSE information in the /etc/licenses directory. This is different from the source release LICENSE and NOTICE files, so make sure to familiarize yourself when using the image.

Code of Conduct

This space applies the ASF Code of Conduct If you have any concerns about the Code, or behavior which you have experienced in the project, please contact us at private@solr.apache.org .

Security Vulnerability Reporting

If you believe you have identified a security vulnerability in this project, please send email to the ASF security team at security@solr.apache.org, detailing the suspected issue and any methods you’ve found to reproduce it. More details can be found here

Please do NOT open an issue in the GitHub repository, as we’d prefer to keep vulnerability reports private until we’ve had an opportunity to review and address them.

Acknowledgements

The Solr Operator was donated to Apache Solr by Bloomberg, after the v0.2.8 release. Many thanks to their contributions over the years!