gtramontina/diagrams

diagrams Docker镜像文档

镜像概述

本Docker镜像为https://github.com/mingrammer/diagrams%E5%B7%A5%E5%85%B7%E6%8F%90%E4%BE%9B%E5%AE%B9%E5%99%A8%E5%8C%96%E8%BF%90%E8%A1%8C%E7%8E%AF%E5%A2%83%E3%80%82%60diagrams%60%E6%98%AF%E4%B8%80%E4%B8%AA%E5%9F%BA%E4%BA%8EPython%E7%9A%84%E5%BC%80%E6%BA%90%E5%BA%93%EF%BC%8C%E7%94%A8%E4%BA%8E%E9%80%9A%E8%BF%87%E4%BB%A3%E7%A0%81%E7%BB%98%E5%88%B6%E4%BA%91%E7%B3%BB%E7%BB%9F%E6%9E%B6%E6%9E%84%E5%9B%BE%EF%BC%8C%E6%94%AF%E6%8C%81AWS%E3%80%81Azure%E3%80%81GCP%E7%AD%89%E4%B8%BB%E6%B5%81%E4%BA%91%E6%9C%8D%E5%8A%A1%E6%8F%90%E4%BE%9B%E5%95%86%E7%9A%84%E5%9B%BE%E6%A0%87%EF%BC%8C%E4%BB%A5%E5%8F%8AKubernetes%E3%80%81Docker%E7%AD%89%E6%8A%80%E6%9C%AF%E7%BB%84%E4%BB%B6%E3%80%82%E8%AF%A5%E9%95%9C%E5%83%8F%E5%B0%81%E8%A3%85%E4%BA%86%60diagrams%60%E5%8F%8A%E5%85%B6%E6%89%80%E6%9C%89%E4%BE%9D%E8%B5%96%EF%BC%88%E5%A6%82Python%E3%80%81Graphviz%E7%AD%89%EF%BC%89%EF%BC%8C%E7%94%A8%E6%88%B7%E5%8F%AF%E7%9B%B4%E6%8E%A5%E5%9C%A8%E5%AE%B9%E5%99%A8%E4%B8%AD%E6%89%A7%E8%A1%8C%E6%9E%B6%E6%9E%84%E5%9B%BE%E7%94%9F%E6%88%90%E8%84%9A%E6%9C%AC%EF%BC%8C%E6%97%A0%E9%9C%80%E5%9C%A8%E6%9C%AC%E5%9C%B0%E9%85%8D%E7%BD%AE%E5%A4%8D%E6%9D%82%E7%8E%AF%E5%A2%83%E3%80%82

核心功能与特性

• 免本地依赖：容器预装所有必要组件，无需在本地安装Python、diagrams库及Graphviz等依赖
• 容器化执行：通过命令行快速启动容器，直接处理架构图生成脚本，简化操作流程
• 指定输出目录：生成的PNG格式架构图自动保存至用户挂载的本地目录，便于后续查看和使用
• 轻量灵活：支持通过管道输入Python脚本，适配不同复杂度的架构图需求

使用场景

• 开发者快速绘图：无需配置本地环境，直接通过容器生成架构图，提升工作效率
• 架构师文档输出：在多环境中保持一致的工具版本，确保架构图样式和输出结果统一
• CI/CD流程集成：作为自动化文档生成环节，在构建流程中自动生成最新架构图并嵌入文档

使用方法与配置说明

前提条件

• 已安装Docker引擎
• 本地存在遵循diagrams语***范的架构图生成脚本（.py文件）

基本运行命令

通过以下命令在容器中执行脚本并生成架构图，输出文件将保存至本地out目录：

sh
cat <diagram-file>.py | docker run -i --rm -v $(pwd)/out:/out diagrams:<version>

命令参数说明

完整示例

1. 创建输出目录：
   在本地创建用于存放输出PNG的目录：

   sh
   mkdir -p out
   

2. 编写架构图脚本：
   创建example_architecture.py文件，内容示例（使用diagrams语法）：

   python
   from docker.xuanyuan.run/diagrams import Diagram
   from docker.xuanyuan.run/diagrams.aws.compute import EC2
   from docker.xuanyuan.run/diagrams.aws.database import RDS
   from docker.xuanyuan.run/diagrams.aws.network import ELB
   
   # 设置show=False避免容器内尝试打开图形界面
   with Diagram("AWS Web Service Architecture", show=False, direction="LR"):
       ELB("负载均衡器") >> EC2("Web服务器") >> RDS("数据库")
   

3. 执行容器命令生成架构图：
   通过管道传递脚本并运行容器：

   sh
   cat example_architecture.py | docker run -i --rm -v $(pwd)/out:/out diagrams:latest
   

4. 查看输出结果：
   生成的AWS Web Service Architecture.png文件将保存在本地out目录中。

注意事项

• 确保本地out目录存在且有写入权限，否则可能导致生成失败
• 脚本中必须设置show=False（如示例），避免容器内尝试打开图形界面导致错误
• 如需使用特定版本的diagrams库，可通过指定镜像标签（如diagrams:1.0.0）控制版本
• 复杂架构图可能需要较长生成时间，建议根据脚本复杂度适当调整执行超时设置

镜像信息

• 官方仓库：https://github.com/gtramontina/docker-diagrams
• 上游项目：https://github.com/mingrammer/diagrams