How to use this image

All examples in this guide use the public image. If you’ve mirrored the repository for your own use (for example, to your Docker Hub namespace), update your commands to reference the mirrored image instead of the public one.

For example:

• Public image: dhi.io/<repository>:<tag>
• Mirrored image: <your-namespace>/dhi-<repository>:<tag>

For the examples, you must first use docker login dhi.io to authenticate to the registry to pull the images.

Run a kapacitor container and display help information

The following command runs the container, displays the help information, and automatically removes the container when it exits. Replace <tag> with the image variant you want to run.

$ docker run --rm -it dhi.io/kapacitor:<tag> help

Run Kapacitor with InfluxDB v3

Note: This example uses -dev image variants for influxdb3-token-init and kapacitor because they require a shell and package manager — the init service installs jq to extract the token, and Kapacitor needs bash to read the token from the shared volume before exec-ing kapacitord. The runtime (non-dev) images don't include a shell or package manager.

Kapacitor is typically run alongside InfluxDB, which it connects to for reading and writing time series data. The following docker-compose.yml shows a minimal setup.

services:
  influxdb3-token-init:
    image: dhi.io/influxdb:3-core-dev
    entrypoint:
      - bash
      - -xc
    command:
      - |
        apt update
        apt install -y jq
        influxdb3 create token --admin --offline --output-file /tokens/admin-token.json
        jq -r '.token' /tokens/admin-token.json > /tokens/token
        chmod 755 /tokens/ && chmod 644 /tokens/*
    volumes:
      - token-data:/tokens

  influxdb3:
    image: dhi.io/influxdb:3-core
    environment:
      INFLUXDB3_ADMIN_TOKEN_FILE: /tokens/admin-token.json
      INFLUXDB3_DISABLE_AUTHZ: health
    command:
      - serve
      - --node-id
      - node1
    ports:
      - "8181:8181"
    volumes:
      - token-data:/tokens:ro
    depends_on:
      influxdb3-token-init:
        condition: service_completed_successfully
    networks:
      - kapacitor

  influxdb3-ready-check:
    image: dhi.io/curl:8
    entrypoint:
      - curl
    command:
      - http://influxdb3:8181/health
    restart: on-failure
    depends_on:
      influxdb3:
        condition: service_started
    networks:
      - kapacitor

  kapacitor:
    image: dhi/kapacitor:1-dev
    entrypoint:
      - bash
      - -c
    command:
      - |
        export KAPACITOR_INFLUXDB_0_TOKEN=$(cat /tokens/token)
        exec kapacitord
    ports:
      - "9092:9092"
    environment:
      KAPACITOR_INFLUXDB_0_URLS_0: http://influxdb3:8181
      KAPACITOR_INFLUXDB_0_DISABLE_SUBSCRIPTIONS: "true"
    volumes:
      - token-data:/tokens:ro
      - kapacitor-data:/var/lib/kapacitor
    depends_on:
      influxdb3-ready-check:
        condition: service_completed_successfully
    networks:
      - kapacitor

volumes:
  token-data:
  kapacitor-data:

networks:
  kapacitor:
    driver: bridge

Start the services with:

$ docker compose up -d

This example demonstrates:

• Starting an InfluxDB server and waiting for it to be ready
• Creating an authentication token
• Starting Kapacitor only once InfluxDB is accepting connections
• Connecting Kapacitor to InfluxDB via the KAPACITOR_INFLUXDB_0_URLS_0 environment variable

Use the Kapacitor CLI

The kapacitor CLI is included in the image and can be used to interact with the running server. For example, to check server statistics or list defined tasks:

$ docker compose exec kapacitor kapacitor stats general
$ docker compose exec kapacitor kapacitor list tasks

For more details about using Kapacitor, refer to the Kapacitor documentation⁠.

Image variants

Docker Hardened Images come in different variants depending on their intended use.

• Runtime variants are designed to run your application in production. These images are intended to be used either directly or as the FROM image in the final stage of a multi-stage build. These images typically:

  • Run as the nonroot user
  • Do not include a shell or a package manager
  • Contain only the minimal set of libraries needed to run the app

• Build-time variants typically include dev in the variant name and are intended for use in the first stage of a multi-stage Dockerfile. These images typically:

  • Run as the root user
  • Include a shell and package manager
  • Are used to build or compile applications

• FIPS variants include fips in the variant name and tag. They come in both runtime and build-time variants. These variants use cryptographic modules that have been validated under FIPS 140, a U.S. government standard for secure cryptographic operations. For example, usage of MD5 fails in FIPS variants.

Migrate to a Docker Hardened Image

To migrate your application to a Docker Hardened Image, you must update your Dockerfile. At minimum, you must update the base image in your existing Dockerfile to a Docker Hardened Image. This and a few other common changes are listed in the following table of migration notes.

The following steps outline the general migration process.

1. Find hardened images for your app.

   A hardened image may have several variants. Inspect the image tags and find the image variant that meets your needs.

2. Update the base image in your Dockerfile.

   Update the base image in your application's Dockerfile to the hardened image you found in the previous step. For framework images, this is typically going to be an image tagged as dev because it has the tools needed to install packages and dependencies.

3. For multi-stage Dockerfiles, update the runtime image in your Dockerfile.

   To ensure that your final image is as minimal as possible, you should use a multi-stage build. All stages in your Dockerfile should use a hardened image. While intermediary stages will typically use images tagged as dev, your final runtime stage should use a non-dev image variant.

4. Install additional packages

   Docker Hardened Images contain minimal packages in order to reduce the potential attack surface. You may need to install additional packages in your Dockerfile. Inspect the image variants to identify which packages are already installed.

   Only images tagged as dev typically have package managers. You should use a multi-stage Dockerfile to install the packages. Install the packages in the build stage that uses a dev image. Then, if needed, copy any necessary artifacts to the runtime stage that uses a non-dev image.

   For Alpine-based images, you can use apk to install packages. For Debian-based images, you can use apt-get to install packages.

Troubleshooting migration

The following are common issues that you may encounter during migration.

General debugging

The hardened images intended for runtime don't contain a shell nor any tools for debugging. The recommended method for debugging applications built with Docker Hardened Images is to use Docker Debug⁠ to attach to these containers. Docker Debug provides a shell, common debugging tools, and lets you install other tools in an ephemeral, writable layer that only exists during the debugging session.

Permissions

By default image variants intended for runtime, run as the nonroot user. Ensure that necessary files and directories are accessible to the nonroot user. You may need to copy files to different directories or change permissions so your application running as the nonroot user can access them.

Privileged ports

Non-dev hardened images run as a nonroot user by default. As a result, applications in these images can't bind to privileged ports (below 1024) when running in Kubernetes or in Docker Engine versions older than 20.10. To avoid issues, configure your application to listen on port 1025 or higher inside the container, even if you map it to a lower port on the host. For example, docker run -p 80:8080 my-image will work because the port inside the container is 8080, and docker run -p 80:81 my-image won't work because the port inside the container is 81.

No shell

By default, image variants intended for runtime don't contain a shell. Use dev images in build stages to run shell commands and then copy any necessary artifacts into the runtime stage. In addition, use Docker Debug to debug containers with no shell.

Entry point

Docker Hardened Images may have different entry points than images such as Docker Official Images. Use docker inspect to inspect entry points for Docker Hardened Images and update your Dockerfile if necessary.