# 架构图 **便携式克劳德特工技能** 使用 [Diagrams]() Python 库的专业架构图生成器。使用真实的云提供商图标（AWS、Azure、GCP、K8s、OnPrem、Generic）生成出版物质量的图表。 **可移植性：**整个“architecture-diagrams/”文件夹是独立的。将其复制到“~/.claude/skills/”或任何项目的“.claude/skills/”目录。每个位置运行一次“./scripts/setup.sh”。 ## 安装和设置 ### 系统先决条件 Graphviz 必须在系统范围内安装（提供“dot”二进制文件）： # Ubuntu/Debian sudo apt安装graphviz # macOS 酿造安装graphviz # RHEL/Fedora sudo dnf 安装 graphviz ### 一次性安装（每个安装位置） cd <路径>/架构图/ chmod +x 脚本/setup.sh ./脚本/setup.sh 这将创建 `.venv/`、安装 Python 依赖项并验证 graphviz。 ### 自动设置检查 cd <路径>/架构图/ 如果[！ -d“.venv”]；然后 ./脚本/setup.sh 菲 echo “技能准备就绪” ## 快速入门 # 1. 导航到您的项目目录 cd ~/项目/我的项目/ # 2.设置技能路径方便 SKILL_DIR=~/.claude-wa/.claude/skills/architecture-diagrams # 3. 验证设置如果[！ -d "$SKILL_DIR/.venv"];然后 cd "$SKILL_DIR" && ./scripts/setup.sh && cd -;菲 # 4.激活venv 源“$SKILL_DIR/.venv/bin/activate” # 5. 在您的项目中创建一个图表脚本猫 > my-diagram.py << 'EOF' 从图表导入图表、簇从diagrams.aws.compute导入EC2 从diagrams.aws.network导入ELB 与图（“我的架构”，show=False）： lb = ELB(“负载均衡器”) 与集群（“Web层”）：网络 = [EC2("网络 1"), EC2("网络 2")] 磅 >> 网页 EOF # 6.生成PNG（输出到当前目录中的./output/png/） python "$SKILL_DIR/scripts/generate.py" my-diagram.py # 输出：~/projects/my-project/output/png/my-diagram.png ## 文件结构 Architecture-diagrams/ <-- 技能根（便携式） SKILL.md # 这个文件 requirements.txt # Python deps（图表、graphviz） .venv/ # Python虚拟环境（由setup.sh创建）脚本/ setup.sh # 创建 .venv 并安装 deps generate.py # 运行图表脚本，输出到 cwd/output/png/ 源代码/ templates/ # 入门模板 — 复制这些 basic-template.py # 带有 TODO 的最小模板示例/ # 工作示例图 cisco-network.py # 包含路由器、交换机、防火墙的网络拓扑 aws-architecture.py # 具有 VPC、ALB、RDS 的 AWS 云架构 kubernetes-cluster.py # 具有命名空间、服务、监控的 K8s 集群文档/ icon-reference.md # 带有顶部图标+导航的索引（首先加载） icon/ # 特定于提供商的图标目录（按需加载，全部≤450行） generic.md # 通用基础设施（26 个图标） aws.md # Amazon Web Services（562 个图标） azure-compute-network.md # Azure：计算、网络、数据库、存储（约 400 个图标） azure-app-devops.md # Azure：应用服务、DevOps、身份、集成、物联网（约 240 个图标） azure-web-security.md # Azure：管理、安全、Web 服务（约 170 个图标） gcp.md # Google 云平台（144 个图标） kubernetes.md # Kubernetes（69 个图标） onprem.md # 本地工具（211 个图标） saas.md # SaaS 提供商（42 个图标） programming.md # 语言和框架（81 个图标） elastic-firebase.md # Elastic Stack、Firebase（~109 个图标） digitalocean-ibm.md # DigitalOcean、IBM Cloud（约 309 个图标） oracle-openstack.md # Oracle OCI、OpenStack（约 415 个图标） outscale-alibaba-misc.md # Outscale、阿里巴巴、GIS、自定义、C4（约 220 个图标） ## 输出路径行为图表在“./output/png/” **相对于您当前工作目录**（不是技能目录）中生成。这意味着输出出现在您的项目文件夹中： # 从你的项目目录 cd ~/项目/我的项目/ python /scripts/generate.py 图.py # 输出：~/projects/my-project/output/png/diagram.png # 自定义输出目录 python /scripts/generate.py diagram.py --output-dir ./diagrams/ # 输出：~/projects/my-project/diagrams/diagram.png # 绝对路径 python /scripts/generate.pydiagram.py --output-dir /tmp/diagrams/ # 输出：/tmp/diagrams/diagram.png ## 图标参考（渐进式披露） **跨 17 个提供商的 2634 个图标**，经过组织以实现高效的上下文加载： 1. **从`docs/icon-reference.md`开始 - 主索引（约 130 行），包含导航表、前 30 个最常用的图标和快速启动导入 2. **从“docs/icons/”按需加载提供程序文件** — 仅加载您需要的特定提供程序文件（例如，AWS 图标的“docs/icons/aws.md”）提供者文件 |图标|何时加载 ---|---|--- `icons/generic.md` | 26 | 26网络设备、操作系统、计算、存储 `icons/aws.md` | 562 | 562 AWS云架构 **天蓝色（分裂）：** | **810** | **Microsoft Azure - 根据需要加载** `icons/azure-compute-network.md` | 〜400 | Azure 计算、网络、数据库、存储 `icons/azure-app-devops.md` | 〜240 | Azure 应用服务、DevOps、身份、物联网 `icons/azure-web-security.md` | 〜170 | Azure 管理、安全、Web `icons/gcp.md` | 144 | 144 GCP架构 `icons/kubernetes.md` | 69 | 69 K8s 集群、Pod、服务 `icons/onprem.md` | 211 | 211自托管基础设施、数据库、CI/CD `icons/saas.md` | 42 | 42 SaaS 提供商 `icons/programming.md` | 81 | 81语言、框架 **其他云（分割）：** | **689** | **其他云提供商 - 根据需要加载** `icons/elastic-firebase.md` | 〜109 |弹性堆栈、Firebase `icons/digitalocean-ibm.md` | 〜309 |数字海洋、IBM 云 `icons/oracle-openstack.md` | 〜415 |甲骨文 OCI、OpenStack `icons/outscale-alibaba-misc.md` | 〜220 | Outscale、阿里巴巴、GIS、定制、C4 ## 核心概念 ### 图上下文管理器每个图都使用“Diagram”上下文管理器：从图表导入图表、簇、边与图（ "图表标题", # 图表上显示的标题 filename="output-name", # 输出文件名（无扩展名） outformat="png", # png, jpg, svg, pdf, 点 show=False, # 不自动打开方向=“TB”，#TB，BT，LR，RL graph_attr={...}, # Graphviz 属性）： # 这里的节点和连接 ### 方向价值|意义|最适合 ---|---|--- `结核病` |从上到下|分层架构、网络拓扑 `BT` |从下到上|数据向上流动 `LR` |从左到右|管道、数据流、时间表 'RL' |从右到左|逆流 ### 图属性图属性 = { "fontsize": "14", # 标题字体大小 "bgcolor": "#ffffff", # 背景颜色 "pad": "0.5", # 图表周围的填充 "nodesep": "0.6", # 水平间距 "ranksep": "0.8", # 行列之间的垂直间距 "splines": "spline", # 边缘布线：样条线、正交、曲线、折线 "concentrate": "true", # 合并平行边 } ## 节点提供商快速参考 ### 通用（网络基础设施）从diagrams.generic.network导入防火墙、路由器、交换机、子网、VPN 从diagrams.generic.compute导入Rack 从diagrams.generic.database导入SQL 从diagrams.generic.storage导入存储从diagrams.generic.device导入手机、平板电脑从diagrams.generic.place导入数据中心从diagrams.generic.os导入Ubuntu、Windows、LinuxGeneral、Debian、RedHat、CentOS 从diagrams.generic.virtualization导入Vmware、Virtualbox、Qemu fromdiagrams.generic.blank import Blank # 用于布局控制的不可见节点 ### AWS # 计算从diagrams.aws.compute导入EC2、ECS、Lambda、Fargate、ElasticBeanstalk、Batch # 数据库从diagrams.aws.database导入RDS、Aurora、Dynamodb、ElastiCache、Neptune、Redshift # 网络从diagrams.aws.network导入ELB、Route53、CloudFront、VPC、APIGateway、DirectConnect # 存储从diagrams.aws.storage导入S3、EFS、FSx # 安全从diagrams.aws.security导入Cognito、WAF、IAM、KMS、CertificateManager # 整合从diagrams.aws.integration导入SQS、SNS、Eventbridge、StepFunctions # 管理从diagrams.aws.management导入Cloudwatch、Cloudformation、Cloudtrail、AutoScaling # 分析从diagrams.aws.analytics导入Kinesis、Athena、Glue、EMR # 一般从diagrams.aws.general导入用户、客户端 ### 天蓝色从diagrams.azure.compute导入VM、FunctionApps、ContainerInstances、KubernetesServices 从diagrams.azure.database导入CosmosDb、SQLDatabases、CacheForRedis 从diagrams.azure.network导入LoadBalancers、ApplicationGateway、DNS、VirtualNetworks 从diagrams.azure.storage导入BlobStorage，StorageAccounts 从diagrams.azure.security导入KeyVaults、ActiveDirectory 从diagrams.azure.integration导入ServiceBus、EventGrid 从diagrams.azure.web导入AppServices ### GCP 从diagrams.gcp.compute导入GCE、GKE、函数、运行、AppEngine 从diagrams.gcp.database导入SQL作为GcpSQL、Spanner、Firestore、BigTable、Memorystore 从diagrams.gcp.network导入LoadBalancing、CDN、DNS作为GcpDNS，VPC作为GcpVPC 从diagrams.gcp.storage导入GCS 从diagrams.gcp.analytics导入BigQuery、PubSub、Dataflow 从diagrams.gcp.security导入IAP，KMS作为GcpKMS ### 库伯内特斯从diagrams.k8s.compute导入Pod、Deployment、StatefulSet、ReplicaSet、Job、CronJob、DaemonSet 从diagrams.k8s.network导入Ingress、Service、NetworkPolicy 从diagrams.k8s.storage导入PV、PVC、StorageClass 从diagrams.k8s.rbac导入ServiceAccount、Role、ClusterRole 从diagrams.k8s.infra导入Node作为K8sNode，Master 从diagrams.k8s.clusterconfig导入HPA、ConfigMap、Secret 从diagrams.k8s.podconfig导入容器 ### 本地部署 # 网络从diagrams.onprem.network导入Nginx、HAProxy、Traefik、Istio、Envoy、Consul、Kong、Apache # 数据库从diagrams.onprem.database导入PostgreSQL、MySQL、MongoDB、Cassandra、Redis作为OnPremRedis 从diagrams.onprem.database导入Neo4J、CockroachDB、InfluxDB、Clickhouse # 队列从diagrams.onprem.queue导入Kafka、RabbitMQ、ActiveMQ、Celery、Nats # 容器从diagrams.onprem.container导入Docker # 持续集成/持续交付从diagrams.onprem.ci导入Jenkins、GithubActions、GitlabCI、CircleCI 从diagrams.onprem.cd 导入 Spinnaker、Tekton 从diagrams.onprem.gitops导入ArgoCD、Flux # 监控从diagrams.onprem.monitoring导入Prometheus、Grafana、Datadog、Splunk、Nagios 从 sketchs.onprem.logging 导入 Loki、Fluentbit 从diagrams.onprem.tracing导入Jaeger、Tempo #国际交流协会从diagrams.onprem.iac导入Terraform、Ansible # VCS 从diagrams.onprem.vcs导入Git、Github、Gitlab # 分析从diagrams.onprem.analytics导入Spark、Hadoop、Flink # 身份验证/安全从diagrams.onprem.security导入Vault、Trivy # 工作流程从diagrams.onprem.workflow导入Airflow、Kubeflow、Nifi # 内存中从diagrams.onprem.inmemory导入Redis、Memcached # 计算从diagrams.onprem.compute导入服务器，Nomad ### 自定义图标从图表.自定义导入自定义 # 使用任何本地PNG/JPG图像作为节点图标 my_service = Custom("我的服务", "./path/to/icon.png") ## 集群（分组）与集群（“VPC”）：与集群（“公共子网”）：网络 = EC2("网络") 与集群（“私有子网”）： api = EC2(“API”) db = RDS("数据库") **集群属性：** with Cluster("样式组", graph_attr={ "bgcolor": "#e8f4fd", # 背景颜色 "style": "dashed", # 实线、虚线、点线、圆角 "color": "#2196F3", # 边框颜色 "penwidth": "2.0", # 边框宽度 "fontsize": "12", # 标签字体大小 "fontcolor": "#333333", # 标签颜色 "labeljust": "l", # 标签对齐方式: l, r, c }): 通过 ## 边（连接） ### 基本连接 # 前进方向节点_a >> 节点_b # 向后方向节点_a << 节点_b # 双向（无箭头）节点_a - 节点_b # 一对多节点_a >> [节点_b，节点_c，节点_d] # 链节点_a >> 节点_b >> 节点_c ### 样式边缘从图表导入 Edge 节点_a >> 边( label="HTTPS", # 边缘的文本标签 color="blue", # 边缘颜色（名称或十六进制） style="dashed", # 实线、虚线、点线、粗体 minlen="2", # 最小边长（等级） ) >> 节点_b ### 边缘样式图案连接类型 |颜色 |风格|示例 ---|---|---|--- 同步API | “蓝色”或“海军蓝” | `固体` | REST/gRPC 调用异步消息 | “橙色”或“绿色” | `虚线` |卡夫卡、SQS、事件数据库访问| “紫色”或“红色”| `固体` | SQL查询复制| `灰色` | `虚线` |数据库复制监控| `灰色` | `点状` |指标/日志外部API | “棕色”或“金色” | `固体` |第三方缓存| `红色` | `固体` | Redis/Memcached 存储| `棕色` | `点状` | S3、NFS、iSCSI ## 输出格式格式|旗帜|使用案例 ---|---|--- 巴布亚新几内亚 | `png`（默认）|文档、演示文稿 SVG | `svg` |可扩展的网络嵌入 PDF | `pdf` |打印质量的文档 JPG| 'jpg'|压缩图像点 | `点` |用于手动编辑的 Graphviz 源 # 单一格式与图（“标题”，outformat =“svg”）：... # 同时使用多种格式与图（“标题”，outformat = [“png”，“svg”，“pdf”]）：... ## 生成脚本用法 # 设置技能路径技能=~/.claude-wa/.claude/skills/architecture-diagrams # 首先激活venv 来源“$SKILL/.venv/bin/activate” # 从示例生成（输出在 ./output/png/ 中） python "$SKILL/scripts/generate.py" "$SKILL/src/examples/cisco-network.py" # 自定义输出名称 python "$SKILL/scripts/generate.py" "$SKILL/src/examples/cisco-network.py" --name my-network #SVG 格式 python "$SKILL/scripts/generate.py" "$SKILL/src/examples/aws-architecture.py" --outformat svg # 自定义输出目录 python "$SKILL/scripts/generate.py" "$SKILL/src/examples/aws-architecture.py" --output-dir ./my-diagrams/ # 在项目目录下生成 cd ~/项目/我的项目/ python "$SKILL/scripts/generate.py" my-diagram.py # 输出：~/projects/my-project/output/png/my-diagram.png ## 常见图表模式 ### 网络拓扑布局：“TB”。对路由器、交换机、防火墙、VPN、子网使用“diagrams.generic.network”。 DMZ、内部、管理区域的集群。请参阅“src/examples/cisco-network.py”。 ### 云架构布局：“TB”。使用 AWS/Azure/GCP 提供商图标。 VPC、子网、可用区的集群。协议的边缘标签。请参阅“src/examples/aws-architecture.py”。 ### Kubernetes 集群布局：“TB”。对 Pod、部署、服务、入口使用 `diagrams.k8s`。命名空间的集群。 OnPrem 用于监控堆栈（Prometheus、Grafana）。请参阅“src/examples/kubernetes-cluster.py”。 ### 微服务布局：“TB”或“LR”。混合提供商：OnPrem 用于服务，AWS 用于基础设施。服务组的集群。边缘样式区分同步/异步/数据流。 ### CI/CD 管道布局：`LR`。使用“diagrams.onprem.ci”和“diagrams.onprem.cd”。具有环境分支的线性流。 ## 常见错误错误|修复 ---|--- `ModuleNotFoundError：图表` |首先激活 venv：`source .venv/bin/activate` `ExecutableNotFound：点` |安装 graphviz：`sudo apt install graphviz` 图表在查看器中打开 |在Diagram()中设置`show=False` 文件保存在错误的目录中 |输出转到 `cwd/output/png/` — 从项目目录运行，或使用 `--output-dir` 提供程序类导入错误 |检查确切的类名称在diagrams.mingrammer.com/docs/nodes/ 杂乱的边缘重叠 |在 graph_attr 中使用 `"splines": "ortho"` 或 `"concentrate": "true"` 节点距离太近 |增加 graph_attr 中的 `nodesep` 和 `ranksep` 图表太大/太小 |调整每个集群的“pad”、“fontsize”和节点数找不到自定义图标 |路径必须相对于脚本的工作目录多个输出不工作 |将列表传递给 outformat: `outformat=["png", "svg"]` ## 故障排除问题 |解决方案 ---|--- `setup.sh` 失败 |确保安装了 Python 3.7+ 和 graphviz 二进制文件 `.venv` 创建失败 |尝试“python3 -m venv .venv --clear”重新创建空白/空输出 |验证节点是否在“with Diagram()”块内定义输出权限被拒绝 |检查 `output/png/` 目录的写入权限缓慢生成 |具有许多节点的大图是正常的 - 减少集群或节点 `点` 段错误 |更新 graphviz：`sudo apt install --only-upgrade graphviz`

架构图

包含技能