solr-operator

Bug Fixes

• Miscellaneous bugfixes and hardening for the "managed scaling" feature adding in v0.8.0.
• Init-containers now avoid writing to "/tmp" and other root FS locations, to better support "read-only" root filesystems
• SolrPrometheusExporter no longer fails liveness probes when the SolrCloud is too large

Upgrade Notes & Compatibility Warnings

• The minimum supported version of Solr has been set to Solr 8.11
• The minimum Kubernetes version supported is now v1.22
• Please refer to the documentation for a complete list of upgrade warnings

Improvements

• Solr 8.11 features are now supported by default, such as maxBooleanClauses, metrics disabling, health endpoint for readinessCheck
• Rolling Updates for SolrClouds using ephemeral storage are now safer and replicas are balanced at the end of the operation to ensure optimal resource utilization.
  • Replica balancing is only supported when Solr 9.3+ is used.

New Features

• Managed scale up and scale down are now supported for SolrClouds.
  • By default, when scaling down a SolrCloud, replicas will be migrated off Pods before they are deleted.
  • By default, when scaling up a SolrCloud, replicas will be balanced across all Pods after the SolrCloud has been scaled up. (Only supported for Solr 9.3+)
• Keystore/Truststore passwords can be explicitly set in the SolrCloud CRD for mountedDir SSL. This enables the use of the CertManager CSI Driver with Solr.

Bug Fixes

• SSL bugs with Solr 9 have been fixed, and v0.8.0 will successfully support SSL for Solr 8.11 and 9.4+

Upgrade Notes & Compatibility Warnings

• Please refer to the documentation for a complete list of upgrade warnings

Bug Fixes

• Upgraded the Kubernetes API clients to fix crash when running with Kubernetes 1.27. https://github.com/apache/solr-operator/issues/583

Upgrade Notes & Compatibility Warnings

• Please refer to the documentation for a complete list of upgrade warnings
• The minimum supported Kubernetes version is now v1.21.
• The required Zookeeper Operator version is now v0.2.15. https://github.com/apache/solr-operator/issues/549
• Options deprecated in v0.6.0 have been removed. https://github.com/apache/solr-operator/issues/553

New Features

• Clusterwide PodDisruptionBudgets are now created for SolrClouds by default. https://github.com/apache/solr-operator/issues/471 and https://github.com/apache/solr-operator/issues/538
• SolrBackups will now backup all collections if no collections are provided. https://github.com/apache/solr-operator/issues/515

Improvements

• During a rolling restart/update, SolrCloud pods are now taken out of the common service endpoint before they are decommissioned. This should improve request reliability during rolling restarts. https://github.com/apache/solr-operator/issues/529
• Many missing Provided Zookeeper options have been added. https://github.com/apache/solr-operator/issues/477, https://github.com/apache/solr-operator/issues/534 and https://github.com/apache/solr-operator/issues/557
• Using volume backupRepositories now initialize faster on pod creation and work with custom user/fsGroup. https://github.com/apache/solr-operator/issues/537
• Default SolrCloud and SolrPrometheusExporter Pod probes have been improved. https://github.com/apache/solr-operator/issues/510
• The Solr Operator now patches Solr resource statuses. This will reduce needless error logging. https://github.com/apache/solr-operator/issues/544
• Custom annotations can be added to serviceAccounts created by the helm charts. https://github.com/apache/solr-operator/pull/480
• The SolrPrometheusExporter service should now work with non-operator Prometheus setups. https://github.com/apache/solr-operator/issues/483

Bug Fixes

• Non-recurring backups now work as-expected. https://github.com/apache/solr-operator/pull/509
• Custom persistent data volume names no longer cause the Solr Operator to crash. https://github.com/apache/solr-operator/issues/479
• Volume backupRepositories now work with custom runAsUser and fsGroup options. https://github.com/apache/solr-operator/issues/519

Upgrade Notes & Compatibility Warnings

• Please refer to the ArtifactHub changelog for a complete list of changes

Bug Fixes

• Users are now able to specify resource constraints for all init-containers.
• The default Solr image version used in newly created solrcloud's has been updated from 8.9 to 8.11
• solrcloud now has a 'solrZkOpts' field, allowing users to specify any system properties needed to connect to their ZooKeeper cluster.
• Users running in GKE can now omit the 'gcsCredentialSecret' field from the GCS backup repositories, and fallback on "Workload Identity" and other "credential-less" authentication mechanisms offered by Google Cloud.

