Terraform 可视化工具 —— Inkdrop-Visualizer 使用指南

Terraform 可视化工具 —— Inkdrop-Visualizer 使用指南

inkdrop-visualizer Visualizes your Terraform 项目地址: https://gitcode.com/gh_mirrors/in/inkdrop-visualizer

1. 项目介绍

Inkdrop-Visualizer 是一个开源的 CLI 工具，它可以创建交互式图表来可视化您的 Terraform 配置。通过将 Terraform Plan 转换为交互式 WebUI，Inkdrop-Visualizer 帮助您快速理解资源之间的关系和依赖。这款工具非常适合于项目文档自动化生成、工程师快速上手新项目以及审查基础设施变更。

2. 项目快速启动

安装

• 使用 Homebrew：

  brew tap inkdrop-org/inkdrop-visualizer
  brew install inkdrop-visualizer
  

• 使用 Linux：

  wget https://github.com/inkdrop-org/inkdrop-visualizer/releases/latest/download/inkdrop-linux-x64.tar.gz
  tar -xzf inkdrop-linux-x64.tar.gz
  chmod +x inkdrop
  mv inkdrop /usr/local/bin/
  

• 使用 NPM：

  npm install -g inkdrop-visualizer
  

• 使用 Docker：

  docker run \
  -v /path/to/your/terraform/root:/tfroot \
  --env TF_VERSION=1.5.7 \
  -p 3000:3000 \
  -it inkdroporg/inkdrop:latest plan.out [additional arguments]
  

  请将 /path/to/your/terraform/root 替换为您的 Terraform 根目录的绝对路径，并将 TF_VERSION 调整为与您本地使用的 Terraform 版本相匹配。

使用

运行以下命令以启动可视化界面：

inkdrop plan.out

此命令将读取 plan.out 文件，并在默认的 WebUI 中显示变更影响。

3. 应用案例和最佳实践

• 代码审查：在代码审查过程中，使用 Inkdrop-Visualizer 快速识别 terraform 配置文件中的资源变更。
• 自动化文档：集成到 CI/CD 流程中，自动生成 Terraform 配置的文档。
• 团队协作：在团队内部共享可视化图表，帮助新成员快速理解现有基础设施。

4. 典型生态项目

• GitHub Actions：通过 GitHub Actions 集成，可以在 PR 中直接查看 Terraform 的变更影响。
• Atlantis：结合 Atlantis，可以在 PR 中评论 SVG 图像，点击后显示详细的交互式图表。

以上指南将帮助您开始使用 Inkdrop-Visualizer，并通过实际案例了解其应用。在实际使用过程中，您可以根据具体需求调整配置和参数。

inkdrop-visualizer Visualizes your Terraform 项目地址: https://gitcode.com/gh_mirrors/in/inkdrop-visualizer