Difference between revisions of "Helm show all elastic/elasticsearch"

From wikieduonline
Jump to navigation Jump to search
(Created page with "{{lc}} == See also == * {{ES}} Category:ES")
 
Line 1: Line 1:
 
{{lc}}
 
{{lc}}
  
 +
apiVersion: v1
 +
appVersion: 7.17.3
 +
description: Official Elastic helm chart for Elasticsearch
 +
home: https://github.com/elastic/helm-charts
 +
icon: https://helm.elastic.co/icons/elasticsearch.png
 +
maintainers:
 +
 +
  name: Elastic
 +
name: elasticsearch
 +
sources:
 +
- https://github.com/elastic/elasticsearch
 +
version: 7.17.3
 +
 +
---
 +
---
 +
clusterName: "elasticsearch"
 +
nodeGroup: "master"
 +
 +
# The service that non master groups will try to connect to when joining the cluster
 +
# This should be set to clusterName + "-" + nodeGroup for your master group
 +
masterService: ""
 +
 +
# Elasticsearch roles that will be applied to this nodeGroup
 +
# These will be set as environment variables. E.g. node.master=true
 +
roles:
 +
  master: "true"
 +
  ingest: "true"
 +
  data: "true"
 +
  remote_cluster_client: "true"
 +
  ml: "true"
 +
 +
replicas: 3
 +
minimumMasterNodes: 2
 +
 +
esMajorVersion: ""
 +
 +
clusterDeprecationIndexing: "false"
 +
 +
# Allows you to add any config files in /usr/share/elasticsearch/config/
 +
# such as elasticsearch.yml and log4j2.properties
 +
esConfig: {}
 +
#  elasticsearch.yml: |
 +
#    key:
 +
#      nestedkey: value
 +
#  log4j2.properties: |
 +
#    key = value
 +
 +
esJvmOptions: {}
 +
#  processors.options: |
 +
#    -XX:ActiveProcessorCount=3
 +
 +
# Extra environment variables to append to this nodeGroup
 +
# This will be appended to the current 'env:' key. You can use any of the kubernetes env
 +
# syntax here
 +
extraEnvs: []
 +
#  - name: MY_ENVIRONMENT_VAR
 +
#    value: the_value_goes_here
 +
 +
# Allows you to load environment variables from kubernetes secret or config map
 +
envFrom: []
 +
# - secretRef:
 +
#    name: env-secret
 +
# - configMapRef:
 +
#    name: config-map
 +
 +
# A list of secrets and their paths to mount inside the pod
 +
# This is useful for mounting certificates for security and for mounting
 +
# the X-Pack license
 +
secretMounts: []
 +
#  - name: elastic-certificates
 +
#    secretName: elastic-certificates
 +
#    path: /usr/share/elasticsearch/config/certs
 +
#    defaultMode: 0755
 +
 +
hostAliases: []
 +
#- ip: "127.0.0.1"
 +
#  hostnames:
 +
#  - "foo.local"
 +
#  - "bar.local"
 +
 +
image: "docker.elastic.co/elasticsearch/elasticsearch"
 +
imageTag: "7.17.3"
 +
imagePullPolicy: "IfNotPresent"
 +
 +
podAnnotations:
 +
  {}
 +
  # iam.amazonaws.com/role: es-cluster
 +
 +
# additionals labels
 +
labels: {}
 +
 +
esJavaOpts: "" # example: "-Xmx1g -Xms1g"
 +
 +
resources:
 +
  requests:
 +
    cpu: "1000m"
 +
    memory: "2Gi"
 +
  limits:
 +
    cpu: "1000m"
 +
    memory: "2Gi"
 +
 +
initResources:
 +
  {}
 +
  # limits:
 +
  #  cpu: "25m"
 +
  #  # memory: "128Mi"
 +
  # requests:
 +
  #  cpu: "25m"
 +
  #  memory: "128Mi"
 +
 +
networkHost: "0.0.0.0"
 +
 +
volumeClaimTemplate:
 +
  accessModes: ["ReadWriteOnce"]
 +
  resources:
 +
    requests:
 +
      storage: 30Gi
 +
 +
rbac:
 +
  create: false
 +
  serviceAccountAnnotations: {}
 +
  serviceAccountName: ""
 +
  automountToken: true
 +
 +
podSecurityPolicy:
 +
  create: false
 +
  name: ""
 +
  spec:
 +
    privileged: true
 +
    fsGroup:
 +
      rule: RunAsAny
 +
    runAsUser:
 +
      rule: RunAsAny
 +
    seLinux:
 +
      rule: RunAsAny
 +
    supplementalGroups:
 +
      rule: RunAsAny
 +
    volumes:
 +
      - secret
 +
      - configMap
 +
      - persistentVolumeClaim
 +
      - emptyDir
 +
 +
persistence:
 +
  enabled: true
 +
  labels:
 +
    # Add default labels for the volumeClaimTemplate of the StatefulSet
 +
    enabled: false
 +
  annotations: {}
 +
 +
extraVolumes:
 +
  []
 +
  # - name: extras
 +
  #  emptyDir: {}
 +
 +
extraVolumeMounts:
 +
  []
 +
  # - name: extras
 +
  #  mountPath: /usr/share/extras
 +
  #  readOnly: true
 +
 +
extraContainers:
 +
  []
 +
  # - name: do-something
 +
  #  image: busybox
 +
  #  command: ['do', 'something']
 +
 +
extraInitContainers:
 +
  []
 +
  # - name: do-something
 +
  #  image: busybox
 +
  #  command: ['do', 'something']
 +
 +
# This is the PriorityClass settings as defined in
 +
# https://kubernetes.io/docs/concepts/configuration/pod-priority-preemption/#priorityclass
 +
priorityClassName: ""
 +
 +
# By default this will make sure two pods don't end up on the same node
 +
# Changing this to a region would allow you to spread pods across regions
 +
antiAffinityTopologyKey: "kubernetes.io/hostname"
 +
 +
# Hard means that by default pods will only be scheduled if there are enough nodes for them
 +
# and that they will never end up on the same node. Setting this to soft will do this "best effort"
 +
antiAffinity: "hard"
 +
 +
# This is the node affinity settings as defined in
 +
# https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#node-affinity-beta-feature
 +
nodeAffinity: {}
 +
 +
# The default is to deploy all pods serially. By setting this to parallel all pods are started at
 +
# the same time when bootstrapping the cluster
 +
podManagementPolicy: "Parallel"
 +
 +
# The environment variables injected by service links are not used, but can lead to slow Elasticsearch boot times when
 +
# there are many services in the current namespace.
 +
# If you experience slow pod startups you probably want to set this to `false`.
 +
enableServiceLinks: true
 +
 +
protocol: http
 +
httpPort: 9200
 +
transportPort: 9300
 +
 +
service:
 +
  enabled: true
 +
  labels: {}
 +
  labelsHeadless: {}
 +
  type: ClusterIP
 +
  # Consider that all endpoints are considered "ready" even if the Pods themselves are not
 +
  # https://kubernetes.io/docs/reference/kubernetes-api/service-resources/service-v1/#ServiceSpec
 +
  publishNotReadyAddresses: false
 +
  nodePort: ""
 +
  annotations: {}
 +
  httpPortName: http
 +
  transportPortName: transport
 +
  loadBalancerIP: ""
 +
  loadBalancerSourceRanges: []
 +
  externalTrafficPolicy: ""
 +
 +
updateStrategy: RollingUpdate
 +
 +
# This is the max unavailable setting for the pod disruption budget
 +
# The default value of 1 will make sure that kubernetes won't allow more than 1
 +
# of your pods to be unavailable during maintenance
 +
maxUnavailable: 1
 +
 +
podSecurityContext:
 +
  fsGroup: 1000
 +
  runAsUser: 1000
 +
 +
securityContext:
 +
  capabilities:
 +
    drop:
 +
      - ALL
 +
  # readOnlyRootFilesystem: true
 +
  runAsNonRoot: true
 +
  runAsUser: 1000
 +
 +
# How long to wait for elasticsearch to stop gracefully
 +
terminationGracePeriod: 120
 +
 +
sysctlVmMaxMapCount: 262144
 +
 +
readinessProbe:
 +
  failureThreshold: 3
 +
  initialDelaySeconds: 10
 +
  periodSeconds: 10
 +
  successThreshold: 3
 +
  timeoutSeconds: 5
 +
 +
# https://www.elastic.co/guide/en/elasticsearch/reference/7.17/cluster-health.html#request-params wait_for_status
 +
clusterHealthCheckParams: "wait_for_status=green&timeout=1s"
 +
 +
## Use an alternate scheduler.
 +
## ref: https://kubernetes.io/docs/tasks/administer-cluster/configure-multiple-schedulers/
 +
##
 +
schedulerName: ""
 +
 +
imagePullSecrets: []
 +
nodeSelector: {}
 +
tolerations: []
 +
 +
# Enabling this will publicly expose your Elasticsearch instance.
 +
# Only enable this if you have security enabled on your cluster
 +
ingress:
 +
  enabled: false
 +
  annotations: {}
 +
  # kubernetes.io/ingress.class: nginx
 +
  # kubernetes.io/tls-acme: "true"
 +
  className: "nginx"
 +
  pathtype: ImplementationSpecific
 +
  hosts:
 +
    - host: chart-example.local
 +
      paths:
 +
        - path: /
 +
  tls: []
 +
  #  - secretName: chart-example-tls
 +
  #    hosts:
 +
  #      - chart-example.local
 +
 +
nameOverride: ""
 +
fullnameOverride: ""
 +
healthNameOverride: ""
 +
 +
lifecycle:
 +
  {}
 +
  # preStop:
 +
  #  exec:
 +
  #    command: ["/bin/sh", "-c", "echo Hello from the postStart handler > /usr/share/message"]
 +
  # postStart:
 +
  #  exec:
 +
  #    command:
 +
  #      - bash
 +
  #      - -c
 +
  #      - |
 +
  #        #!/bin/bash
 +
  #        # Add a template to adjust number of shards/replicas
 +
  #        TEMPLATE_NAME=my_template
 +
  #        INDEX_PATTERN="logstash-*"
 +
  #        SHARD_COUNT=8
 +
  #        REPLICA_COUNT=1
 +
  #        ES_URL=http://localhost:9200
 +
  #        while [[ "$(curl -s -o /dev/null -w '%{http_code}\n' $ES_URL)" != "200" ]]; do sleep 1; done
 +
  #        curl -XPUT "$ES_URL/_template/$TEMPLATE_NAME" -H 'Content-Type: application/json' -d'{"index_patterns":['\""$INDEX_PATTERN"\"'],"settings":{"number_of_shards":'$SHARD_COUNT',"number_of_replicas":'$REPLICA_COUNT'}}'
 +
 +
sysctlInitContainer:
 +
  enabled: true
 +
 +
keystore: []
 +
 +
