tf-summarize 树形视图实战用 -tree 与 -separate-tree 理清资源层级关系【免费下载链接】tf-summarizeA command-line utility to print the summary of the terraform plan项目地址: https://gitcode.com/gh_mirrors/tf/tf-summarize当你的 Terraform 项目规模越来越大terraform plan的输出动辄几十上百行想要一眼看清哪些资源会变、哪些模块层级受影响往往很吃力。tf-summarize就是为解决这个问题而生的命令行工具它能将terraform plan解析成简洁的摘要而其中的树形视图功能-tree与-separate-tree更是把资源之间的 module 层级、依赖关系呈现得清清楚楚。本文就用最直观的方式带你快速上手这两种树形视图的实战用法。为什么你需要树形视图而不是普通表格默认情况下tf-summarize输出的是表格格式每一行对应一个资源的变更类型add / delete / update。当变更数量超过 10 个或者资源嵌套在多层 module 中时表格里那一长串地址例如module.github[terraform-plan-summary].github_repository.repository会让你很难快速定位这个资源到底属于哪个模块。而树形视图会把资源地址按.拆分成层级自动构建出 module → 资源类型 → 资源名称 的树状结构层级关系一目了然。下面这张截图直观展示了表格、树形和带连线树形三种输出效果的差异最快上手-tree 一键输出资源层级树-tree是最基础的树形视图参数它会保留完整的模块嵌套关系并用缩进符号|---表示层级。执行方式很简单terraform plan -outtfplan tf-summarize -tree tfplan也可以直接用 JSON 格式的 plan 作为输入terraform show -json tfplan | tf-summarize -tree输出的树形视图大致长这样|---github_repository | |---terraform_plan_summary() |---module | |---github[demo-repository] | | |---github_branch | | | |---development() | | | |---main() | | |---github_repository | | | |---repository() | |---github[terraform-plan-summary] | | |---github_branch | | | |---demo(-)每个叶子节点末尾的标记含义如下标记含义对应操作()新增资源create(-)删除资源delete(~)修改资源update(→)资源被移动/重命名moved这正是tf-summarize树形视图最实用的一点你在审查 plan 时不用再逐行读地址扫一眼树的层级和符号就能知道哪个模块下要加什么、删什么。更直观的 -draw 参数把树画成 2D 图形如果你的终端支持 Unicode强烈建议加上-draw参数让树形视图从缩进文本升级成带边框和连线的 2D 图形视觉效果接近思维导图tf-summarize -tree -draw tfplan输出会变成类似这样的方框连线结构╭─╮ │.│ ╰┬╯ │ ╭──────┴─────╮ │module │ ╰──────┬─────╯ │ ╭────┴───╮ │github │ ╰────┬───╯ │ ╭──────┴──────╮ │github_branch│ ╰──────┬──────╯ │ ╭──────┴─────╮ │development()│ ╰─────────────╯需要提醒的是-draw只能与-tree或-separate-tree搭配使用单独使用会直接报错这一点在 main.go 的参数校验逻辑中有所体现。建议在 Code Review 或 CI 日志中展示时使用-draw它能让评审者 3 秒内理解变更范围。进阶实战-separate-tree 按操作类型分组当一次 plan 同时包含新增、删除、修改、重建等多种操作时混在一棵大树里仍然不够直观。此时-separate-tree就派上用场了——它会按照add / delete / change / recreate等操作类型把资源拆分成多棵独立的树并用分隔线隔开tf-summarize -separate-tree tfplan # 或者结合 -draw tf-summarize -separate-tree -draw tfplan输出结构大致如下################### ADD ################### |---module | |---github[demo-repository] | | |---github_branch | | | |---development() | | | |---main() ################### DELETE ################### |---module | |---github[terraform-plan-summary] | | |---github_branch | | | |---demo(-)这个模式非常适合上线前风险审查先看 DELETE 区块确认没有误删再看 RECREATE 区块评估重建带来的服务中断风险最后才关注 ADD 和 CHANGE。分组逻辑由 terraformstate/terraform_state.go 中的GetAllResourceChanges实现而具体的分组渲染则位于 writer/separate_tree.go。-tree 与 -separate-tree 怎么选一张表看懂对比维度-tree-separate-tree展示方式单一完整层级树按操作类型拆分为多棵树适合场景资源少、层级结构清晰变更多、需要分类审查阅读重点模块归属与嵌套关系增删改各有哪些资源与 -draw 搭配✅ 支持✅ 支持与 -md 搭配❌ 冲突❌ 冲突两者背后的树构建逻辑是共通的tree.CreateTree会把资源地址按.和[ ]拆分逐层挂到对应的父节点下相关实现可查看 tree/tree.go 和 writer/tree.go。也就是说-separate-tree相当于先按操作分组再对每组分别画树。三个实用技巧让树形视图更好用技巧一输出到文件方便归档与评论。树形视图默认打印到终端配合-out参数可以保存成文件便于在 PR 评论或周报中引用tf-summarize -tree -draw -outtree_summary.txt tfplan技巧二直接读取示例 plan 快速体验。仓库中自带了一份完整的示例计划文件 example/tfplan.json你无需真实环境就能立刻体验tf-summarize -tree example/tfplan.json tf-summarize -separate-tree example/tfplan.json技巧三在 CI 流水线中自动生成层级摘要。把-tree -draw的输出贴到 GitHub Actions 或 Codefresh 的评论中团队成员每次提交都能自动看到结构化的变更摘要官方示例可参考 example/codefresh/codefresh.yaml。快速安装并开始使用macOS 用户可以直接用 Homebrew 安装brew install tf-summarizeGo 开发者也可以一行命令装好go install github.com/dineshba/tf-summarizelatest结语掌握tf-summarize的树形视图等于给 Terraform plan 审查装上了显微镜 分类器-tree让你看清资源层级关系-separate-tree让你按操作类型快速分类排查配合-draw还能输出高颜值的 2D 树形图。下次跑terraform plan时不妨试着用这两个参数替换默认的表格输出你会立刻感受到结构化的力量。【免费下载链接】tf-summarizeA command-line utility to print the summary of the terraform plan项目地址: https://gitcode.com/gh_mirrors/tf/tf-summarize创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考