<!-- Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to You under the Apache License, Version 2.0 the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. -->

Solr Operator

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

The project is Production Ready, and has been successfully used to manage production SolrClouds for some of the largest users of Solr.

The API Version is still beta (v1beta1), and minor versions can have backwards-incompatible API changes. However, the Solr Operator will always have upgrade paths that are backwards-compatible. Please check the version compatibility and upgrade/deprecation notes for more information.

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

• Reference the version compatibility and upgrade/deprecation notes provided below
• Create a GitHub Issue in this repo, describing your problem with as much detail as possible
• Reach out on our Slack channel!

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

Menu

• Documentation
• Version Compatibility and Upgrade Notes
• Contributions
• License
• Code of Conduct
• Security Vulnerability Reporting

Documentation

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

• Local Tutorial
• Helm Instructions via Artifact Hub
  • The released helm charts and their instructions should be used for all safe and stable deployments. The charts found in helm/ are not guaranteed to be compatible with the last stable release, and should only be used for development purposes.
• Running the Solr Operator
• Known Issues
• Available Solr Resources
  • Solr Clouds
  • Solr Backups
  • Solr Metrics
• Development

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.

If you are trying to run tests locally in IntelliJ/GoLand, refer to the IDEA tests docs.

Please refer to the E2E/Integration Testing guide for information on how to run full integration tests for your changes.

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!