barisgece/cmak-docker repository overview

⁠kafka-manager-docker (CMAK)

You are invited to contribute new features, fixes, or updates⁠, large or small; I am always thrilled to receive pull requests, and do my best to process them as fast as I can.

⁠Tags

Kafka Manager images come in two flavors:

• stable: Build from latest Kafka Manager repository release.
• latest: Periodically assembled master builds. Better not to use in production.

⁠How to use this image

CMAK⁠ uses Zookeeper only as storage for own settings. I.e. Zookeeper only plays role of a local database. CMAK is unable to detect Kafka cluster from provided Zookeper, Kafka cluster settings must be provided explicitely.

It's recommended to always run dedicated Zookeeper instance to be used by CMAK.

Use docker-compose with following content:

version: '3.6'
services:
  zk:
    image: zookeeper:latest
    restart: always
    environment:
      ZOO_SERVERS: server.1=0.0.0.0:2888:3888;2181
  cmak:
    image: hlebalbau/kafka-manager:stable
    restart: always
    ports:
      - "9000:9000"
    environment:
      ZK_HOSTS: "zk:2181"

To quickly launch the file above, execute

$ curl -sL https://raw.githubusercontent.com/hleb-albau/kafka-manager-docker/master/examples/docker-compose-sample.yaml | \
    docker-compose -f - up

⁠Configuration

⁠CMAK application configuration

CMAK reads its configuration from file /cmak/conf/application.conf⁠. Every parameter could be overriden via JVM system property, i.e. -DmyProp=myVal. Properties are passed to CMAK container via docker arguments⁠.

For example, to enable basic authentication and configure zookeeper hosts using docker-compose:

version: '3.6'
services:
  zk:
    image: zookeeper:latest
    restart: always
    environment:
      ZOO_SERVERS: server.1=0.0.0.0:2888:3888;2181
  cmak:
    image: hlebalbau/kafka-manager:stable
    restart: always
    command:
      - "-Dcmak.zkhosts=zk:2181"
      - "-DbasicAuthentication.enabled=true"
      - "-DbasicAuthentication.username=username"
      - "-DbasicAuthentication.password=password"
    ports:
      - "9000:9000"

To quickly launch the file above, execute

$ curl -sL https://raw.githubusercontent.com/hleb-albau/kafka-manager-docker/master/examples/docker-compose-override.yaml | \
    docker-compose -f - up

⁠Kafka clusters configuration

CMAK doesn't provide tools to preconfigure managed Kafka clusters from files. It could be done either via HTTP API or via CMAK UI in browser. This could be inconvenient for declarative configuration or GitOps flow.

To overcome the issue there exist standalone cmak2zk tool. The information and usage examples could be found at cmak2zk homepage⁠.

⁠Usage in Kubernetes

It is possible to use dedicated CMAK operator for installing and configuring CMAK in Kubernetes. That operator uses this docker image as one of its component.

Installation instructions available at CMAK operator homepage⁠.

⁠Issues

If you have any problems with or questions about this image, please contact us through a GitHub issue⁠.