Run Heartbeat on Docker

Docker images for Heartbeat are available from the Elastic Docker registry. The base image is centos:7.

A list of all published Docker images and tags is available at www.docker.elastic.co.

These images are free to use under the Elastic license. They contain open source and free commercial features and access to paid commercial features. Start a 30-day trial to try out all of the paid commercial features. See the Subscriptions page for information about Elastic license levels.

Pull the image

edit

Obtaining Heartbeat for Docker is as simple as issuing a docker pull command against the Elastic Docker registry.

docker pull docker.elastic.co/beats/heartbeat:8.17.0

Alternatively, you can download other Docker images that contain only features available under the Apache 2.0 license. To download the images, go to www.docker.elastic.co.

Optional: Verify the image

edit

You can use the Cosign application to verify the Heartbeat Docker image signature.

wget https://artifacts.elastic.co/cosign.pub
cosign verify --key cosign.pub docker.elastic.co/beats/heartbeat:8.17.0

The cosign command prints the check results and the signature payload in JSON format:

Verification for docker.elastic.co/beats/heartbeat:8.17.0 --
The following checks were performed on each of these signatures:
  - The cosign claims were validated
  - Existence of the claims in the transparency log was verified offline
  - The signatures were verified against the specified public key

Run the Heartbeat setup

edit

A known issue in version 8.17.0 prevents Beats Docker images from starting when no options are provided. When running an image on that version, add an --environment container parameter to avoid the problem. This is planned to be addressed in issue #42060.

Running Heartbeat with the setup command will create the index pattern and load visualizations and machine learning jobs. Run this command:

docker run --rm \
--cap-add=NET_RAW \
docker.elastic.co/beats/heartbeat:8.17.0 \
setup -E setup.kibana.host=kibana:5601 \
-E output.elasticsearch.hosts=["elasticsearch:9200"]

	Substitute your Kibana and Elasticsearch hosts and ports.
	If you are using the hosted Elasticsearch Service in Elastic Cloud, replace the `-E output.elasticsearch.hosts` line with the Cloud ID and elastic password using this syntax:

-E cloud.id=<Cloud ID from Elasticsearch Service> \
-E cloud.auth=elastic:<elastic password>

Run Heartbeat on a read-only file system

edit

If you’d like to run Heartbeat in a Docker container on a read-only file system, you can do so by specifying the --read-only option. Heartbeat requires a stateful directory to store application data, so with the --read-only option you also need to use the --mount option to specify a path to where that data can be stored.

For example:

docker run --rm \
  --mount type=bind,source=$(pwd)/data,destination=/usr/share/heartbeat/data \
  --read-only \
  docker.elastic.co/beats/heartbeat:8.17.0

Configure Heartbeat on Docker

edit

The Docker image provides several methods for configuring Heartbeat. The conventional approach is to provide a configuration file via a volume mount, but it’s also possible to create a custom image with your configuration included.

Example configuration file

edit

Download this example configuration file as a starting point:

curl -L -O https://raw.githubusercontent.com/elastic/beats/8.17/deploy/docker/heartbeat.docker.yml

Volume-mounted configuration

edit

One way to configure Heartbeat on Docker is to provide heartbeat.docker.yml via a volume mount. With docker run, the volume mount can be specified like this.

docker run -d \
  --name=heartbeat \
  --user=heartbeat \
  --volume="$(pwd)/heartbeat.docker.yml:/usr/share/heartbeat/heartbeat.yml:ro" \
  --cap-add=NET_RAW \
  docker.elastic.co/beats/heartbeat:8.17.0 \
  --strict.perms=false -e \
  -E output.elasticsearch.hosts=["elasticsearch:9200"]

	Substitute your Elasticsearch hosts and ports.
	If you are using the hosted Elasticsearch Service in Elastic Cloud, replace the `-E output.elasticsearch.hosts` line with the Cloud ID and elastic password using the syntax shown earlier.

Customize your configuration

edit

The heartbeat.docker.yml downloaded earlier should be customized for your environment. See Configure for more details. Edit the configuration file and customize it to match your environment then re-deploy your Heartbeat container.

Custom image configuration

edit

It’s possible to embed your Heartbeat configuration in a custom image. Here is an example Dockerfile to achieve this:

FROM docker.elastic.co/beats/heartbeat:8.17.0
COPY --chown=root:heartbeat heartbeat.yml /usr/share/heartbeat/heartbeat.yml

Required network capabilities

edit

Under Docker, Heartbeat runs 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.

docker run --cap-add=NET_RAW docker.elastic.co/beats/heartbeat:8.17.0

« Repositories for APT and YUM Running Heartbeat on Kubernetes »