cruise-control

packaged by Chainguard

Chainguard Container for cruise-control

Minimal Cruise Control image for automated Apache Kafka workload rebalancing and self-healing via a REST API.

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/cruise-control:latest

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

Compatibility Notes

• The image runs as the non-root user 65532; mounted configuration must be readable by that user. Logs are written to /usr/share/java/cruise-control/logs (pre-created and writable).
• LinkedIn does not publish an official Cruise Control container image; the filesystem layout follows the upstream repository (/usr/share/java/cruise-control, with a compatibility symlink from /opt/cruise-control).
• The cruise-control-ui frontend is not included; this image serves the REST API only.

Getting Started

The cruise-control image runs Cruise Control, LinkedIn's automation service for Apache Kafka: it continuously monitors broker workload and exposes cluster rebalancing, anomaly detection, and self-healing operations through a REST API on port 9090.

Prerequisites

Cruise Control needs two things from the Kafka cluster it manages:

1. The Cruise Control metrics reporter on every broker's classpath. The jar ships in this image at /usr/share/java/cruise-control/cruise-control/build/dependant-libs/cruise-control-metrics-reporter.jar; copy it into the broker's libs/ directory and set metric.reporters=com.linkedin.kafka.cruisecontrol.metricsreporter.CruiseControlMetricsReporter in the broker config.
2. A reachable bootstrap server, configured via bootstrap.servers in cruisecontrol.properties.

Run the service

docker run -d -p 9090:9090 \
  -v $PWD/cruisecontrol.properties:/usr/share/java/cruise-control/config/cruisecontrol.properties \
  cgr.dev/ORGANIZATION/cruise-control:latest

The entrypoint runs kafka-cruise-control-start.sh config/cruisecontrol.properties from /usr/share/java/cruise-control; mount your configuration over the shipped config/ files (the defaults assume bootstrap.servers=localhost:9092 and replication factor 2). Check the state once it is up:

curl -s 'http://localhost:9090/kafkacruisecontrol/state?json=true'
curl -s 'http://localhost:9090/kafkacruisecontrol/kafka_cluster_state?json=true'

See the Cruise Control REST API documentation for the full endpoint reference (proposals, rebalance, add_broker, remove_broker, ...).

Documentation and Resources

• Cruise Control repository
• REST API documentation
• Configuration reference

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.