canal/canal-admin

canal-webui Docker镜像文档

一、镜像概述和主要用途

canal-webui 是基于 canal/osadmin:v1 基础镜像构建的 Docker 镜像，提供 canal 服务的 Web 管理界面（WebUI）功能。该镜像集成了 canal-admin 组件，通过可视化界面实现对 canal 服务的配置管理、实例监控、日志查看等操作，简化 canal 数据同步服务的运维流程。

二、核心功能和特性

核心功能

• 提供 canal 服务的 Web 可视化管理界面，支持 canal server 和 instance 的配置与管理
• 监控 canal 服务运行状态，包括服务健康度、数据同步进度等关键指标
• 支持 canal 实例的创建、启动、停止、重启等生命周期管理
• 提供日志查看功能，便于问题排查和运维调试

镜像特性

• 基于 canal/osadmin:v1 稳定基础镜像，确保运行环境兼容性
• 内置 canal-admin 组件，开箱即用，无需额外配置
• 暴露 8089 端口用于 Web 界面访问，默认启动脚本自动化初始化服务
• 目录权限规范化，确保服务以非 root 用户（admin）安全运行

三、使用场景和适用范围

适用场景

• 基于 canal 实现 MySQL 数据同步场景中，需要通过 Web 界面便捷管理 canal 服务的场景
• 多 canal server 或多 instance 环境下的集中化配置与监控需求
• 开发或测试环境中快速部署 canal 管理界面，简化手动配置流程

适用人群

• 数据同步工程师、数据库管理员（DBA）
• 负责 canal 服务运维的开发或运维人员
• 需要可视化管理 canal 实例的技术团队

四、详细使用方法和配置说明

前提条件

• 已安装 Docker 环境（推荐 Docker 19.03+）
• 若需持久化配置或日志，需准备本地目录用于挂载

获取镜像

由于官方未提供明确镜像名称，实际使用时需根据镜像仓库地址拉取，示例命令（假设镜像名为 canal/canal-webui）：

bash
docker pull canal/canal-webui:latest

快速启动（docker run 命令）

通过以下命令快速启动容器，映射 Web 端口并运行服务：

bash
docker run -d \
  --name canal-webui \
  -p 8089:8089 \
  --restart=always \
  canal/canal-webui:latest

参数说明

• -d：后台运行容器
• --name canal-webui：指定容器名称为 canal-webui
• -p 8089:8089：将容器内 8089 端口映射到宿主机 8089 端口，用于 Web 界面访问
• --restart=always：容器退出时自动重启，确保服务持续可用

docker-compose 部署示例

创建 docker-compose.yml 文件，配置如下：

yaml
version: '3'
services:
  canal-webui:
    image: canal/canal-webui:latest
    container_name: canal-webui
    ports:
      - "8089:8089"  # Web 界面访问端口
    volumes:
      - ./canal-admin-conf:/home/admin/canal-admin/conf  # 挂载本地配置文件（可选）
      - ./canal-admin-logs:/home/admin/canal-admin/logs  # 挂载日志目录（可选）
    restart: always
    user: admin  # 以 admin 用户运行，与镜像内部权限匹配

启动命令：

bash
docker-compose up -d

配置说明

端口映射

• 容器默认暴露 8089 端口，用于 Web 界面访问，需通过 -p 宿主机端口:8089 映射到宿主机，例如 -p 8080:8089 可通过 http://宿主机IP:8080 访问。

目录挂载

为实现配置持久化或日志持久化，可挂载以下关键目录：

• 配置文件目录：/home/admin/canal-admin/conf
  用于自定义 canal-admin 配置（如数据库连接、服务端口等），默认配置文件包括 application.yml、canal_manager.sql 等。挂载后，容器启动时会优先使用本地配置。

• 日志目录：/home/admin/canal-admin/logs
  用于持久化 canal-admin 运行日志，便于问题排查。挂载示例：

  bash
  docker run -d \
    --name canal-webui \
    -p 8089:8089 \
    -v /local/path/to/conf:/home/admin/canal-admin/conf \
    -v /local/path/to/logs:/home/admin/canal-admin/logs \
    canal/canal-webui:latest
  

服务访问

容器启动后，通过浏览器访问 http://宿主机IP:8089 即可打开 canal WebUI。默认登录凭据需参考 canal-admin 官方文档（通常初始用户名为 admin，密码为 123456，首次登录需修改密码）。

五、注意事项

• 镜像运行依赖 canal 服务后端（如 canal server、数据库），需确保 WebUI 可正常连接后端服务（配置文件中需正确设置数据库地址、canal server 地址等）
• 生产环境建议通过目录挂载持久化配置和日志，避免容器重建导致配置丢失
• 若需修改服务启动参数，可通过自定义启动脚本覆盖默认 app.sh（需挂载脚本至 /home/admin/app.sh 并赋予执行权限）
• 镜像基于 CentOS 系统构建（通过 yum clean all 推测），若需调整系统依赖，可通过 Dockerfile 二次构建