Pod PreStop hook

When an Elasticsearch Pod is terminated, its Endpoint is removed from the Service and the Elasticsearch process is terminated. As these two operations happen in parallel, a race condition exists. If the Elasticsearch process is already shut down, but the Endpoint is still a part of the Service, any new connection might fail. For more information, check Termination of pods.

Moreover, kube-proxy resynchronizes its rules every 30 seconds by default. During that time window of 30 seconds, the terminating Pod IP may still be used when targeting the service. Please note the resync operation itself may take some time, especially if kube-proxy is configured to use iptables with a lot of services and rules to apply.

To address this issue and minimize unavailability, ECK relies on a PreStop lifecycle hook. It waits for an additional PRE_STOP_ADDITIONAL_WAIT_SECONDS (defaulting to 50). The additional wait time is used to:

The exact behavior is configurable using an environment variable, for example:

spec:
  version: 8.17.0
  nodeSets:
    - name: default
      count: 1
      podTemplate:
        spec:
          containers:
          - name: elasticsearch
            env:
            - name: PRE_STOP_ADDITIONAL_WAIT_SECONDS
              value: "5"

The pre-stop lifecycle hook also tries to gracefully shut down the Elasticsearch node in case of a termination that is not caused by the ECK operator. Examples of such terminations could be Kubernetes node maintenance or a Kubernetes upgrade. In these cases the script will try to interact with the Elasticsearch API to notify Elasticsearch of the impending termination of the node. The intent is to avoid relocation and recovery of shards while the Elasticsearch node is only temporarily unavailable.

This is done on a best effort basis. In particular requests to an Elasticsearch cluster already in the process of shutting down might fail if the Kubernetes service has already been removed. The script allows for PRE_STOP_MAX_DNS_ERRORS which default to 2 before giving up.

When using local persistent volumes a different behaviour might be desirable because the Elasticsearch node’s associated storage will not be available anymore on the new Kubernetes node. PRE_STOP_SHUTDOWN_TYPE allows to override the default shutdown type to one of the possible values. Please be aware that setting it to anything other than restart might mean that the pre-stop hook will run longer than terminationGracePeriodSeconds of the Pod while moving data out of the terminating Pod and will not be able to complete unless you also adjust that value in the podTemplate.