HUB
Sign inSign up
ROS 2

dhi.io/ros

ROS 2

CIS
FIPS
STIG
linux/amd64
linux/arm64

Robot Operating System 2 (ROS 2) base, with the client libraries, command line tools, launch, rosbag2, tf2 and URDF over Fast DDS.

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.

Start a ros image

The tag names the ROS 2 distribution: jazzy and lyrical carry the ROS 2 base set (ros_core plus rosbag2, tf2, URDF and robot_state_publisher), and <distro>-ros-base is the same image. The entry point sources /opt/ros/<distro>/setup.bash and then runs the command you pass, as the upstream image does.

Basic usage

List the topics on the ROS graph:

$ docker run --rm dhi.io/ros:jazzy ros2 topic list

Open an interactive shell with the ROS 2 environment loaded:

$ docker run --rm -it dhi.io/ros:jazzy
Environment variables

The image sets the variables setup.bash sets, so ros2 and the ROS 2 libraries resolve even when a Kubernetes command: replaces the entry point.

VariableDescriptionDefaultRequired
ROS_DISTROThe ROS 2 distribution in the imagejazzyNo
ROS_DOMAIN_IDThe DDS domain; nodes only see nodes with the same domain IDunset (0)No
ROS_AUTOMATIC_DISCOVERY_RANGEHow far discovery reaches: SUBNET, LOCALHOST, OFFSUBNETNo
ROS_LOG_DIRWhere nodes write their log files~/.ros/logNo

Common ros use cases

Talker and listener with Docker Compose

Two containers on one Compose network discover each other over Fast DDS:

services:
  talker:
    image: dhi.io/ros:jazzy
    command: ["ros2", "topic", "pub", "--rate", "1", "/chatter", "std_msgs/msg/String", "{data: hello}"]
  listener:
    image: dhi.io/ros:jazzy
    command: ["ros2", "topic", "echo", "/chatter", "std_msgs/msg/String"]
    depends_on:
      - talker
$ docker compose up
Build a workspace in a multi-stage Dockerfile

Build your packages with colcon in the dev variant and copy the install tree into the runtime variant. This example builds a workspace whose packages sit under src/:

# syntax=docker/dockerfile:1
FROM dhi.io/ros:jazzy-dev AS build
WORKDIR /ws
COPY src ./src
RUN colcon build --merge-install

FROM dhi.io/ros:jazzy
COPY --from=build /ws/install /ws/install
CMD ["bash", "-c", "source /ws/install/setup.bash && ros2 launch my_package my_launch.py"]
Record a bag

With the Compose file above, record the talker's /chatter topic from a one-off container on the same network. It writes to a host directory as your own user, so the files belong to you:

$ mkdir -p bags
$ docker compose run --rm --user "$(id -u):$(id -g)" -e ROS_LOG_DIR=/tmp -v "$PWD/bags:/bags" listener \
  timeout -s INT 10 ros2 bag record --output /bags/session --topics /chatter

docker compose run starts the talker first. timeout stops the recording with SIGINT after 10 seconds, so the command exits with status 124 and the bag is complete. Show what it recorded:

$ docker run --rm -v "$PWD/bags:/bags" dhi.io/ros:jazzy ros2 bag info /bags/session

Non-hardened images vs. Docker Hardened Images

FeatureUpstream ros imageDocker Hardened ros image
Userrootnonroot (UID 65532); logs go to /home/nonroot/.ros/log
BaseUbuntu with packages.ros.orgDebian 13 (Python 3.13) or Alpine 3.24 (Python 3.14); ROS 2 is built from the distribution's ros2.repos
Adding ROS packagesapt-get install ros-<distro>-<package>packages.ros.org has no Debian 13 packages; build extra packages from source with colcon in the dev variant
Build toolsros-base tags include colcon, rosdep, vcstool and a compilercolcon, rosdep, vcstool, the compiler, headers and CMake configs are in the dev variant only
rosdepInitialized and updatedInstalled in the dev variant, not initialized; ROS package keys resolve to ros-<distro>-* packages that Debian 13 lacks
Tags<distro>-ros-core, <distro>-ros-base, <distro>-perception<distro> and <distro>-ros-base carry the ros-base set; there is no ros-core or perception tag
MiddlewareFast DDSFast DDS only
tf2_toolsIncluded, with graphvizIn the dev variant only

Image variants

Docker Hardened Images come in different variants depending on their intended use. Image variants are identified by their tag.

  • 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 a 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 tag 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.

To view the image variants and get more information about them, select the Tags tab for this repository, and then select a tag.

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.

ItemMigration note
Base imageReplace your base images in your Dockerfile with a Docker Hardened Image.
Package managementNon-dev images, intended for runtime, don't contain package managers. Use package managers only in images with a dev tag.
Non-root userBy default, non-dev images, intended for runtime, run as the nonroot user. Ensure that necessary files and directories are accessible to the nonroot user.
Multi-stage buildUtilize images with a dev tag for build stages and non-dev images for runtime. For binary executables, use a static image for runtime.
TLS certificatesDocker Hardened Images contain standard TLS certificates by default. There is no need to install TLS certificates.
PortsNon-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.
Entry pointDocker Hardened Images may have different entry points than images such as Docker Official Images. Inspect entry points for Docker Hardened Images and update your Dockerfile if necessary.
No shellBy default, non-dev images, intended for runtime, don't contain a shell. Use dev images in build stages to run shell commands and then copy artifacts to the runtime stage.

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.