gtramontina/diagrams Docker 镜像 - 轩辕镜像 | Docker 镜像高效稳定拉取服务

diagrams Docker镜像文档

镜像概述

本Docker镜像为diagrams工具提供容器化运行环境。diagrams是一个基于Python的开源库，用于通过代码绘制云系统架构图，支持AWS、Azure、GCP等主流云服务提供商的图标，以及Kubernetes、Docker等技术组件。该镜像封装了diagrams及其所有依赖（如Python、Graphviz等），用户可直接在容器中执行架构图生成脚本，无需在本地配置复杂环境。

核心功能与特性

• 免本地依赖：容器预装所有必要组件，无需在本地安装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 diagrams import Diagram
   from diagrams.aws.compute import EC2
   from diagrams.aws.database import RDS
   from 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）控制版本
• 复杂架构图可能需要较长生成时间，建议根据脚本复杂度适当调整执行超时设置

镜像信息

• 官方仓库：[***]
• 上游项目：diagrams官方库