Upgrade Notes & Compatibility Warnings

• Please refer to the documentation for a complete list of upgrade warnings
• The project now uses GoLang 1.17

Bug Fixes

• Fix security vulnerabilities introduced by dependencies
• Ability to run sidecars of the Solr Operator that use the root user, when installing via the Helm Chart
• The zk.external option in the solr helm chart is now functional
• Resource checking for pods across all generated resources has been fixed, will not overwrite equivalent resources with different units
  • Necessary step for GKE Autopilot and the Vertical Pod Autoscaler
• Support ArgoCD for the CRDs
• Fix bugs in documentation

Upgrade Notes & Compatibility Warnings

• Please refer to the documentation for a complete list of upgrade warnings
• The minimum supported Kubernetes version is now v1.19
• Remove Persistence option for SolrBackup. by @HoustonPutman in https://github.com/apache/solr-operator/pull/357

New Features

• Support custom Lifecycle for Solr & PrometheusExporter containers by @vladiceanu in https://github.com/apache/solr-operator/pull/324
• Allow users to take GCS-based backups by @gerlowskija in https://github.com/apache/solr-operator/pull/302
• Add support for Solr Modules and additional libs by @HoustonPutman in https://github.com/apache/solr-operator/pull/332
• Add support for S3Repositories by @HoustonPutman in https://github.com/apache/solr-operator/pull/345
• Add ability to set pod topologySpreadConstraints by @HoustonPutman in https://github.com/apache/solr-operator/pull/350
• Support to bootstrap from a user-supplied security.json and minor refactorings to pass auth headers through a Context by @thelabdude in https://github.com/apache/solr-operator/pull/356
• Enable Solr Operator metrics when using the helm chart. by @HoustonPutman in https://github.com/apache/solr-operator/pull/360
• Ability to set ingressClassName for v1 Ingress. by @HoustonPutman in https://github.com/apache/solr-operator/pull/363
• Add support for more ZK Pod options. by @HoustonPutman in https://github.com/apache/solr-operator/pull/361
• Specify individual backupRepo availability in SolrCloud Status by @HoustonPutman in https://github.com/apache/solr-operator/pull/358
• Add ability to schedule recurring incremental backups by @HoustonPutman in https://github.com/apache/solr-operator/pull/359

Improvements

• Upgrade to use Kubebuilder 3 by @HoustonPutman in https://github.com/apache/solr-operator/pull/321
• Allow for managed restarts across multiple SolrCloud resources. by @HoustonPutman in https://github.com/apache/solr-operator/pull/349
• Enable leader election for the operator by default. by @HoustonPutman in https://github.com/apache/solr-operator/pull/367
• Add example on how to trigger manual restart to docs by @nosvalds in https://github.com/apache/solr-operator/pull/354
• Refactor security related code into a separate solr_security_util.go vs. sprinkled throughout the codebase. by @thelabdude in https://github.com/apache/solr-operator/pull/334
• Start documenting Solr features supported in future versions. by @HoustonPutman in https://github.com/apache/solr-operator/pull/342
• Clear up difference between SolrCloud CRD and Solr Helm chart options by @HoustonPutman in https://github.com/apache/solr-operator/pull/362
• Better messaging around supported Solr images. by @HoustonPutman in https://github.com/apache/solr-operator/pull/373

Bug Fixes

• Fix imagePullSecrets bug when updating Zookeeper Clusters by @HoustonPutman in https://github.com/apache/solr-operator/pull/344
• Properly resolve the name of the basic auth secret for a SolrCloud when calling the backup API by @thelabdude in https://github.com/apache/solr-operator/pull/370

Upgrade Notes & Compatibility Warnings

