The Solr Operator manages Apache Solr Clouds within Kubernetes. It is built on top of the Kube Builder framework.
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.
Please visit the following pages for documentation on using and developing the Solr Operator:
Do to the addition of possible sidecar/initContainers for SolrClouds, the version of CRDs used had to be upgraded to apiextensions.k8s.io/v1
.
This means that Kubernetes support is now limited to 1.16+. If you are unable to use a newer version of Kubernetes, please install the v0.2.6
version of the Solr Operator for use with Kubernetes 1.15 and below.
The location of backup-restore volume mounts in Solr containers has changed from /var/solr/solr-backup-restore
to /var/solr/data/backup-restore
. This change was made to ensure that there were no issues using the backup API with solr 8.6+, which restricts the locations that backup data can be saved to and read from. This change should be transparent if you are merely using the SolrBackup CRD. All files permissions issues with SolrBackups should now be addressed.
The default PodManagementPolicy
for StatefulSets has been changed to Parallel
from OrderedReady
. This change will not affect existing StatefulSets, as PodManagementPolicy
cannot be updated. In order to continue using OrderedReady
on new SolrClouds, please use the following setting:SolrCloud.spec.customSolrKubeOptions.statefulSetOptions.podManagementPolicy
The SolrCloud
and SolrPrometheusExporter
services' portNames have changed to "solr-client"
and "solr-metrics"
from "ext-solr-client"
and "ext-solr-metrics"
, respectively. This is due to a bug in Kubernetes where portName
and targetPort
must match for services.
Support for etcd
/zetcd
deployments has been removed.
The section for a Zookeeper cluster Spec SolrCloud.spec.zookeeperRef.provided.zookeeper
has been DEPRECATED. The same fields (except for the deprecated persistentVolumeClaimSpec
option) are now available under SolrCloud.spec.zookeeperRef.provided
.
Data Storage options have been expanded, and moved from their old locations.
SolrCloud.spec.dataPvcSpec
has been DEPRECATED.SolrCloud.spec.dataStorage.persistent.pvcTemplate.spec=<spec>
SolrCloud.spec.backupRestoreVolume
has been DEPRECATED.SolrCloud.spec.dataStorage.backupRestoreOptions.Volume=<volume-source>
--ingressBaseDomain
has been DEPRECATED. In order to set the external baseDomain of your clouds, please begin to use SolrCloud.spec.solrAddressability.external.domainName
instead. You will also need to set SolrCloud.spec.solrAddressability.external.method
to Ingress
. The --ingressBaseDomain
argument is backwards compatible, and all existing SolrCloud objects will be auto-updated once your operator is upgraded to v0.2.6
. The argument will be removed in a future version (v0.3.0
).v0.2.6
.SolrCloud.spec.solrPodPolicy
has been DEPRECATED in favor of the SolrCloud.spec.customSolrKubeOptions.podOptions
option.
This option is backwards compatible, but will be removed in a future version (v0.3.0
).
SolrPrometheusExporter.spec.solrPodPolicy
has been DEPRECATED in favor of the SolrPrometheusExporter.spec.customKubeOptions.podOptions
option.
This option is backwards compatible, but will be removed in a future version (v0.3.0
).
ZkCluster.Status
, which used an IP, to using the service name. This will cause a rolling restart of your solrs using the provided zookeeper option, but there will be no data loss.gomod
instead of dep
SolrCloud.spec.zookeeperRef.provided.zookeeper.persistentVolumeClaimSpec
has been DEPRECATED in favor of the SolrCloud.zookeeperRef.provided.zookeeper.persistence
option.v0.3.0
).0.2.4
is required.SolrCloud.Spec.persistentVolumeClaim
was renamed to SolrCloud.Spec.dataPvcSpec
If you require compatibility with previous versions, please install version v0.2.6
of the Solr Operator.
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 sending a Pull Request, please make sure you read our Contribution Guidelines.
Please read the LICENSE file here.
This project has adopted a Code of Conduct. If you have any concerns about the Code, or behavior which you have experienced in the project, please contact us at opensource@bloomberg.net.
If you believe you have identified a security vulnerability in this project, please send email to the project team at opensource@bloomberg.net, detailing the suspected issue and any methods you've found to reproduce it.
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.
Download Details:
Author: apache
Official Github: https://github.com/apache/solr-operator
License: Apache-2.0 license