automq

packaged by Chainguard

Chainguard Container for automq

AutoMQ is a Kafka-compatible streaming platform backed by S3-compatible object storage

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/automq:latest

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

Compatibility Notes

Chainguard's automq container image is comparable to the automqinc/automq image, with the following differences:

• The image runs as the nonroot user (UID 65532) instead of root. /opt/kafka/kafka/config, /opt/kafka/kafka/logs, /opt/kafka/scripts, and /data/kafka are writable by that user.
• The distribution lives at the same paths as upstream: /opt/automq/kafka and /opt/kafka/kafka, with /opt/kafka/scripts/start.sh.
• The image ships a Java runtime rather than a full JDK, and leaves out upstream's debugging and network tools such as vim, htop, iproute2, curl, wget, nc, and dig.
• The image replaces the plain automqinc/automq tags only. It doesn't match the -bitnami, -kafka, and -strimzi builds, which use their own users and filesystem layouts.
• Like all other Chainguard Containers, automq features a stripped down, minimal design with few-to-zero CVEs.

Getting Started

AutoMQ keeps its data in S3-compatible object storage, so the broker needs a bucket before it starts. This example uses MinIO for local testing; the overrides match upstream's docker-compose.yaml.

Create a network and start MinIO with two buckets:

docker network create automq
docker run -d --name minio --network automq \
  -e MINIO_ROOT_USER=minioadmin -e MINIO_ROOT_PASSWORD=minioadmin \
  cgr.dev/ORGANIZATION/minio:latest server /data
until docker exec minio mc --config-dir /tmp/mc alias set local http://localhost:9000 minioadmin minioadmin; do sleep 2; done
docker exec minio mc --config-dir /tmp/mc mb local/automq-data local/automq-ops

Start a single node that acts as both broker and controller. Setting cluster.id makes AutoMQ format its storage on first start:

S3='region=us-east-1&endpoint=http://minio:9000&pathStyle=true'
docker run -d --name automq --hostname automq --network automq \
  -e KAFKA_S3_ACCESS_KEY=minioadmin -e KAFKA_S3_SECRET_KEY=minioadmin \
  -e KAFKA_HEAP_OPTS="-Xms1g -Xmx1g -XX:MaxDirectMemorySize=1g" \
  cgr.dev/ORGANIZATION/automq:latest bash -c "
  /opt/automq/kafka/bin/kafka-server-start.sh /opt/automq/kafka/config/kraft/server.properties \
    --override cluster.id=rZdE0DjZSrqy96PXrMUZVw \
    --override node.id=0 \
    --override controller.quorum.voters=0@automq:9093 \
    --override controller.quorum.bootstrap.servers=automq:9093 \
    --override advertised.listeners=PLAINTEXT://automq:9092 \
    --override s3.data.buckets='0@s3://automq-data?$S3' \
    --override s3.ops.buckets='1@s3://automq-ops?$S3' \
    --override s3.wal.path='0@s3://automq-data?$S3'"

Wait for the broker to accept connections:

until docker exec automq /opt/automq/kafka/bin/kafka-broker-api-versions.sh \
  --bootstrap-server automq:9092 > /dev/null 2>&1; do sleep 2; done

Create a topic, then produce and consume a message:

docker exec automq /opt/automq/kafka/bin/kafka-topics.sh --bootstrap-server automq:9092 --create --topic demo
echo "hello automq" | docker exec -i automq /opt/automq/kafka/bin/kafka-console-producer.sh \
  --bootstrap-server automq:9092 --topic demo
docker exec automq /opt/automq/kafka/bin/kafka-console-consumer.sh --bootstrap-server automq:9092 \
  --topic demo --from-beginning --max-messages 1

The consumer prints:

hello automq

Configuration

Table topics write a topic's records into an Apache Iceberg table. To use an Iceberg REST catalog, add these overrides to the broker command. AutoMQ reuses the data bucket's endpoint and credentials for the table files:

--override automq.table.topic.catalog.type=rest \
--override automq.table.topic.catalog.uri=http://<catalog-host>:8181/catalog \
--override automq.table.topic.catalog.warehouse=<warehouse>

Then enable it per topic:

docker exec automq /opt/automq/kafka/bin/kafka-topics.sh --bootstrap-server automq:9092 --create --topic orders \
  --config automq.table.topic.enable=true \
  --config automq.table.topic.namespace=default \
  --config automq.table.topic.convert.value.type=raw \
  --config automq.table.topic.transform.value.type=none

If every client listener uses TLS, also give the built-in metrics reporter a client config, or it connects in plaintext and retries. Prefix the client properties with autobalancer.client.auth., for example autobalancer.client.auth.security.protocol=SSL together with the matching autobalancer.client.auth.ssl.truststore.* settings.

Documentation and Resources

• AutoMQ documentation
• Table topic overview
• GitHub repository

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.