mohsenasm/swarm-dashboard

Swarm Dashboard

Docker Swarm模式的简单监控仪表盘。

https://github.com/mohsenasm/swarm-dashboard/actions/workflows/main.yml/badge.svg](https://github.com/mohsenasm/swarm-dashboard/actions/workflows/main.yml)

Swarm Dashboard以服务和节点为单位展示Docker Swarm上所有运行中的任务，提供空间高效的可视化界面，适合快速概览Swarm状态。它还显示Swarm节点和容器的CPU/内存/磁盘使用情况。

使用场景

适用于需要实时监控Docker Swarm集群状态的场景，包括服务部署情况、节点资源使用、容器运行状态等，帮助管理员快速了解集群健康状况。

使用方法

仪表盘需要部署在某个Swarm管理器节点上。可通过以下Docker Compose文件进行配置：

yml
# compose.yml
version: "3"

services:
  swarm-dashboard:
    image: mohsenasm/swarm-dashboard:latest
    volumes:
      - /var/run/docker.sock:/var/run/docker.sock  # 挂载Docker套接字以访问Docker API
    ports:
      - 8080:8080  # 仪表盘Web端口
    environment:
      TZ: "your_timezone"  # 设置时区，如Asia/Shanghai
      ENABLE_AUTHENTICATION: "false"  # 是否启用基本认证
      ENABLE_HTTPS: "false"  # 是否启用HTTPS
      NODE_EXPORTER_SERVICE_NAME_REGEX: "node-exporter"  # node-exporter服务名称正则表达式
      CADVISOR_SERVICE_NAME_REGEX: "cadvisor"  # cadvisor服务名称正则表达式
    deploy:
      placement:
        constraints:
          - node.role == manager  # 约束仅部署在管理器节点
  
  node-exporter:  # 可选，用于收集节点资源使用数据
    image: quay.io/prometheus/node-exporter:v1.6.1
    volumes:
      - '/:/host:ro'  # 只读挂载主机根文件系统
    command:
      - '--path.rootfs=/host'  # 指定根文件系统路径
    deploy:
      mode: global  # 全局部署，每个节点运行一个实例

  cadvisor:  # 可选，用于收集容器资源使用数据
    image: gcr.io/cadvisor/cadvisor:v0.47.2
    volumes:
      - /:/rootfs:ro
      - /var/run:/var/run:rw
      - /sys:/sys:ro
      - /var/lib/docker/:/var/lib/docker:ro
      - /dev/disk/:/dev/disk:ro
    deploy:
      mode: global  # 全局部署，每个节点运行一个实例

部署命令：

bash
$ docker stack deploy -c compose.yml sd

注意：node-exporter和cadvisor为可选组件，分别用于获取节点CPU/内存/磁盘使用情况和容器CPU/内存使用情况。若未指定NODE_EXPORTER_SERVICE_NAME_REGEX和CADVISOR_SERVICE_NAME_REGEX环境变量，默认不启用这些功能（为保持向后兼容性）。

高级用法

以下环境变量可用于更多自定义配置：

安全

• 已对发送到客户端的Docker事件数据进行脱敏处理。早期版本会发送完整Docker事件数据（包括环境变量，可能误存密码），建议使用新版本以提升安全性。

• 可通过ENABLE_AUTHENTICATION环境变量启用基本认证。WebSocket服务器会拒绝未提供有效认证令牌的连接。

• 可通过ENABLE_HTTPS环境变量启用HTTPS和WSS，支持Let's Encrypt集成（基于DNS挑战）。

生产环境使用注意事项

对于正式部署，需考虑以下两点：

1. 安全性：仪表盘的Node.js服务器直接访问Docker守护进程套接字（docker.sock），且运行在管理器节点上。若服务器被入侵，***者将获得整个Swarm的控制权，需严格限制访问。

2. 性能：当前与Docker API的交互实现较为简单，每1000毫秒轮询一次API，若数据变化则推送到所有WebSocket连接。未来可能会优化为更高效的变更监听机制。

开发路线图

• 显示更多服务详情（发布端口、镜像名称及版本）
• 节点/服务/任务详情面板

欢迎提交功能请求和拉取请求。本地构建/测试代码可参考test-cluster目录下的commands.md。

参考项目

• 主要灵感来源于https://github.com/dockersamples/docker-swarm-visualizer

贡献者

• Mohammad-Mohsen Aseman-Manzar（当前维护者）- 代码、文档
• Viktor Charypar（原仓库所有者）- 代码、文档
• Clementine Brown - 设计