30分钟上手！用Diagrams代码绘制企业级CI/CD流水线架构图

你还在为绘制复杂的DevOps工具链架构图烦恼吗？用Visio拖拽图标效率低下，用PPT调整布局费时费力，团队协作时版本混乱难以维护？Diagrams（代码绘图工具）让这一切成为过去！只需几行Python代码，就能生成专业的CI/CD流水线架构图，轻松解决架构可视化难题。

读完本文，你将学会：

• 用Diagrams快速搭建CI/CD流水线架构图
• 集成主流CI/CD工具（Jenkins、GitLab CI、GitHub Actions等）
• 优化架构图展示效果的实用技巧
• 如何将架构图纳入版本控制，实现团队协作

什么是Diagrams？

Diagrams是一个基于Python的开源绘图工具，它允许你用代码定义云系统架构。不同于传统的可视化绘图工具，Diagrams通过编写代码来描述系统组件和它们之间的关系，然后自动生成高质量的架构图。

Diagrams支持多种云服务提供商和DevOps工具，包括AWS、Azure、GCP、Kubernetes等，以及CI/CD工具如Jenkins、GitLab CI、GitHub Actions等。这使得它成为绘制DevOps工具链架构图的理想选择。

官方文档：README.md

安装Diagrams

在开始之前，我们需要先安装Diagrams及其依赖。

前提条件

• Python 3.7或更高版本
• Graphviz（用于渲染图表）

安装步骤

1. 安装Graphviz

# Ubuntu/Debian
sudo apt-get install graphviz

# macOS (使用Homebrew)
brew install graphviz

# Windows (使用Chocolatey)
choco install graphviz

2. 安装Diagrams

# 使用pip
pip install diagrams

# 使用pipenv
pipenv install diagrams

# 使用poetry
poetry add diagrams

详细安装指南：docs/getting-started/installation.md

快速入门：绘制简单CI/CD流水线

让我们从一个简单的CI/CD流水线开始，它包含代码仓库、CI工具、CD工具和部署目标。

代码示例

from diagrams import Diagram, Cluster
from diagrams.onprem.vcs import Git
from diagrams.onprem.ci import Jenkins, GitlabCI, GithubActions
from diagrams.onprem.cd import Spinnaker, Tekton
from diagrams.k8s.compute import Pod

with Diagram("简单CI/CD流水线", show=False, direction="LR"):
    git = Git("代码仓库")
    
    with Cluster("CI工具"):
        ci_tools = [Jenkins("Jenkins"), 
                    GitlabCI("GitLab CI"),
                    GithubActions("GitHub Actions")]
    
    with Cluster("CD工具"):
        cd_tools = [Spinnaker("Spinnaker"),
                    Tekton("Tekton")]
    
    git >> ci_tools >> cd_tools >> Pod("K8s部署")

生成图表

运行上述代码：

python ci_cd_pipeline.py

这将生成一个名为简单CI/CD流水线.png的文件，包含我们定义的CI/CD流水线架构图。

企业级CI/CD流水线架构

接下来，让我们构建一个更复杂的企业级CI/CD流水线架构，包含代码质量检查、安全扫描、测试和多环境部署。

代码示例

from diagrams import Diagram, Cluster, Edge
from diagrams.onprem.vcs import Git, GitLab, GitHub
from diagrams.onprem.ci import Jenkins, GitlabCI, GithubActions
from diagrams.onprem.cd import Spinnaker, Tekton
from diagrams.onprem.codequality import SonarQube
from diagrams.onprem.security import OWASPZAP
from diagrams.onprem.testing import JUnit, Selenium
from diagrams.onprem.monitoring import Prometheus, Grafana
from diagrams.k8s.compute import Pod, Deployment
from diagrams.k8s.network import Ingress

with Diagram("企业级CI/CD流水线架构", show=False, direction="LR", 
             graph_attr={"fontsize": "12", "bgcolor": "white"}):
    
    with Cluster("代码仓库"):
        repos = [Git("Git"),
                 GitLab("GitLab"),
                 GitHub("GitHub")]
    
    with Cluster("CI工具"):
        ci_tools = [Jenkins("Jenkins"),
                    GitlabCI("GitLab CI"),
                    GithubActions("GitHub Actions")]
    
    with Cluster("代码质量与安全"):
        quality = SonarQube("代码质量检查")
        security = OWASPZAP("安全扫描")
    
    with Cluster("测试自动化"):
        testing = [JUnit("单元测试"),
                   Selenium("UI测试")]
    
    with Cluster("CD工具"):
        cd_tools = [Spinnaker("Spinnaker"),
                    Tekton("Tekton")]
    
    with Cluster("Kubernetes集群"):
        with Cluster("开发环境"):
            dev = Deployment("开发部署")
        
        with Cluster("测试环境"):
            test = Deployment("测试部署")
        
        with Cluster("生产环境"):
            prod = [Ingress("入口") >> Deployment("生产部署")]
    
    with Cluster("监控"):
        monitoring = Prometheus("指标收集") >> Grafana("可视化")
    
    repos >> Edge(label="代码提交") >> ci_tools
    ci_tools >> Edge(label="构建") >> quality
    ci_tools >> Edge(label="构建") >> security
    quality >> Edge(label="通过") >> testing
    security >> Edge(label="通过") >> testing
    testing >> Edge(label="测试通过") >> cd_tools
    cd_tools >> Edge(label="部署到开发") >> dev
    cd_tools >> Edge(label="部署到测试") >> test
    cd_tools >> Edge(label="部署到生产") >> prod
    [dev, test, prod] >> Edge(label="指标") >> monitoring

生成的架构图

这个架构图展示了一个完整的企业级CI/CD流水线，从代码提交到多环境部署，再到监控，涵盖了现代DevOps实践的主要环节。

高级技巧：自定义和优化架构图

Diagrams提供了多种方式来自定义和优化架构图，使其更易于理解和美观。

自定义样式

你可以自定义图表的背景色、字体大小、节点颜色等：

graph_attr = {
    "fontsize": "14",
    "bgcolor": "transparent",
    "fontname": "SimHei"  # 支持中文
}

node_attr = {
    "fontsize": "10",
    "shape": "box",
    "style": "filled",
    "fillcolor": "#f8f9fa"
}

with Diagram("自定义样式CI/CD流水线", show=False, graph_attr=graph_attr, node_attr=node_attr):
    # 图表定义...

使用不同布局

Diagrams支持多种布局方向，包括从上到下（TB）、从下到上（BT）、从左到右（LR）和从右到左（RL）：

with Diagram("水平布局CI/CD流水线", show=False, direction="LR"):
    # 图表定义...

添加注释和标签

你可以为连接添加标签，说明组件之间的交互：

repos >> Edge(label="代码提交触发构建") >> ci_tools
ci_tools >> Edge(label="运行测试", color="blue", style="dashed") >> testing

总结

Diagrams是一个功能强大的工具，可以帮助DevOps工程师和架构师快速绘制清晰、专业的CI/CD流水线架构图。通过代码定义架构，我们可以轻松维护和版本控制架构图，确保团队成员始终使用最新的架构信息。

无论是简单的流水线还是复杂的企业级架构，Diagrams都能满足你的需求。开始尝试用代码绘制你的下一个CI/CD架构图吧！

官方指南：docs/guides/diagram.md 更多示例：docs/getting-started/examples.md

希望这篇文章能帮助你更好地理解和使用Diagrams绘制CI/CD流水线架构图。如果你有任何问题或建议，请随时在项目仓库中提出。