datastax/pulsar-admin-console

DataStax Apache Pulsar 管理控制台

1. 镜像概述和主要用途

DataStax Apache Pulsar 管理控制台（简称"Pulsar 管理控制台"）是一个基于Web的UI工具，用于管理Apache Pulsar的主题、命名空间、源、 sink及其他各种特性。该控制台采用VueJS开发，运行于浏览器中，并包含一个Web服务器，用于提供控制台文件服务、配置管理及认证服务。其核心功能是作为Pulsar集群的可视化管理界面，简化Pulsar资源的配置与监控操作。

2. 核心功能和特性

• 全面的Pulsar资源管理：支持主题、命名空间、源、sink等Pulsar核心组件的可视化管理
• 代理请求机制：内置服务器可将控制台请求代理至Pulsar broker或Pulsar proxy
• 多认证模式支持：提供none、user、k8s和openidconnect四种认证模式
• 灵活配置体系：支持默认配置与本地覆盖配置文件结合的方式
• TLS安全支持：可配置TLS加密通信，支持自签名证书
• 集群适配性：支持连接单节点或集群环境的Pulsar服务
• 可定制化界面：支持自定义通知文本、功能模块启用/禁用等

3. 使用场景和适用范围

• Pulsar集群日常管理：适用于开发、测试及生产环境中Pulsar资源的创建、配置与监控
• Pulsar运维可视化：为运维人员提供直观的集群状态查看与问题诊断工具
• 开发调试辅助：帮助开发人员快速配置Pulsar主题、测试消息生产消费
• 多环境适配：支持单机Pulsar环境、Kubernetes部署的Pulsar集群及多区域部署的Pulsar集群
• 权限管控场景：通过多种认证模式满足不同安全级别需求的企业环境

4. 安装与部署

4.1 传统安装（基于Node.js）

前置条件

• Node.js 16.15或更高版本

安装步骤

1. 从https://github.com/datastax/pulsar-admin-console/releases下载最新版本的tarball包
2. 解压tarball包：

   bash
   tar xfvz pulsar-admin-console-<version>.tar.gz
   

3. 更新配置（详见"配置说明"章节）

4.2 Docker部署

Docker Run 示例

bash
docker run -d \
  --name pulsar-admin-console \
  -p 6454:6454 \
  -v $(pwd)/config:/app/config \
  -e NODE_ENV=production \
  -e NODE_EXTRA_CA_CERTS=/app/config/ca.crt \
  docker.xuanyuan.run/datastax/pulsar-admin-console:<version>

Docker Compose 示例

yaml
version: '3.8'
services:
  pulsar-admin-console:
    image: docker.xuanyuan.run/datastax/pulsar-admin-console:<version>
    container_name: pulsar-admin-console
    restart: always
    ports:
      - "6454:6454"
    volumes:
      - ./config:/app/config
    environment:
      - NODE_ENV=production
      - NODE_EXTRA_CA_CERTS=/app/config/ca.crt
    networks:
      - pulsar-network

networks:
  pulsar-network:
    driver: bridge

5. 配置说明

5.1 配置文件结构

控制台配置文件位于./config目录，主配置文件为default.json。可通过添加local.json等文件覆盖默认配置（配置文件加载优先级遵循https://github.com/node-config/node-config/wiki/Configuration-Files）。配置包含控制台通用参数及`server_config`下的服务器特定配置。

5.2 核心配置参数

5.3 环境变量

6. 启动与访问

6.1 传统方式启动

1. 进入安装目录的server子目录：

   bash
   cd ./pulsar-admin-console-<version>/server
   

2. 启动服务：

   bash
   npm start
   

3. 在浏览器中访问（默认端口6454）：

   bash
   http://localhost:6454
   

6.2 Docker方式启动

1. 使用docker run启动（见4.2节）或docker-compose启动：

   bash
   docker-compose up -d
   

2. 在浏览器中访问：

   bash
   http://<宿主机IP>:6454
   

7. 认证模式详解

7.1 none模式

• 特点：无登录界面，控制台不执行认证
• 适用场景：开发环境或已禁用Pulsar认证的集群
• 配置要求：确保Pulsar集群已禁用认证，无需额外配置

7.2 user模式

• 特点：控制台通过用户名/密码登录，使用令牌访问Pulsar
• 配置步骤：
  1. 在配置文件中设置：

     json
     {
       "auth_mode": "user",
       "server_config": {
         "user_auth": {
           "username": "admin",
           "password": "secure_password"
         },
         "admin_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."  // 或配置token_path指向令牌文件
       }
     }
     

  2. 确保Pulsar令牌具有足够权限（建议使用超级用户令牌）

7.3 k8s模式

• 特点：从Kubernetes密钥中获取用户凭证，使用令牌访问Pulsar
• 配置步骤：
  1. 在Kubernetes中创建前缀为dashboard-user-的密钥（如dashboard-user-admin），包含password字段
  2. 配置文件设置：

     json
     {
       "auth_mode": "k8s",
       "server_config": {
         "kubernetes": {
           "k8s_namespace": "pulsar"
         },
         "admin_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."  // 或配置token_path
       }
     }
     

  3. 确保控制台服务器具有Kubernetes API访问权限（如运行在集群内Pod中）

7.4 openidconnect模式

• 特点：通过OpenID Connect兼容的身份提供商认证（如Keycloak、Okta）
• 配置步骤：
  1. 配置身份提供商（如Keycloak），创建客户端并映射sub声明
  2. 配置文件设置：

     json
     {
       "auth_mode": "openidconnect",
       "oauth_client_id": "pulsar-admin-console",
       "server_config": {
         "oauth2": {
           "identity_provider_url": "https://keycloak:8443",
           "token_endpoint": "/realms/pulsar/protocol/openid-connect/token",
           "grant_type": "password"
         }
       }
     }
     

  3. 配置反向代理（如Nginx）路由认证请求至身份提供商

8. 开发环境设置（可选）

8.1 Node.js版本要求

• Node.js: v14.18.3
• npm: 6.14.15

8.2 环境配置

使用nvm管理Node.js版本：

bash
# 安装nvm（如未安装）
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.3/install.sh | bash

# 加载nvm并安装指定版本
nvm use
nvm install