This documentation contains work-in-progress information for future Elastic Stack and Cloud releases. Use the version selector to view supported release docs. It also contains some Elastic Cloud serverless information. Check out our serverless docs for more details.
« Repositories for APT and YUM Packetbeat and systemd »
Elastic Docs ›Packetbeat Reference [master] ›Set up and run Packetbeat

Run Packetbeat on Docker

edit

Run Packetbeat on Docker

edit

Docker images for Packetbeat 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 Packetbeat for Docker is as simple as issuing a docker pull command against the Elastic Docker registry.

Version 9.0.0-beta1 of Packetbeat has not yet been released. No Docker image is currently available for Packetbeat 9.0.0-beta1.

docker pull docker.elastic.co/beats/packetbeat:9.0.0-beta1

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 Packetbeat Docker image signature.

Version 9.0.0-beta1 of Packetbeat has not yet been released. No Docker image is currently available for Packetbeat 9.0.0-beta1.

wget https://artifacts.elastic.co/cosign.pub
cosign verify --key cosign.pub docker.elastic.co/beats/packetbeat:9.0.0-beta1

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

Verification for docker.elastic.co/beats/packetbeat:9.0.0-beta1 --
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 Packetbeat setup

edit

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

docker run --rm \
--cap-add=NET_ADMIN \
docker.elastic.co/beats/packetbeat:9.0.0-beta1 \
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 Packetbeat on a read-only file system

edit

If you’d like to run Packetbeat in a Docker container on a read-only file system, you can do so by specifying the --read-only option. Packetbeat 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/packetbeat/data \
  --read-only \
  docker.elastic.co/beats/packetbeat:9.0.0-beta1

Configure Packetbeat on Docker

edit

The Docker image provides several methods for configuring Packetbeat. 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/master/deploy/docker/packetbeat.docker.yml

Volume-mounted configuration

edit

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

docker run -d \
  --name=packetbeat \
  --user=packetbeat \
  --volume="$(pwd)/packetbeat.docker.yml:/usr/share/packetbeat/packetbeat.yml:ro" \
  --cap-add="NET_RAW" \
  --cap-add="NET_ADMIN" \
  --network=host \
  docker.elastic.co/beats/packetbeat:9.0.0-beta1 \
  --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 packetbeat.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 Packetbeat container.

Custom image configuration

edit

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

FROM docker.elastic.co/beats/packetbeat:9.0.0-beta1
COPY --chown=root:packetbeat packetbeat.yml /usr/share/packetbeat/packetbeat.yml

Required network capabilities

edit

Under Docker, Packetbeat runs as a non-root user, but requires some privileged network capabilities to operate correctly. Ensure that the NET_ADMIN capability is available to the container.

docker run --cap-add=NET_ADMIN docker.elastic.co/beats/packetbeat:9.0.0-beta1

Capture traffic from the host system

edit

By default, Docker networking will connect the Packetbeat container to an isolated virtual network, with a limited view of network traffic. You may wish to connect the container directly to the host network in order to see traffic destined for, and originating from, the host system. With docker run, this can be achieved by specifying --network=host.

docker run --cap-add=NET_ADMIN --network=host docker.elastic.co/beats/packetbeat:9.0.0-beta1

On Windows and MacOS, specifying --network=host will bind the container’s network interface to the virtual interface of Docker’s embedded Linux virtual machine, not to the physical interface of the host system.

« Repositories for APT and YUM Packetbeat and systemd »