Terraform provider/variable 共享模块

Question

有没有一种方法可以为项目中定义的所有模块抽象提供者。

比如我有这个项目

├── modules
│   ├── RDS
│   └── VPC
└── stacks
    ├── production
    │   └── main.tf
    └── staging
        └── main.tf

而且效果很好... 问题出在模块的定义上

├── RDS
│   ├── README.md
│   ├── main.tf
│   ├── providers.tf
│   └── variables.tf
└── VPC
    ├── README.md
    ├── main.tf
    ├── providers.tf
    └── variables.tf

这两个模块中的提供者完全相同

# providers.tf
provider "aws" {
  region = "${var.region}"
  version = "~> 1.26"
}

每个模块中的变量都不同，但它们都有region变量。

# variables.tf
variable "region" {
  default     = "eu-central-1"
  description = "AWS region."
}
# other module dependent variables...

有没有办法在模块级别定义这些信息位所以我最终得到大致像这样的东西

├── modules
│   ├── providers.tf  <<< include the *shared* provider definition block
│   ├── variables.tf  <<< include the *shared* region vaiable definition block
│   ├── RDS
│   │   ├── README.md
│   │   ├── main.tf
│   │   └── variables.tf
│   └── VPC
│       ├── README.md
│       ├── main.tf
│       └── variables.tf

最后一件事，模块定义大部分时间都有一个资源属性（从 terraform 注册表中拉出一个模块...因此我不知道从注册表中继承源代码和基本模块）

Answer 1

现在还不可能做到这一点。之前在以下问题中就 github 讨论过同一主题：

TL;DR
在模块之间共享变量违反了 Terraform 核心 clarity/explicity 原则。

解决方法
解决方法是将 *shared* 文件放在父目录中，并使用符号链接将它们添加到模块中。

Answer 2

如果你知道terragrunt，这就完全没有问题了。

Terragrunt is a thin wrapper for Terraform that provides extra tools for working with multiple Terraform modules.

它是为您刚刚遇到的问题而设计的。

account
 └ _global
 └ region
    └ _global
    └ environment
       └ resource

快速入门

查看 terragrunt-infrastructure-modules-example and terragrunt-infrastructure-live-example 存储库以获得演示这些功能的完整示例代码

您可以使用 prod/terraform.tfvars 或 prod/account.tfvars 作为全局变量，或者将 tfvars 文件放在 _global 文件夹下。

Answer 3

您可以通过传入要使用的提供程序别名来从模块中抽象提供程序参数。这允许您创建一个模块而不引用诸如 Region 之类的东西，然后在调用时传递这些细节。

对于您的用例，您可以在堆栈文件夹中定义别名提供程序（最好在文件中定义它并为每个堆栈文件夹创建符号链接）：

# stacks/{staging,production}/providers.tf
provider "aws" {
  alias  = "us-east-1"
  region = "us-east-1"
}

provider "aws" {
  alias   = "us-east-2"
  region  = "us-east-2"
}

然后当您调用模块时，传入您要使用的提供者别名（这假设一个模块只使用任何特定提供者类型中的一种）：

# stacks/{staging,production}/main.tf
module "VPC-us-east-1" {
  source = "../../modules/VPC"

  providers = {
    aws      = "aws.us-east-1"
  }
}

module "VPC-us-east-2" {
  source = "../../modules/VPC"

  providers = {
    aws      = "aws.us-east-2"
  }
}

Answer 4

Hashicorp 配置语言目前没有全局变量特性。

和variables用于定义模块的模块接口或充当ENV变量（内联ENV）。因此，这不是将变量用作全局共享的最佳方式。因为每次你定义一些模块时，你总是需要考虑你在上层模块上使用了哪些变量。可能你最终会像这样：first_module_s3_bucket_name、second_module_s3_bucket_name.

但是 locals 共享给子模块更有意义。因为，当地人想帮助避免重复相同的值。

如果您有兴趣，可以对 Hashicorp 功能请求进行新的讨论。

https://github.com/hashicorp/terraform/issues/25431

Terraform provider/variable 共享模块

Terraform provider/variable sharing in modules

terraform

terraform-provider-aws

快速入门