networkPolicy:
 +
  ## Enable creation of NetworkPolicy resources. Only Ingress traffic is filtered for now.
 +
  ## In order for a Pod to access Elasticsearch, it needs to have the following label:
 +
  ## {{ template "uname" . }}-client: "true"
 +
  ## Example for default configuration to access HTTP port:
 +
  ## elasticsearch-master-http-client: "true"
 +
  ## Example for default configuration to access transport port:
 +
  ## elasticsearch-master-transport-client: "true"
 +
 +
  http:
 +
    enabled: false
 +
    ## if explicitNamespacesSelector is not set or set to {}, only client Pods being in the networkPolicy's namespace
 +
    ## and matching all criteria can reach the DB.
 +
    ## But sometimes, we want the Pods to be accessible to clients from other namespaces, in this case, we can use this
 +
    ## parameter to select these namespaces
 +
    ##
 +
    # explicitNamespacesSelector:
 +
    #  # Accept from namespaces with all those different rules (only from whitelisted Pods)
 +
    #  matchLabels:
 +
    #    role: frontend
 +
    #  matchExpressions:
 +
    #    - {key: role, operator: In, values: [frontend]}
 +
    ## Additional NetworkPolicy Ingress "from" rules to set. Note that all rules are OR-ed.
 +
    ##
 +
    # additionalRules:
 +
    #  - podSelector:
 +
    #      matchLabels:
 +
    #        role: frontend
 +
    #  - podSelector:
 +
    #      matchExpressions:
 +
    #        - key: role
 +
    #          operator: In
 +
    #          values:
 +
    #            - frontend
 +
 +
  transport:
 +
    ## Note that all Elasticsearch Pods can talk to themselves using transport port even if enabled.
 +
    enabled: false
 +
    # explicitNamespacesSelector:
 +
    #  matchLabels:
 +
    #    role: frontend
 +
    #  matchExpressions:
 +
    #    - {key: role, operator: In, values: [frontend]}
 +
    # additionalRules:
 +
    #  - podSelector:
 +
    #      matchLabels:
 +
    #        role: frontend
 +
    #  - podSelector:
 +
    #      matchExpressions:
 +
    #        - key: role
 +
    #          operator: In
 +
    #          values:
 +
    #            - frontend
 +
 +
tests:
 +
  enabled: true
 +
 +
# Deprecated
 +
# please use the above podSecurityContext.fsGroup instead
 +
fsGroup: ""
 +
 +
---
 +
# Elasticsearch Helm Chart
 +
 +
