Elasticsearch is a highly scalable open-source full-text search and analytics engine. It allows you to store, search, and analyze big volumes of data quickly and in near real time.

TL;DR

$ helm install bitnami/elasticsearch

Introduction

This chart bootstraps a Elasticsearch deployment on a Kubernetes cluster using the Helm package manager.

Bitnami charts can be used with Kubeapps for deployment and management of Helm Charts in clusters. This Helm chart has been tested on top of Bitnami Kubernetes Production Runtime (BKPR). Deploy BKPR to get automated TLS certificates, logging and monitoring for your applications.

Prerequisites

Kubernetes 1.6+ with Beta APIs enabled
PV provisioner support in the underlying infrastructure

Installing the Chart

To install the chart with the release name my-release:

$ helm install --name my-release bitnami/elasticsearch

The command deploys Elasticsearch on the Kubernetes cluster in the default configuration. The configuration section lists the parameters that can be configured during installation.

Tip

: List all releases using helm list

Uninstalling the Chart

To uninstall/delete the my-release release:

$ helm delete my-release

The command removes all the Kubernetes components associated with the chart and deletes the release. Remove also the chart using --purge option:

$ helm delete --purge my-release

Configuration

The following table lists the configurable parameters of the Elasticsearch chart and their default values.

Parameter	Description	Default
`global.imageRegistry`	Global Docker image registry	`nil`
`image.registry`	Elasticsearch image registry	`docker.io`
`image.repository`	Elasticsearch image repository	`bitnami/elasticsearch`
`image.tag`	Elasticsearch image tag	`{VERSION}`
`image.pullPolicy`	Image pull policy	`Always`
`image.pullSecrets`	Specify docker-registry secret names as an array	`[]` (does not add image pull secrets to deployed pods)
`name`	Elasticsearch cluster name	`elastic`
`plugins`	Comma, semi-colon or space separated list of plugins to install at initialization	`nil`
`config`	Elasticsearch node custom configuration	``
`master.name`	Master-eligible node pod name	`master`
`master.replicas`	Desired number of Elasticsearch master-eligible nodes	`2`
`master.heapSize`	Master-eligible node heap size	`128m`
`master.antiAffinity`	Master-eligible node pod anti-affinity policy	`soft`
`master.service.type`	Kubernetes Service type (master-eligible nodes)	`ClusterIP`
`master.service.port`	Kubernetes Service port for Elasticsearch transport port (master-eligible nodes)	`9300`
`master.service.nodePort`	Kubernetes Service nodePort (master-eligible nodes)	`nil`
`master.service.annotations`	Annotations for master-eligible nodes service	{}
`master.service.loadBalancerIP`	loadBalancerIP if master-eligible nodes service type is `LoadBalancer`	`nil`
`master.resources`	CPU/Memory resource requests/limits for master-eligible nodes pods	`requests: { cpu: "25m", memory: "256Mi" }`
`master.livenessProbe.enabled`	Enable/disable the liveness probe (master-eligible nodes pod)	`true`
`master.livenessProbe.initialDelaySeconds`	Delay before liveness probe is initiated (master-eligible nodes pod)	`90`
`master.livenessProbe.periodSeconds`	How often to perform the probe (master-eligible nodes pod)	`10`
`master.livenessProbe.timeoutSeconds`	When the probe times out (master-eligible nodes pod)	`5`
`master.livenessProbe.successThreshold`	Minimum consecutive successes for the probe to be considered successful after having failed (master-eligible nodes pod)	`1`
`master.livenessProbe.failureThreshold`	Minimum consecutive failures for the probe to be considered failed after having succeeded	`5`
`master.readinessProbe.enabled`	Enable/disable the readiness probe (master-eligible nodes pod)	`true`
`master.readinessProbe.initialDelaySeconds`	Delay before readiness probe is initiated (master-eligible nodes pod)	`90`
`master.readinessProbe.periodSeconds`	How often to perform the probe (master-eligible nodes pod)	`10`
`master.readinessProbe.timeoutSeconds`	When the probe times out (master-eligible nodes pod)	`5`
`master.readinessProbe.successThreshold`	Minimum consecutive successes for the probe to be considered successful after having failed (master-eligible nodes pod)	`1`
`master.readinessProbe.failureThreshold`	Minimum consecutive failures for the probe to be considered failed after having succeeded	`5`
`securityContext.enabled`	Enable security context	`true`
`securityContext.fsGroup`	Group ID for the container	`1001`
`securityContext.runAsUser`	User ID for the container	`1001`
`discovery.name`	Discover node pod name	`discovery`
`coordinating.name`	Coordinating-only node pod name	`coordinating-only`
`coordinating.replicas`	Desired number of Elasticsearch coordinating-only nodes	`2`
`coordinating.heapSize`	Coordinating-only node heap size	`128m`
`coordinating.antiAffinity`	Coordinating-only node pod anti-affinity policy	`soft`
`coordinating.service.type`	Kubernetes Service type (coordinating-only nodes)	`ClusterIP`
`coordinating.service.port`	Kubernetes Service port for REST API (coordinating-only nodes)	`9200`
`coordinating.service.nodePort`	Kubernetes Service nodePort (coordinating-only nodes)	`nil`
`coordinating.service.annotations`	Annotations for coordinating-only nodes service	{}
`coordinating.service.loadBalancerIP`	loadBalancerIP if coordinating-only nodes service type is `LoadBalancer`	`nil`
`coordinating.resources`	CPU/Memory resource requests/limits for coordinating-only nodes pods	`requests: { cpu: "25m", memory: "256Mi" }`
`coordinating.livenessProbe.enabled`	Enable/disable the liveness probe (coordinating-only nodes pod)	`true`
`coordinating.livenessProbe.initialDelaySeconds`	Delay before liveness probe is initiated (coordinating-only nodes pod)	`90`
`coordinating.livenessProbe.periodSeconds`	How often to perform the probe (coordinating-only nodes pod)	`10`
`coordinating.livenessProbe.timeoutSeconds`	When the probe times out (coordinating-only nodes pod)	`5`
`coordinating.livenessProbe.successThreshold`	Minimum consecutive successes for the probe to be considered successful after having failed (coordinating-only nodes pod)	`1`
`coordinating.livenessProbe.failureThreshold`	Minimum consecutive failures for the probe to be considered failed after having succeeded	`5`
`coordinating.readinessProbe.enabled`	Enable/disable the readiness probe (coordinating-only nodes pod)	`true`
`coordinating.readinessProbe.initialDelaySeconds`	Delay before readiness probe is initiated (coordinating-only nodes pod)	`90`
`coordinating.readinessProbe.periodSeconds`	How often to perform the probe (coordinating-only nodes pod)	`10`
`coordinating.readinessProbe.timeoutSeconds`	When the probe times out (coordinating-only nodes pod)	`5`
`coordinating.readinessProbe.successThreshold`	Minimum consecutive successes for the probe to be considered successful after having failed (coordinating-only nodes pod)	`1`
`coordinating.readinessProbe.failureThreshold`	Minimum consecutive failures for the probe to be considered failed after having succeeded	`5`
`data.name`	Data node pod name	`data`
`data.replicas`	Desired number of Elasticsearch data nodes nodes	`3`
`data.heapSize`	Data node heap size	`1024m`
`data.antiAffinity`	Data pod anti-affinity policy	`soft`
`data.resources`	CPU/Memory resource requests/limits for data nodes	`requests: { cpu: "25m", memory: "1152Mi" }`
`data.persistence.enabled`	Enable persistence using a `PersistentVolumeClaim`	`true`
`data.persistence.annotations`	Persistent Volume Claim annotations	`{}`
`data.persistence.storageClass`	Persistent Volume Storage Class	``
`data.persistence.accessModes`	Persistent Volume Access Modes	`[ReadWriteOnce]`
`data.persistence.size`	Persistent Volume Size	`8Gi`
`data.livenessProbe.enabled`	Enable/disable the liveness probe (data nodes pod)	`true`
`data.livenessProbe.initialDelaySeconds`	Delay before liveness probe is initiated (data nodes pod)	`90`
`data.livenessProbe.periodSeconds`	How often to perform the probe (data nodes pod)	`10`
`data.livenessProbe.timeoutSeconds`	When the probe times out (data nodes pod)	`5`
`data.livenessProbe.successThreshold`	Minimum consecutive successes for the probe to be considered successful after having failed (data nodes pod)	`1`
`data.livenessProbe.failureThreshold`	Minimum consecutive failures for the probe to be considered failed after having succeeded	`5`
`data.readinessProbe.enabled`	Enable/disable the readiness probe (data nodes pod)	`true`
`data.readinessProbe.initialDelaySeconds`	Delay before readiness probe is initiated (data nodes pod)	`90`
`data.readinessProbe.periodSeconds`	How often to perform the probe (data nodes pod)	`10`
`data.readinessProbe.timeoutSeconds`	When the probe times out (data nodes pod)	`5`
`data.readinessProbe.successThreshold`	Minimum consecutive successes for the probe to be considered successful after having failed (data nodes pod)	`1`
`data.readinessProbe.failureThreshold`	Minimum consecutive failures for the probe to be considered failed after having succeeded	`5`
`ingest.enabled`	Enable ingest nodes	`false`
`ingest.name`	Ingest node pod name	`ingest`
`ingest.replicas`	Desired number of Elasticsearch ingest nodes	`2`
`ingest.heapSize`	Ingest node heap size	`128m`
`ingest.antiAffinity`	Ingest node pod anti-affinity policy	`soft`
`ingest.service.type`	Kubernetes Service type (ingest nodes)	`ClusterIP`
`ingest.service.port`	Kubernetes Service port Elasticsearch transport port (ingest nodes)	`9300`
`ingest.service.nodePort`	Kubernetes Service nodePort (ingest nodes)	`nil`
`ingest.service.annotations`	Annotations for ingest nodes service	{}
`ingest.service.loadBalancerIP`	loadBalancerIP if ingest nodes service type is `LoadBalancer`	`nil`
`ingest.resources`	CPU/Memory resource requests/limits for ingest nodes pods	`requests: { cpu: "25m", memory: "256Mi" }`
`ingest.livenessProbe.enabled`	Enable/disable the liveness probe (ingest nodes pod)	`true`
`ingest.livenessProbe.initialDelaySeconds`	Delay before liveness probe is initiated (ingest nodes pod)	`90`
`ingest.livenessProbe.periodSeconds`	How often to perform the probe (ingest nodes pod)	`10`
`ingest.livenessProbe.timeoutSeconds`	When the probe times out (ingest nodes pod)	`5`
`ingest.livenessProbe.successThreshold`	Minimum consecutive successes for the probe to be considered successful after having failed (ingest nodes pod)	`1`
`ingest.livenessProbe.failureThreshold`	Minimum consecutive failures for the probe to be considered failed after having succeeded	`5`
`ingest.readinessProbe.enabled`	Enable/disable the readiness probe (ingest nodes pod)	`true`
`ingest.readinessProbe.initialDelaySeconds`	Delay before readiness probe is initiated (ingest nodes pod)	`90`
`ingest.readinessProbe.periodSeconds`	How often to perform the probe (ingest nodes pod)	`10`
`ingest.readinessProbe.timeoutSeconds`	When the probe times out (ingest nodes pod)	`5`
`ingest.readinessProbe.successThreshold`	Minimum consecutive successes for the probe to be considered successful after having failed (ingest nodes pod)	`1`
`ingest.readinessProbe.failureThreshold`	Minimum consecutive failures for the probe to be considered failed after having succeeded	`5`
`metrics.enabled`	Enable prometheus exporter	`false`
`metrics.name`	Metrics pod name	`metrics`
`metrics.image.registry`	Metrics exporter image registry	`docker.io`
`metrics.image.repository`	Metrics exporter image repository	`bitnami/elasticsearch-exporter`
`metrics.image.tag`	Metrics exporter image tag	`1.0.2`
`metrics.image.pullPolicy`	Metrics exporter image pull policy	`Always`
`metrics.service.type`	Metrics exporter endpoint service type	`ClusterIP`
`metrics.resources`	Metrics exporter resource requests/limit	`requests: { cpu: "25m" }`
`sysctlImage.enabled`	Enable kernel settings modifier image	`false`
`sysctlImage.registry`	Kernel settings modifier image registry	`docker.io`
`sysctlImage.repository`	Kernel settings modifier image repository	`bitnami/minideb`
`sysctlImage.tag`	Kernel settings modifier image tag	`latest`
`sysctlImage.pullPolicy`	Kernel settings modifier image pull policy	`Always`

