使用 Terraform 时如何自动生成inputs.tf和outputs.tf变量？

各位小伙伴们，大家好呀！看看今天我又给各位带来了什么文章？本文标题是《使用 Terraform 时如何自动生成inputs.tf和outputs.tf变量？》，很明显是关于Golang的文章哈哈哈，其中内容主要会涉及到等等，如果能帮到你，觉得很不错的话，欢迎各位多多点评和分享！

注意：请参阅下面的 #### 更新 ### 部分。为了清楚地说明我想要实现的目标，我对问题进行了大量修改，但将其添加为附录，而不是重写问题。

随着我的基础设施的发展，现在不可能手动在我的variables.tf 文件中添加输入变量，然后将这些值同步到我的outputs.tf 文件中的输出变量。它不仅占用了大量不必要的时间，还可能花费更多时间返回并修复 terraform validate 告诉我因人为错误而错过的内容。在构建/使用其参数添加额外管理层的模块时尤其如此。

一定有更好的方法吗？这就是我想要实现的目标。

假设我正在创建一个 Azure AKS Kubernetes 集群。 Terraform 资源为 azurerm_kubernetes_cluster.

创建基本安装只需要 8 个参数，但还有近 250 个附加参数。它们都有默认值。根据文档页面，他们也已经有了精彩的描述。 （我厌倦了复制并粘贴到我的 variables { description = "this"} 块中。）

该信息位于文档中。 terraform plan 还了解每一个附加计划，因为它当然出现在预申请计划中。 (apply后已知)意味着它是可选的，但会有一个默认值。

在我的梦想世界中，我会运行这个假设的命令序列：

• 地形规划
• terraform document <- 这里它自动生成每个参数作为变量块并将其插入到variables.tf中。它还会自动生成每个可能的 output "out_putable" {} 块并将其插入到outputs.tf中。
• terraform apply -update-inputs -update-outputs <- 这里所有可选的（应用后已知的）现在都已知，并且它应该相应地自动更新variables.tf和outputs.tf。添加 -update-modules 标志可以让它处理使用模块引入的附加层。

这感觉像是以前已经解决过的问题。在我编写一个解析 Terraform Web 文档和 terraform show 的输出的自定义工具之前，是否已经有一种方法可以做到这一点？ Terraform-docs 是我为 README.md 找到解决方案的最接近的。如果它能满足我的需要，我还没弄清楚。

我怎样才能自动化这一切？

############ 更新 ############

本文和视频对于 Terraform 在组织中的演变非常准确。我的组织处于模式 3 后期和模式 5 早期之间。当我们分解“Terralith”时，我们的团队之间存在不一致的情况（模式、命名约定、变量和参数选择等）。这些开始导致 CI​​/CD 中出现错误，迫使票据审核流程减慢速度。

所有资源都有必需和可选参数。但在我的组织中，例如，我们需要额外的可选参数。

场景：日本的开发人员 A 创建了一个资源，忘记了一个或两个可选变量，或者将它们命名为一些晦涩的名称，等等。美国的开发人员 B 被阻止，直到他们可以召开会议并进行讨论。考虑到时区、语言差异、票务审查，这一期现在延迟了一周或更长时间。

我需要自动化此操作并创建精确的一致性，以便开发 A 开始时与开发 B 开始时或期望的完全一致；并且，CI/CD 测试所期望的 - 模板化初始过程（如果您愿意的话）。换句话说，我需要删除手动创建 main.tf、variables.tf、outputs.tf 等的人为因素。

以下是关于如何实现这一目标的想法：

• 使用 Golang 通过查询 API 自动生成文件 如何查询 API 以获取特定资源的所有 required 参数的列表？

我发现我可以查询提供者信息，但找不到信息来检索资源信息。我的想法是，当开发人员想要创建新资源时，他将运行 go 或 typescript 来生成清单文件以及预期的命名约定，并准确地填充 main.tf、variables.tf、outputs.tf 等大家都在期待什么数据。我正在寻找类似 curl 的形式registry.terraform.io/providers/hashicorp/azurerm/v2.99/resource_group?required=yes 这应该向我显示所有必需的参数以及我可以直接从 API 使用的描述和其他信息。

• 使用 CDKTF 从 JSON 生成 HCL manifest.tf 文件 如何使用 CDKTF 生成 HCL .tf 文件？ CDKTF 正是我正在寻找的 - 除了相反。 HCL 与 JSON 无缝兼容。运行 cdktf Synth 创建 ./out/cdk.tf.out 我非常接近！ 如何将该文件转换为 main.tf？！？

这里的目标是拥有一个主文件，所有未来的清单文件都从中派生。无论我们使用 azurerm_kubernetes_cluster 1 次还是 1000 次，我确信每个参数、每个变量名称、每个所需的输出都是完全相同的。如果我们想要的结构需要机会，它将在 JSON 级别进行更新，并且 CI/CD 可以确保这些更改在其使用的实例之间传播。

我知道我可以使用 cdk.out.tf 文件作为模块的替代品，但我不希望我的团队成员必须学习打字稿或如何读取 json。如果我可以创建一个模板化的 JSON 文件，其中包含我期望用户开始使用的内容，并且如果他们可以运行一些命令，例如 cdktf Convert cdk.tf.out --HCL output-file.tf 那么我就完成了我的目标.

如果 cdktf Synth 可以创建 HCL JSON 文件，并且 cdktf Convert 可以获取 manifest.tf 文件并将其转换为 HCL JSON，它不能做完全相反的事情吗？将 HCL JSON 文件转换为人类可读的声明性 Manifest.tf 文件？

也许可以这样想。如果要允许模块进入模块注册表，Terraform 具有模块所需的文件结构。我正在尝试为我们组织使用的每种资源创建一个类似的所需结构，无论其使用时间和地点。

正确答案

如果您的目标是从资源类型模式派生输入变量和输出值，那么 terraform 可以为您提供执行此操作的信息。

在已使用您要使用其资源类型的提供程序的配置的工作目录中，运行以下命令：

terraform providers schema -json

结果包含当前配置的提供程序中可用的所有资源类型中的 a JSON description 个，以及每个资源类型的有关其属性的元数据，包括每个资源类型的类型约束信息和描述。

您可以根据该信息生成您需要的任何其他文件。

请注意，如果您打算构建导出特定资源类型 the Terraform documentation explicitly recommends against this 的整个表面积（所有输入和所有输出）的模块，建议直接使用该资源类型，因为这样的模块通常无法提供足够的资源其好处超过了它所带来的额外复杂性和维护开销：

以上就是《使用 Terraform 时如何自动生成inputs.tf和outputs.tf变量？》的详细内容，更多关于的资料请关注golang学习网公众号！