tealtools/dekaf

Dekaf Docker镜像文档

概述

Dekaf 是 Apache Pulsar 的可视化管理界面（UI）工具，旨在简化 Pulsar 集群的日常运维、监控与管理操作。通过直观的图形界面，用户可便捷地查看集群状态、管理主题（Topics）、监控消息流、配置租户与命名空间等，降低 Pulsar 集群的使用门槛。

核心功能和特性

• 集群监控：实时展示 Pulsar 集群节点状态、 broker 健康度、资源使用率（CPU、内存、网络）等关键指标。
• 主题管理：支持主题的创建、删除、配置修改（如分区数、保留策略、TTL 等），并可查看主题元数据与统计信息。
• 消息流可视化：实时查看主题的消息生产/消费速率、积压量、消费者组（Consumer Groups）状态及消息内容详情。
• 租户与命名空间管理：支持租户（Tenants）、命名空间（Namespaces）的创建、权限配置及元数据管理。
• 多环境适配：兼容 Pulsar 单机模式、集群模式及云原生部署环境，支持 TLS 加密与多种认证方式（如 Token、OAuth2、Kerberos）。
• 轻量部署：基于 Docker 容器化封装，部署流程简单，配置灵活，可快速集成到现有 Pulsar 环境。

使用场景和适用范围

• Pulsar 运维人员：日常集群监控、问题排查、资源调整与配置管理。
• 开发人员：调试消息生产/消费逻辑、验证主题配置有效性、查看消息流转细节。
• 测试环境：快速搭建 Pulsar 可视化管理界面，简化测试流程。
• 中小规模集群：作为轻量级管理工具，替代命令行操作，提升效率。

使用方法和配置说明

前置条件

• 已安装 Docker 或 Docker Compose。
• 可访问目标 Pulsar 集群的 broker 服务端口（默认 6650，用于消息通信）和 Web 服务端口（默认 8080，用于管理 API 通信）。

镜像拉取

从 Docker 镜像仓库拉取最新版 Dekaf 镜像：

bash
docker pull dekaf/dekaf:latest

基本运行命令（docker run）

通过 docker run 快速启动 Dekaf 容器，需指定 Pulsar 集群的服务地址：

bash
docker run -d \
  --name dekaf \
  -p 8088:8080 \  # Dekaf 服务端口（默认 8080，可自定义映射）
  -e PULSAR_SERVICE_URL=pulsar://pulsar-broker:6650 \  # Pulsar broker 服务地址（用于消息通信）
  -e PULSAR_WEB_SERVICE_URL=http://pulsar-broker:8080 \  # Pulsar Web 服务地址（用于管理 API）
  dekaf/dekaf:latest

启动后，通过 http://<宿主机IP>:8088 访问 Dekaf 界面。

Docker Compose 部署示例

以下是集成 Pulsar 单机版与 Dekaf 的 docker-compose.yml 配置示例：

yaml
version: '3.8'

services:
  pulsar-standalone:
    image: apachepulsar/pulsar:latest
    command: bin/pulsar standalone
    ports:
      - "6650:6650"  # Pulsar broker 端口
      - "8080:8080"  # Pulsar Web 服务端口
    volumes:
      - pulsar-data:/pulsar/data
    networks:
      - pulsar-network

  dekaf:
    image: dekaf/dekaf:latest
    depends_on:
      - pulsar-standalone
    ports:
      - "8088:8080"  # Dekaf 访问端口
    environment:
      - PULSAR_SERVICE_URL=pulsar://pulsar-standalone:6650  # 连接 Pulsar broker
      - PULSAR_WEB_SERVICE_URL=http://pulsar-standalone:8080  # 连接 Pulsar Web 服务
      - LOG_LEVEL=info  # 日志级别（可选：debug/info/warn/error）
    networks:
      - pulsar-network

networks:
  pulsar-network:
    driver: bridge

volumes:
  pulsar-data:

启动命令：

bash
docker-compose up -d

配置参数说明

环境变量配置

Dekaf 支持通过环境变量自定义配置，核心参数如下：

自定义配置文件（可选）

如需更复杂的配置（如自定义 TLS 证书、高级认证参数），可通过挂载配置文件实现。默认配置文件路径为 /app/config/application.yml，挂载示例：

bash
docker run -d \
  --name dekaf \
  -p 8088:8080 \
  -v /host/path/to/application.yml:/app/config/application.yml \  # 挂载自定义配置文件
  dekaf/dekaf:latest

部署验证

容器启动后，通过以下步骤验证部署：

1. 访问 http://<宿主机IP>:<映射端口>（如 http://localhost:8088），打开 Dekaf 登录界面。
2. 若未配置认证（PULSAR_AUTH_TYPE=none），直接点击“连接”进入主界面。
3. 在左侧导航栏选择“集群”，确认 Pulsar 集群状态为“已连接”，即可开始使用各项功能。

注意事项

• 版本兼容性：Dekaf 版本需与 Pulsar 集群版本匹配（具体兼容矩阵参考 Dekaf 官方文档）。
• 网络连通性：确保 Dekaf 容器可访问 Pulsar broker 和 Web 服务的端口（如 6650、8080），容器网络模式建议使用 bridge 或与 Pulsar 集群同一网络。
• 认证安全：生产环境中建议启用 TLS 加密与认证（如 Token），避免使用明文传输敏感信息。