在 Terraform 中，如何使用另一个部署的资源？

Question

Terraform v0.12.x

这是我另一个 post How to use Terraform modules for code re-use?.

的后续问题

我有 2 个模块旨在重用其他模块。我的目录结构是...

/terraform/
/terraform/blue/main.tf
/terraform/green/main.tf
/terraform/module_snapshot/main.tf
/terraform/module_ebs/main.tf

我想在两个部署 blue/main.tf 和 green/main.tf 之间重复使用 module_ebs/main.tf。它只是

resource "aws_ebs_volume" "ebs" {
  availability_zone = "us-east-1a"
  snapshot_id       = "sn-123456abcded"
  size              = 500
  type              = "gp2"
  tags = {
    Name        = "test-ebs"
  }
}

output "ebs_id" {
  value       = aws_ebs_volume.ebs.id
  description = "Volume id of the EBS volume"
}

想法是 green/main.tf 使用 module_ebs/main.tf 创建一个 EBS 卷（它有一个名为 ebs_id 的输出）。

provider "aws" {
  region = "us-east-1"
}

terraform {
  required_version = ">= 0.12.17, < 0.13"
  backend "s3" {
    bucket = "my-terraform-states"
    key    = "test-modules/terraform.tfstate"
    region = "us-east-1"
  }
}

module "green_ebs" {
  source "../module_ebs"
}
output "green_ebs_id" {
  value = module.green_ebs.ebs_id
}

执行此操作时，我获得了所需的 EBS 卷

$ cd /terraform/green
$ terraform plan -out out.o
$ terraform apply "out.o"
green_ebs_id = "vol-123456abcdef"

现在我想 blue/main.tf 拍摄 green 的 EBS 卷的快照，所以我做了

provider "aws" {
  region = "us-east-1"
}

terraform {
  required_version = ">= 0.12.17, < 0.13"
  backend "s3" {
    bucket = "my-terraform-states"
    key    = "test-modules/terraform.tfstate"
    region = "us-east-1"
  }
}

module "green" {
  source "../module"
}
module "snapshot" {
  source "../module_snapshot"
  green_ebs_id = module.green.green_ebs_id
}
output "blue_ebs_id" {
  value = module.blue_ebs.ebs_id
}

然而，当我运行上面的脚本时，它也（当然）运行s green/main.tf，这当然会破坏它的 EBS 卷并创建另一个，这这不是我想做的。

$ cd /terraform/blue
$ terraform plan -out out.o
# module.green.aws_ebs_volume.ebs will be destroyed
- resource "aws_ebs_volume" "ebs" {
...
}

如何在不破坏和重新创建的情况下使用另一个部署的资源？

Answer 1

如果您可以使用外部“入门”脚本（bash、jq 等），那么您绝对可以做到这一点。在您的第一个运行之后，将创建一个 terraform.tfstate 文件。它包含所有已创建资源的描述及其 ID。使用您的起始脚本，您可以遍历状态文件，提取必要的 ID 并使用 terraform import {module_2_resource_name} {module_1_resource_id} 将资源导入到您的新模块中。您也可以尝试直接使用 terraform import -state=path 重用其他状态文件。但你应该小心。 module_1 和 module_2 中的资源定义应该相同以避免破坏。

Answer 2

如何实现这一点有几种不同的变体，这些变体有一些不同的权衡因素，例如 coupling 以及隐式关系与显式接口。

一种常见的方法是建立一些约定，下游配置可以通过这些约定间接找到上游配置使用数据源创建的对象。在您的情况下，这可能涉及为您的 EBS 卷设计一个两个配置都同意的标记方案，以便第二个配置可以找到第一个配置创建的对象。

在第一个配置中：

resource "aws_ebs_volume" "ebs" {
  availability_zone = "us-east-1a"
  snapshot_id       = "sn-123456abcded"
  size              = 500
  type              = "gp2"
  tags = {
    Name = "production-appname"
  }
}

第二种配置：

data "aws_ebs_volume" "example" {
  filter {
    name   = "tag:Name"
    values = ["production-appname"]
  }
}

此示例中的约定是“名称”标签的值为“生产应用程序名称”。这可能不完全符合您的目的，但它展示了总体思路。然后第二个配置可以通过 data.aws_ebs_volume.example.id.

访问该 id

正如我在开头提到的那样，上述方法进行了一些设计权衡：

耦合相对较低，因为第二个模块只需要something先前创建了一个带有特定标签的EBS卷，所以你稍后可以重构您的系统，以便在不同的 Terraform 配置中创建 EBS 卷，或者使用 Terraform 以外的其他软件，而不对下游进行任何更改。
但是，这两者之间的联系是隐含的，因为它依赖于共享约定而不是显式接口。这可能会使整个系统架构更难理解，除非您小心地将这些隐式约定记录在您的团队知道的地方。

另一种变体是让您的上游配置明确地将信息发布到专门用于该目的的配置存储中。例如，在 AWS 中，您可能会使用 AWS SSM Parameter Store，它在 Terraform 中使用 aws_ssm_parameter 托管资源类型和数据源表示：

resource "aws_ssm_parameter" "foo" {
  name  = "appname_ebs_volume_id"
  type  = "String"
  value = aws_ebs_volume.ebs.id
}

data "aws_ssm_parameter" "foo" {
  name = "appname_ebs_volume_id"
}

同样，这两种配置之间有一个共同的约定，但约定是写入一个专门用于存储配置的位置，因此表示“会合点”（在本例中为 SSM 参数）显然在上游和下游配置中，保持相似的耦合程度但增加了明确性。

最后一个选择是利用大多数“真实”Terraform 配置将其状态快照保存在远程网络位置这一事实。 terraform_remote_state 数据源是一个特殊的数据源，它从远程位置读取状态快照并提取存储在那里的根模块输出，因此您可以在其他地方使用该数据。因此，您可以使用已在第一个模块中声明的输出来填充第二个模块中的资源配置，只要应用第二个模块的每个人都有足够的访问权限来读取第一个模块的最新状态快照。

我认为，第三个选项与第一个选项有相反的权衡：

耦合度高，因为下游配置配置为直接从其他配置的状态读取此值。如果您稍后要重构并将 EBS 卷移动到不同的 Terraform 配置或使用其他软件对其进行管理，则需要编辑第二个配置以向其传授新源。
然而，这可能是最明确的选项，因为 EBS 卷 ID 显然是有意从第一个配置中导出作为用于其他地方的值，而第二个配置准确描述了哪个子系统负责生成该值。

None 这些选项在所有情况下都是“正确”或“错误”，但我个人认为第二个选项是其他两个选项之间的一个很好的折衷方案，因为它缓和了两个竞争设计考虑因素。选择哪一个 select 将取决于您要描述的系统的目标和限制，但如果您的情况没有明确的“赢家”，我认为第二个是一个很好的默认设置。

在 Terraform 文档指南 Module Composition 中，有一些关于以灵活方式减少耦合和分解系统的技术的一般指导。它不是专门关于跨多个单独的 Terraform 配置拆分基础设施，但那里描述的技术可以帮助您进行设置，以便您以后可以更轻松地更改有关如何分解系统的决定，这样您就可以推迟添加多个单独的 Terraform 配置的复杂性配置，直到您真正需要这样做。

在 Terraform 中，如何使用另一个部署的资源？

In Terraform, how can I use another deployment's resources?

terraform

terraform-provider-aws