Terraform 转图表

使用方法

1. 01

   粘贴或拖入 Terraform 代码

   一个 .tf 文件、同一模块的多个文件，或 terraform show -json 为已保存的计划或当前 state 输出的 JSON。无需运行 terraform init。

2. 02

   查看架构图

   每个资源会按类型变成一张卡片，例如计算、数据库或队列。网络、子网和资源组会变成框架，包住放置在其中的资源。

3. 03

   在 Archboard 中打开

   保存为新图表后，可以重新排列卡片、添加备注、分享链接，或导出为 SVG 和 PNG。注册只需 Google 或 GitHub 账号。

从 Terraform 代码中绘制哪些内容

图表根据配置中的以下块和参数生成：

• resourcedata

  资源按类型绘制为卡片。aws_lb_target_group_attachment 这类起连接作用的资源会变成连线，aws_s3_bucket_versioning 这类设置资源会折叠进所属的存储桶；data 数据源会被跳过，除非有资源放置在其中。

• depends_on

  一个资源对另一个资源的每次引用（例如 aws_iam_role.app.arn）都会绘制一条连线，字符串、heredoc 和 locals 中的引用也包括在内。depends_on 会添加一条虚线连线；如果两个资源之间已有引用，或目标是 time_sleep 这类被隐藏的辅助资源，则不添加。

• vpc_idsubnet_id

  通过 vpc_id 和 subnet_id 确定位置：只在一个子网中的资源放在该子网内，分布在一个 VPC 多个子网中的资源放在 VPC 框架内，Azure 资源则放在各自的资源组中。

• modulesource

  每个 module 块绘制为一张卡片。terraform-aws-modules/vpc/aws、eks、rds 等常用 Registry 模块会绘制为它们创建的网络框架、集群或数据库，使用该 VPC 模块子网的资源会放在框架内。

• resource_changes

  使用计划 JSON 时，每张资源卡片都会标明计划将对该资源做什么：+ 创建、~ 更新、− 删除或 ± 替换。计划不改动的资源不带标记；VPC、子网等框架以及折叠进卡片的设置资源也不带标记。

• awsazurermgoogle

  AWS、Azure 和 Google Cloud 的资源；如果使用多个云厂商，会画在同一张图中。没有专用卡片的类型会显示为通用卡片，并标出资源类型。

Terraform 计划可视化

计划 JSON 能生成最完整的图表：count 和 for_each 会变成真实的实例数量，模块会展开出其中的资源，资源卡片会标出计划中的变更。在平时运行 terraform plan 的位置运行以下两条命令，然后粘贴 JSON：

1. 创建计划并保存到 plan.out，不会应用任何变更。

   terraform plan -out plan.out

2. 以 JSON 格式输出已保存的计划。粘贴输出内容，或重定向到 plan.json 后把该文件拖到这里。

   terraform show -json plan.out

Terraform 架构图不包含什么

• 变量和 locals 的值、.tfvars 文件、tags、user_data 以及其他属性值。卡片使用 bucket、function_name 等字面名称，没有时使用代码中的资源名。
• .tf 文件中 count 和 for_each 的展开：配置不会被求值，所以 count = 3 的资源是一张标有 ×3 的卡片，使用 for_each 的资源标为 ×N。粘贴计划 JSON 即可看到真实的实例数量。
• 远程模块的内容：不会下载 Registry 和 Git 模块。不在常用列表中的模块保持为一张卡片，其中的资源可通过计划 JSON 看到。
• 云上的实际状态、配置漂移、费用，或运行时哪些服务相互调用。图表显示的是配置如何连接资源，而不是流量。