Specify each parameter using the --set key=value[,key=value] argument to helm install. For example,

$ helm install --name my-release \
  --set name=my-elastic,client.service.port=8080 \
  bitnami/elasticsearch

The above command sets the Elasticsearch cluster name to my-elastic and REST port number to 8080.

Alternatively, a YAML file that specifies the values for the parameters can be provided while installing the chart. For example,

$ helm install --name my-release -f values.yaml bitnami/elasticsearch

Tip

: You can use the default values.yaml. values-production.yaml has defaults optimized for use in production environments.

Persistence

The Bitnami Elasticsearch image stores the Elasticsearch data at the /bitnami/elasticsearch/data path of the container.

By default, the chart mounts a Persistent Volume at this location. The volume is created using dynamic volume provisioning. See the Configuration section to configure the PVC.

Troubleshooting

Currently, Elasticsearch requires some changes in the kernel of the host machine to work as expected. If those values are not set in the underlying operating system, the ES containers fail to boot with ERROR messages. More information about these requirements can be found in the links below:

You can use a privileged initContainer to changes those settings in the Kernel by enabling the sysctlImage.enabled:

$ helm install --name my-release \
  --set sysctlImage.enabled=true \
  bitnami/elasticsearch

Upgrading

To 3.0.0

Backwards compatibility is not guaranteed unless you modify the labels used on the chart's deployments. Use the workaround below to upgrade from versions previous to 3.0.0. The following example assumes that the release name is elasticsearch:

$ kubectl patch deployment elasticsearch-coordinating --type=json -p='[{"op": "remove", "path": "/spec/selector/matchLabels/chart"}]'
$ kubectl patch deployment elasticsearch-ingest --type=json -p='[{"op": "remove", "path": "/spec/selector/matchLabels/chart"}]'
$ kubectl patch deployment elasticsearch-master --type=json -p='[{"op": "remove", "path": "/spec/selector/matchLabels/chart"}]'
$ kubectl patch deployment elasticsearch-metrics --type=json -p='[{"op": "remove", "path": "/spec/selector/matchLabels/chart"}]'
$ kubectl delete statefulset elasticsearch-data --cascade=false