Solr Operator Upgrade Notes

Please carefully read the entries for all versions between the version you are running and the version you want to upgrade to.

Ensure to read the Upgrade Warnings and Notes for the version you are upgrading to as well as the versions you are skipping.

If you want to skip versions when upgrading, be sure to check out the [upgrading-minor-versions-vxa-vxb] and [upgrading-patch-versions-vxya-vzyb] sections.

Version Compatibility Matrixes

Kubernetes Versions

Solr Operator Version 1.15 1.16 - 1.18 1.19 - 1.20 1.21 1.22+

v0.2.6

YES

YES

YES

YES

NO

v0.2.7

NO

YES

YES

YES

NO

v0.2.8

NO

YES

YES

YES

NO

v0.3.x

NO

YES

YES

YES

NO

v0.4.x

NO

YES

YES

YES

NO

v0.5.x

NO

NO

YES

YES

YES

v0.6.x

NO

NO

YES

YES

YES

v0.7.x

NO

NO

NO

YES

YES

v0.8.x

NO

NO

NO

NO

YES

v0.9.x

NO

NO

NO

NO

YES

v0.10.x

NO

NO

NO

NO

YES

Solr Versions

Solr Operator Version 7.7 8.0 - 8.10 8.11 9.0 - 9.3 9.4+ 10.0+

v0.2.7

YES

YES

YES

NO

NO

NO

v0.2.8

YES

YES

YES

NO

NO

NO

v0.3.x

YES

YES

YES

NO

NO

NO

v0.4.x

YES

YES

YES

NO

NO

NO

v0.5.x

YES

YES

YES

NO

NO

NO

v0.6.x

YES

YES

YES

YES 1

YES 1

NO

v0.7.x

YES

YES

YES

YES 1

YES 1

NO

v0.8.x

NO

NO

YES

YES 1

YES

NO

v0.9.x

NO

NO

YES

YES 1

YES

NO

v0.10.x

NO

NO

YES

YES 1

YES

YES 2

Exceptions

  • 1 SolrTLS and SolrClientTLS are not supported

  • 2 The SolrPrometheusExporter is not supported, because solr-exporter was removed in Solr 10

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.

Upgrade Instructions

Please follow the instructions below when upgrading the Solr Operator.

However, no matter the upgrade, always read the Upgrade Warnings and Notes for every version between

Upgrading minor versions (vX.A. → vX.B.)

In order to upgrade minor versions (e.g. v0.2.5 → v0.3.0), you must upgrade one minor version at a time (e.g. v0.2.0 → v0.3.0 → v0.4.0). It is also necessary to upgrade to the latest patch version before upgrading to the next minor version. Therefore if you are running v0.2.5 and you want to upgrade to v0.3.0, you must first upgrade to v0.2.8 before upgrading to v0.3.0.

There when upgrading minor versions, there may be CRD options that have been deprecated. The Solr Operator will automatically change the existing Solr resources to use the new format. Therefore when upgrading to the next version, which may remove the deprecated option, the existing resources will behave correctly. However, creating new resources with the deprecated options will fail. Be sure to carefully read the Upgrade Warnings and Notes to be sure you are not using deprecated options.

Upgrading patch versions (vX.Y.A → vZ.Y.B)

You should be able to upgrade from a version to any patch version with the same minor and major versions. It is always encouraged to upgrade to the latest patch version of the minor and major version you are running. There is no need to upgrade one patch version at a time (e.g. v0.2.5 → v0.2.6 → v0.2.7 → v0.2.8), instead you can leap to the latest patch version (e.g. v0.2.5 → v0.2.8).

Where the Helm charts are published

The Solr Operator and Solr Helm charts are published as OCI artifacts to the GitHub Container Registry, at oci://ghcr.io/apache/solr-operator/helm. They can be installed either straight from the registry, or through the Helm repository at https://solr.apache.org/charts, which lists the same charts. Both are supported.

  • OCI Charts

  • Charts Repo

Installing from the OCI registry needs no helm repo add, and no credentials.

helm install solr-operator oci://ghcr.io/apache/solr-operator/helm/solr-operator --version 0.10.0
helm install example oci://ghcr.io/apache/solr-operator/helm/solr --version 0.10.0