• Please refer to the documentation for a complete list of upgrade warnings
• The Zookeeper Operator dependency has been upgraded to v0.2.12 (#271)
• Removed deprecated Solr Operator Helm chart option useZkOperator, use zookeeper-operator.use instead (#286)

New Features

• A helm chart to template and deploy SolrCloud resources (#112)
• Ability to schedule automatic restarts for SolrClouds (#281)
• Ability to use HostPath volumes for ephemeral Solr storage (#266)
• Customize serviceAccountName for SolrCloud and SolrPrometheusExporter (#264)
• Introduced ephemeral option for Zookeeper storage (#259)
• Ability to customize probes for PrometheusExporter (#282)
• Add a mountedServerTLSDir config option to support a unique certificate per pod mounted dynamically by an external agent or CSI driver (#291)
• Ability to terminate TLS at Ingress for SolrCloud (#268)
• Ability to schedule automatic restarts for SolrPrometheusExporters (#310)
• Ability to specify ZK Config properties for provided Zookeeper Clusters (#290)
• Option to watch for updates to the mTLS client certificate used by the operator to call Solr pods (#317)
• Configuration options to support an additional client TLS cert in addition to the server certificate (#300)

Improvements

• Default Solr Version upgraded to 8.9, does not affect existing clouds (#285)
• Changed Solr Operator base Docker image to reduce vulnerabilities (#294)
• Grant access to the /admin/zookeeper/status path to the k8s role in the initial security.json (#289)

Bug Fixes

• Remove users role from the all permission in the initial security.json (#274)

Upgrade Notes & Compatibility Warnings

• Please refer to the documentation for a complete list of upgrade warnings.
• The Solr Operator is now an Apache project managed by the Apache Solr PMC.
  • The CRDs are now under the solr.apache.org group instead of solr.bloomberg.com.
• The Zookeeper Operator is now up-to-date with the most recent release, v0.2.9 (#231)

New Features

• The Solr Operator now fully supports running Solr in a secure and locked down way
  • Basic Auth support is now built in when requested in the SolrCloud CRD (#218)
  • Solr can be run with TLS (optional mTLS, if provided to the operator) (#209, #255)
• Support custom log4j2 config from user-provided ConfigMap (#193)
• Override Prometheus exporter config XML via a user-supplied ConfigMap (#189)
• The Zookeeper Operator can be installed as a helm chart dependency, with the Solr Operator (#231)
• Added support for the Kubernetes Horizontal Pod Autoscaler (HPA) (#254)

Improvements

• Allow the definition of multiple imagePullSecrets (#216)
• More helm chart options are provided to customize running the Solr Operator (#250)
• Solr pod shutdown is more graceful, has better coordination between Kubernetes and Solr (#226)

Bug Fixes

• Fixed ignored options in podOptions probes (#208)

Miscellaneous

• Upgrade Go to 1.16 (#239)
• Use k8s.io/api/networking/v1beta1 Ingress. (#217)

This will be the final v0.2.* Solr Operator release, and the final bloomberg/solr-operator release.
All future releases can be found at apache/solr-operator.

Bug Fixes

• Fixing upgrade issue with new Status fields (#170)

This will be the final v0.2.* Solr Operator release, and the final bloomberg/solr-operator release.
All future releases can be found at apache/solr-operator.

Upgrade Notes & Compatibility Warnings

• Kubernetes 1.16+ is required for for this release of the Solr Operator..
  
Please continue using v0.2.6 until you are able to upgrade your Kubernetes cluster.
• Please refer to the main page for a complete list of upgrade warnings.

New Features

• Adding PriorityClassName in podOptions (#152)
• Adding option to provide ZK ACLs (#144)
• Adding dataStorage options for SolrCloud (#156)
  • PVC reclaim policy
  • Ephemeral Volume spec for non-persistent storage
• Ability to provide custom solr.xml for SolrCloud (#158)
• Ability to specify sidecar container and additional initContainers (#159)
• Introducing a manned SolrCloud update strategy (#133)

Improvements

• Gracefully shutdown Solr nodes using the Solr stop port (#131)
• Adding scope: Namespaced to all CRDs (#137)
• Move chroot creation logic to pod postStart and out of operator (#140)
• Change default SolrCloud podManagementPolicy to Parallel from OrderedReady

Bug Fixes

• ZKConnectionString now uses all ZK hosts with Provided ZK (#138)
• Fix service port name and status URL bugs (#145)
• Fix never-ending reconcile loop for ZKs
• Fix never-ending reconcile loop for ingresses in Kube 1.18+
• Backups
  • SolrBackup now works with Solr 8.6+
  • Fixed an issue with volume permissions in the read-write-many volume

Miscellaneous

• Upgrade dependencies of the Solr Operator (#147)
• Remove Etcd support from the Solr Operator (#132)
• Remove default imagePullPolicy for pods (#155)
• Upgraded CRD versions to v1, from v1beta1

Upgrade Notes

New Features

• Helm related bugfixes (#113 , #114 , #115 , #116)
• Adding namespace functionality to operator and helm chart (#124)
• Adding custom addressability options to solrcloud (#95)
• Adding configurable liveness, readiness, startup checks (#126)

Documentation

• Updated documentation away from readme (#110)
• Fixed links in documentation (#125)

Upgrade Notes

New Features

• Adding missing inputs for ZK tolerations and node selector support (#108)

Upgrade Notes

Dependency Upgrades

• The default supported version of the Zookeeper Operator has been upgraded to 0.2.6 (#93)
  This will not affect clouds already created before upgrading the Solr Operator, however we do suggest first upgrading your Zookeeper images to pravega/zookeeper:0.2.6, then upgrading your zookeeper operator version to pravega/zookeeper-operator:0.2.6

Bug Fixes

• Fixing logging in collection util. (#92)
• Fixing int to string conversion in logging (#96)
• Fixed logging in Collection Deletion. (#100)
• Fixed usage of empty routerField and made routerName an enum. (#99)

New Features

• Adding feature/tolerations and node selector to PodOptions (#107)

Upgrade Notes

All non-ingress Solr Node addresses will change to use port 8983 when the operator is upgraded. The nodes will no longer be addressable with port 80.

Bug Fixes

• The headlessService for non-ingress SolrClouds no longer maps ports (#87)
  • This caused issues with solrCloud nodes addressing other nodes in the cluster, because headlessServices do not actually allow mapping of ports.
  • SolrClouds that are deployed with ingresses will not be affected.

New Features

• The solrNode status now contains the name of the Kubernetes node it runs on. (#89)

Upgrade Notes

Deprecation Warning

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

Bug Fixes

• The maxShardsPerNode option for SolrCollections is correctly set now (#79)

New Features

• Introduction of the Solr Operator Helm Chart (#70)
• New customization API for Kubernetes Resources. Users now have the ability to change attributes of the Kubernetes resources created by the Solr Operator.
  • SolrCloud (#74, #75)
    • StatefulSet - Labels, Annotations
    • Pod - Labels, Annotations, Volumes, EnvVars, Resources, Affinity, SecurityContext
    • Services - Labels, Annotations
    • Ingress - Labels, Annotations
    • ConfigMap - Labels, Annotations
  • SolrPrometheusExporter (#83)
    • Deployment - Labels, Annotations
    • Pod - Labels, Annotations, Volumes, EnvVars, Resources, Affinity, SecurityContext
    • Service - Labels, Annotations
    • ConfigMap - Labels, Annotations

Other

• The Prometheus Exporter example was fixed (#81)

Upgrade Notes

Bug Fixes

• Rest Config NPE in the backup controller (#65)
• Infinite loop while setting defaults for SolrBackup resources (#64)
• Setting defaults and reconciling Provided ZKs with Persistence (#64)

New Features

• Solr Services (individual node + headless) are now addressable even when pods are not ready (#67)
  • This allows Solr to communicate between nodes even when the node is not "ready", which may be determined by internal solr state.
• A service account was added for the default deployment of the solr-operator (#69)
• A chRoot can now be specified for provided ZK instances for SolrClouds (#62)
• Non-root (/) chRoots are now verified, and created if necessary, before they can be used. (#62)
  • This means that StatefulSets will not be created/updated with a new ChRoot until it has been successfully verified or created.

Other Changes

• The internal directory used for backup data in the solr pod has changed to match needed directory permissions. This will cause a rolling restart of your solr cloud nodes using the backupRestoreVolume option, but there will be no other effect. (#65)
• 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 solr cloud nodes using the provided zookeeper option, but there will be no data loss. (#62)

Upgrade Notes

• An upgrade to the ZKOperator version 0.2.4 is required
• SolrCloud.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.
• Uses gomod instead of dep for dependency management

Bug Fixes

• Fixed status/solrPod reconciling loops.
  • If an ingress is used, the solr pods now use hostAliases to map the
    ingress URL of each solr node to the IP of the corresponding service
• Fixed a bug related to the first pod of the Solr StatefulSet starting
  without a zkConnectionString

New Features

• Added CollectionAlias CRD to manage aliases with SolrClouds & SolrCollections