pmsipilot/docker-compose-viz

docker-compose-viz

镜像概述

docker-compose-viz 是一个用于可视化Docker Compose配置文件的工具，能够将docker-compose.yml中的服务、链接、卷、依赖、端口和网络等关系以图形方式展示，帮助用户直观理解容器架构和组件间交互。

核心功能与特性

• 多输出格式：支持dot（图形描述语言）、image（图片文件）和display（直接显示）三种输出格式
• 关系可视化：清晰展示服务间的链接、卷挂载、依赖关系、端口映射、网络归属和扩展服务等
• 灵活筛选：可指定仅显示特定服务的关系图
• 自定义输出：支持指定输出文件路径，强制覆盖已有文件，以及水平布局展示
• 无侵入性：通过Docker容器运行，无需在主机安装额外依赖

使用场景

• Docker Compose配置文件的结构分析与文档生成
• 向团队成员或 stakeholders 展示容器架构
• 排查服务间依赖关系和网络连接问题
• 教学或培训中演示容器化应用架构

使用方法

基础运行命令

bash
docker run --rm -it --name dcv -v $(pwd):/input pmsipilot/docker-compose-viz

命令参数说明

render [options] [--] [<input-file>]

参数详解

图表元素解读

链接（links）

• 表示：实线箭头，指向声明链接的服务
• 含义：箭头起点服务在箭头终点服务中被引用
• 示例：mysql -> ambassador 表示 "mysql在ambassador中被识别为mysql"
• 外部链接：使用相同形状但显示为灰色

卷（volumes）

• volumes_from：虚线箭头，指向使用卷的服务，如"api使用logs的卷"
• volumes（主机目录挂载）：文件夹图标，通过虚线箭头连接到服务
  • 双向箭头：目录可从容器写入（读写权限）
  • 单向箭头：目录仅可读（只读权限）

依赖（depends_on）

• 表示：点线箭头，指向声明依赖的服务
• 含义：箭头起点服务依赖箭头终点服务
• 示例：mysql -> logs 表示 "mysql依赖logs"

端口（ports）

• 表示：圆形图标，通过实线箭头指向声明端口的服务
• 含义：主机端口流量路由到容器端口
• 示例：2480 -> orientdb 表示 "主机端口2480路由到orientdb的2480端口"

网络（networks）

• 表示：五边形图标，通过实线箭头指向网络
• 含义：服务加入指定网络并在网络中使用特定别名
• 外部网络：显示为灰色五边形

扩展服务（extends）

• 表示：组件形状，通过反向箭头连接到被扩展服务
• 含义：箭头起点服务扩展箭头终点服务
• 示例：mysql -> db 表示 "mysql扩展服务db"

使用示例

生成dot格式文件

bash
docker run --rm -v $(pwd):/input pmsipilot/docker-compose-viz render -m dot -o docker-compose.graph.dot

生成PNG图片

bash
docker run --rm -v $(pwd):/input pmsipilot/docker-compose-viz render -m image -o architecture.png

仅显示特定服务

bash
docker run --rm -v $(pwd):/input pmsipilot/docker-compose-viz render --only api --only mysql

水平布局显示

bash
docker run --rm -it -v $(pwd):/input pmsipilot/docker-compose-viz render -r

许可证

MIT许可证 (MIT) Copyright (c) 2016 PMSIpilot