Chainguard Container for clickhouse-keeper-fips

ClickHouse Keeper is a distributed coordination service that provides a ZooKeeper-compatible API for managing ClickHouse clusters. It handles distributed consensus, configuration management, and leader election using the Raft algorithm.

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/clickhouse-keeper-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 ClickHouse Keeper FIPS container image is comparable to the official ClickHouse Keeper image, built with FIPS-validated cryptographic modules. Like most other Chainguard container images, the ClickHouse Keeper image contains only the dependencies it needs to function, and doesn't include things like a shell or package manager.

ClickHouse Keeper provides a ZooKeeper-compatible API and uses the Raft consensus algorithm for distributed coordination. It's designed as a modern replacement for ZooKeeper in ClickHouse clusters.

Important: ClickHouse Keeper is bundled into the main ClickHouse server binary. When deploying with ClickStack (the recommended upstream Helm chart), ClickHouse Keeper is deployed using the bundled binary from the main ClickHouse image, so this separate ClickHouse Keeper FIPS image is not needed.

This separate ClickHouse Keeper FIPS image is only needed if you are using the Altinity ClickHouse Helm chart, which deploys ClickHouse Keeper as a separate component with its own dedicated image.

Getting Started

Docker Usage

ClickHouse Keeper is typically deployed as a cluster of 3 or more nodes for high availability. For testing purposes, you can run a single node:

docker run -d --rm --name clickhouse-keeper \
  -p 9181:9181 \
  cgr.dev/ORGANIZATION/clickhouse-keeper-fips:latest

The default ports for ClickHouse Keeper are:

• 9181: Client connections (ZooKeeper-compatible API)
• 9444: Raft protocol communication between keeper nodes

Kubernetes Deployment

Deploy using the Altinity ClickHouse Helm chart:

helm repo add clickhouse https://helm.altinity.com
helm repo update

Create a values.yaml file to use the Chainguard ClickHouse Keeper FIPS image:

keeper:
  enabled: true
  replicaCount: 3
  image:
    repository: cgr.dev/ORGANIZATION/clickhouse-keeper-fips
    tag: latest

Deploy the ClickHouse cluster with Keeper:

helm install clickhouse clickhouse/clickhouse -f values.yaml

For more details on ClickHouse Keeper configuration with the Altinity Helm chart, see the chart documentation.

Verifying ClickHouse Keeper

You can verify the Keeper cluster is functioning by using the clickhouse-keeper-client tool:

kubectl exec -it <keeper-pod-name> -- \
  clickhouse-keeper-client --host 127.0.0.1 --port 9181 \
  --query "ls /"

To test data replication across the cluster:

# Write data on one node
kubectl exec -it <keeper-pod-0> -- \
  clickhouse-keeper-client --host 127.0.0.1 --port 9181 \
  --query "create /test-data 'test-value'"

# Read data from another node
kubectl exec -it <keeper-pod-1> -- \
  clickhouse-keeper-client --host 127.0.0.1 --port 9181 \
  --query "get /test-data"

When using the clickhouse-keeper-client tool with this image, note that the history file feature requires a writable directory. Use the --history-file flag to specify a location or disable it:

clickhouse-keeper-client --history-file=/dev/null --host 127.0.0.1 --port 2181 --query "ls /"

FIPS Support

This image is built with FIPS 140-3 compliant cryptographic modules and follows FIPS compliance requirements. The image includes:

• OpenSSL configured in FIPS mode
• ClickHouse Keeper built with FIPS-compliant cryptographic libraries
• Removal of non-FIPS compliant ciphers and algorithms

Documentation and Resources

• ClickHouse Keeper Official Documentation
• Altinity ClickHouse Operator Documentation
• ClickHouse Keeper Configuration Reference
• Disaster Recovery Guide

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.