来源: https://github.com/antonbabenko/terraform-best-practices/tree/master/examples/large-terraform

此示例包含的代码作为为大型基础设施构建 Terraform 配置的示例，该基础设施使用：

• 2个AWS账户

• 2个地区

• 2 个独立的环境（prod 和 stage 什么都不共享）。 每个环境都位于一个单独的 AWS 账户中，并跨越 2 个区域之间的资源

• 每个环境都使用来自 的不同版本的现成基础设施模块 (alb)

• 每个环境都使用相同版本的内部模块modules/network，因为它来自本地目录

Terraform 官方文档详细阐述了 。请仔细阅读以便理解本节的其余部分。

本节内容将介绍本书中所使用的核心概念。

资源 (Resource)

类似aws_vpc, aws_db_instance

Terraform 代码结构

来源:

此示例包含的代码作为为中型基础设施构建 Terraform 配置的示例，该基础设施使用：

• 2个AWS账户

• 2 个独立的环境 (prod 和 stage

Terraform 是一款非常强大（如果不是现在最强大的）的工具，也是最常用的基础设施即代码管理工具之一。它使开发人员可以做很多事情，并且帮助开发人员轻松应对各种复杂实现或集成。

本书中描述的一些信息可能并不像是最佳实践。为了帮助读者区分哪些是已经确立的最佳实践，哪些是个人偏好的最佳实践，我有时使用提示来提供一些上下文，并使用图标来指定与最佳实践相关的各个小节的成熟度水平。

本书于2018年在阳光明媚的马德里开始编写，可在此处免费获取 - https://www.terraform-best-practices.com/ 。 经过若干年不断迭代更新，它包含了更多与Terraform 1.0相关的实际最佳实践。最终，本书应该包含大多数无可争议的最佳实践和对 Terraform 用户的建议。

赞助商

Please if you want to become a sponsor.

其他语言版本

若您有意参与本书翻译，请与我联系。

贡献

随着社区的日益成熟和新思路的不断实践和验证，我一直希望得到反馈并更新本书。 如果你对某些话题感兴趣，请，或者点赞您感兴趣的问题。如果您有补充内容并且想要贡献，请提交pull request（不必担心文字是否华丽）。

作者

本书在不同贡献者和翻译人员的协助下由 维护。

版权

本书使用Apache 2 License许可协议，具体请查看协议本身。

本书作者和贡献者无法保证本书内容的有效性。 请确保您了解本书提供的信息是免费提供的，并且您与此内容或项目相关的任何人之间没有任何协议或合同。 作者和贡献者不承担任何一方因本内容中包含的、关联的或链接的信息的错误或遗漏而造成的任何损失、损害或中断的任何责任，无论此类错误或遗漏是由于疏忽、事故或任何其他原因造成的。

版权所有 © 2018-2023 Anton Babenko。

还有一个研讨会，供想要练习本指南中描述的某些内容的人使用。

内容在这里 - https://github.com/antonbabenko/terraform-best-practices-workshop

有关Terraform代码结构的问题是社区中迄今为止最常见的问题。 每个人都在某个时候考虑过项目的最佳代码结构。

我应该如何构建我的 Terraform 配置？

这是一个有很多解决方案的问题之一，很难给出通用的建议，所以让我们从理解我们正在处理什么开始。

• 你的项目有多复杂？

  • 相关resources（资源）数量

  • Terraform 提供商的数量（参见下面关于“逻辑提供者”的注释）

• 你的基础架构多久更改一次？

  • 从每月/每周/每天一次

  • 到连续（每次有新提交时）

• 代码更改发起者？ 当一个新的artifact（构件）生成时，是否让 CI 服务器更新存储库？

  • 只有开发人员可以推送到基础架构存储库

  • 每个人都可以通过打开 PR（包括在 CI 服务器上运行的自动化任务）来提出对任何事物的更改

• 你使用哪种部署平台或部署服务？

  • AWS CodeDeploy、Kubernetes 或 OpenShift 需要稍微不同的方法

• 环境如何分组？

  • 按环境、地区、项目

开始了解 Terraform 配置的结构

当开始或编写示例代码时，将所有代码放在 main.tf中是一个好主意。 在所有其他情况下，最好将多个文件按逻辑拆分，如下所示：

• main.tf - 调用modules（模块）、locals（本地）和data sources（数据源）来创建所有资源

• variables.tf - 包含在main.tf 中使用的变量声明

terraform.tfvars 不应在除（组合）之外的任何地方使用。

如何考虑 Terraform 配置结构？

结构化代码的常见建议

• 使用更少的资源可以更轻松、更快速地进行工作

  • terraform plan 和 terraform apply 都调用 cloud API 来验证资源状态

在本书中，示例项目按复杂性分组 —— 从小型到超大型基础设施。这种分离并不严格，因此还要检查其他结构。

基础架构模块和组合的编排

拥有小型基础设施意味着存在少量依赖项和资源。 随着项目的增长，链接 Terraform 配置的执行、连接不同的基础设施模块以及在组合中传递值的需求变得显而易见。

开发人员使用的编排解决方案至少有5个不同的群体:

1. 仅限Terraform。 非常简单，开发人员只需了解 Terraform 即可完成工作。

2. Terragrunt。 纯编排工具，可用于编排整个基础架构以及处理依赖项。 Terragrunt 原生地操作基础设施模块和组合，因此它减少了代码重复。

3. In-house scripts（内部脚本）。 通常，这发生在编排的起点和发现 Terragrunt 之前。

考虑到这一点，本书回顾了这些项目结构中的前两个，即仅使用Terraform和Terragrunt。

请参阅下一章中 或 的代码结构示例。

我应该注意并考虑使用哪些工具？

• - 编排工具（Orchestration tool）

使用 locals 指定资源之间的显式依赖关系

这是一种有用的方法，可以向Terraform提供提示，即使在Terraform配置中没有直接依赖关系，某些资源也应该在其它资源之前被删除。

来源:

此示例包含的代码作为为小型基础设施构建 Terraform 配置的示例，其中不使用外部依赖项。

- 非常积极地使用 Terraform 并且可以告诉你很多（如果你问他们的话）的人的名单。

- HashiCorp 的 Terraform 上精选的资源列表。

- Anton Babenko 的YouTube 频道“Your Weekly Dose of Terraform”，包含评论、采访、问答、实时编码和一些使用 Terraform 的黑客技术的直播。

Documentation（文档）

自动生成的文档

是一个用于管理和维护多语言预提交挂钩的框架。它是用 Python 编写的，是一个强大的工具，可以在代码提交到 git 存储库之前在开发人员的机器上自动执行某些操作。通常，它用于运行 linters 和格式化代码（参见）。

通过 Terraform 配置，pre-commit可用于格式化和验证代码，以及更新文档。

查看 以熟悉它，以及已经使用它的现有存储库（例如， ）。

terraform-docs

是一种工具，可以从 Terraform 模块以各种输出格式完成文档的生成。你可以手动运行它（没有预提交挂钩），或使用 来自动更新文档。

@todo：记录模块版本、发布、GH actions

参考资源

1. 预提交框架主页：

2. 用于预提交框架的Terraform 的 git 钩子集合：

3. 的博客文章：

一般约定

1. 在任何地方（资源名称、数据源名称、变量名称、输出等）使用 _ (下划线) 而不是 - (破折号)。

2. 非常适合使用小写字母和数字（即使支持 UTF-8）。

资源和数据源参数

1. 不要在资源名称中重复资源类型（既不要部分，更不要完全）：

   resource "aws_route_table" "public" {}

resource（资源）代码示例

count / for_each的使用

tags（标签）的放置

count（计数）条件

Variables（变量）

1. 不要在资源模块中重新造轮子：使用你正在使用的资源的“参数参考”部分中定义的变量 name，description和 default。

2. 对变量验证的支持相当有限（例如，无法访问其他变量或进行查找）。 相应地计划，因为在许多情况下此功能是无用的。

3. 当type是list(...)

Outputs（输出）

使输出在其范围之外保持一致且易于理解（当用户使用模块时，它返回的值的类型和属性应该很明显）。

1. 输出的名称应该描述它包含的属性，并且不像你通常想要的那样自由。

2. 输出名称的良好结构类似于{name}_{type}_{attribute}，其中：

   1. {name}

output（输出）代码示例

最多返回一个安全组ID：

当有多个相同类型的资源时，this 在输出名称中应省略：

如果返回值是列表，则使用复数名称