[![Build Status](https://img.shields.io/jenkins/s/https/devops-ci.elastic.co/job/elastic+helm-charts+master.svg)](https://devops-ci.elastic.co/job/elastic+helm-charts+master/) [![Artifact HUB](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/elastic)](https://artifacthub.io/packages/search?repo=elastic)
 +
 +
This Helm chart is a lightweight way to configure and run our official
 +
[Elasticsearch Docker image][].
 +
 +
<!-- development warning placeholder -->
 +
 +
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
 +
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
 +
 +
 +
- [Requirements](#requirements)
 +
- [Installing](#installing)
 +
  - [Install released version using Helm repository](#install-released-version-using-helm-repository)
 +
  - [Install development version from a branch](#install-development-version-from-a-branch)
 +
- [Upgrading](#upgrading)
 +
- [Usage notes](#usage-notes)
 +
- [Configuration](#configuration)
 +
  - [Deprecated](#deprecated)
 +
- [FAQ](#faq)
 +
  - [How to deploy this chart on a specific K8S distribution?](#how-to-deploy-this-chart-on-a-specific-k8s-distribution)
 +
  - [How to deploy dedicated nodes types?](#how-to-deploy-dedicated-nodes-types)
 +
    - [Clustering and Node Discovery](#clustering-and-node-discovery)
 +
  - [How to deploy clusters with security (authentication and TLS) enabled?](#how-to-deploy-clusters-with-security-authentication-and-tls-enabled)
 +
  - [How to migrate from helm/charts stable chart?](#how-to-migrate-from-helmcharts-stable-chart)
 +
  - [How to install plugins?](#how-to-install-plugins)
 +
  - [How to use the keystore?](#how-to-use-the-keystore)
 +
    - [Basic example](#basic-example)
 +
    - [Multiple keys](#multiple-keys)
 +
    - [Custom paths and keys](#custom-paths-and-keys)
 +
  - [How to enable snapshotting?](#how-to-enable-snapshotting)
 +
  - [How to configure templates post-deployment?](#how-to-configure-templates-post-deployment)
 +
- [Contributing](#contributing)
 +
 +
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
 +
<!-- Use this to update TOC: -->
 +
<!-- docker run --rm -it -v $(pwd):/usr/src jorgeandrada/doctoc --github -->
 +
 +
 +
## Requirements
 +
 +
* Kubernetes >= 1.14
 +
* [Helm][] >= 2.17.0
 +
* Minimum cluster requirements include the following to run this chart with
 +
default settings. All of these settings are configurable.
 +
  * Three Kubernetes nodes to respect the default "hard" affinity settings
 +
  * 1GB of RAM for the JVM heap
 +
 +
See [supported configurations][] for more details.
 +
 +
## Installing
 +
 +
This chart is tested with the latest 7.17.3 version.
 +
 +
### Install released version using Helm repository
 +
 +
* Add the Elastic Helm charts repo:
 +
`helm repo add elastic https://helm.elastic.co`
 +
 +
* Install it:
 +
  - with Helm 3: `helm install elasticsearch --version <version> elastic/elasticsearch`
 +
  - with Helm 2 (deprecated): `helm install --name elasticsearch --version <version> elastic/elasticsearch`
 +
 +
### Install development version from a branch
 +
 +
* Clone the git repo: `git clone [email protected]:elastic/helm-charts.git`
 +
 +
* Checkout the branch : `git checkout 7.17`
 +
 +
* Install it:
 +
  - with Helm 3: `helm install elasticsearch ./helm-charts/elasticsearch --set imageTag=7.17.3`
 +
  - with Helm 2 (deprecated): `helm install --name elasticsearch ./helm-charts/elasticsearch --set imageTag=7.17.3`
 +
 +
 +
## Upgrading
 +
 +
Please always check [CHANGELOG.md][] and [BREAKING_CHANGES.md][] before
 +
upgrading to a new chart version.
 +
 +
 +
## Usage notes
 +
 +
* This repo includes a number of [examples][] configurations which can be used
 +
as a reference. They are also used in the automated testing of this chart.
 +
* Automated testing of this chart is currently only run against GKE (Google
 +
Kubernetes Engine).
 +
* The chart deploys a StatefulSet and by default will do an automated rolling
 +
update of your cluster. It does this by waiting for the cluster health to become
 +
green after each instance is updated. If you prefer to update manually you can
 +
set `OnDelete` [updateStrategy][].
 +
* It is important to verify that the JVM heap size in `esJavaOpts` and to set
 +
the CPU/Memory `resources` to something suitable for your cluster.
 +
* To simplify chart and maintenance each set of node groups is deployed as a
 +
separate Helm release. Take a look at the [multi][] example to get an idea for
 +
how this works. Without doing this it isn't possible to resize persistent
 +
volumes in a StatefulSet. By setting it up this way it makes it possible to add
 +
more nodes with a new storage size then drain the old ones. It also solves the
 +
problem of allowing the user to determine which node groups to update first when
 +
doing upgrades or changes.
 +
* We have designed this chart to be very un-opinionated about how to configure
 +
Elasticsearch. It exposes ways to set environment variables and mount secrets
 +
inside of the container. Doing this makes it much easier for this chart to
 +
support multiple versions with minimal changes.
 +
 +
 +
## Configuration
 +
 +
| Parameter                          | Description                                                                                                                                                                                                                                                                                                      | Default                                          |
 +
|------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------|
 +
| `antiAffinityTopologyKey`          | The [anti-affinity][] topology key. By default this will prevent multiple Elasticsearch nodes from running on the same Kubernetes node                                                                                                                                                                            | `kubernetes.io/hostname`                        |
 +
| `antiAffinity`                    | Setting this to hard enforces the [anti-affinity][] rules. If it is set to soft it will be done "best effort". Other values will be ignored                                                                                                                                                                      | `hard`                                          |
 +
| `clusterHealthCheckParams`        | The [Elasticsearch cluster health status params][] that will be used by readiness [probe][] command                                                                                                                                                                                                              | `wait_for_status=green&timeout=1s`              |
 +
| `clusterName`                      | This will be used as the Elasticsearch [cluster.name][] and should be unique per cluster in the namespace                                                                                                                                                                                                        | `elasticsearch`                                  |
 +
| `clusterDeprecationIndexing`      | Enable or disable deprecation logs to be indexed (should be disabled when deploying master only node groups)                                                                                                                                                                                                      | `false`                                          |
 +
| `enableServiceLinks`              | Set to false to disabling service links, which can cause slow pod startup times when there are many services in the current namespace.                                                                                                                                                                            | `true`                                          |
 +
| `envFrom`                          | Templatable string to be passed to the [environment from variables][] which will be appended to the `envFrom:` definition for the container                                                                                                                                                                      | `[]`                                            |
 +
| `esConfig`                        | Allows you to add any config files in `/usr/share/elasticsearch/config/` such as `elasticsearch.yml` and `log4j2.properties`. See [values.yaml][] for an example of the formatting                                                                                                                                | `{}`                                            |
 +
| `esJavaOpts`                      | [Java options][] for Elasticsearch. This is where you could configure the [jvm heap size][]                                                                                                                                                                                                                      | `""`                                            |
 +
| `esJvmOptions`                    | [Java options][] for Elasticsearch. Override the default JVM options by adding custom options files .  See [values.yaml][] for an example of the formatting                                                                                                                                                      | `{}`                                            |
 +
| `esMajorVersion`                  | Deprecated. Instead, use the version of the chart corresponding to your ES minor version. Used to set major version specific configuration. If you are using a custom image and not running the default Elasticsearch version you will need to set this to the version you are running (e.g. `esMajorVersion: 6`) | `""`                                            |
 +
| `extraContainers`                  | Templatable string of additional `containers` to be passed to the `tpl` function                                                                                                                                                                                                                                  | `""`                                            |
 +
| `extraEnvs`                        | Extra [environment variables][] which will be appended to the `env:` definition for the container                                                                                                                                                                                                                | `[]`                                            |
 +
| `extraInitContainers`              | Templatable string of additional `initContainers` to be passed to the `tpl` function                                                                                                                                                                                                                              | `""`                                            |
 +
| `extraVolumeMounts`                | Templatable string of additional `volumeMounts` to be passed to the `tpl` function                                                                                                                                                                                                                                | `""`                                            |
 +
| `extraVolumes`                    | Templatable string of additional `volumes` to be passed to the `tpl` function                                                                                                                                                                                                                                    | `""`                                            |
 +
| `fullnameOverride`                | Overrides the `clusterName` and `nodeGroup` when used in the naming of resources. This should only be used when using a single `nodeGroup`, otherwise you will have name conflicts                                                                                                                                | `""`                                            |
 +
| `healthNameOverride`              | Overrides `test-elasticsearch-health` pod name                                                                                                                                                                                                                                                                    | `""`                                            |
 +
| `hostAliases`                      | Configurable [hostAliases][]                                                                                                                                                                                                                                                                                      | `[]`                                            |
 +
| `httpPort`                        | The http port that Kubernetes will use for the healthchecks and the service. If you change this you will also need to set [http.port][] in `extraEnvs`                                                                                                                                                            | `9200`                                          |
 +
| `imagePullPolicy`                  | The Kubernetes [imagePullPolicy][] value                                                                                                                                                                                                                                                                          | `IfNotPresent`                                  |
 +
| `imagePullSecrets`                | Configuration for [imagePullSecrets][] so that you can use a private registry for your image                                                                                                                                                                                                                      | `[]`                                            |
 +
| `imageTag`                        | The Elasticsearch Docker image tag                                                                                                                                                                                                                                                                                | `7.17.3`                                        |
 +
| `image`                            | The Elasticsearch Docker image                                                                                                                                                                                                                                                                                    | `docker.elastic.co/elasticsearch/elasticsearch`  |
 +
| `ingress`                          | Configurable [ingress][] to expose the Elasticsearch service. See [values.yaml][] for an example                                                                                                                                                                                                                  | see [values.yaml][]                              |
 +
| `initResources`                    | Allows you to set the [resources][] for the `initContainer` in the StatefulSet                                                                                                                                                                                                                                    | `{}`                                            |
 +
| `keystore`                        | Allows you map Kubernetes secrets into the keystore. See the [config example][] and [how to use the keystore][]                                                                                                                                                                                                  | `[]`                                            |
 +
| `labels`                          | Configurable [labels][] applied to all Elasticsearch pods                                                                                                                                                                                                                                                        | `{}`                                            |
 +
| `lifecycle`                        | Allows you to add [lifecycle hooks][]. See [values.yaml][] for an example of the formatting                                                                                                                                                                                                                      | `{}`                                            |
 +
| `masterService`                    | The service name used to connect to the masters. You only need to set this if your master `nodeGroup` is set to something other than `master`. See [Clustering and Node Discovery][] for more information                                                                                                        | `""`                                            |
 +
| `maxUnavailable`                  | The [maxUnavailable][] value for the pod disruption budget. By default this will prevent Kubernetes from having more than 1 unhealthy pod in the node group                                                                                                                                                      | `1`                                              |
 +
| `minimumMasterNodes`              | The value for [discovery.zen.minimum_master_nodes][]. Should be set to `(master_eligible_nodes / 2) + 1`. Ignored in Elasticsearch versions >= 7                                                                                                                                                                  | `2`                                              |
 +
| `nameOverride`                    | Overrides the `clusterName` when used in the naming of resources                                                                                                                                                                                                                                                  | `""`                                            |
 +
| `networkHost`                      | Value for the [network.host Elasticsearch setting][]                                                                                                                                                                                                                                                              | `0.0.0.0`                                        |
 +
| `networkPolicy`                    | The [NetworkPolicy](https://kubernetes.io/docs/concepts/services-networking/network-policies/) to set. See [`values.yaml`](./values.yaml) for an example                                                                                                                                                          | `{http.enabled: false,transport.enabled: false}` |
 +
| `nodeAffinity`                    | Value for the [node affinity settings][]                                                                                                                                                                                                                                                                          | `{}`                                            |
 +
| `nodeGroup`                        | This is the name that will be used for each group of nodes in the cluster. The name will be `clusterName-nodeGroup-X` , `nameOverride-nodeGroup-X` if a `nameOverride` is specified, and `fullnameOverride-X` if a `fullnameOverride` is specified                                                                | `master`                                        |
 +
| `nodeSelector`                    | Configurable [nodeSelector][] so that you can target specific nodes for your Elasticsearch cluster                                                                                                                                                                                                                | `{}`                                            |
 +
| `persistence`                      | Enables a persistent volume for Elasticsearch data. Can be disabled for nodes that only have [roles][] which don't require persistent data                                                                                                                                                                        | see [values.yaml][]                              |
 +
| `podAnnotations`                  | Configurable [annotations][] applied to all Elasticsearch pods                                                                                                                                                                                                                                                    | `{}`                                            |
 +
| `podManagementPolicy`              | By default Kubernetes [deploys StatefulSets serially][]. This deploys them in parallel so that they can discover each other                                                                                                                                                                                      | `Parallel`                                      |
 +
| `podSecurityContext`              | Allows you to set the [securityContext][] for the pod                                                                                                                                                                                                                                                            | see [values.yaml][]                              |
 +
| `podSecurityPolicy`                | Configuration for create a pod security policy with minimal permissions to run this Helm chart with `create: true`. Also can be used to reference an external pod security policy with `name: "externalPodSecurityPolicy"`                                                                                        | see [values.yaml][]                              |
 +
| `priorityClassName`                | The name of the [PriorityClass][]. No default is supplied as the PriorityClass must be created first                                                                                                                                                                                                              | `""`                                            |
 +
| `protocol`                        | The protocol that will be used for the readiness [probe][]. Change this to `https` if you have `xpack.security.http.ssl.enabled` set                                                                                                                                                                              | `http`                                          |
 +
| `rbac`                            | Configuration for creating a role, role binding and ServiceAccount as part of this Helm chart with `create: true`. Also can be used to reference an external ServiceAccount with `serviceAccountName: "externalServiceAccountName"`, or automount the service account token                                      | see [values.yaml][]                              |
 +
| `readinessProbe`                  | Configuration fields for the readiness [probe][]                                                                                                                                                                                                                                                                  | see [values.yaml][]                              |
 +
| `replicas`                        | Kubernetes replica count for the StatefulSet (i.e. how many pods)                                                                                                                                                                                                                                                | `3`                                              |
 +
| `resources`                        | Allows you to set the [resources][] for the StatefulSet                                                                                                                                                                                                                                                          | see [values.yaml][]                              |
 +
| `roles`                            | A hash map with the specific [roles][] for the `nodeGroup`                                                                                                                                                                                                                                                        | see [values.yaml][]                              |
 +
| `schedulerName`                    | Name of the [alternate scheduler][]                                                                                                                                                                                                                                                                              | `""`                                            |
 +
| `secretMounts`                    | Allows you easily mount a secret as a file inside the StatefulSet. Useful for mounting certificates and other secrets. See [values.yaml][] for an example                                                                                                                                                        | `[]`                                            |
 +
| `securityContext`                  | Allows you to set the [securityContext][] for the container                                                                                                                                                                                                                                                      | see [values.yaml][]                              |
 +
| `service.annotations`              | [LoadBalancer annotations][] that Kubernetes will use for the service. This will configure load balancer if `service.type` is `LoadBalancer`                                                                                                                                                                      | `{}`                                            |
 +
| `service.enabled`                  | Enable non-headless service                                                                                                                                                                                                                                                                                      | `true`                                          |
 +
| `service.externalTrafficPolicy`    | Some cloud providers allow you to specify the [LoadBalancer externalTrafficPolicy][]. Kubernetes will use this to preserve the client source IP. This will configure load balancer if `service.type` is `LoadBalancer`                                                                                            | `""`                                            |
 +
| `service.httpPortName`            | The name of the http port within the service                                                                                                                                                                                                                                                                      | `http`                                          |
 +
| `service.labelsHeadless`          | Labels to be added to headless service                                                                                                                                                                                                                                                                            | `{}`                                            |
 +
| `service.labels`                  | Labels to be added to non-headless service                                                                                                                                                                                                                                                                        | `{}`                                            |
 +
| `service.loadBalancerIP`          | Some cloud providers allow you to specify the [loadBalancer][] IP. If the `loadBalancerIP` field is not specified, the IP is dynamically assigned. If you specify a `loadBalancerIP` but your cloud provider does not support the feature, it is ignored.                                                        | `""`                                            |
 +
| `service.loadBalancerSourceRanges` | The IP ranges that are allowed to access                                                                                                                                                                                                                                                                          | `[]`                                            |
 +
| `service.nodePort`                | Custom [nodePort][] port that can be set if you are using `service.type: nodePort`                                                                                                                                                                                                                                | `""`                                            |
 +
| `service.transportPortName`        | The name of the transport port within the service                                                                                                                                                                                                                                                                | `transport`                                      |
 +
| `service.publishNotReadyAddresses` | Consider that all endpoints are considered "ready" even if the Pods themselves are not                                                                                                                                                                                                                            | `false`                                          |
 +
| `service.type`                    | Elasticsearch [Service Types][]                                                                                                                                                                                                                                                                                  | `ClusterIP`                                      |
 +
| `sysctlInitContainer`              | Allows you to disable the `sysctlInitContainer` if you are setting [sysctl vm.max_map_count][] with another method                                                                                                                                                                                                | `enabled: true`                                  |
 +
| `sysctlVmMaxMapCount`              | Sets the [sysctl vm.max_map_count][] needed for Elasticsearch                                                                                                                                                                                                                                                    | `262144`                                        |
 +
| `terminationGracePeriod`          | The [terminationGracePeriod][] in seconds used when trying to stop the pod                                                                                                                                                                                                                                        | `120`                                            |
 +
| `tests.enabled`                    | Enable creating test related resources when running `helm template` or `helm test`                                                                                                                                                                                                                                | `true`                                          |
 +
| `tolerations`                      | Configurable [tolerations][]                                                                                                                                                                                                                                                                                      | `[]`                                            |
 +
| `transportPort`                    | The transport port that Kubernetes will use for the service. If you change this you will also need to set [transport port configuration][] in `extraEnvs`                                                                                                                                                        | `9300`                                          |
 +
| `updateStrategy`                  | The [updateStrategy][] for the StatefulSet. By default Kubernetes will wait for the cluster to be green after upgrading each pod. Setting this to `OnDelete` will allow you to manually delete each pod during upgrades                                                                                          | `RollingUpdate`                                  |
 +
| `volumeClaimTemplate`              | Configuration for the [volumeClaimTemplate for StatefulSets][]. You will want to adjust the storage (default `30Gi` ) and the `storageClassName` if you are using a different storage class                                                                                                                      | see [values.yaml][]                              |
 +
 +
### Deprecated
 +
 +
| Parameter | Description                                                                                                  | Default |
 +
|-----------|---------------------------------------------------------------------------------------------------------------|---------|
 +
| `fsGroup` | The Group ID (GID) for [securityContext][] so that the Elasticsearch user can read from the persistent volume | `""`    |
 +
 +
 +
## FAQ
 +
 +
### How to deploy this chart on a specific K8S distribution?
 +
 +
This chart is designed to run on production scale Kubernetes clusters with
 +
multiple nodes, lots of memory and persistent storage. For that reason it can be
 +
a bit tricky to run them against local Kubernetes environments such as
 +
[Minikube][].
 +
 +
This chart is highly tested with [GKE][], but some K8S distribution also
 +
requires specific configurations.
 +
 +
We provide examples of configuration for the following K8S providers:
 +
 +
- [Docker for Mac][]
 +
- [KIND][]
 +
- [Minikube][]
 +
- [MicroK8S][]
 +
- [OpenShift][]
 +
 +
### How to deploy dedicated nodes types?
 +
 +
All the Elasticsearch pods deployed share the same configuration. If you need to
 +
deploy dedicated [nodes types][] (for example dedicated master and data nodes),
 +
you can deploy multiple releases of this chart with different configurations
 +
while they share the same `clusterName` value.
 +
 +
For each Helm release, the nodes types can then be defined using `roles` value.
 +
 +
An example of Elasticsearch cluster using 2 different Helm releases for master
 +
and data nodes can be found in [examples/multi][].
 +
 +
#### Clustering and Node Discovery
 +
 +
This chart facilitates Elasticsearch node discovery and services by creating two
 +
`Service` definitions in Kubernetes, one with the name `$clusterName-$nodeGroup`
 +
and another named `$clusterName-$nodeGroup-headless`.
 +
Only `Ready` pods are a part of the `$clusterName-$nodeGroup` service, while all
 +
pods ( `Ready` or not) are a part of `$clusterName-$nodeGroup-headless`.
 +
 +
If your group of master nodes has the default `nodeGroup: master` then you can
 +
just add new groups of nodes with a different `nodeGroup` and they will
 +
automatically discover the correct master. If your master nodes have a different
 +
`nodeGroup` name then you will need to set `masterService` to
 +
`$clusterName-$masterNodeGroup`.
 +
 +
The chart value for `masterService` is used to populate
 +
`discovery.zen.ping.unicast.hosts` , which Elasticsearch nodes will use to
 +
contact master nodes and form a cluster.
 +
Therefore, to add a group of nodes to an existing cluster, setting
 +
`masterService` to the desired `Service` name of the related cluster is
 +
sufficient.
 +
 +
### How to deploy clusters with security (authentication and TLS) enabled?
 +
 +
This Helm chart can use existing [Kubernetes secrets][] to setup
 +
credentials or certificates for examples. These secrets should be created
 +
outside of this chart and accessed using [environment variables][] and volumes.
 +
 +
An example of Elasticsearch cluster using security can be found in
 +
[examples/security][].
 +
 +
### How to migrate from helm/charts stable chart?
 +
 +
If you currently have a cluster deployed with the [helm/charts stable][] chart
 +
you can follow the [migration guide][].
 +
 +
### How to install plugins?
 +
 +
The recommended way to install plugins into our Docker images is to create a
 +
[custom Docker image][].
 +
 +
The Dockerfile would look something like:
 +
 +
```
 +
ARG elasticsearch_version
 +
FROM docker.elastic.co/elasticsearch/elasticsearch:${elasticsearch_version}
 +
 +
RUN bin/elasticsearch-plugin install --batch repository-gcs
 +
```
 +
 +
And then updating the `image` in values to point to your custom image.
 +
 +
There are a couple reasons we recommend this.
 +
 +
1. Tying the availability of Elasticsearch to the download service to install
 +
plugins is not a great idea or something that we recommend. Especially in
 +
Kubernetes where it is normal and expected for a container to be moved to
 +
another host at random times.
 +
2. Mutating the state of a running Docker image (by installing plugins) goes
 +
against best practices of containers and immutable infrastructure.
 +
 +
### How to use the keystore?
 +
 +
#### Basic example
 +
 +
Create the secret, the key name needs to be the keystore key path. In this
 +
example we will create a secret from a file and from a literal string.
 +
 +
```
 +
kubectl create secret generic encryption-key --from-file=xpack.watcher.encryption_key=./watcher_encryption_key
 +
kubectl create secret generic slack-hook --from-literal=xpack.notification.slack.account.monitoring.secure_url='https://hooks.slack.com/services/asdasdasd/asdasdas/asdasd'
 +
```
 +
 +
To add these secrets to the keystore:
 +
 +
```
 +
keystore:
 +
  - secretName: encryption-key
 +
  - secretName: slack-hook
 +
```
 +
 +
#### Multiple keys
 +
 +
All keys in the secret will be added to the keystore. To create the previous
 +
example in one secret you could also do:
 +
 +
```
 +
kubectl create secret generic keystore-secrets --from-file=xpack.watcher.encryption_key=./watcher_encryption_key --from-literal=xpack.notification.slack.account.monitoring.secure_url='https://hooks.slack.com/services/asdasdasd/asdasdas/asdasd'
 +
```
 +
 +
```
 +
keystore:
 +
  - secretName: keystore-secrets
 +
```
 +
 +
#### Custom paths and keys
 +
 +
If you are using these secrets for other applications (besides the Elasticsearch
 +
keystore) then it is also possible to specify the keystore path and which keys
 +
you want to add. Everything specified under each `keystore` item will be passed
 +
through to the `volumeMounts` section for mounting the [secret][]. In this
 +
example we will only add the `slack_hook` key from a secret that also has other
 +
keys. Our secret looks like this:
 +
 +
```
 +
kubectl create secret generic slack-secrets --from-literal=slack_channel='#general' --from-literal=slack_hook='https://hooks.slack.com/services/asdasdasd/asdasdas/asdasd'
 +
```
 +
 +
We only want to add the `slack_hook` key to the keystore at path
 +
`xpack.notification.slack.account.monitoring.secure_url`:
 +
 +
```
 +
keystore:
 +
  - secretName: slack-secrets
 +
    items:
 +
    - key: slack_hook
 +
      path: xpack.notification.slack.account.monitoring.secure_url
 +
```
 +
 +
You can also take a look at the [config example][] which is used as part of the
 +
automated testing pipeline.
 +
 +
### How to enable snapshotting?
 +
 +
1. Install your [snapshot plugin][] into a custom Docker image following the
 +
[how to install plugins guide][].
 +
2. Add any required secrets or credentials into an Elasticsearch keystore
 +
following the [how to use the keystore][] guide.
 +
3. Configure the [snapshot repository][] as you normally would.
 +
4. To automate snapshots you can use [Snapshot Lifecycle Management][] or a tool
 +
like [curator][].
 +
 +
### How to configure templates post-deployment?
 +
 +
You can use `postStart` [lifecycle hooks][] to run code triggered after a
 +
container is created.
 +
 +
Here is an example of `postStart` hook to configure templates:
 +
 +
```yaml
 +
lifecycle:
 +
  postStart:
 +
    exec:
 +
      command:
 +
        - bash
 +
        - -c
 +
        - |
 +
          #!/bin/bash
 +
          # Add a template to adjust number of shards/replicas
 +
          TEMPLATE_NAME=my_template
 +
          INDEX_PATTERN="logstash-*"
 +
          SHARD_COUNT=8
 +
          REPLICA_COUNT=1
 +
          ES_URL=http://localhost:9200
 +
          while [[ "$(curl -s -o /dev/null -w '%{http_code}\n' $ES_URL)" != "200" ]]; do sleep 1; done
 +
          curl -XPUT "$ES_URL/_template/$TEMPLATE_NAME" -H 'Content-Type: application/json' -d'{"index_patterns":['\""$INDEX_PATTERN"\"'],"settings":{"number_of_shards":'$SHARD_COUNT',"number_of_replicas":'$REPLICA_COUNT'}}'
 +
```
 +
 +
 +
## Contributing
 +
 +
Please check [CONTRIBUTING.md][] before any contribution or for any questions
 +
about our development and testing process.
 +
 +
[7.17]: https://github.com/elastic/helm-charts/releases
 +
[#63]: https://github.com/elastic/helm-charts/issues/63
 +
[BREAKING_CHANGES.md]: https://github.com/elastic/helm-charts/blob/master/BREAKING_CHANGES.md
 +
[CHANGELOG.md]: https://github.com/elastic/helm-charts/blob/master/CHANGELOG.md
 +
[CONTRIBUTING.md]: https://github.com/elastic/helm-charts/blob/master/CONTRIBUTING.md
 +
[alternate scheduler]: https://kubernetes.io/docs/tasks/administer-cluster/configure-multiple-schedulers/#specify-schedulers-for-pods
 +
[annotations]: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/
 +
[anti-affinity]: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#affinity-and-anti-affinity
 +
[cluster.name]: https://www.elastic.co/guide/en/elasticsearch/reference/7.17/important-settings.html#cluster-name
 +
[clustering and node discovery]: https://github.com/elastic/helm-charts/tree/7.17/elasticsearch/README.md#clustering-and-node-discovery
 +
[config example]: https://github.com/elastic/helm-charts/tree/7.17/elasticsearch/examples/config/values.yaml
 +
[curator]: https://www.elastic.co/guide/en/elasticsearch/client/curator/7.9/snapshot.html
 +
[custom docker image]: https://www.elastic.co/guide/en/elasticsearch/reference/7.17/docker.html#_c_customized_image
 +
[deploys statefulsets serially]: https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/#pod-management-policies
 +
[discovery.zen.minimum_master_nodes]: https://www.elastic.co/guide/en/elasticsearch/reference/7.17/discovery-settings.html#minimum_master_nodes
 +
[docker for mac]: https://github.com/elastic/helm-charts/tree/7.17/elasticsearch/examples/docker-for-mac
 +
[elasticsearch cluster health status params]: https://www.elastic.co/guide/en/elasticsearch/reference/7.17/cluster-health.html#request-params
 +
[elasticsearch docker image]: https://www.elastic.co/guide/en/elasticsearch/reference/7.17/docker.html
 +
[environment variables]: https://kubernetes.io/docs/tasks/inject-data-application/define-environment-variable-container/#using-environment-variables-inside-of-your-config
 +
[environment from variables]: https://kubernetes.io/docs/tasks/configure-pod-container/configure-pod-configmap/#configure-all-key-value-pairs-in-a-configmap-as-container-environment-variables
 +
[examples]: https://github.com/elastic/helm-charts/tree/7.17/elasticsearch/examples/
 +
[examples/multi]: https://github.com/elastic/helm-charts/tree/7.17/elasticsearch/examples/multi
 +
[examples/security]: https://github.com/elastic/helm-charts/tree/7.17/elasticsearch/examples/security
 +
[gke]: https://cloud.google.com/kubernetes-engine
 +
[helm]: https://helm.sh
 +
[helm/charts stable]: https://github.com/helm/charts/tree/master/stable/elasticsearch/
 +
[how to install plugins guide]: https://github.com/elastic/helm-charts/tree/7.17/elasticsearch/README.md#how-to-install-plugins
 +
[how to use the keystore]: https://github.com/elastic/helm-charts/tree/7.17/elasticsearch/README.md#how-to-use-the-keystore
 +
[http.port]: https://www.elastic.co/guide/en/elasticsearch/reference/7.17/modules-http.html#_settings
 +
[imagePullPolicy]: https://kubernetes.io/docs/concepts/containers/images/#updating-images
 +
[imagePullSecrets]: https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/#create-a-pod-that-uses-your-secret
 +
[ingress]: https://kubernetes.io/docs/concepts/services-networking/ingress/
 +
[java options]: https://www.elastic.co/guide/en/elasticsearch/reference/7.17/jvm-options.html
 +
[jvm heap size]: https://www.elastic.co/guide/en/elasticsearch/reference/7.17/heap-size.html
 +
[hostAliases]: https://kubernetes.io/docs/concepts/services-networking/add-entries-to-pod-etc-hosts-with-host-aliases/
 +
[kind]: https://github.com/elastic/helm-charts/tree/7.17/elasticsearch/examples/kubernetes-kind
 +
[kubernetes secrets]: https://kubernetes.io/docs/concepts/configuration/secret/
 +
[labels]: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/
 +
[lifecycle hooks]: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/
 +
[loadBalancer annotations]: https://kubernetes.io/docs/concepts/services-networking/service/#ssl-support-on-aws
 +
[loadBalancer externalTrafficPolicy]: https://kubernetes.io/docs/tasks/access-application-cluster/create-external-load-balancer/#preserving-the-client-source-ip
 +
[loadBalancer]: https://kubernetes.io/docs/concepts/services-networking/service/#loadbalancer
 +
[maxUnavailable]: https://kubernetes.io/docs/tasks/run-application/configure-pdb/#specifying-a-poddisruptionbudget
 +
[migration guide]: https://github.com/elastic/helm-charts/tree/7.17/elasticsearch/examples/migration/README.md
 +
[minikube]: https://github.com/elastic/helm-charts/tree/7.17/elasticsearch/examples/minikube
 +
[microk8s]: https://github.com/elastic/helm-charts/tree/7.17/elasticsearch/examples/microk8s
 +
[multi]: https://github.com/elastic/helm-charts/tree/7.17/elasticsearch/examples/multi/
 +
[network.host elasticsearch setting]: https://www.elastic.co/guide/en/elasticsearch/reference/7.17/network.host.html
 +
[node affinity settings]: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#node-affinity-beta-feature
 +
[node-certificates]: https://www.elastic.co/guide/en/elasticsearch/reference/7.17/configuring-tls.html#node-certificates
 +
[nodePort]: https://kubernetes.io/docs/concepts/services-networking/service/#nodeport
 +
[nodes types]: https://www.elastic.co/guide/en/elasticsearch/reference/7.17/modules-node.html
 +
[nodeSelector]: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#nodeselector
 +
[openshift]: https://github.com/elastic/helm-charts/tree/7.17/elasticsearch/examples/openshift
 +
[priorityClass]: https://kubernetes.io/docs/concepts/configuration/pod-priority-preemption/#priorityclass
 +
[probe]: https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-probes/
 +
[resources]: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/
 +
[roles]: https://www.elastic.co/guide/en/elasticsearch/reference/7.17/modules-node.html
 +
[secret]: https://kubernetes.io/docs/concepts/configuration/secret/#using-secrets
 +
[securityContext]: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/
 +
[service types]: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types
 +
[snapshot lifecycle management]: https://www.elastic.co/guide/en/elasticsearch/reference/7.17/snapshot-lifecycle-management.html
 +
[snapshot plugin]: https://www.elastic.co/guide/en/elasticsearch/plugins/7.17/repository.html
 +
[snapshot repository]: https://www.elastic.co/guide/en/elasticsearch/reference/7.17/modules-snapshots.html
 +
[supported configurations]: https://github.com/elastic/helm-charts/tree/7.17/README.md#supported-configurations
 +
[sysctl vm.max_map_count]: https://www.elastic.co/guide/en/elasticsearch/reference/7.17/vm-max-map-count.html#vm-max-map-count
 +
[terminationGracePeriod]: https://kubernetes.io/docs/concepts/workloads/pods/pod/#termination-of-pods
 +
[tolerations]: https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/
 +
[transport port configuration]: https://www.elastic.co/guide/en/elasticsearch/reference/7.17/modules-transport.html#_transport_settings
 +
[updateStrategy]: https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/
 +
[values.yaml]: https://github.com/elastic/helm-charts/tree/7.17/elasticsearch/values.yaml
 +
[volumeClaimTemplate for statefulsets]: https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/#stable-storage
 +
  
  

Revision as of 05:42, 1 November 2022

apiVersion: v1
appVersion: 7.17.3
description: Official Elastic helm chart for Elasticsearch
home: https://github.com/elastic/helm-charts
icon: elasticsearch.png
maintainers:
- email: [email protected]
  name: Elastic
name: elasticsearch
sources:
- https://github.com/elastic/elasticsearch
version: 7.17.3

---
---
clusterName: "elasticsearch"
nodeGroup: "master"

# The service that non master groups will try to connect to when joining the cluster
# This should be set to clusterName + "-" + nodeGroup for your master group
masterService: ""

# Elasticsearch roles that will be applied to this nodeGroup
# These will be set as environment variables. E.g. node.master=true
roles:
  master: "true"
  ingest: "true"
  data: "true"
  remote_cluster_client: "true"
  ml: "true"

replicas: 3
minimumMasterNodes: 2

esMajorVersion: ""

clusterDeprecationIndexing: "false"

# Allows you to add any config files in /usr/share/elasticsearch/config/
# such as elasticsearch.yml and log4j2.properties
esConfig: {}
#  elasticsearch.yml: |
#    key:
#      nestedkey: value
#  log4j2.properties: |
#    key = value

esJvmOptions: {}
#  processors.options: |
#    -XX:ActiveProcessorCount=3

# Extra environment variables to append to this nodeGroup
# This will be appended to the current 'env:' key. You can use any of the kubernetes env
# syntax here
extraEnvs: []
#  - name: MY_ENVIRONMENT_VAR
#    value: the_value_goes_here

# Allows you to load environment variables from kubernetes secret or config map
envFrom: []
# - secretRef:
#     name: env-secret
# - configMapRef:
#     name: config-map

# A list of secrets and their paths to mount inside the pod
# This is useful for mounting certificates for security and for mounting
# the X-Pack license
secretMounts: []
#  - name: elastic-certificates
#    secretName: elastic-certificates
#    path: /usr/share/elasticsearch/config/certs
#    defaultMode: 0755

hostAliases: []
#- ip: "127.0.0.1"
#  hostnames:
#  - "foo.local"
#  - "bar.local"

image: "docker.elastic.co/elasticsearch/elasticsearch"
imageTag: "7.17.3"
imagePullPolicy: "IfNotPresent"

podAnnotations:
  {}
  # iam.amazonaws.com/role: es-cluster

# additionals labels
labels: {}

esJavaOpts: "" # example: "-Xmx1g -Xms1g"

resources:
  requests:
    cpu: "1000m"
    memory: "2Gi"
  limits:
    cpu: "1000m"
    memory: "2Gi"

initResources:
  {}
  # limits:
  #   cpu: "25m"
  #   # memory: "128Mi"
  # requests:
  #   cpu: "25m"
  #   memory: "128Mi"

networkHost: "0.0.0.0"

volumeClaimTemplate:
  accessModes: ["ReadWriteOnce"]
  resources:
    requests:
      storage: 30Gi

rbac:
  create: false
  serviceAccountAnnotations: {}
  serviceAccountName: ""
  automountToken: true

podSecurityPolicy:
  create: false
  name: ""
  spec:
    privileged: true
    fsGroup:
      rule: RunAsAny
    runAsUser:
      rule: RunAsAny
    seLinux:
      rule: RunAsAny
    supplementalGroups:
      rule: RunAsAny
    volumes:
      - secret
      - configMap
      - persistentVolumeClaim
      - emptyDir

persistence:
  enabled: true
  labels:
    # Add default labels for the volumeClaimTemplate of the StatefulSet
    enabled: false
  annotations: {}

extraVolumes:
  []
  # - name: extras
  #   emptyDir: {}

extraVolumeMounts:
  []
  # - name: extras
  #   mountPath: /usr/share/extras
  #   readOnly: true

extraContainers:
  []
  # - name: do-something
  #   image: busybox
  #   command: ['do', 'something']

extraInitContainers:
  []
  # - name: do-something
  #   image: busybox
  #   command: ['do', 'something']

# This is the PriorityClass settings as defined in
# https://kubernetes.io/docs/concepts/configuration/pod-priority-preemption/#priorityclass
priorityClassName: ""

# By default this will make sure two pods don't end up on the same node
# Changing this to a region would allow you to spread pods across regions
antiAffinityTopologyKey: "kubernetes.io/hostname"

# Hard means that by default pods will only be scheduled if there are enough nodes for them
# and that they will never end up on the same node. Setting this to soft will do this "best effort"
antiAffinity: "hard"

# This is the node affinity settings as defined in
# https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#node-affinity-beta-feature
nodeAffinity: {}

# The default is to deploy all pods serially. By setting this to parallel all pods are started at
# the same time when bootstrapping the cluster
podManagementPolicy: "Parallel"

# The environment variables injected by service links are not used, but can lead to slow Elasticsearch boot times when
# there are many services in the current namespace.
# If you experience slow pod startups you probably want to set this to `false`.
enableServiceLinks: true

protocol: http
httpPort: 9200
transportPort: 9300

service:
  enabled: true
  labels: {}
  labelsHeadless: {}
  type: ClusterIP
  # Consider that all endpoints are considered "ready" even if the Pods themselves are not
  # https://kubernetes.io/docs/reference/kubernetes-api/service-resources/service-v1/#ServiceSpec
  publishNotReadyAddresses: false
  nodePort: ""
  annotations: {}
  httpPortName: http
  transportPortName: transport
  loadBalancerIP: ""
  loadBalancerSourceRanges: []
  externalTrafficPolicy: ""

updateStrategy: RollingUpdate

# This is the max unavailable setting for the pod disruption budget
# The default value of 1 will make sure that kubernetes won't allow more than 1
# of your pods to be unavailable during maintenance
maxUnavailable: 1

podSecurityContext:
  fsGroup: 1000
  runAsUser: 1000

securityContext:
  capabilities:
    drop:
      - ALL
  # readOnlyRootFilesystem: true
  runAsNonRoot: true
  runAsUser: 1000

# How long to wait for elasticsearch to stop gracefully
terminationGracePeriod: 120

sysctlVmMaxMapCount: 262144

readinessProbe:
  failureThreshold: 3
  initialDelaySeconds: 10
  periodSeconds: 10
  successThreshold: 3
  timeoutSeconds: 5

# https://www.elastic.co/guide/en/elasticsearch/reference/7.17/cluster-health.html#request-params wait_for_status
clusterHealthCheckParams: "wait_for_status=green&timeout=1s"

## Use an alternate scheduler.
## ref: https://kubernetes.io/docs/tasks/administer-cluster/configure-multiple-schedulers/
##
schedulerName: ""

imagePullSecrets: []
nodeSelector: {}
tolerations: []

# Enabling this will publicly expose your Elasticsearch instance.
# Only enable this if you have security enabled on your cluster
ingress:
  enabled: false
  annotations: {}
  # kubernetes.io/ingress.class: nginx
  # kubernetes.io/tls-acme: "true"
  className: "nginx"
  pathtype: ImplementationSpecific
  hosts:
    - host: chart-example.local
      paths:
        - path: /
  tls: []
  #  - secretName: chart-example-tls
  #    hosts:
  #      - chart-example.local

nameOverride: ""
fullnameOverride: ""
healthNameOverride: ""

lifecycle:
  {}
  # preStop:
  #   exec:
  #     command: ["/bin/sh", "-c", "echo Hello from the postStart handler > /usr/share/message"]
  # postStart:
  #   exec:
  #     command:
  #       - bash
  #       - -c
  #       - |
  #         #!/bin/bash
  #         # Add a template to adjust number of shards/replicas
  #         TEMPLATE_NAME=my_template
  #         INDEX_PATTERN="logstash-*"
  #         SHARD_COUNT=8
  #         REPLICA_COUNT=1
  #         ES_URL=http://localhost:9200
  #         while [[ "$(curl -s -o /dev/null -w '%{http_code}\n' $ES_URL)" != "200" ]]; do sleep 1; done
  #         curl -XPUT "$ES_URL/_template/$TEMPLATE_NAME" -H 'Content-Type: application/json' -d'{"index_patterns":['\""$INDEX_PATTERN"\"'],"settings":{"number_of_shards":'$SHARD_COUNT',"number_of_replicas":'$REPLICA_COUNT'}}'

sysctlInitContainer:
  enabled: true

keystore: []

networkPolicy:
  ## Enable creation of NetworkPolicy resources. Only Ingress traffic is filtered for now.
  ## In order for a Pod to access Elasticsearch, it needs to have the following label:
  ## Template:Template "uname" .-client: "true"
  ## Example for default configuration to access HTTP port:
  ## elasticsearch-master-http-client: "true"
  ## Example for default configuration to access transport port:
  ## elasticsearch-master-transport-client: "true"

  http:
    enabled: false
    ## if explicitNamespacesSelector is not set or set to {}, only client Pods being in the networkPolicy's namespace
    ## and matching all criteria can reach the DB.
    ## But sometimes, we want the Pods to be accessible to clients from other namespaces, in this case, we can use this
    ## parameter to select these namespaces
    ##
    # explicitNamespacesSelector:
    #   # Accept from namespaces with all those different rules (only from whitelisted Pods)
    #   matchLabels:
    #     role: frontend
    #   matchExpressions:
    #     - {key: role, operator: In, values: [frontend]}
    ## Additional NetworkPolicy Ingress "from" rules to set. Note that all rules are OR-ed.
    ##
    # additionalRules:
    #   - podSelector:
    #       matchLabels:
    #         role: frontend
    #   - podSelector:
    #       matchExpressions:
    #         - key: role
    #           operator: In
    #           values:
    #             - frontend

  transport:
    ## Note that all Elasticsearch Pods can talk to themselves using transport port even if enabled.
    enabled: false
    # explicitNamespacesSelector:
    #   matchLabels:
    #     role: frontend
    #   matchExpressions:
    #     - {key: role, operator: In, values: [frontend]}
    # additionalRules:
    #   - podSelector:
    #       matchLabels:
    #         role: frontend
    #   - podSelector:
    #       matchExpressions:
    #         - key: role
    #           operator: In
    #           values:
    #             - frontend

tests:
  enabled: true

# Deprecated
# please use the above podSecurityContext.fsGroup instead
fsGroup: ""

---
# Elasticsearch Helm Chart

[![Build Status](https://img.shields.io/jenkins/s/https/devops-ci.elastic.co/job/elastic+helm-charts+master.svg)](https://devops-ci.elastic.co/job/elastic+helm-charts+master/) [![Artifact HUB](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/elastic)](https://artifacthub.io/packages/search?repo=elastic)

This Helm chart is a lightweight way to configure and run our official
[Elasticsearch Docker image][].




- [Requirements](#requirements)
- [Installing](#installing)
  - [Install released version using Helm repository](#install-released-version-using-helm-repository)
  - [Install development version from a branch](#install-development-version-from-a-branch)
- [Upgrading](#upgrading)
- [Usage notes](#usage-notes)
- [Configuration](#configuration)
  - [Deprecated](#deprecated)
- [FAQ](#faq)
  - [How to deploy this chart on a specific K8S distribution?](#how-to-deploy-this-chart-on-a-specific-k8s-distribution)
  - [How to deploy dedicated nodes types?](#how-to-deploy-dedicated-nodes-types)
    - [Clustering and Node Discovery](#clustering-and-node-discovery)
  - [How to deploy clusters with security (authentication and TLS) enabled?](#how-to-deploy-clusters-with-security-authentication-and-tls-enabled)
  - [How to migrate from helm/charts stable chart?](#how-to-migrate-from-helmcharts-stable-chart)
  - [How to install plugins?](#how-to-install-plugins)
  - [How to use the keystore?](#how-to-use-the-keystore)
    - [Basic example](#basic-example)
    - [Multiple keys](#multiple-keys)
    - [Custom paths and keys](#custom-paths-and-keys)
  - [How to enable snapshotting?](#how-to-enable-snapshotting)
  - [How to configure templates post-deployment?](#how-to-configure-templates-post-deployment)
- [Contributing](#contributing)



## Requirements

* Kubernetes >= 1.14
* [Helm][] >= 2.17.0
* Minimum cluster requirements include the following to run this chart with
default settings. All of these settings are configurable.
  * Three Kubernetes nodes to respect the default "hard" affinity settings
  * 1GB of RAM for the JVM heap

See [supported configurations][] for more details.

## Installing

This chart is tested with the latest 7.17.3 version.

### Install released version using Helm repository

* Add the Elastic Helm charts repo:
`helm repo add elastic https://helm.elastic.co`

* Install it:
  - with Helm 3: `helm install elasticsearch --version <version> elastic/elasticsearch`
  - with Helm 2 (deprecated): `helm install --name elasticsearch --version <version> elastic/elasticsearch`

### Install development version from a branch

* Clone the git repo: `git clone [email protected]:elastic/helm-charts.git`

* Checkout the branch : `git checkout 7.17`

* Install it:
  - with Helm 3: `helm install elasticsearch ./helm-charts/elasticsearch --set imageTag=7.17.3`
  - with Helm 2 (deprecated): `helm install --name elasticsearch ./helm-charts/elasticsearch --set imageTag=7.17.3`


## Upgrading

Please always check [CHANGELOG.md][] and [BREAKING_CHANGES.md][] before
upgrading to a new chart version.


## Usage notes

* This repo includes a number of [examples][] configurations which can be used
as a reference. They are also used in the automated testing of this chart.
* Automated testing of this chart is currently only run against GKE (Google
Kubernetes Engine).
* The chart deploys a StatefulSet and by default will do an automated rolling
update of your cluster. It does this by waiting for the cluster health to become
green after each instance is updated. If you prefer to update manually you can
set `OnDelete` [updateStrategy][].
* It is important to verify that the JVM heap size in `esJavaOpts` and to set
the CPU/Memory `resources` to something suitable for your cluster.
* To simplify chart and maintenance each set of node groups is deployed as a
separate Helm release. Take a look at the [multi][] example to get an idea for
how this works. Without doing this it isn't possible to resize persistent
volumes in a StatefulSet. By setting it up this way it makes it possible to add
more nodes with a new storage size then drain the old ones. It also solves the
problem of allowing the user to determine which node groups to update first when
doing upgrades or changes.
* We have designed this chart to be very un-opinionated about how to configure
Elasticsearch. It exposes ways to set environment variables and mount secrets
inside of the container. Doing this makes it much easier for this chart to
support multiple versions with minimal changes.


## Configuration

| Parameter                          | Description                                                                                                                                                                                                                                                                                                       | Default                                          |
|------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------|
| `antiAffinityTopologyKey`          | The [anti-affinity][] topology key. By default this will prevent multiple Elasticsearch nodes from running on the same Kubernetes node                                                                                                                                                                            | `kubernetes.io/hostname`                         |
| `antiAffinity`                     | Setting this to hard enforces the [anti-affinity][] rules. If it is set to soft it will be done "best effort". Other values will be ignored                                                                                                                                                                       | `hard`                                           |
| `clusterHealthCheckParams`         | The [Elasticsearch cluster health status params][] that will be used by readiness [probe][] command                                                                                                                                                                                                               | `wait_for_status=green&timeout=1s`               |
| `clusterName`                      | This will be used as the Elasticsearch [cluster.name][] and should be unique per cluster in the namespace                                                                                                                                                                                                         | `elasticsearch`                                  |
| `clusterDeprecationIndexing`       | Enable or disable deprecation logs to be indexed (should be disabled when deploying master only node groups)                                                                                                                                                                                                      | `false`                                          |
| `enableServiceLinks`               | Set to false to disabling service links, which can cause slow pod startup times when there are many services in the current namespace.                                                                                                                                                                            | `true`                                           |
| `envFrom`                          | Templatable string to be passed to the [environment from variables][] which will be appended to the `envFrom:` definition for the container                                                                                                                                                                       | `[]`                                             |
| `esConfig`                         | Allows you to add any config files in `/usr/share/elasticsearch/config/` such as `elasticsearch.yml` and `log4j2.properties`. See [values.yaml][] for an example of the formatting                                                                                                                                | `{}`                                             |
| `esJavaOpts`                       | [Java options][] for Elasticsearch. This is where you could configure the [jvm heap size][]                                                                                                                                                                                                                       | `""`                                             |
| `esJvmOptions`                     | [Java options][] for Elasticsearch. Override the default JVM options by adding custom options files .  See [values.yaml][] for an example of the formatting                                                                                                                                                       | `{}`                                             |
| `esMajorVersion`                   | Deprecated. Instead, use the version of the chart corresponding to your ES minor version. Used to set major version specific configuration. If you are using a custom image and not running the default Elasticsearch version you will need to set this to the version you are running (e.g. `esMajorVersion: 6`) | `""`                                             |
| `extraContainers`                  | Templatable string of additional `containers` to be passed to the `tpl` function                                                                                                                                                                                                                                  | `""`                                             |
| `extraEnvs`                        | Extra [environment variables][] which will be appended to the `env:` definition for the container                                                                                                                                                                                                                 | `[]`                                             |
| `extraInitContainers`              | Templatable string of additional `initContainers` to be passed to the `tpl` function                                                                                                                                                                                                                              | `""`                                             |
| `extraVolumeMounts`                | Templatable string of additional `volumeMounts` to be passed to the `tpl` function                                                                                                                                                                                                                                | `""`                                             |
| `extraVolumes`                     | Templatable string of additional `volumes` to be passed to the `tpl` function                                                                                                                                                                                                                                     | `""`                                             |
| `fullnameOverride`                 | Overrides the `clusterName` and `nodeGroup` when used in the naming of resources. This should only be used when using a single `nodeGroup`, otherwise you will have name conflicts                                                                                                                                | `""`                                             |
| `healthNameOverride`               | Overrides `test-elasticsearch-health` pod name                                                                                                                                                                                                                                                                    | `""`                                             |
| `hostAliases`                      | Configurable [hostAliases][]                                                                                                                                                                                                                                                                                      | `[]`                                             |
| `httpPort`                         | The http port that Kubernetes will use for the healthchecks and the service. If you change this you will also need to set [http.port][] in `extraEnvs`                                                                                                                                                            | `9200`                                           |
| `imagePullPolicy`                  | The Kubernetes [imagePullPolicy][] value                                                                                                                                                                                                                                                                          | `IfNotPresent`                                   |
| `imagePullSecrets`                 | Configuration for [imagePullSecrets][] so that you can use a private registry for your image                                                                                                                                                                                                                      | `[]`                                             |
| `imageTag`                         | The Elasticsearch Docker image tag                                                                                                                                                                                                                                                                                | `7.17.3`                                         |
| `image`                            | The Elasticsearch Docker image                                                                                                                                                                                                                                                                                    | `docker.elastic.co/elasticsearch/elasticsearch`  |
| `ingress`                          | Configurable [ingress][] to expose the Elasticsearch service. See [values.yaml][] for an example                                                                                                                                                                                                                  | see [values.yaml][]                              |
| `initResources`                    | Allows you to set the [resources][] for the `initContainer` in the StatefulSet                                                                                                                                                                                                                                    | `{}`                                             |
| `keystore`                         | Allows you map Kubernetes secrets into the keystore. See the [config example][] and [how to use the keystore][]                                                                                                                                                                                                   | `[]`                                             |
| `labels`                           | Configurable [labels][] applied to all Elasticsearch pods                                                                                                                                                                                                                                                         | `{}`                                             |
| `lifecycle`                        | Allows you to add [lifecycle hooks][]. See [values.yaml][] for an example of the formatting                                                                                                                                                                                                                       | `{}`                                             |
| `masterService`                    | The service name used to connect to the masters. You only need to set this if your master `nodeGroup` is set to something other than `master`. See [Clustering and Node Discovery][] for more information                                                                                                         | `""`                                             |
| `maxUnavailable`                   | The [maxUnavailable][] value for the pod disruption budget. By default this will prevent Kubernetes from having more than 1 unhealthy pod in the node group                                                                                                                                                       | `1`                                              |
| `minimumMasterNodes`               | The value for [discovery.zen.minimum_master_nodes][]. Should be set to `(master_eligible_nodes / 2) + 1`. Ignored in Elasticsearch versions >= 7                                                                                                                                                                  | `2`                                              |
| `nameOverride`                     | Overrides the `clusterName` when used in the naming of resources                                                                                                                                                                                                                                                  | `""`                                             |
| `networkHost`                      | Value for the [network.host Elasticsearch setting][]                                                                                                                                                                                                                                                              | `0.0.0.0`                                        |
| `networkPolicy`                    | The [NetworkPolicy](https://kubernetes.io/docs/concepts/services-networking/network-policies/) to set. See [`values.yaml`](./values.yaml) for an example                                                                                                                                                          | `{http.enabled: false,transport.enabled: false}` |
| `nodeAffinity`                     | Value for the [node affinity settings][]                                                                                                                                                                                                                                                                          | `{}`                                             |
| `nodeGroup`                        | This is the name that will be used for each group of nodes in the cluster. The name will be `clusterName-nodeGroup-X` , `nameOverride-nodeGroup-X` if a `nameOverride` is specified, and `fullnameOverride-X` if a `fullnameOverride` is specified                                                                | `master`                                         |
| `nodeSelector`                     | Configurable [nodeSelector][] so that you can target specific nodes for your Elasticsearch cluster                                                                                                                                                                                                                | `{}`                                             |
| `persistence`                      | Enables a persistent volume for Elasticsearch data. Can be disabled for nodes that only have [roles][] which don't require persistent data                                                                                                                                                                        | see [values.yaml][]                              |
| `podAnnotations`                   | Configurable [annotations][] applied to all Elasticsearch pods                                                                                                                                                                                                                                                    | `{}`                                             |
| `podManagementPolicy`              | By default Kubernetes [deploys StatefulSets serially][]. This deploys them in parallel so that they can discover each other                                                                                                                                                                                       | `Parallel`                                       |
| `podSecurityContext`               | Allows you to set the [securityContext][] for the pod                                                                                                                                                                                                                                                             | see [values.yaml][]                              |
| `podSecurityPolicy`                | Configuration for create a pod security policy with minimal permissions to run this Helm chart with `create: true`. Also can be used to reference an external pod security policy with `name: "externalPodSecurityPolicy"`                                                                                        | see [values.yaml][]                              |
| `priorityClassName`                | The name of the [PriorityClass][]. No default is supplied as the PriorityClass must be created first                                                                                                                                                                                                              | `""`                                             |
| `protocol`                         | The protocol that will be used for the readiness [probe][]. Change this to `https` if you have `xpack.security.http.ssl.enabled` set                                                                                                                                                                              | `http`                                           |
| `rbac`                             | Configuration for creating a role, role binding and ServiceAccount as part of this Helm chart with `create: true`. Also can be used to reference an external ServiceAccount with `serviceAccountName: "externalServiceAccountName"`, or automount the service account token                                       | see [values.yaml][]                              |
| `readinessProbe`                   | Configuration fields for the readiness [probe][]                                                                                                                                                                                                                                                                  | see [values.yaml][]                              |
| `replicas`                         | Kubernetes replica count for the StatefulSet (i.e. how many pods)                                                                                                                                                                                                                                                 | `3`                                              |
| `resources`                        | Allows you to set the [resources][] for the StatefulSet                                                                                                                                                                                                                                                           | see [values.yaml][]                              |
| `roles`                            | A hash map with the specific [roles][] for the `nodeGroup`                                                                                                                                                                                                                                                        | see [values.yaml][]                              |
| `schedulerName`                    | Name of the [alternate scheduler][]                                                                                                                                                                                                                                                                               | `""`                                             |
| `secretMounts`                     | Allows you easily mount a secret as a file inside the StatefulSet. Useful for mounting certificates and other secrets. See [values.yaml][] for an example                                                                                                                                                         | `[]`                                             |
| `securityContext`                  | Allows you to set the [securityContext][] for the container                                                                                                                                                                                                                                                       | see [values.yaml][]                              |
| `service.annotations`              | [LoadBalancer annotations][] that Kubernetes will use for the service. This will configure load balancer if `service.type` is `LoadBalancer`                                                                                                                                                                      | `{}`                                             |
| `service.enabled`                  | Enable non-headless service                                                                                                                                                                                                                                                                                       | `true`                                           |
| `service.externalTrafficPolicy`    | Some cloud providers allow you to specify the [LoadBalancer externalTrafficPolicy][]. Kubernetes will use this to preserve the client source IP. This will configure load balancer if `service.type` is `LoadBalancer`                                                                                            | `""`                                             |
| `service.httpPortName`             | The name of the http port within the service                                                                                                                                                                                                                                                                      | `http`                                           |
| `service.labelsHeadless`           | Labels to be added to headless service                                                                                                                                                                                                                                                                            | `{}`                                             |
| `service.labels`                   | Labels to be added to non-headless service                                                                                                                                                                                                                                                                        | `{}`                                             |
| `service.loadBalancerIP`           | Some cloud providers allow you to specify the [loadBalancer][] IP. If the `loadBalancerIP` field is not specified, the IP is dynamically assigned. If you specify a `loadBalancerIP` but your cloud provider does not support the feature, it is ignored.                                                         | `""`                                             |
| `service.loadBalancerSourceRanges` | The IP ranges that are allowed to access                                                                                                                                                                                                                                                                          | `[]`                                             |
| `service.nodePort`                 | Custom [nodePort][] port that can be set if you are using `service.type: nodePort`                                                                                                                                                                                                                                | `""`                                             |
| `service.transportPortName`        | The name of the transport port within the service                                                                                                                                                                                                                                                                 | `transport`                                      |
| `service.publishNotReadyAddresses` | Consider that all endpoints are considered "ready" even if the Pods themselves are not                                                                                                                                                                                                                            | `false`                                          |
| `service.type`                     | Elasticsearch [Service Types][]                                                                                                                                                                                                                                                                                   | `ClusterIP`                                      |
| `sysctlInitContainer`              | Allows you to disable the `sysctlInitContainer` if you are setting [sysctl vm.max_map_count][] with another method                                                                                                                                                                                                | `enabled: true`                                  |
| `sysctlVmMaxMapCount`              | Sets the [sysctl vm.max_map_count][] needed for Elasticsearch                                                                                                                                                                                                                                                     | `262144`                                         |
| `terminationGracePeriod`           | The [terminationGracePeriod][] in seconds used when trying to stop the pod                                                                                                                                                                                                                                        | `120`                                            |
| `tests.enabled`                    | Enable creating test related resources when running `helm template` or `helm test`                                                                                                                                                                                                                                | `true`                                           |
| `tolerations`                      | Configurable [tolerations][]                                                                                                                                                                                                                                                                                      | `[]`                                             |
| `transportPort`                    | The transport port that Kubernetes will use for the service. If you change this you will also need to set [transport port configuration][] in `extraEnvs`                                                                                                                                                         | `9300`                                           |
| `updateStrategy`                   | The [updateStrategy][] for the StatefulSet. By default Kubernetes will wait for the cluster to be green after upgrading each pod. Setting this to `OnDelete` will allow you to manually delete each pod during upgrades                                                                                           | `RollingUpdate`                                  |
| `volumeClaimTemplate`              | Configuration for the [volumeClaimTemplate for StatefulSets][]. You will want to adjust the storage (default `30Gi` ) and the `storageClassName` if you are using a different storage class                                                                                                                       | see [values.yaml][]                              |

### Deprecated

| Parameter | Description                                                                                                   | Default |
|-----------|---------------------------------------------------------------------------------------------------------------|---------|
| `fsGroup` | The Group ID (GID) for [securityContext][] so that the Elasticsearch user can read from the persistent volume | `""`    |


## FAQ

### How to deploy this chart on a specific K8S distribution?

This chart is designed to run on production scale Kubernetes clusters with
multiple nodes, lots of memory and persistent storage. For that reason it can be
a bit tricky to run them against local Kubernetes environments such as
[Minikube][].

This chart is highly tested with [GKE][], but some K8S distribution also
requires specific configurations.

We provide examples of configuration for the following K8S providers:

- [Docker for Mac][]
- [KIND][]
- [Minikube][]
- [MicroK8S][]
- [OpenShift][]

### How to deploy dedicated nodes types?

All the Elasticsearch pods deployed share the same configuration. If you need to
deploy dedicated [nodes types][] (for example dedicated master and data nodes),
you can deploy multiple releases of this chart with different configurations
while they share the same `clusterName` value.

For each Helm release, the nodes types can then be defined using `roles` value.

An example of Elasticsearch cluster using 2 different Helm releases for master
and data nodes can be found in [examples/multi][].

#### Clustering and Node Discovery

This chart facilitates Elasticsearch node discovery and services by creating two
`Service` definitions in Kubernetes, one with the name `$clusterName-$nodeGroup`
and another named `$clusterName-$nodeGroup-headless`.
Only `Ready` pods are a part of the `$clusterName-$nodeGroup` service, while all
pods ( `Ready` or not) are a part of `$clusterName-$nodeGroup-headless`.

If your group of master nodes has the default `nodeGroup: master` then you can
just add new groups of nodes with a different `nodeGroup` and they will
automatically discover the correct master. If your master nodes have a different
`nodeGroup` name then you will need to set `masterService` to
`$clusterName-$masterNodeGroup`.

The chart value for `masterService` is used to populate
`discovery.zen.ping.unicast.hosts` , which Elasticsearch nodes will use to
contact master nodes and form a cluster.
Therefore, to add a group of nodes to an existing cluster, setting
`masterService` to the desired `Service` name of the related cluster is
sufficient.

### How to deploy clusters with security (authentication and TLS) enabled?

This Helm chart can use existing [Kubernetes secrets][] to setup
credentials or certificates for examples. These secrets should be created
outside of this chart and accessed using [environment variables][] and volumes.

An example of Elasticsearch cluster using security can be found in
[examples/security][].

### How to migrate from helm/charts stable chart?

If you currently have a cluster deployed with the [helm/charts stable][] chart
you can follow the [migration guide][].

### How to install plugins?

The recommended way to install plugins into our Docker images is to create a
[custom Docker image][].

The Dockerfile would look something like:

```
ARG elasticsearch_version
FROM docker.elastic.co/elasticsearch/elasticsearch:${elasticsearch_version}

RUN bin/elasticsearch-plugin install --batch repository-gcs
```

And then updating the `image` in values to point to your custom image.

There are a couple reasons we recommend this.

1. Tying the availability of Elasticsearch to the download service to install
plugins is not a great idea or something that we recommend. Especially in
Kubernetes where it is normal and expected for a container to be moved to
another host at random times.
2. Mutating the state of a running Docker image (by installing plugins) goes
against best practices of containers and immutable infrastructure.

### How to use the keystore?

#### Basic example

Create the secret, the key name needs to be the keystore key path. In this
example we will create a secret from a file and from a literal string.

```
kubectl create secret generic encryption-key --from-file=xpack.watcher.encryption_key=./watcher_encryption_key
kubectl create secret generic slack-hook --from-literal=xpack.notification.slack.account.monitoring.secure_url='https://hooks.slack.com/services/asdasdasd/asdasdas/asdasd'
```

To add these secrets to the keystore:

```
keystore:
  - secretName: encryption-key
  - secretName: slack-hook
```

#### Multiple keys

All keys in the secret will be added to the keystore. To create the previous
example in one secret you could also do:

```
kubectl create secret generic keystore-secrets --from-file=xpack.watcher.encryption_key=./watcher_encryption_key --from-literal=xpack.notification.slack.account.monitoring.secure_url='https://hooks.slack.com/services/asdasdasd/asdasdas/asdasd'
```

```
keystore:
  - secretName: keystore-secrets
```

#### Custom paths and keys

If you are using these secrets for other applications (besides the Elasticsearch
keystore) then it is also possible to specify the keystore path and which keys
you want to add. Everything specified under each `keystore` item will be passed
through to the `volumeMounts` section for mounting the [secret][]. In this
example we will only add the `slack_hook` key from a secret that also has other
keys. Our secret looks like this:

```
kubectl create secret generic slack-secrets --from-literal=slack_channel='#general' --from-literal=slack_hook='https://hooks.slack.com/services/asdasdasd/asdasdas/asdasd'
```

We only want to add the `slack_hook` key to the keystore at path
`xpack.notification.slack.account.monitoring.secure_url`:

```
keystore:
  - secretName: slack-secrets
    items:
    - key: slack_hook
      path: xpack.notification.slack.account.monitoring.secure_url
```

You can also take a look at the [config example][] which is used as part of the
automated testing pipeline.

### How to enable snapshotting?

1. Install your [snapshot plugin][] into a custom Docker image following the
[how to install plugins guide][].
2. Add any required secrets or credentials into an Elasticsearch keystore
following the [how to use the keystore][] guide.
3. Configure the [snapshot repository][] as you normally would.
4. To automate snapshots you can use [Snapshot Lifecycle Management][] or a tool
like [curator][].

### How to configure templates post-deployment?

You can use `postStart` [lifecycle hooks][] to run code triggered after a
container is created.

Here is an example of `postStart` hook to configure templates:

```yaml
lifecycle:
  postStart:
    exec:
      command:
        - bash
        - -c
        - |
          #!/bin/bash
          # Add a template to adjust number of shards/replicas
          TEMPLATE_NAME=my_template
          INDEX_PATTERN="logstash-*"
          SHARD_COUNT=8
          REPLICA_COUNT=1
          ES_URL=http://localhost:9200
          while [[ "$(curl -s -o /dev/null -w '%{http_code}\n' $ES_URL)" != "200" ]]; do sleep 1; done
          curl -XPUT "$ES_URL/_template/$TEMPLATE_NAME" -H 'Content-Type: application/json' -d'{"index_patterns":['\""$INDEX_PATTERN"\"'],"settings":{"number_of_shards":'$SHARD_COUNT',"number_of_replicas":'$REPLICA_COUNT'}}'
```


## Contributing

Please check [CONTRIBUTING.md][] before any contribution or for any questions
about our development and testing process.

[7.17]: https://github.com/elastic/helm-charts/releases
[#63]: https://github.com/elastic/helm-charts/issues/63
[BREAKING_CHANGES.md]: https://github.com/elastic/helm-charts/blob/master/BREAKING_CHANGES.md
[CHANGELOG.md]: https://github.com/elastic/helm-charts/blob/master/CHANGELOG.md
[CONTRIBUTING.md]: https://github.com/elastic/helm-charts/blob/master/CONTRIBUTING.md
[alternate scheduler]: https://kubernetes.io/docs/tasks/administer-cluster/configure-multiple-schedulers/#specify-schedulers-for-pods
[annotations]: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/
[anti-affinity]: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#affinity-and-anti-affinity
[cluster.name]: https://www.elastic.co/guide/en/elasticsearch/reference/7.17/important-settings.html#cluster-name
[clustering and node discovery]: https://github.com/elastic/helm-charts/tree/7.17/elasticsearch/README.md#clustering-and-node-discovery
[config example]: https://github.com/elastic/helm-charts/tree/7.17/elasticsearch/examples/config/values.yaml
[curator]: https://www.elastic.co/guide/en/elasticsearch/client/curator/7.9/snapshot.html
[custom docker image]: https://www.elastic.co/guide/en/elasticsearch/reference/7.17/docker.html#_c_customized_image
[deploys statefulsets serially]: https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/#pod-management-policies
[discovery.zen.minimum_master_nodes]: https://www.elastic.co/guide/en/elasticsearch/reference/7.17/discovery-settings.html#minimum_master_nodes
[docker for mac]: https://github.com/elastic/helm-charts/tree/7.17/elasticsearch/examples/docker-for-mac
[elasticsearch cluster health status params]: https://www.elastic.co/guide/en/elasticsearch/reference/7.17/cluster-health.html#request-params
[elasticsearch docker image]: https://www.elastic.co/guide/en/elasticsearch/reference/7.17/docker.html
[environment variables]: https://kubernetes.io/docs/tasks/inject-data-application/define-environment-variable-container/#using-environment-variables-inside-of-your-config
[environment from variables]: https://kubernetes.io/docs/tasks/configure-pod-container/configure-pod-configmap/#configure-all-key-value-pairs-in-a-configmap-as-container-environment-variables
[examples]: https://github.com/elastic/helm-charts/tree/7.17/elasticsearch/examples/
[examples/multi]: https://github.com/elastic/helm-charts/tree/7.17/elasticsearch/examples/multi
[examples/security]: https://github.com/elastic/helm-charts/tree/7.17/elasticsearch/examples/security
[gke]: https://cloud.google.com/kubernetes-engine
[helm]: https://helm.sh
[helm/charts stable]: https://github.com/helm/charts/tree/master/stable/elasticsearch/
[how to install plugins guide]: https://github.com/elastic/helm-charts/tree/7.17/elasticsearch/README.md#how-to-install-plugins
[how to use the keystore]: https://github.com/elastic/helm-charts/tree/7.17/elasticsearch/README.md#how-to-use-the-keystore
[http.port]: https://www.elastic.co/guide/en/elasticsearch/reference/7.17/modules-http.html#_settings
[imagePullPolicy]: https://kubernetes.io/docs/concepts/containers/images/#updating-images
[imagePullSecrets]: https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/#create-a-pod-that-uses-your-secret
[ingress]: https://kubernetes.io/docs/concepts/services-networking/ingress/
[java options]: https://www.elastic.co/guide/en/elasticsearch/reference/7.17/jvm-options.html
[jvm heap size]: https://www.elastic.co/guide/en/elasticsearch/reference/7.17/heap-size.html
[hostAliases]: https://kubernetes.io/docs/concepts/services-networking/add-entries-to-pod-etc-hosts-with-host-aliases/
[kind]: https://github.com/elastic/helm-charts/tree/7.17/elasticsearch/examples/kubernetes-kind
[kubernetes secrets]: https://kubernetes.io/docs/concepts/configuration/secret/
[labels]: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/
[lifecycle hooks]: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/
[loadBalancer annotations]: https://kubernetes.io/docs/concepts/services-networking/service/#ssl-support-on-aws
[loadBalancer externalTrafficPolicy]: https://kubernetes.io/docs/tasks/access-application-cluster/create-external-load-balancer/#preserving-the-client-source-ip
[loadBalancer]: https://kubernetes.io/docs/concepts/services-networking/service/#loadbalancer
[maxUnavailable]: https://kubernetes.io/docs/tasks/run-application/configure-pdb/#specifying-a-poddisruptionbudget
[migration guide]: https://github.com/elastic/helm-charts/tree/7.17/elasticsearch/examples/migration/README.md
[minikube]: https://github.com/elastic/helm-charts/tree/7.17/elasticsearch/examples/minikube
[microk8s]: https://github.com/elastic/helm-charts/tree/7.17/elasticsearch/examples/microk8s
[multi]: https://github.com/elastic/helm-charts/tree/7.17/elasticsearch/examples/multi/
[network.host elasticsearch setting]: https://www.elastic.co/guide/en/elasticsearch/reference/7.17/network.host.html
[node affinity settings]: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#node-affinity-beta-feature
[node-certificates]: https://www.elastic.co/guide/en/elasticsearch/reference/7.17/configuring-tls.html#node-certificates
[nodePort]: https://kubernetes.io/docs/concepts/services-networking/service/#nodeport
[nodes types]: https://www.elastic.co/guide/en/elasticsearch/reference/7.17/modules-node.html
[nodeSelector]: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#nodeselector
[openshift]: https://github.com/elastic/helm-charts/tree/7.17/elasticsearch/examples/openshift
[priorityClass]: https://kubernetes.io/docs/concepts/configuration/pod-priority-preemption/#priorityclass
[probe]: https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-probes/
[resources]: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/
[roles]: https://www.elastic.co/guide/en/elasticsearch/reference/7.17/modules-node.html
[secret]: https://kubernetes.io/docs/concepts/configuration/secret/#using-secrets
[securityContext]: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/
[service types]: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types
[snapshot lifecycle management]: https://www.elastic.co/guide/en/elasticsearch/reference/7.17/snapshot-lifecycle-management.html
[snapshot plugin]: https://www.elastic.co/guide/en/elasticsearch/plugins/7.17/repository.html
[snapshot repository]: https://www.elastic.co/guide/en/elasticsearch/reference/7.17/modules-snapshots.html
[supported configurations]: https://github.com/elastic/helm-charts/tree/7.17/README.md#supported-configurations
[sysctl vm.max_map_count]: https://www.elastic.co/guide/en/elasticsearch/reference/7.17/vm-max-map-count.html#vm-max-map-count
[terminationGracePeriod]: https://kubernetes.io/docs/concepts/workloads/pods/pod/#termination-of-pods
[tolerations]: https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/
[transport port configuration]: https://www.elastic.co/guide/en/elasticsearch/reference/7.17/modules-transport.html#_transport_settings
[updateStrategy]: https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/
[values.yaml]: https://github.com/elastic/helm-charts/tree/7.17/elasticsearch/values.yaml
[volumeClaimTemplate for statefulsets]: https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/#stable-storage



See also

Retrieved from "https://www.wikieduonline.com/index.php?title=Helm_show_all_elastic/elasticsearch&oldid=195742"

Advertising: