zenoh

packaged by Chainguard

Chainguard Container for zenoh

Eclipse Zenoh router (zenohd) with the REST and storage-manager plugins

Chainguard Containers are regularly-updated, secure-by-default container images.

Download this Container Image

For those with access, this container image is available on cgr.dev:

docker pull cgr.dev/ORGANIZATION/zenoh:latest

Be sure to replace the ORGANIZATION placeholder with the name used for your organization's private repository within the Chainguard Registry.

Compatibility Notes

This image provides zenohd, the router daemon of Eclipse Zenoh, with the REST and storage-manager plugins. It is licensed under EPL-2.0 OR Apache-2.0, and is designed as a drop-in replacement for the upstream eclipse/zenoh image:

• The entrypoint is /entrypoint.sh. It prints itself, then runs /$BINARY with the supplied arguments (BINARY=zenohd, RUST_LOG=info). The script is taken from upstream's image build, except that it quotes "$@", so arguments containing spaces reach zenohd intact.
• The binary is available at /zenohd and /usr/bin/zenohd. The plugins are installed in /usr/lib, which is in zenohd's default plugin search path, and are also linked at upstream's /libzenoh_plugin_rest.so and /libzenoh_plugin_storage_manager.so, so configs that name them by __path__ keep working.
• zenohd is built with the same Rust toolchain as upstream, because zenohd refuses to load plugins built with a different rustc.
• The image is glibc-based, while upstream's binaries are musl builds. Plugins built for the upstream image will not load; build custom plugins for a *-unknown-linux-gnu target against the same zenoh version and features, with the rustc release that zenohd --version reports.
• Like upstream, the image includes libstdc++, so custom plugins that link C++, such as a RocksDB storage backend, can load.
• Unlike upstream, the image runs as the nonroot user (UID 65532) by default. A storage backend that writes to disk needs a volume that this user can write to. Upstream mounts custom plugins and backends at /root/.zenoh (plugins in its lib/); here HOME is /home/nonroot, so mount the same directory, readable by UID 65532, at /home/nonroot/.zenoh, or the plugins themselves into /usr/local/lib.

The image listens on the same ports as upstream: 7446/udp for multicast scouting, 7447/tcp for the zenoh protocol, and 8000/tcp for the REST API (only when the REST plugin is enabled). Unlike upstream, the image declares no exposed ports, so docker run -P publishes nothing; publish ports with -p.

Getting Started

Print the version:

docker run --rm cgr.dev/ORGANIZATION/zenoh:latest --version

Be sure to replace the ORGANIZATION placeholder with the name used for your organization's private repository within the Chainguard Registry.

Start a router with the REST API and an in-memory storage for demo/**, then write and read a value:

docker run -d --name zenoh -p 7447:7447 -p 8000:8000 cgr.dev/ORGANIZATION/zenoh:latest \
  --rest-http-port 8000 \
  --cfg='plugins/storage_manager/storages/demo:{key_expr:"demo/**",volume:"memory"}'

# The REST API can answer before the storage subscribes, so re-send the PUT until it is stored.
until curl -sf -X PUT -H 'Content-Type: text/plain' -d 'hello' http://localhost:8000/demo/example &&
  curl -sf http://localhost:8000/demo/example | grep -q hello; do sleep 1; done
curl -sf http://localhost:8000/demo/example

Configuration

zenohd takes a JSON5 configuration file with -c, and single settings with --cfg KEY:VALUE. Write a file, mount it, and point zenohd at it. The file must be readable by UID 65532:

cat > zenohd.json5 <<'EOF'
{
  mode: "router",
  plugins: {
    rest: { http_port: 8000 },
  },
}
EOF
chmod 644 zenohd.json5
docker run -d --name zenoh-config -p 7448:7447 -p 8001:8000 \
  -v "$PWD/zenohd.json5:/etc/zenohd/zenohd.json5:ro" \
  cgr.dev/ORGANIZATION/zenoh:latest -c /etc/zenohd/zenohd.json5

Upstream's DEFAULT_CONFIG.json5 documents every option with its default. See also the configuration reference.

Documentation and Resources

• Zenoh documentation
• Configuration reference
• REST plugin

What are Chainguard Containers?

Chainguard's free tier of Starter container images are built with Wolfi, our minimal Linux undistro.

All other Chainguard Containers are built with Chainguard OS, Chainguard's minimal Linux operating system designed to produce container images that meet the requirements of a more secure software supply chain.

The main features of Chainguard Containers include:

• Minimal design, without unnecessary software bloat
• Daily builds to ensure container images are up-to-date with available security patches
• High quality build-time SBOMs attesting to the provenance of all artifacts within the image
• Verifiable signatures provided by Sigstore
• Reproducible builds with Cosign and apko (read more about reproducibility)

For cases where you need container images with shells and package managers to build or debug, most Chainguard Containers come paired with a development, or -dev, variant.

In all other cases, including Chainguard Containers tagged as :latest or with a specific version number, the container images include only an open-source application and its runtime dependencies. These minimal container images typically do not contain a shell or package manager.

Although the -dev container image variants have similar security features as their more minimal versions, they include additional software that is typically not necessary in production environments. We recommend using multi-stage builds to copy artifacts from the -dev variant into a more minimal production image.

Need additional packages?

To improve security, Chainguard Containers include only essential dependencies. Need more packages? Chainguard customers can use Custom Assembly to add packages, either through the Console, chainctl, or API.

To use Custom Assembly in the Chainguard Console: navigate to the image you'd like to customize in your Organization's list of images, and click on the Customize image button at the top of the page.

Learn More

Refer to our Chainguard Containers documentation on Chainguard Academy. Chainguard also offers VMs and Libraries — contact us for access.

Trademarks

This software listing is packaged by Chainguard. The trademarks set forth in this offering are owned by their respective companies, and use of them does not imply any affiliation, sponsorship, or endorsement by such companies.