leonpatmore/kafka-cli

Kafka CLI Docker 镜像文档

镜像概述

Kafka CLI Docker镜像为用户提供了一个预打包的环境，包含完整的Kafka命令行工具（CLI脚本），旨在简化Kafka集群的管理、测试和操作流程。通过该镜像，用户无需在本地系统安装Kafka即可直接使用其命令行工具，适合容器化环境下的Kafka相关操作。

核心功能与特性

• 内置完整Kafka CLI工具：包含Kafka官方提供的所有命令行脚本，如kafka-topics.sh（主题管理）、kafka-console-producer.sh（消息生产）、kafka-console-consumer.sh（消息消费）、kafka-consumer-groups.sh（消费组管理）等。
• 轻量级设计：基于简洁的基础镜像构建，体积小巧，启动快速。
• 环境无关性：无需本地配置Kafka依赖，通过容器化方式即可运行，避免环境冲突。
• 易于集成：可无缝集成到Docker Compose、Kubernetes等容器编排工具中，支持CI/CD流程。

使用场景与适用范围

• 开发环境：开发人员快速执行Kafka命令，验证主题配置、消息生产消费等功能。
• 测试环境：自动化测试中通过命令行工具操作Kafka集群，验证集群行为。
• 临时管理：对Kafka集群进行临时操作，如创建/删除主题、查看消费组状态、调整分区数量等。
• CI/CD流程：在持续集成/部署过程中集成Kafka命令，实现环境初始化或数据准备。

镜像信息

• 镜像名称：leonpatmore/kafka-cli:latest

使用方法

基本使用

通过docker run命令直接执行Kafka CLI脚本，格式如下：

bash
docker run --rm leonpatmore/kafka-cli:latest <kafka-script> [options]

参数说明

• --rm：容器退出后自动删除，避免残留容器文件。
• <kafka-script>：需执行的Kafka CLI脚本名称（如kafka-topics.sh）。
• [options]：对应Kafka脚本的参数（如--bootstrap-server指定Kafka集群地址）。

示例

1. 列出Kafka集群中的所有主题

bash
docker run --rm leonpatmore/kafka-cli:latest kafka-topics.sh \
  --list \
  --bootstrap-server kafka-broker:9092

2. 创建一个新主题

bash
docker run --rm leonpatmore/kafka-cli:latest kafka-topics.sh \
  --create \
  --topic test-topic \
  --bootstrap-server kafka-broker:9092 \
  --partitions 3 \
  --replication-factor 2

3. 从主题消费消息

bash
docker run --rm leonpatmore/kafka-cli:latest kafka-console-consumer.sh \
  --topic test-topic \
  --bootstrap-server kafka-broker:9092 \
  --from-beginning

4. 向主题生产消息（交互式）

bash
docker run -it --rm leonpatmore/kafka-cli:latest kafka-console-producer.sh \
  --topic test-topic \
  --bootstrap-server kafka-broker:9092

与Docker Compose集成

在docker-compose.yml中定义服务，方便与Kafka集群联动：

yaml
version: '3'
services:
  kafka-cli:
    image: leonpatmore/kafka-cli:latest
    depends_on:
      - kafka
    command: kafka-topics.sh --list --bootstrap-server kafka:9092

  kafka:
    image: confluentinc/cp-kafka:latest
    environment:
      KAFKA_ADVERTISED_LISTENERS: PLAINTEXT://kafka:9092
      KAFKA_OFFSETS_TOPIC_REPLICATION_FACTOR: 1
    depends_on:
      - zookeeper

  zookeeper:
    image: confluentinc/cp-zookeeper:latest
    environment:
      ZOOKEEPER_CLIENT_PORT: 2181

执行docker-compose up kafka-cli即可列出Kafka集群中的主题。

注意事项

• 确保容器能够网络访问Kafka集群（通过--network参数指定网络或使用Docker Compose的默认网络）。
• 对于需要持久化配置的场景，可通过-v参数挂载本地配置文件到容器内的Kafka配置目录（如/etc/kafka）。
• 根据实际Kafka版本需求，可通过指定镜像标签（如非latest版本）确保CLI工具与集群版本兼容。