The Helm repository’s entries point at the OCI registry, so it serves exactly the same charts. It requires Helm v3.8 or later, and keeps existing helm repo add setups and chart dependencies on https://solr.apache.org/charts working.

helm repo add apache-solr https://solr.apache.org/charts
helm repo update
helm install solr-operator apache-solr/solr-operator --version 0.10.0
helm install example apache-solr/solr --version 0.10.0

The signed chart tarballs on the Apache download mirrors remain the official release artifacts. The OCI copies are byte-identical to them, and carry the same signatures, so the charts can be verified with either source. See Verifying the Helm charts.

Verifying the Helm charts

The charts are signed with the Solr release signing keys, and Helm can check that signature when installing or upgrading, with --verify.

Helm reads keys from a keyring in the legacy GnuPG format, ~/.gnupg/pubring.gpg by default. GnuPG 2.1 and later no longer write that file, so import the Solr keys and export them to a keyring for Helm first:

curl -sL https://dist.apache.org/repos/dist/release/solr/KEYS | gpg --import
gpg --export > ~/solr-keyring.gpg

Then pass --verify and the keyring to helm install or helm upgrade:

  • OCI Charts

  • Charts Repo

helm install solr-operator oci://ghcr.io/apache/solr-operator/helm/solr-operator --version 0.10.0 \
  --verify --keyring ~/solr-keyring.gpg
helm install example oci://ghcr.io/apache/solr-operator/helm/solr --version 0.10.0 \
  --verify --keyring ~/solr-keyring.gpg
helm install solr-operator apache-solr/solr-operator --version 0.10.0 \
  --verify --keyring ~/solr-keyring.gpg
helm install example apache-solr/solr --version 0.10.0 \
  --verify --keyring ~/solr-keyring.gpg

Helm refuses to install a chart whose signature does not verify against the keyring.

Installing the Solr Operator vs Solr CRDs

Installing the Solr Operator, especially via the Helm Chart, does not necessarily mean that you are installing the required CRDs for that version of the Solr Operator.

If the Solr CRDs already exist in your Kubernetes cluster, then Helm will not update them even if the CRDs have changed between the Helm chart versions. Instead, you will need to manually install the CRDs whenever upgrading your Solr Operator. You should always upgrade your CRDs before upgrading the Operator

You can do this via the following command, replacing <version> with the version of the Solr Operator you are installing:

# Just replace the Solr CRDs
kubectl replace -f "http://solr.apache.org/operator/downloads/crds/<version>/all.yaml"
# Just replace the Solr CRDs and all CRDs it might depend on (e.g. ZookeeperCluster)
kubectl replace -f "http://solr.apache.org/operator/downloads/crds/<version>/all-with-dependencies.yaml"

It is strongly recommended to use kubectl create or kubectl replace, instead of kubectl apply when creating/updating CRDs.

Upgrading the Zookeeper Operator

When upgrading the Solr Operator, you may need to upgrade the Zookeeper Operator at the same time. If you are using the Solr Helm chart to deploy the Zookeeper operator, then you won’t need to do anything besides installing the CRD’s with dependencies, and upgrade the Solr Operator helm deployment.

# Just replace the Solr CRDs and all CRDs it might depend on (e.g. ZookeeperCluster)
kubectl replace -f "http://solr.apache.org/operator/downloads/crds/v0.10.0/all-with-dependencies.yaml"
helm upgrade solr-operator oci://ghcr.io/apache/solr-operator/helm/solr-operator --version 0.10.0

Note that the Helm chart version does not contain a v prefix, which the downloads version does. The Helm chart version is the only part of the Solr Operator release that does not use the v prefix.

Upgrade Warnings and Notes

