Calimero Docker images

Dockerfiles for Calimero tools, server, and testnetwork. Built Docker images are available on Docker Hub.

Building images

The build-images.sh script assumes that the repository layout of required Calimero sources follows the GitHub layout, i.e., the required repositories are sibling directories of calimero-docker.

For building Calimero Docker images, use

./build-images.sh {armv7, aarch64, amd64}

JDK and Java runtime

The Dockerfiles use a custom-built JDK and (minimal) Java runtime for building and running the Calimero tools/server/testnetwork, respectively. A JDK/runtime image build requires several minutes to build (or really long if using Docker buildx):

• Run setup-external-jdk.sh.
• In the resulting Docker container, run make images CONF=. If the Shenandoah GC is used, export JAVA_TOOL_OPTIONS="-XX:+UseShenandoahGC" if a build error occurs.
• Run build-java-image.sh to create the final the Docker image

Pre-built Docker images are available on Docker Hub.

Alternatively, replace the JDK/runtime in the calimero-tools/server Dockerfile with an image of your choice.

Currently used custom JDK/runtime configurations

• Architectures: x86-64, ARMv7, AArch64
• C1 compiler
• GC: Shenandoah GC (on ARMv7 Serial GC, Shenandoah is not supported)
• Optimize for size
• Modules: java.base (+ java.xml for Calimero tools)

Running containers

Docker options

• Use host network: --net host
• Bind-mount a server configuration: -v /calimero-server/config/server-config.xml:/usr/app/server-config.xml (with server-config.xml located on the host in the folder /calimero-server/config)
• USB access: -v /dev/bus/usb:/dev/bus/usb --group-add <gid> --device-cgroup-rule='c 189:* rw'. In detail:
  • Bind-mount the USB directory: -v /dev/bus/usb:/dev/bus/usb
  • Add the container process to the USB group: --group-add <gid>, with the group ID (gid) given by ls -ln /dev/bus/usb/*/*; for example, gid=46 (plugdev).
  • Give container permission to read/write USB devices: --device-cgroup-rule='c 189:* rw'
  • If the above options don't work, try --privileged -u 0

Application options

• -v, -vv, -vvv: log at level info (default), debug, or trace, respectively. This option has to be passed as first argument.
• --no-stdin (KNX Server specific): do not use standard input, to run the server as daemon or without a terminal. This option has to be passed before the server configuration.