Type to search.

Running Heartbeat on Kubernetes

Serverless

Elastic Cloud Serverless projects are autoscaled environments, fully managed by Elastic and available on Elastic Cloud.

Availability

  • Generally available

    This functionality is generally available and ready for production usage.

Serverless interfaces and procedures might differ from classic Elastic Stack deployments.

Stack

The Elastic Stack includes Elastic's core products such as Elasticsearch, Kibana, Logstash, and Beats.

Availability

  • Generally available

    This functionality is generally available and ready for production usage.

Unless stated otherwise on the page, this functionality is available when your Elastic Stack is deployed on Elastic Cloud Hosted, Elastic Cloud Enterprise, Elastic Cloud on Kubernetes, and self-managed environments.

This documentation corresponds to the latest patch available for each minor version. If you're not using the latest patch, check the release notes for changes.

Heartbeat Docker images can be used on Kubernetes to check resources uptime.

Tip

Running Elastic Cloud on Kubernetes? See Run Beats on ECK

Kubernetes deploy manifests for Heartbeat

A single Heartbeat can check for uptime of the whole cluster.

Everything is deployed under kube-system namespace, you can change that by updating the YAML file.

To get the manifests just run:

Shell 
curl -L -O https://raw.githubusercontent.com/elastic/beats/9.5/deploy/kubernetes/heartbeat-kubernetes.yaml
Warning

If you are using Kubernetes 1.7 or earlier: Heartbeat uses a hostPath volume to persist internal data, it’s located under /var/lib/heartbeat-data. The manifest uses folder autocreation (DirectoryOrCreate), which was introduced in Kubernetes 1.8. You will need to remove type: DirectoryOrCreate from the manifest and create the host folder yourself.

Settings

Some parameters are exposed in the manifest to configure logs destination, by default they will use an existing Elasticsearch deploy if it’s present, but you may want to change that behavior, so just edit the YAML file and modify them:

YAML 
- name: ELASTICSEARCH_HOST
  value: elasticsearch
- name: ELASTICSEARCH_PORT
  value: "9200"
- name: ELASTICSEARCH_USERNAME
  value: elastic
- name: ELASTICSEARCH_PASSWORD
  value: changeme

Deploy

To deploy Heartbeat to Kubernetes just run:

Shell 
kubectl create -f heartbeat-kubernetes.yaml

Then you should be able to check the status by running:

Shell 
$ kubectl --namespace=kube-system get deployment/heartbeat

NAME        READY   UP-TO-DATE   AVAILABLE   AGE
heartbeat   1/1     1            1           1m

Running Heartbeat as unprivileged user

Under Kubernetes, Heartbeat can run as a non-root user, but requires some privileged network capabilities to operate correctly. Ensure that the NET_RAW capability is available to the container.

YAML 
containers:
- name: heartbeat
  image: docker.elastic.co/beats/heartbeat:9.5.6
  securityContext:
    runAsUser: 1000
    runAsGroup: 1000
    capabilities:
      add: [ NET_RAW ]