automq-fips

packaged by Chainguard

Chainguard Container for automq-fips

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-fips: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-fips 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-fips features a stripped down, minimal design with few-to-zero CVEs.

FIPS Support

The automq-fips image uses the Bouncy Castle FIPS provider for all Java cryptography, including TLS between clients and brokers and the S3 connection. It differs from the non-FIPS image in these ways:

• Kafka keystores and truststores must be BCFKS or PEM. JKS and PKCS12 are rejected. To create BCFKS stores with the image's keytool, set JAVA_TOOL_OPTIONS=--module-path=/usr/share/java/bouncycastle-fips/.
• Cipher suites outside the FIPS-approved set, such as ChaCha20-Poly1305, are refused.
• SCRAM passwords must be at least 14 characters.
• The checksumAlgorithm=CRC64NVME bucket option and SigV4a signing (S3 Multi-Region Access Points) are not supported, because they depend on the AWS CRT native library, which the image doesn't include.
• PEM private keys in legacy OpenSSL encryption (Proc-Type: 4,ENCRYPTED) are refused; use encrypted PKCS#8.

Getting Started

AutoMQ keeps its data in S3-compatible object storage, so the broker needs a bucket before it starts. This example runs MinIO over TLS for local testing, so both the client listener and the S3 connection go through the FIPS provider. The overrides follow upstream's docker-compose.yaml.

Create a certificate for MinIO, then start it with two buckets:

mkdir -p automq-tls/minio && chmod 777 automq-tls
openssl req -x509 -newkey rsa:2048 -nodes -days 30 -subj "/CN=minio" \
  -addext "subjectAltName=DNS:minio" \
  -keyout automq-tls/minio/private.key -out automq-tls/minio/public.crt
chmod 644 automq-tls/minio/private.key

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

Create a BCFKS keystore for the broker and a BCFKS truststore that holds the broker and MinIO certificates:

PASS=AutoMQStoreP@ss123
docker run --rm -v "$PWD/automq-tls:/tls" \
  -e JAVA_TOOL_OPTIONS=--module-path=/usr/share/java/bouncycastle-fips/ \
  cgr.dev/ORGANIZATION/automq-fips:latest sh -c "
  bc='-storetype BCFKS -providername BCFIPS -storepass $PASS'
  \$JAVA_HOME/bin/keytool -genkeypair -alias broker -keyalg RSA -keysize 2048 -validity 30 \
    -dname CN=automq -ext SAN=dns:automq -keystore /tls/broker.bcfks -keypass $PASS \$bc
  \$JAVA_HOME/bin/keytool -exportcert -alias broker -keystore /tls/broker.bcfks -file /tls/broker.der \$bc
  \$JAVA_HOME/bin/keytool -importcert -noprompt -alias broker -file /tls/broker.der -keystore /tls/trust.bcfks \$bc
  \$JAVA_HOME/bin/keytool -importcert -noprompt -alias minio -file /tls/minio/public.crt -keystore /tls/trust.bcfks \$bc"

cat > automq-tls/client.properties <<EOF
security.protocol=SSL
ssl.truststore.type=BCFKS
ssl.truststore.location=/tls/trust.bcfks
ssl.truststore.password=$PASS
EOF

Start a single node that acts as both broker and controller, with an SSL client listener and S3 over HTTPS. Setting cluster.id makes AutoMQ format its storage on first start:

S3='region=us-east-1&endpoint=https://minio:9000&pathStyle=true'
docker run -d --name automq --hostname automq --network automq -v "$PWD/automq-tls:/tls" \
  -e KAFKA_S3_ACCESS_KEY=minioadmin -e KAFKA_S3_SECRET_KEY=minioadmin \
  -e KAFKA_HEAP_OPTS="-Xms1g -Xmx1g -XX:MaxDirectMemorySize=1g" \
  -e KAFKA_OPTS="-Djavax.net.ssl.trustStore=/tls/trust.bcfks -Djavax.net.ssl.trustStoreType=BCFKS -Djavax.net.ssl.trustStorePassword=$PASS" \
  cgr.dev/ORGANIZATION/automq-fips: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 listeners=SSL://:9092,CONTROLLER://:9093 \
    --override advertised.listeners=SSL://automq:9092 \
    --override listener.security.protocol.map=CONTROLLER:PLAINTEXT,SSL:SSL \
    --override inter.broker.listener.name=SSL \
    --override ssl.keystore.type=BCFKS \
    --override ssl.keystore.location=/tls/broker.bcfks \
    --override ssl.keystore.password=$PASS \
    --override ssl.key.password=$PASS \
    --override ssl.truststore.type=BCFKS \
    --override ssl.truststore.location=/tls/trust.bcfks \
    --override ssl.truststore.password=$PASS \
    --override autobalancer.client.auth.security.protocol=SSL \
    --override autobalancer.client.auth.ssl.truststore.type=BCFKS \
    --override autobalancer.client.auth.ssl.truststore.location=/tls/trust.bcfks \
    --override autobalancer.client.auth.ssl.truststore.password=$PASS \
    --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 TLS connections:

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

Create a topic, then produce and consume a message over TLS:

bin=/opt/automq/kafka/bin
docker exec automq $bin/kafka-topics.sh --bootstrap-server automq:9092 \
  --command-config /tls/client.properties --create --topic demo
echo "hello automq" | docker exec -i automq $bin/kafka-console-producer.sh \
  --bootstrap-server automq:9092 --producer.config /tls/client.properties --topic demo
docker exec automq $bin/kafka-console-consumer.sh --bootstrap-server automq:9092 \
  --consumer.config /tls/client.properties --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 \
  --command-config /tls/client.properties --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. The Getting Started example does this with the autobalancer.client.auth.* overrides.

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.