v0.10.0

  • Solr 10 support, and Solr image tags must start with the Solr version

    The Solr Operator now supports Solr 10. Solr 10 needs a different solr.xml, different env vars and different bin/solr commands than Solr 9, so the operator reads the Solr version from spec.solrImage.tag. The tag must therefore start with the Solr version, e.g. 9.10.0, 10.0.0, 9.10, 8.11, 10, 9.10.0-slim, 10.0.0-my-custom-build or 10.0.0@sha256:<digest>. Tags without a version, such as latest or slim, and custom tags that don’t start with the Solr version, are not accepted. The operator does not reconcile a SolrCloud with such a tag, or with an unsupported Solr major version; it emits an UnsupportedSolrVersion Warning event instead. Before upgrading the operator, check the image tags of your SolrClouds (including the image.tag value of the solr Helm chart) and change them where needed. SolrClouds that never set a tag got the operator’s default tag at the time they were created (e.g. 8.11), which is accepted. Upgrading the operator restarts the pods of every SolrCloud, including the ones that stay on Solr 8.11 or 9.x. The Solr 10 specific changes are gated on the Solr major version and do not affect them, but other changes in this release do alter the pod template of every SolrCloud: the new solr.apache.org/storageMinimumSize annotation, the removal of the postStart lifecycle hook, and the new SOLR_TOOL_OPTS environment variable on the ZooKeeper setup initContainer. This is a managed rolling restart that takes the cluster operation lock and respects maxPodsUnavailable, so it behaves like any other rolling restart, but plan for it. Changing a tag, e.g. from latest to 9.10.0, changes the pod template and therefore restarts all Solr pods, even if the new tag points to the same image. If you pass -Dsolr.allowPaths=…​ via solrOpts, use -Dsolr.security.allow.paths=…​ when moving to Solr 10, which doesn’t read the old camelCase name anymore. Alternatively, set the paths via an environment variable in spec.customSolrKubeOptions.podOptions.envVars: SOLR_ALLOW_PATHS on Solr 9.6+, and SOLR_SECURITY_ALLOW_PATHS on Solr 10. Solr 10 still reads SOLR_ALLOW_PATHS, but logs a deprecation warning for it. Solr 10 can’t open indexes that were created with Solr 8, as Lucene only reads indexes created by the previous major version, so check Solr’s own upgrade notes before upgrading a SolrCloud that started on Solr 8.

  • Solr 10: custom solr.xml files need to be updated

    If you provide your own solr.xml (via spec.customSolrKubeOptions.configMapOptions.providedConfigMap), it needs to change together with the Solr version. Solr 10 refuses to start with settings it no longer supports, such as hostContext and genericCoreNodeNames, while Solr 9 requires hostContext, so no single solr.xml works for both. Create a new ConfigMap with a Solr 10 solr.xml, and change spec.solrImage.tag and providedConfigMap in the same update of the SolrCloud. The operator emits an InvalidConfigMap Warning event if the custom solr.xml of a Solr 10 SolrCloud still contains hostContext or genericCoreNodeNames, but it doesn’t stop the rolling restart. The easiest way is to start from the solr.xml that ships with Solr 10 (server/solr/solr.xml) and re-apply your changes; use ${solr.host.advertise:} for the host setting.

  • Solr 10: custom log4j2.xml files need to be updated

    Solr 10 renamed the solr.log.dir system property to solr.logs.dir. If you provide your own log4j2.xml (via spec.customSolrKubeOptions.configMapOptions.providedConfigMap), any appender referring to ${sys:solr.log.dir} stops working on Solr 10. Log4j cannot resolve the old property, so every appender using it fails to initialise and Solr starts with console logging only, writing no log files at all. Solr still starts and still logs to stdout, which makes this easy to miss. Use ${sys:solr.logs.dir}, or ${env:SOLR_LOGS_DIR}, which the Solr container image sets on both Solr 9 and Solr 10 and therefore needs no change when upgrading.

  • The SolrPrometheusExporter does not support Solr 10

    solr-exporter was removed from the Solr distribution in Solr 10, so Solr 10 images don’t contain /opt/solr/prometheus-exporter anymore. A SolrPrometheusExporter with a Solr 10 image cannot start, and one with an older image cannot read the metrics of Solr 10, which only serves them in Prometheus format. The operator does not create or update the resources of a SolrPrometheusExporter that uses a Solr 10 image or refers to a Solr 10 SolrCloud; it emits an UnsupportedSolrVersion Warning event and sets its status to not ready instead. An existing exporter Deployment keeps running when its SolrCloud is upgraded to Solr 10, but it no longer reports Solr’s metrics. Delete any SolrPrometheusExporter for a SolrCloud before upgrading that SolrCloud to Solr 10. Instead, each Solr 10 node exposes its metrics in Prometheus format at /solr/admin/metrics, so Prometheus can scrape the Solr pods directly (see #820).

  • The Helm charts are now published as OCI artifacts to oci://ghcr.io/apache/solr-operator/helm. The Helm repository at https://solr.apache.org/charts keeps working, and now lists the same OCI charts, which requires Helm v3.8 or later. See Where the Helm charts are published.

  • The default Solr version has been upgraded from 8.11 to 9.11.0. This only affects newly created resources, since the operator writes the resolved Solr version into the resource’s spec on the first reconcile, so an operator upgrade never changes the Solr version of a running cluster. Note that a Solr >=9.10 node refuses to start if its major.minor version is lower than the highest version already running in the same Solr cluster, so a rolling downgrade of Solr requires setting the SOLR_CLOUD_DOWNGRADE_ENABLED envVar to true on the pods. Solr 9.11.0 carries several CVE fixes, so existing clusters on an older Solr version have to set their image tag themselves to pick them up.

  • The CRDs gain the new optional pod fields from the Kubernetes 1.32 to 1.37 API types, settable through podOptions. Upgrade the CRDs along with the operator, see Installing the Solr Operator vs Solr CRDs, before using them. No existing field or default changed.

  • Operator logs now default to json encoding at info level. Set the new helm value development to true (CLI flag --zap-devel) for the previous console encoding at debug level.

  • The cp-solr-xml initContainer has been removed. The solr.xml is now mounted read-only into /var/solr/data/solr.xml from the ConfigMap, via a subPath volumeMount, instead of being copied there before Solr starts.

    • This changes the Solr pod spec, so the Solr pods are restarted when the operator is upgraded. SolrClouds using updateStrategy.method: Manual are the exception, since neither the operator nor Kubernetes deletes their pods: they keep running with the old layout until you delete the pods yourself.

    • The solr.xml is now only visible inside the Solr container. Sidecars and custom initContainers that mount the data volume no longer get it from there. With persistent or hostPath data storage they do still see the solr.xml that cp-solr-xml copied onto the volume before the upgrade, but that copy is stale and will never be updated again. Mount the solr.xml ConfigMap into such a container if it needs the current configuration.

    • The permission fixing that cp-solr-xml also did for volume backupRepositories has moved to a new volume-prep initContainer, which is only created for SolrClouds that have a volume backupRepository. All other Solr pods now start without any volume prep initContainer.

  • Solr pods now get the availability_zone system property, set from the topology.kubernetes.io/zone label of the node they run on, for Solr’s AffinityPlacementFactory. The label is only copied onto pods by Kubernetes v1.35+, and the property is empty on older versions, which leaves replica placement unchanged. Solr pods also get the spread_domain system property, set to the name of their Kubernetes node, which Solr only uses when spreadAcrossDomains is enabled in the AffinityPlacementFactory configuration. These are part of the same pod spec change that restarts the Solr pods during this upgrade, so they do not cause an additional restart.

  • The preStop hook running solr stop has been removed, along with the SOLR_STOP_WAIT envVar that only served it, so pod deletions no longer emit a FailedPreStopHook warning event. Solr now shuts down on the SIGTERM that Kubernetes sends, which runs the same graceful shutdown.

    • This is part of the same pod spec change that restarts the Solr pods during this upgrade, so it does not cause an additional restart. The old pods emit the FailedPreStopHook event one last time as they are replaced.

    • A stopped Solr container now exits with code 143 instead of 0, so its last state shows Error instead of Completed.

    • A custom Solr image whose entrypoint does not pass SIGTERM on to the Solr process is now killed at the end of terminationGracePeriodSeconds. Fix the entrypoint, or set your own preStop hook through customSolrKubeOptions.podOptions.lifecycle.

  • Authenticated probes now actually fail when authentication fails

    When solrSecurity.probesRequireAuth is enabled, the generated liveness/readiness/startup probe command used to discard the exit code of the Solr request, so the probes reported success no matter what Solr answered. The probes now exit with the status of the Solr request.

    If a SolrCloud is running with credentials that the probe endpoints reject, its pods were previously reported as healthy and will now correctly go un-ready and be restarted. Check that the basic auth secret is valid, and that the probe paths are authorized for that user, before upgrading.

v0.8.0

  • The minimum supported Solr version is now 8.11

    If you are unable to use a newer version of Solr, please install the v0.7.1 version of the Solr Operator. However, it is strongly suggested to upgrade to newer versions of Solr that are actively supported. See the version compatibility matrix for more information.

  • Kubernetes support is now limited to 1.22+.

    If you are unable to use a newer version of Kubernetes, please install the v0.7.1 version of the Solr Operator for use with Kubernetes 1.21. See the version compatibility matrix for more information.

  • The new SolrCloud.spec.scaling.vacatePodsOnScaleDown option is enabled by default. This means that any SolrCloud that has its spec.replicas decreased will have the replicas migrated off of the soon-to-be-deleted pods by default. Set this value to false to retain the previous functionality. More information can be found in the Solr Pod Scale-Down documentation.

  • The POD_HOSTNAME envVar in SolrCloud Pods has been deprecated. Use POD_NAME instead.

  • Use of the hostPort system property placeholder in custom solr.xml files has been deprecated. Use <int name="hostPort">${solr.port.advertise:80}</int>, the default value used by Solr, instead.

  • By default solrcloud resources will now use /admin/info/system and /admin/info/health for liveness and readiness checks, respectively. Administrators that provide custom security.json files for their clusters should either exempt both of these endpoints from authentication entirely, or configure permissions ensuring the relevant Solr user account can access them without issue.

v0.7.0

  • Kubernetes support is now limited to 1.21+.

    If you are unable to use a newer version of Kubernetes, please install the v0.6.0 version of the Solr Operator for use with Kubernetes 1.20 and below. See the version compatibility matrix for more information.

  • The required version of the Zookeeper Operator to use with this version has been upgraded from v0.2.14 to v0.2.15. If you use the Solr Operator helm chart, then by default the new version of the Zookeeper Operator will be installed as well. Refer to the helm chart documentation if you want to manage the Zookeeper Operator installation yourself. Please refer to the Zookeeper Operator release notes before upgrading. Make sure to install the correct version of the Zookeeper Operator CRDs, as shown above.

  • PodDisruptionBudgets are now created by default alongside SolrCloud instances. The maximum number of pods allowed down at any given time is aligned with the Managed Update settings provided in the spec. If this is not provided, the default setting (25%) is used. PodDisruptionBudget creation can be disabled for a solrcloud resource, by setting spec.availability.podDisruptionBudget.enabled to false.

  • Provided Zookeeper pods use the IfNotPresent pullPolicy by default. Users that specify this field manually will not see a change.

  • The Solr Operator now tries to limit connectivity to pods before they are deleted, for rolling updates or other reasons. Before the pod is killed, and evicted of replicas if ephemeral storage is used, a readinessCondition will be set to false. The Headless Service does not use readiness, so internode traffic will not be affected, however the ClusterIP (common) service will no longer include these nodes until they have been restarted. This change will improve request success rates during a rolling restart. Refer to the Managed Updates documentation.

  • The deprecated SolrCloud CRD field Spec.solrAddressability.external.ingressTLSTerminationSecret has been removed, please use Spec.solrAddressability.external.ingressTLSTermination.tlsSecret instead. In order to have these fields changed automatically, upgrade to the v0.6.0 version of the Solr operator before upgrading to the v0.7.0 version. However, all new SolrCloud resources will need to respect this field change.

  • The deprecated SolrCloud CRD field Spec.solrAddressability.external.additionalDomains has been removed, please use Spec.solrAddressability.external.additionalDomainNames instead. In order to have these fields changed automatically, upgrade to the v0.6.0 version of the Solr operator before upgrading to the v0.7.0 version. However, all new SolrCloud resources will need to respect this field change.

v0.6.0

  • The default Solr version for the SolrCloud and SolrPrometheusExporter resources has been upgraded from 8.9 to 8.11. This will not affect any existing resources, as default versions are hard-written to the resources immediately. Only new resources created after the Solr Operator is upgraded to v0.6.0 will be affected.

  • The required version of the Zookeeper Operator to use with this version has been upgraded from v0.2.12 to v0.2.14. If you use the Solr Operator helm chart, then by default the new version of the Zookeeper Operator will be installed as well. Refer to the helm chart documentation if you want to manage the Zookeeper Operator installation yourself. Please refer to the Zookeeper Operator release notes before upgrading. Make sure to install the correct version of the Zookeeper Operator CRDS, as shown above.

  • The SolrCloud CRD field Spec.solrAddressability.external.additionalDomains has been renamed to additionalDomainNames. In this release additionalDomains is still accepted, but all values will automatically be added to additionalDomainNames and the field will be set to nil by the operator. The additionalDomains option will be removed in a future version.

  • The SolrCloud CRD field Spec.solrAddressability.external.ingressTLSTerminationSecret has been moved to Spec.solrAddressability.external.ingressTLSTermination.tlsSecret. In this release ingressTLSTerminationSecret is still accepted, but all values will automatically be changed to ingressTLSTermination.tlsSecret and the original field will be set to nil by the operator. The ingressTLSTerminationSecret option will be removed in a future version.

  • SolrPrometheusExporter resources without any image specifications (SolrPrometheusExporter.Spec.image.) will use the referenced SolrCloud image, if the reference is by name, not zkConnectionString. If any SolrPrometheusExporter.Spec.image. option is provided, then those values will be defaulted by the Solr Operator and the SolrCloud image will not be used. When upgrading from v0.5.* to v0.6.0, only new SolrPrometheusExporter resources will use this new feature. To enable it on existing resources, update the resources and remove the SolrPrometheusExporter.Spec.image section.

  • CRD options deprecated in v0.5.0 have been removed. This includes field SolrCloud.spec.dataStorage.backupRestoreOptions, SolrBackup.spec.persistence and SolrBackup.status.persistenceStatus. Upgrading to v0.5. will remove these options on existing and new SolrCloud and SolrBackup resources. However, once the Solr CRDs are upgraded to v0.6.0, you will no longer be able to submit resources with the options listed above. Please migrate your systems to use the new options while running v0.5., before upgrading to v0.6.0.

v0.5.0

  • Due to the deprecation and removal of networking.k8s.io/v1beta1 in Kubernetes v1.22, networking.k8s.io/v1 will be used for Ingresses.

    This means that Kubernetes support is now limited to 1.19+.

    If you are unable to use a newer version of Kubernetes, please install the v0.4.0 version of the Solr Operator for use with Kubernetes 1.18 and below. See the version compatibility matrix for more information.

    This also means that if you specify a custom ingressClass via an annotation, you should change to use the SolrCloud.spec.customSolrKubeOptions.ingressOptions.ingressClassName instead. The ability to set the class through annotations is now deprecated in Kubernetes and will be removed in future versions.

  • The legacy way of specifying a backupRepository has been DEPRECATED. Instead of using SolrCloud.spec.dataStorage.backupRestoreOptions, use SolrCloud.spec.backupRepositories. The SolrCloud.spec.dataStorage.backupRestoreOptions option will be removed in v0.6.0.

    Note: Do not take backups while upgrading from the Solr Operator v0.4.0 to v0.5.0. Wait for the SolrClouds to be updated, after the Solr Operator is upgraded, and complete their rolling restarts before continuing to use the Backup functionality.

  • The location of Solr backup data as well as the name of the Solr backups have been changed, when using volume repositories. Previously the name of the backup (in solr) was set to the name of the collection. Now the name given to the backup in Solr will be set to <backup-resource-name>-<collection-name>, without the < or > characters, where the backup-resource-name is the name of the SolrBackup resource.

    The directory in the Read-Write-Many Volume, required for volume repositories, that backups are written to is now /cloud/<solr-cloud-name>/backups by default, instead of /cloud/<solr-cloud-name>/backups/<backup-name>. Because the backup name in Solr uses both the SolrBackup resource name and the collection name, there should be no collisions in this directory. However, this can be overridden using the SolrBackup.spec.location option, which is appended to /cloud/<solr-cloud-name>.

  • The SolrBackup persistence option has been removed as of v0.5.0. Users should plan to keep their backup data in the shared volume if using a Volume Backup repository. If SolrBackup.spec.persistence is provided, it will be removed and written back to Kubernetes.

    Users using the S3 persistence option should try to use the S3 backup repository instead. This requires Solr 8.10 or higher.

  • Default ports when using TLS are now set to 443 instead of 80. This affects solrCloud.Spec.SolrAddressability.CommonServicePort and solrCloud.Spec.SolrAddressability.CommonServicePort field defaulting. Users already explicitly setting these values will not be affected.

v0.4.0

  • The required version of the Zookeeper Operator to use with this version has been upgraded from v0.2.9 to v0.2.12. If you use the Solr Operator helm chart, then by default the new version of the Zookeeper Operator will be installed as well. Refer to the helm chart documentation if you want to manage the Zookeeper Operator installation yourself. Please refer to the Zookeeper Operator release notes before upgrading. Make sure to install the correct version of the Zookeeper Operator CRDS, as shown above.

  • The deprecated Solr Operator Helm chart option useZkOperator has been removed, use zookeeper-operator.use instead.

    Note: The old option takes a string "true"/"false", while the new option takes a boolean true/false.

  • The default Solr version for SolrCloud and SolrPrometheusExporter resources has been upgraded from 7.7.0 to 8.9. This will not affect any existing resources, as default versions are hard-written to the resources immediately. Only new resources created after the Solr Operator is upgraded to v0.4.0 will be affected.

  • In previous versions of the Solr Operator, the provided Zookeeper instances could only use Persistent Storage. Now ephemeral storage is enabled, and used by default if Solr is using ephemeral storage. The ZK storage type can be explicitly set via Spec.zookeeperRef.provided.ephemeral or Spec.zookeeperRef.provided.persistence, however if neither is set, the Solr Operator will default to use the type of storage (persistent or ephemeral) that Solr is using.

    This means that the default Zookeeper Storage type can change for users using ephemeral storage for Solr. If you require ephemeral Solr storage and persistent Zookeeper Storage, be sure to explicitly set that starting in v0.4.0.

v0.3.0

  • All deprecated CRD fields and Solr Operator options from v0.2.* have been removed.

  • The SolrCollection and SolrCollectionAlias have been removed. Please use the Solr APIs to manage these resources instead. Discussion around the removal can be found in Issue #204.

  • The required version of the Zookeeper Operator to use with this version has been upgraded from v0.2.6 to v0.2.9. If you use the Solr Operator helm chart, then by default the new version of the Zookeeper Operator will be installed as well. Refer to the helm chart documentation if you want to manage the Zookeeper Operator installation yourself. Please refer to the Zookeeper Operator release notes before upgrading.

v0.2.7

  • Due 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. Please instead use the following instead: SolrCloud.spec.dataStorage.persistent.pvcTemplate.spec=<spec>

    • SolrCloud.spec.backupRestoreVolume has been DEPRECATED. Please instead use the following instead: SolrCloud.spec.dataStorage.backupRestoreOptions.Volume=<volume-source>

v0.2.6

  • The solr-operator argument --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.4

  • The default supported version of the Zookeeper Operator has been upgraded to v0.2.6. If you are using the provided zookeeper option for your SolrClouds, then you will want to upgrade your zookeeper operator version as well as the version and image of the zookeeper that you are running. You can find examples of the zookeeper operator as well as solrClouds that use provided zookeepers in the examples directory. Please refer to the Zookeeper Operator release notes before upgrading.

v0.2.3

  • If you do not use an ingress with the Solr Operator, the Solr Hostname and Port will change when upgrading to this version. This is to fix an outstanding bug. Because of the headless service port change, you will likely see an outage for inter-node communication until all pods have been restarted.

v0.2.2

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

v0.2.1

  • The zkConnectionString used for provided zookeepers changed from using the string provided in the 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.

v0.2.0

  • Uses gomod instead of dep

  • SolrCloud.spec.zookeeperRef.provided.zookeeper.persistentVolumeClaimSpec has been DEPRECATED in favor of the SolrCloud.zookeeperRef.provided.zookeeper.persistence option. This option is backwards compatible, but will be removed in a future version (v0.3.0).

  • An upgrade to the ZKOperator version 0.2.4 is required.