You are looking at preliminary documentation for a future release. Not what you want? See the current release documentation.
Elastic Docs ›Heartbeat Reference [master] ›Set up and run Heartbeat
« Repositories for APT and YUM Running Heartbeat on Kubernetes »

Run Heartbeat on Dockeredit

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 imageedit

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

However, version 8.9.0 of Heartbeat has not yet been released, so no Docker image is currently available for this version.

Optional: Verify the imageedit

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

Version 8.9.0 of Heartbeat has not yet been released, so no Docker image is currently available for this version.

Run the Heartbeat setupedit

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

docker run \
--cap-add=NET_RAW \
docker.elastic.co/beats/heartbeat:8.9.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>

Configure Heartbeat on Dockeredit

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 fileedit

Download this example configuration file as a starting point:

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

Volume-mounted configurationedit

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.9.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 configurationedit

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 configurationedit

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.9.0
COPY --chown=root:heartbeat heartbeat.yml /usr/share/heartbeat/heartbeat.yml

Required network capabilitiesedit

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.9.0
« Repositories for APT and YUM Running Heartbeat on Kubernetes »