什么是 tf-summarize?Terraform Plan 摘要神器一篇文章完全解读【免费下载链接】tf-summarizeA command-line utility to print the summary of the terraform plan项目地址: https://gitcode.com/gh_mirrors/tf/tf-summarize每次运行terraform plan输出动辄几百上千行新增、修改、删除的资源混在一起想快速看清这次改动到底影响了谁简直是一种折磨。如果你也面临这样的痛点那么tf-summarize就是为你准备的答案。tf-summarize 是一款开源的命令行工具它的唯一使命就是把 Terraform Plan 的输出压缩成一份清晰简洁的摘要让你一眼看清所有资源变更。本文将带你从零开始一篇文章完全读懂它的安装、用法与进阶技巧。为什么你需要一个 Terraform Plan 摘要工具在基础设施即代码IaC的日常工作中terraform plan几乎是每天都要执行的命令。它的输出包含大量信息但恰恰因为太全反而让人难以快速抓住重点变更混杂创建add、更新update、删除delete、重建recreate混在一起需要人工筛选篇幅巨大资源一多plan 输出轻松超过几十屏滚动查找费时费力难以汇报想向同事或上级说明本次变更范围时缺乏一目了然的汇总视图tf-summarize正是为解决这些问题而生它直接读取 terraform plan或 plan 的 JSON 输出帮你把变更按操作类型分组输出成表格、树状结构或 JSON几秒钟内就能掌握全貌。tf-summarize 的核心功能一览这个工具虽然轻量但功能相当齐全功能说明 表格摘要默认输出按 add / delete / update 分组列出受影响的资源 树状视图-tree参数按模块和资源类型展示层级关系 图形化树-tree -draw输出 2D 图形树层次一目了然️ 分离树-separate-tree将增删改重建分成四棵独立的树 JSON 输出-json输出结构化数据方便脚本进一步处理 HTML 报告-html生成可视化 HTML 变更报告✍️ Markdown 表格-md输出 Markdown 格式表格可直接贴进 PR快速掌握 tf-summarize 的安装方法tf-summarize 支持多种安装途径总有一种适合你。方式一Go 一键安装最快如果你已有 Go 环境一行命令即可完成go install github.com/dineshba/tf-summarizelatest方式二HomebrewmacOS / Linuxbrew install tf-summarize方式三Docker无需安装任何依赖docker run -v $PWD:/workspace -w /workspace ghcr.io/dineshba/tf-summarize -v方式四源码编译安装如果想尝鲜最新特性可以克隆仓库后自行编译git clone https://gitcode.com/gh_mirrors/tf/tf-summarize cd tf-summarize make build编译产物会生成在dist/目录下复制到 PATH 即可使用。编译与发布的完整脚本逻辑可以参考仓库根目录的 Makefile入口程序则在 main.go。tf-summarize 最常用的 5 个命令用法安装完成后先执行terraform plan -outtfplan生成 plan 文件然后就可以开始体验了。① 表格摘要默认最常用terraform show -json tfplan | tf-summarize输出效果就是文章开头截图中的表格CHANGE 列标注 add / delete / updateNAME 列列出具体资源一眼扫完所有变更。② 树状结构视图terraform show -json tfplan | tf-summarize -tree当项目使用了大量 module 时树状视图能清晰地展示资源归属关系绿色()表示新增、红色(-)表示删除、黄色(~)表示更新。③ 图形化树视图terraform show -json tfplan | tf-summarize -tree -draw从上面的演示动图可以看到-draw参数会把树渲染成带边框的 2D 图形层级关系更加直观非常适合截图放进文档或汇报材料。④ 直接读取 JSON 文件terraform show -json tfplan output.json tf-summarize output.json注意如果你把 plan 输出重定向到文件务必保证文件以.json结尾这样 tf-summarize 才能正确识别——它内部正是通过文件扩展名来决定使用哪种解析器相关逻辑见 parser/parser.go。⑤ 输出 JSON 供脚本处理tf-summarize -json tfplan | jq配合jq之类的工具你可以把变更数据接入自己的自动化流程-outsummary.md参数则能把摘要直接写入文件。把 tf-summarize 接入 CI/CD 流水线tf-summarize 的价值远不止本地使用把它接入 CI/CD 后每次 MR/PR 都能自动附上一份清晰的变更摘要。GitHub Actions 中使用只需在 workflow 中加入setup-tf-summarize步骤即可自动安装随后直接调用命令生成摘要。示例配置可以参考仓库中的 example/demo.yml。Codefresh 流水线中使用在 Codefresh 中先通过 terraform 镜像执行 plan 并输出 JSON再由 tf-summarize 镜像渲染摘要完整配置见 example/codefresh/codefresh.yamlTerraformPlan: commands: - terraform plan -outtfplan - terraform show -json tfplan output.json tfSummarize: commands: - tf-summarize output.json你还可以把摘要直接以评论的形式自动发布到 PR 中团队成员无需打开流水线日志就能在对话里看到本次变更影响的范围代码评审效率大幅提升。项目内部结构速览进阶如果你对实现原理感兴趣这个项目的代码组织非常清晰值得一读reader/负责从文件或标准输入读取 plan 数据parser/支持 JSON 与二进制两种 plan 格式的解析terraformstate/解析结果的数据结构定义与资源变更统计writer/多种输出格式的渲染器表格、树、HTML、JSON模板在 writer/templates/main.go命令行入口负责参数校验与整体流程调度tf-summarize 常见问题解答Q1tf-summarize 能直接读取二进制 tfplan 吗可以。直接传入tfplan文件即可工具会自动识别并调用二进制解析器如果传的是 JSON 文件则要求以.json结尾。Q2Docker 方式运行有哪些限制Docker 镜像内没有 terraform 二进制无法把二进制 tfplan 转成 JSON因此只能处理 JSON 文件。想用二进制 plan请先执行terraform show -json tfplan转换。Q3多个输出参数可以同时使用吗不可以。-md、-json、-json-sum、-html只能四选一-tree与-separate-tree也不能同时出现否则会直接报错退出。Q4支持读取 terraform state 文件吗支持。当前版本已可直接读取 terraform state 文件生成摘要无需先手工转换成 JSON。总结让 Terraform Plan 摘要成为日常习惯tf-summarize 用极低的学习成本解决了 Terraform 使用中最常见的信息过载问题。无论你是刚接触 Terraform 的新手还是管理着上百个资源的资深工程师它都能帮你把每次 plan 变成一份清爽的变更清单。现在就安装试试相信你会和我一样再也回不去逐行翻 plan 输出的日子了。【免费下载链接】tf-summarizeA command-line utility to print the summary of the terraform plan项目地址: https://gitcode.com/gh_mirrors/tf/tf-summarize创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考 什么是 tf-summarize?Terraform Plan 摘要神器一篇文章完全解读
什么是 tf-summarize?Terraform Plan 摘要神器一篇文章完全解读【免费下载链接】tf-summarizeA command-line utility to print the summary of the terraform plan项目地址: https://gitcode.com/gh_mirrors/tf/tf-summarize每次运行terraform plan输出动辄几百上千行新增、修改、删除的资源混在一起想快速看清这次改动到底影响了谁简直是一种折磨。如果你也面临这样的痛点那么tf-summarize就是为你准备的答案。tf-summarize 是一款开源的命令行工具它的唯一使命就是把 Terraform Plan 的输出压缩成一份清晰简洁的摘要让你一眼看清所有资源变更。本文将带你从零开始一篇文章完全读懂它的安装、用法与进阶技巧。为什么你需要一个 Terraform Plan 摘要工具在基础设施即代码IaC的日常工作中terraform plan几乎是每天都要执行的命令。它的输出包含大量信息但恰恰因为太全反而让人难以快速抓住重点变更混杂创建add、更新update、删除delete、重建recreate混在一起需要人工筛选篇幅巨大资源一多plan 输出轻松超过几十屏滚动查找费时费力难以汇报想向同事或上级说明本次变更范围时缺乏一目了然的汇总视图tf-summarize正是为解决这些问题而生它直接读取 terraform plan或 plan 的 JSON 输出帮你把变更按操作类型分组输出成表格、树状结构或 JSON几秒钟内就能掌握全貌。tf-summarize 的核心功能一览这个工具虽然轻量但功能相当齐全功能说明 表格摘要默认输出按 add / delete / update 分组列出受影响的资源 树状视图-tree参数按模块和资源类型展示层级关系 图形化树-tree -draw输出 2D 图形树层次一目了然️ 分离树-separate-tree将增删改重建分成四棵独立的树 JSON 输出-json输出结构化数据方便脚本进一步处理 HTML 报告-html生成可视化 HTML 变更报告✍️ Markdown 表格-md输出 Markdown 格式表格可直接贴进 PR快速掌握 tf-summarize 的安装方法tf-summarize 支持多种安装途径总有一种适合你。方式一Go 一键安装最快如果你已有 Go 环境一行命令即可完成go install github.com/dineshba/tf-summarizelatest方式二HomebrewmacOS / Linuxbrew install tf-summarize方式三Docker无需安装任何依赖docker run -v $PWD:/workspace -w /workspace ghcr.io/dineshba/tf-summarize -v方式四源码编译安装如果想尝鲜最新特性可以克隆仓库后自行编译git clone https://gitcode.com/gh_mirrors/tf/tf-summarize cd tf-summarize make build编译产物会生成在dist/目录下复制到 PATH 即可使用。编译与发布的完整脚本逻辑可以参考仓库根目录的 Makefile入口程序则在 main.go。tf-summarize 最常用的 5 个命令用法安装完成后先执行terraform plan -outtfplan生成 plan 文件然后就可以开始体验了。① 表格摘要默认最常用terraform show -json tfplan | tf-summarize输出效果就是文章开头截图中的表格CHANGE 列标注 add / delete / updateNAME 列列出具体资源一眼扫完所有变更。② 树状结构视图terraform show -json tfplan | tf-summarize -tree当项目使用了大量 module 时树状视图能清晰地展示资源归属关系绿色()表示新增、红色(-)表示删除、黄色(~)表示更新。③ 图形化树视图terraform show -json tfplan | tf-summarize -tree -draw从上面的演示动图可以看到-draw参数会把树渲染成带边框的 2D 图形层级关系更加直观非常适合截图放进文档或汇报材料。④ 直接读取 JSON 文件terraform show -json tfplan output.json tf-summarize output.json注意如果你把 plan 输出重定向到文件务必保证文件以.json结尾这样 tf-summarize 才能正确识别——它内部正是通过文件扩展名来决定使用哪种解析器相关逻辑见 parser/parser.go。⑤ 输出 JSON 供脚本处理tf-summarize -json tfplan | jq配合jq之类的工具你可以把变更数据接入自己的自动化流程-outsummary.md参数则能把摘要直接写入文件。把 tf-summarize 接入 CI/CD 流水线tf-summarize 的价值远不止本地使用把它接入 CI/CD 后每次 MR/PR 都能自动附上一份清晰的变更摘要。GitHub Actions 中使用只需在 workflow 中加入setup-tf-summarize步骤即可自动安装随后直接调用命令生成摘要。示例配置可以参考仓库中的 example/demo.yml。Codefresh 流水线中使用在 Codefresh 中先通过 terraform 镜像执行 plan 并输出 JSON再由 tf-summarize 镜像渲染摘要完整配置见 example/codefresh/codefresh.yamlTerraformPlan: commands: - terraform plan -outtfplan - terraform show -json tfplan output.json tfSummarize: commands: - tf-summarize output.json你还可以把摘要直接以评论的形式自动发布到 PR 中团队成员无需打开流水线日志就能在对话里看到本次变更影响的范围代码评审效率大幅提升。项目内部结构速览进阶如果你对实现原理感兴趣这个项目的代码组织非常清晰值得一读reader/负责从文件或标准输入读取 plan 数据parser/支持 JSON 与二进制两种 plan 格式的解析terraformstate/解析结果的数据结构定义与资源变更统计writer/多种输出格式的渲染器表格、树、HTML、JSON模板在 writer/templates/main.go命令行入口负责参数校验与整体流程调度tf-summarize 常见问题解答Q1tf-summarize 能直接读取二进制 tfplan 吗可以。直接传入tfplan文件即可工具会自动识别并调用二进制解析器如果传的是 JSON 文件则要求以.json结尾。Q2Docker 方式运行有哪些限制Docker 镜像内没有 terraform 二进制无法把二进制 tfplan 转成 JSON因此只能处理 JSON 文件。想用二进制 plan请先执行terraform show -json tfplan转换。Q3多个输出参数可以同时使用吗不可以。-md、-json、-json-sum、-html只能四选一-tree与-separate-tree也不能同时出现否则会直接报错退出。Q4支持读取 terraform state 文件吗支持。当前版本已可直接读取 terraform state 文件生成摘要无需先手工转换成 JSON。总结让 Terraform Plan 摘要成为日常习惯tf-summarize 用极低的学习成本解决了 Terraform 使用中最常见的信息过载问题。无论你是刚接触 Terraform 的新手还是管理着上百个资源的资深工程师它都能帮你把每次 plan 变成一份清爽的变更清单。现在就安装试试相信你会和我一样再也回不去逐行翻 plan 输出的日子了。【免费下载链接】tf-summarizeA command-line utility to print the summary of the terraform plan项目地址: https://gitcode.com/gh_mirrors/tf/tf-summarize创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考