terravision

泰瑞视讯

TerraVision 是一个 CLI 工具，可将 Terraform 代码转换为专业云架构图，并解决云项目中最重要的文档（架构文档）保持最新的问题。随着现在高速发布的规范，机器生成的架构图比依赖云架构师绘制的与现实不再相符的自由式图表更准确。 Terravision 安全地运行 100% 客户端，无需依赖 Terraform 或访问您的云环境，动态解析您有条件创建的资源和变量，并生成架构的自动视觉效果。 Terravision 被设计为一个“文档即代码”(DaC) 工具，可以包含在 CI/CD 管道中，以便在构建/测试/发布管道阶段之后更新架构图，并补充其他文档生成器，例如 readthedocs.io。目前它支持 AWS，很快就会支持 Google 和 Azure 云。

转这个...

进入这个...

该软件仍处于 alpha 测试阶段，代码按“原样”共享，不带任何明示或暗示的保证或条件。使用风险自负。

特拉维森的好处

1. 成本
   • 保存 Visio/绘图软件许可证 - Terravision 是免费且开源的
   • 不需要任何成本来启动云资源，它可以立即从您的本地计算机上运行
   • 定期更新图表、对齐、连接点和布置图标并不是对架构师人员成本的最佳利用
2. 加速和自动化
   • 使用 TF 变量文件作为输入，从同一 TF 代码创建多个变体图
   • 通过将 terravision 作为 CI/CD 管道的一部分运行，自动创建架构图
   • 基于 YAML 的图表即代码允许您使用额外的自定义标签和资源来注释生成的图表，例如非托管资源或未在 TF 代码中捕获的外部系统
3. 整个组织的一致性
   • 自动下载您的组织/外部模块，以确保下游 Terraform 模块的最新视图
   • 跨团队使用行业标准图标和 AWS/GCP/Azure 批准的风格来设计一致的架构图
4. 准确的能见度
   • 图表的实时状态显示当前基础设施与当今生产中部署的基础设施完全匹配
   • 以可视化方式帮助第三方架构审查、审计、监控、报告和调试堆栈
   • 自定义图表代码和输出图像可以放入源/版本控制中，以获得更好的可维护性和可发现性
5. 安全
   • 无需授予您的 AWS 账户或 CLI 的访问权限即可绘制图表
   • 不会创建侵入性云资源，例如扫描企业需要批准的实例或元数据表
   • 所有源代码都保留在您的本地环境中，图表在您的计算机上生成，无需调用外部 API

安装与使用

所有版本的外部依赖项

• graphviz https://graphviz.org/download/
• git https://git-scm.com/downloads
• terraform https://developer.hashicorp.com/terraform/downloads

快速入门

1. 安装上面列出的所有外部依赖项
2. 克隆 repo git clone https://github.com/patrickchugh/terravision.git
3. 通过执行cd terravision和pwd获取工作目录（完整路径）。
4. 将 terravision 文件夹添加到您的PATH值中，例如export PATH=$PATH:/Users/<PATH TO TERRAVISION>以便您可以从任何地方运行它。 <PATH TO TERRAVISION>将是第 3 行的输出。
5. 安装 python 需求cd terravision && pip install -r requirements.txt
6. 确保您的 terravision python 脚本可以使用chmod +x terravision执行
7. 运行terravision并按以下格式指定 Terraform 源文件：

$ terravision draw --source ~ /src/my-terraform-code

对于具有工作区的 Terraform 堆栈，您可以使用--workspace参数：

$ terraform draw --source ~ /src/my-terraform-code --workspace development

对于 Git 存储库中的 Terraform 源代码，您还可以使用以下形式：

$ terravision draw --source https://github.com/your-repo/terraform-examples.git

如果您想要的代码位于文件夹层次结构下，请使用//字符表示 Git 存储库中的子文件夹。

$ terravision draw --source https://github.com/your-repo/terraform-examples.git//mysubfolder/secondfolder/

注释生成的图表

自动生成的图表不会包含您需要的所有细节，最多只能完成 80-90% 的工作。要添加自定义注释，例如主图标题、箭头上的附加标签或在 Terraform 外部创建的附加资源，请在源代码文件夹中包含terravision.yml文件，它将自动加载。或者，指定注释文件的路径作为 terravision 的参数。

terravision --source https://github.com/your-repo/terraform-examples.git --annotate /Users/me/MyDocuments/annotations.yml

.yml 文件是一种标准 YAML 配置文件，类似于下面的示例，其中包含一个或多个名为title 、 connect 、 disconnect 、 add 、 remove或update标题。节点名称遵循与 Terraform 资源名称相同的约定 https://registry.terraform.io/providers/hashicorp/aws/latest/docs 并支持通配符。您可以通过修改资源的属性并添加label属性（Terraform 中不存在）来向任何 TF 资源添加自定义标签。对于线/连接，您可以通过添加 terravision 特定的edge_labels来修改资源属性，以将文本添加到特定资源节点的连接线上。请参阅下面的示例：

 format : 0.1
# Main Diagram heading
title : Serverless Wordpress Site
# Draw new connection lines that are not apparent from the Terraforms
connect :
  aws_rds_cluster.this :
    - aws_ssm_parameter.db_master_user : Retrieve credentials from SSM
# Remove connections between nodes that are currently shown
disconnect :
  # Wildcards mean these disconnections apply to any cloudwatch type resource called logs
  aws_cloudwatch*.logs :
    - aws_ecs_service.this
    - aws_ecs_cluster.this
# Delete the following nodes
remove :
  - aws_iam_role.task_execution_role
# Add the following nodes
add :
  aws_subnet.another_one :
    # Specify Terraform attributes for a resource like this 
    cidr_block : " 123.123.1.1 "
# Modify attributes of existing node
update :
  aws_ecs_service.this :
    # Add custom labels to the connection lines that already exist between ECS->RDS
    edge_labels :
      - aws_rds_cluster.this : Database Queries
  # Wildcards save you listing multiple resources of the same type. This edge label is added to all CF->ACM connections.
  aws_cloudfront* :
    edge_labels :
      - aws_acm_certificate.this : SSL Cert
 # Add a custom label to a resource node. Overrides default label
  aws_ecs_service.this :
   label : " My Custom Label "

详细帮助

键入terravision --help以获取完整命令列表或特定命令的帮助