Apache Solr is the popular, blazing-fast, open source enterprise search platform built on Apache Lucene™.
Solr is highly reliable, scalable and fault tolerant, providing distributed indexing, replication and load-balanced querying, automated failover and recovery, centralized configuration and more. Solr powers the search and navigation features of many of the world's largest internet sites.
Documentation around using Apache Solr can be found on it's official site.
Check out the following tutorials on getting started with Solr.
This Helm chart relies on the Solr Operator being installed. You can install the Solr Operator via it's Helm chart.
If you are using a provided Zookeeper instance for your Solr Cloud, then you must also install the Zookeeper Operator. However, it is installed by default as a dependency when using the Solr Operator Helm chart.
Please make sure that the same version of the Solr Operator chart and Solr chart are installed. The Solr version can be any supported version of Solr you wish to run, but the chart version must match the chart version of the Solr Operator that you have installed.
Before upgrading your Solr Operator and Solr Helm chart version, please refer to the Upgrade Notes. There may be breaking changes between the version you are using and the version you want to upgrade to.
To install a SolrCloud for the first time in your cluster, you can use the latest version or a specific version, run with the following commands:
helm install example apache-solr/solr --version 0.8.0-prerelease --set image.tag=8.8
The command deploys a SolrCloud object on the Kubernetes cluster with the default configuration. The Solr Operator is then in charge of creating the necessary Kubernetes resources to run that Solr Cloud. The configuration section lists the parameters that can be configured during installation.
Note that the Helm chart version does not contain a v prefix, which the Solr Operator release versions do.
If you are upgrading your SolrCloud deployment, you should always use a specific version of the chart and upgrade after upgrading the Solr Operator to the same version:
helm upgrade example apache-solr/solr --version 0.8.0-prerelease --reuse-values --set image.tag=8.11
The upgrade will be done according to the upgradeStrategy.method chosen in the values.
Be sure to select the update strategy that best fits your use case.
However, the Managed strategy is highly recommended.
To uninstall/delete the Solr Cloud, run:
helm uninstall example
The command removes the SolrCloud resource, and then Kubernetes will garbage collect the resources owned by that SolrCloud, including the StatefulSet, Services, ConfigMap, etc.
Please note that there is not a 1-1 mapping from SolrCloud CRD options to Solr Helm options.
All options should be supported, but they might be slightly renamed in some scenarios, such as customSolrKubeOptions.
Please read below to see what the Helm chart values are for the options you need.
Descriptions on how to use these options can be found in the SolrCloud documentation.
| Key | Type | Default | Description |
|---|---|---|---|
| fullnameOverride | string | "" |
A custom name for the Solr Operator Deployment |
| nameOverride | string | "" |
|
| replicas | int | 3 |
The number of Solr pods to run in the Solr Cloud. If you want to use autoScaling, do not set this field. |
| image.repository | string | "solr" |
The repository of the Solr image |
| image.tag | string | "8.11" |
The tag/version of Solr to run |
| image.pullPolicy | string | PullPolicy for the Solr image, defaults to the empty Pod behavior | |
| image.imagePullSecret | string | PullSecret for the Solr image | |
| busyBoxImage.repository | string | "busybox" |
The repository of the BusyBox image |
| busyBoxImage.tag | string | "1.28.0-glibc" |
The tag/version of BusyBox to run |
| busyBoxImage.pullPolicy | string | PullPolicy for the BusyBox image, defaults to the empty Pod behavior | |
| busyBoxImage.imagePullSecret | string | PullSecret for the BusyBox image | |
| solrOptions.javaMemory | string | "-Xms1g -Xmx2g" |
Java memory parameters |
| solrOptions.javaOpts | string | "" |
Additional java arguments to pass via the command line. ZooKeeper-connection related properties should be reserved for solrOptions.zkJavaOpts (see below). |
| solrOptions.zkJavaOpts | string | "" |
Additional java arguments required to connect to ZooKeeper to pass via the command line |
| solrOptions.logLevel | string | "INFO" |
Log level to run Solr under |
| solrOptions.gcTune | string | "" |
GC Tuning parameters for Solr |
| solrOptions.solrModules | []string | List of packaged Solr Modules to load when running Solr. Note: There is no need to specify solr modules necessary for other parts of the Spec (i.e. backupRepositories[].gcs), those will be added automatically. |
|
| solrOptions.additionalLibs | []string | List of paths in the Solr Image to add to the classPath when running Solr. Note: There is no need to include paths for solrModules here if already listed in solrModules, those paths will be added automatically. |
|
| solrOptions.security.authenticationType | string | "" |
Type of authentication to use for Solr |
| solrOptions.security.basicAuthSecret | string | "" |
Name of Secret in the same namespace that stores the basicAuth information for the Solr user |
| solrOptions.security.probesRequireAuth | boolean | Whether the probes for the SolrCloud pod require auth | |
| solrOptions.security.bootstrapSecurityJson.name | string | Name of a Secret in the same namespace that stores a user-provided security.json to bootstrap the Solr security config |
|
| solrOptions.security.bootstrapSecurityJson.key | string | Key holding the user-provided security.json in the bootstrap security Secret |
|
| updateStrategy.method | string | "Managed" |
The method for conducting updates of Solr pods. Either Managed, StatefulSet or Manual. See the docs for more information |
| updateStrategy.managedUpdate.maxPodsUnavailable | int-or-string | "25%" |
The number of Solr pods in a Solr Cloud that are allowed to be unavailable during the rolling restart. Either a static number, or a percentage representing the percentage of total pods requested for the statefulSet. |
| updateStrategy.managedUpdate.maxShardReplicasUnavailable | int-or-string | 1 |
The number of replicas for each shard allowed to be unavailable during the restart. Either a static number, or a percentage representing the percentage of the number of replicas for a shard. |
| updateStrategy.restartSchedule | string (CRON) | A CRON schedule for automatically restarting the Solr Cloud. Refer here for all possible CRON syntaxes accepted. | |
| availability.podDisruptionBudget.enabled | boolean | true |
Create PodDisruptionBudget(s) to ensure the availability of SolrNodes. |
| availability.podDisruptionBudget.method | string | "ClusterWide" |
The method by which PodDisruptionBudgets should be created. The only option currently is ClusterWide. |
| serviceAccount.create | boolean | false |
Create a serviceAccount to be used for all pods being deployed (Solr & ZK). If serviceAccount.name is not specified, the full name of the deployment will be used. |
| serviceAccount.name | string | The optional default service account used for Solr and ZK unless overridden below. If serviceAccount.create is set to false, this serviceAccount must exist in the target namespace. |
|
| backupRepositories | []object | A list of BackupRepositories to connect your SolrCloud to. Visit the SolrBackup docs or run kubectl explain solrcloud.spec.backupRepositories to see the available options. |
|
| autoscaling.vacatePodsOnScaleDown | boolean | true |
While scaling down the SolrCloud, move replicas off of Solr Pods before they are deleted. This only affects pods that will not exist after the scaleDown operation. |
See the documentation for more information.
| Key | Type | Default | Description |
|---|---|---|---|
| dataStorage.type | string | "ephemeral" |
Whether your Solr data storage should be ephemeral or persistent. The storage.<ephemeral,persistent>.* options are used only if their storage type is selected here. |
| dataStorage.capacity | string | "20Gi" |
Capacity for your data storage, ephemeral or persistent |
| dataStorage.ephemeral.emptyDir | object | Specify options for and ephemeral emptyDir volume to store Solr data. | |
| dataStorage.ephemeral.hostPath | object | Specify options for and ephemeral hostPath volume to store Solr data. Is not used when emptyDir is specified. |
|
| dataStorage.persistent.reclaimPolicy | string | "Retain" |
Determines whether to delete or keep the PVCs when Solr is deleted or scaled down. Either Retain or Delete. |
| dataStorage.persistent.pvc.name | string | Override the default Solr data PVC base-name | |
| dataStorage.persistent.pvc.annotations | map[string]string | Set the annotations for your Solr data PVCs | |
| dataStorage.persistent.pvc.labels | map[string]string | Set the labels for your Solr data PVCs | |
| dataStorage.persistent.pvc.storageClassName | string | Override the default storageClass for your Solr data PVCs |
See the documentation for more information.
If providing external addressability, then method and domainName must be provided.
External addressability is disabled by default.
| Key | Type | Default | Description |
|---|---|---|---|
| addressability.podPort | int | 8983 |
The port that Solr should listen on within the pod. |
| addressability.commonServicePort | int | `` | The port that Solr's load-balancing common service should listen on. |
| addressability.kubeDomain | string | The cluster domain the Kubernetes is addressed under. Overrides the global.clusterDomain option. |
|
| addressability.external.method | string | The method by which Solr should be made addressable outside of the Kubernetes cluster. Either Ingress or ExternalDNS |
|
| addressability.external.domainName | string | The base domain name that Solr nodes should be addressed under. | |
| addressability.external.additionalDomainNames | []string | Additional base domain names that Solr nodes should be addressed under. These are not used to advertise Solr locations, just the domainName is. |
|
| addressability.external.useExternalAddress | boolean | false |
Make the official hostname of the SolrCloud nodes the external address. This cannot be used when hideNodes is set to true or ingressTLSTermination is used. |
| addressability.external.hideNodes | boolean | false |
Do not make the individual Solr nodes addressable outside of the Kubernetes cluster. |
| addressability.external.hideCommon | boolean | false |
Do not make the load-balanced common Solr endpoint addressable outside of the Kubernetes cluster. |
| addressability.external.nodePortOverride | int | Override the port of individual Solr nodes when using the Ingress method. This will default to 80 if using an Ingress without TLS and 443 when using an Ingress with Solr TLS enabled (not TLS Termination described below). |
|
| addressability.external.ingressTLSTermination.tlsSecret | string | Name a of Kubernetes TLS Secret to terminate TLS when using the Ingress method. Cannot be used when useDefaultTlsSecret is used. |
|
| addressability.external.ingressTLSTermination.useDefaultTLSSecret | boolean | false |
Use the default TLS Secret set by your Ingress controller, if your Ingress controller supports this feature. Cannot be used when tlsSecret is used. |
Specify what ZooKeeper cluster your SolrCloud should connect to.
If you specify zk.address or zk.externalAddress, then no ZooKeeper cluster will be created for you.
If neither of those options are specified, then a new ZooKeeper cluster will be created by the Zookeeper Operator, with the settings provided under zk.provided.*.
Currently the Zookeeper Operator does not support ACLs, so do not use the provided ZK cluster in conjunction with them.
| Key | Type | Default | Description |
|---|---|---|---|
| zk.chroot | string | A ZooKeeper Node to host all the information for this SolrCloud under | |
| zk.uniqueChroot | boolean | false |
If true, this will add the /<namespace>/<name> to the end of the provided chroot, if any is provided. This will let you deploy multiple Solr Clouds without having to manage the specific chroots yourself. |
| zk.address | string | An existing ZooKeeper cluster address to use for Solr. Must be reachable within the Kubernetes cluster. | |
| zk.externalAddress | string | An existing ZooKeeper cluster address to use for Solr. Must be reachable within and outside the Kubernetes cluster. | |
| zk.provided.replicas | int | 3 |
The number of replicas to run for your ZooKeeper cluster. |
| zk.provided.image.repository | string | "pravega/zookeeper" |
The repository of the Zookeeper image. NB: The operator will only work with this repository. |
| zk.provided.image.tag | string | The tag/version of Zookeeper to run. Generally leave this blank, so that the Zookeeper Operator can manage it. | |
| zk.provided.image.pullPolicy | string | "IfNotPresent" |
PullPolicy for the ZooKeeper image |
| zk.provided.image.imagePullSecret | string | PullSecret for the ZooKeeper image | |
| zk.provided.storageType | string | Explicitly set the Zookeeper storage type, not necessary if providing a "persistence" or "ephemeral" option below, or if you want to use same option that you use for Solr. | |
| zk.provided.persistence.reclaimPolicy | string | "Retain" |
Determines whether to delete or keep the PVCs when ZooKeeper is deleted or scaled down. Either Retain or Delete. |
| zk.provided.persistence.spec | object | A PVC Spec for the ZooKeeper PVC(s) | |
| zk.provided.persistence.annotations | object | Annotations to use for the ZooKeeper PVC(s) | |
| zk.provided.ephemeral.emptydirvolumesource | object | An emptyDir volume source for the ZooKeeper Storage on each pod. | |
| zk.provided.config | object | Zookeeper Config Options to set for the provided cluster. For all possible options, run: kubectl explain solrcloud.spec.zookeeperRef.provided.config |
|
| zk.provided.labels | map[string]string | Set the ZookeeperCluster.spec.labels option, providing labels for all Zookeeper child resources. |
|
| zk.provided.initContainers | []object | Add additional initContainers for Zookeeper Pods. | |
| zk.provided.containers | []object | Add additional containers for Zookeeper Pods. | |
| zk.provided.volumes | []object | Add additional volumes for Zookeeper Pods. | |
| zk.provided.volumeMounts | []object | Add additional volumeMounts for Zookeeper Pods. | |
| zk.provided.maxUnavailableReplicas | int | 1 |
Customize the maxUnavailableReplicas for the Zookeeper's PodDisruptionBudget. |
| zk.provided.adminServerService.annotations | map[string]string | Add annotations to the Zookeeper Admin Service. | |
| zk.provided.adminServerService.external | boolean | false |
Make the Zookeeper Admin Service available externally. |
| zk.provided.clientService.annotations | map[string]string | Add annotations to the Zookeeper Client Service. | |
| zk.provided.headlessService.annotations | map[string]string | Add annotations to the Zookeeper Headless Service. | |
| zk.provided.zookeeperPodPolicy.topologySpreadConstraints | []object | Set PodTopologySpreadConstraints for Zookeeper pods. | |
| zk.provided.zookeeperPodPolicy.labels | map[string]string | List of additional labels to add to the Zookeeper pod | |
| zk.provided.zookeeperPodPolicy.annotations | map[string]string | List of additional annotations to add to the Zookeeper pod | |
| zk.provided.zookeeperPodPolicy.serviceAccountName | string | Optional serviceAccount to run the ZK Pod under | |
| zk.provided.zookeeperPodPolicy.resources.limits | map[string]string | Provide Resource limits for the ZooKeeper containers | |
| zk.provided.zookeeperPodPolicy.resources.requests | map[string]string | Provide Resource requests for the ZooKeeper containers | |
| zk.provided.zookeeperPodPolicy.nodeSelector | map[string]string | Add a node selector for the ZooKeeper pod, to specify where it can be scheduled | |
| zk.provided.zookeeperPodPolicy.affinity | object | Add Kubernetes affinity information for the ZooKeeper pod | |
| zk.provided.zookeeperPodPolicy.tolerations | []object | Specify a list of Kubernetes tolerations for the ZooKeeper pod | |
| zk.provided.zookeeperPodPolicy.env | []object | List of additional environment variables for the ZooKeeper container | |
| zk.provided.zookeeperPodPolicy.securityContext | object | Security context for the entire ZooKeeper pod. More information can be found in the [Kubernetes docs](More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context). | |
| zk.provided.zookeeperPodPolicy.terminationGracePeriodSeconds | int | 30 |
The amount of time that Kubernetes will give for a zookeeper pod instance to shutdown normally. |
| zk.provided.zookeeperPodPolicy.imagePullSecrets | []object | List of image pull secrets to inject into the Zookeeper pod. | |
| zk.provided.probes.readinessProbe | object | Override the default readinessProbe for Zookeeper Pods. | |
| zk.provided.probes.livenessProbe | object | Override the default livenessProbe for Zookeeper Pods. | |
| zk.acl.secret | string | Name of a secret in the same namespace as the Solr cloud that stores the ZK admin ACL information | |
| zk.acl.usernameKey | string | Key in the Admin ACL Secret that stores the ACL username | |
| zk.acl.passwordKey | string | Key in the Admin ACL Secret that stores the ACL password | |
| zk.readOnlyAcl.secret | string | Name of a secret in the same namespace as the Solr cloud that stores the ZK read-only ACL information | |
| zk.readOnlyAcl.usernameKey | string | Key in the read-only ACL Secret that stores the ACL username | |
| zk.readOnlyAcl.passwordKey | string | Key in the read-only ACL Secret that stores the ACL password |
See documentation for more information.
Solr TLS is disabled by default. Provide any of the following to enable it.
| Key | Type | Default | Description |
|---|---|---|---|
| solrTLS.clientAuth | string | "None" |
Whether clientAuth is Needed, Wanted or None in Solr |
| solrTLS.verifyClientHostname | boolean | false |
Whether Solr should verify client hostnames |
| solrTLS.checkPeerName | boolean | false |
Whether Solr should check peer names |
| solrTLS.restartOnTLSSecretUpdate | boolean | false |
Whether Solr pods should auto-restart when the TLS Secrets are updated |
| solrTLS.pkcs12Secret.name | string | Name of the Secret that stores the keystore file in PKCS12 format | |
| solrTLS.pkcs12Secret.key | string | Key in the Secret that stores the keystore file in PKCS12 format | |
| solrTLS.keyStorePasswordSecret.name | string | Name of the Secret that stores the keystore password | |
| solrTLS.keyStorePasswordSecret.key | string | Key in the Secret that stores the keystore password | |
| solrTLS.trustStoreSecret.name | string | Name of the Secret that stores the Solr TLS truststore | |
| solrTLS.trustStoreSecret.key | string | Key in the Secret that stores the Solr TLS truststore | |
| solrTLS.trustStorePasswordSecret.name | string | Name of the Secret that stores the truststore password | |
| solrTLS.trustStorePasswordSecret.key | string | Key in the Secret that stores the truststore password | |
| solrTLS.mountedTLSDir.path | string | The path on the main Solr container where the TLS files are mounted by some external agent or CSI Driver | |
| solrTLS.mountedTLSDir.keystoreFile | string | Name of the keystore file in the mounted directory | |
| solrTLS.mountedTLSDir.keystorePasswordFile | string | Override the name of the keystore password file; defaults to keystore-password | |
| solrTLS.mountedTLSDir.truststoreFile | string | Name of the truststore file in the mounted directory | |
| solrTLS.mountedTLSDir.truststorePasswordFile | string | Override the name of the truststore password file; defaults to the same value as the KeystorePasswordFile |
See documentation for more information.
Configure Solr to use a separate TLS certificate for client auth.
| Key | Type | Default | Description |
|---|---|---|---|
| solrClientTLS.pkcs12Secret.name | string | Name of the Secret that stores the client keystore file in PKCS12 format | |
| solrClientTLS.pkcs12Secret.key | string | Key in the Secret that stores the client keystore file in PKCS12 format | |
| solrClientTLS.keyStorePasswordSecret.name | string | Name of the Secret that stores the client keystore password | |
| solrClientTLS.keyStorePasswordSecret.key | string | Key in the Secret that stores the client keystore password | |
| solrClientTLS.trustStoreSecret.name | string | Name of the Secret that stores the client truststore in PKCS12 format | |
| solrClientTLS.trustStoreSecret.key | string | Key in the Secret that stores the client truststore in PKCS12 format | |
| solrClientTLS.trustStorePasswordSecret.name | string | Name of the Secret that stores the truststore password | |
| solrClientTLS.trustStorePasswordSecret.key | string | Key in the Secret that stores the truststore password | |
| solrClientTLS.mountedTLSDir.path | string | The path on the main Solr container where the TLS files are mounted by some external agent or CSI Driver | |
| solrClientTLS.mountedTLSDir.keystoreFile | string | Name of the keystore file in the mounted directory | |
| solrClientTLS.mountedTLSDir.keystorePasswordFile | string | Override the name of the keystore password file; defaults to keystore-password | |
| solrClientTLS.mountedTLSDir.truststoreFile | string | Name of the truststore file in the mounted directory | |
| solrClientTLS.mountedTLSDir.truststorePasswordFile | string | Override the name of the truststore password file; defaults to the same value as the KeystorePasswordFile |
| Key | Type | Default | Description |
|---|---|---|---|
| global.imagePullSecrets | []object | The list of imagePullSecrets to include in pods | |
| global.clusterDomain | string | The cluster domain the Kubernetes is addressed under. |
Note: In the SolrCloud Spec, all of these options all fall under customSolrKubeOptions.
When using the helm chart, omit customSolrKubeOptions.
| Key | Type | Default | Description |
|---|---|---|---|
| podOptions.annotations | map[string]string | Custom annotations to add to the Solr pod | |
| podOptions.labels | map[string]string | Custom labels to add to the Solr pod | |
| podOptions.resources.limits | map[string]string | Provide Resource limits for the Solr container | |
| podOptions.resources.requests | map[string]string | Provide Resource requests for the Solr container | |
| podOptions.defaultInitContainerResources.limits | map[string]string | Provide Resource limits for Solr's default initContainer(s) | |
| podOptions.defaultInitContainerResources.requests | map[string]string | Provide Resource requests for Solr's default initContainer(s) | |
| podOptions.nodeSelector | map[string]string | Add a node selector for the Solr pod, to specify where it can be scheduled | |
| podOptions.affinity | object | Add Kubernetes affinity information for the Solr pod | |
| podOptions.tolerations | []object | Specify a list of Kubernetes tolerations for the Solr pod | |
| podOptions.topologySpreadConstraints | []object | Specify a list of Kubernetes topologySpreadConstraints for the Solr pod. No need to provide a labelSelector, as the Solr Operator will default that for you. More information can be found in the documentation. |
|
| podOptions.serviceAccountName | string | Optional serviceAccount to run the Solr pods under | |
| podOptions.priorityClassName | string | Optional priorityClassName for the Solr pod | |
| podOptions.sidecarContainers | []object | An optional list of additional containers to run along side the Solr in its pod | |
| podOptions.initContainers | []object | An optional list of additional initContainers to run before the Solr container starts | |
| podOptions.envVars | []object | List of additional environment variables for the Solr container | |
| podOptions.podSecurityContext | object | Security context for the Solr pod | |
| podOptions.terminationGracePeriodSeconds | int | Optional amount of time to wait for Solr to stop on its own, before manually killing it | |
| podOptions.livenessProbe | object | Custom liveness probe for the Solr container | |
| podOptions.readinessProbe | object | Custom readiness probe for the Solr container | |
| podOptions.startupProbe | object | Custom startup probe for the Solr container | |
| podOptions.lifecycle | object | Custom lifecycle for the Solr container | |
| podOptions.imagePullSecrets | []object | List of image pull secrets to inject into the Solr pod, in addition to global.imagePullSecrets |
|
| podOptions.volumes | []object | List of additional volumes to attach to the Solr pod, and optionally how to mount them to the Solr container | |
| statefulSetOptions.annotations | map[string]string | Custom annotations to add to the Solr statefulSet | |
| statefulSetOptions.labels | map[string]string | Custom labels to add to the Solr statefulSet | |
| statefulSetOptions.podManagementPolicy | string | "Parallel" |
Policy for how Solr pods should be managed in the statefulSet, "OrderedReady" or "Parallel" |
| commonServiceOptions.annotations | map[string]string | Custom annotations to add to the Solr common service | |
| commonServiceOptions.labels | map[string]string | Custom labels to add to the Solr common service | |
| commonServiceOptions.sessionAffinity | string | "None" |
Choose session affinity to setup for the common service. Available options are "None" and "ClientIP". |
| commonServiceOptions.sessionAffinityConfig | object | Sets configuration of session affinity | |
| headlessServiceOptions.annotations | map[string]string | Custom annotations to add to the Solr headless service | |
| headlessServiceOptions.labels | map[string]string | Custom labels to add to the Solr headless service | |
| nodeServiceOptions.annotations | map[string]string | Custom annotations to add to the Solr node service(s) | |
| nodeServiceOptions.labels | map[string]string | Custom labels to add to the Solr node service(s) | |
| ingressOptions.annotations | map[string]string | Custom annotations to add to the Solr ingress, if an Ingress is created/used | |
| ingressOptions.labels | map[string]string | Custom labels to add to the Solr ingress, if an Ingress is created/used | |
| ingressOptions.ingressClassName | string | Set the name of the IngressClass to use, if an Ingress is created/used | |
| configMapOptions.annotations | map[string]string | Custom annotations to add to the Solr configMap | |
| configMapOptions.labels | map[string]string | Custom labels to add to the Solr configMap | |
| configMapOptions.providedConfigMap | string | Provide an existing configMap for the Solr XML and/or Solr log4j files. ADVANCED |