Module Variable和Output_Terraform(Terraform)-阿里云帮助中心

本文详细介绍 Terraform Module 中的 Variable 和 Output 的用法

概述

Variable（变量）和 Output（输出）是 Terraform Module（模块）系统的核心组件，它们使模块具有可重用性、灵活性和可组合性。模块变量允许用户在不修改模块源代码的情况下自定义其行为，而输出值则使模块能够将关键信息传递给其调用者或其他依赖模块。这种参数化和信息传递机制是构建可维护、可扩展和组合式基础设施代码的基础。

变量为模块提供了灵活性，允许在不同环境（如开发、测试和生产）中使用不同的配置值，同时保持基础设施代码的一致性。通过变量类型系统和验证规则，Terraform 确保输入数据的正确性和安全性。而输出值则创建了模块间的通信渠道，允许一个模块的资源属性（如资源标识符、连接字符串或网络地址）成为另一个模块的输入，从而建立整体基础设施的依赖图。

模块变量和输出的正确使用对于创建可跨区域、跨环境复用的标准化组件至关重要。例如，通过参数化的网络模块、安全组模块和计算资源模块，组织可以确保所有团队一致地部署符合企业标准的基础设施。本文将详细介绍模块变量和输出的声明、使用以及最佳实践，通过实际示例展示如何在阿里云基础设施中应用这些概念。

模块变量

到目前为止的示例中，我们都使用了硬编码的资源属性。例如，在服务器模块的 main.tf 文件中，网络名称是硬编码的。如果多次使用相同的服务器模块，在执行 terraform plan 或 terraform apply 时会收到名称冲突错误。

在这种情况下，我们需要能够灵活地在不同环境中配置不同的属性值，同时在其他方面保持标准化。通过使用变量，我们可以在不修改源代码的情况下自定义模块的各个方面。

变量的重要性

变量在处理不同环境（如开发、生产和预发）时特别有用。最佳实践是在预发环境中使用较小的机器类型，而在生产环境中使用较大的机器类型。

使用输入变量参数化模块

步骤 1：替换硬编码值

将模块中的硬编码值替换为变量。例如，将网络名称参数化：

# 原始代码
resource "alicloud_vpc" "main" {
  vpc_name = "my-vpc" # 硬编码值
}

# 参数化后的代码
resource "alicloud_vpc" "main" {
  vpc_name = var.vpc_name # 使用变量
}

步骤 2：声明变量

在 variables.tf 文件中声明参数化的属性。确保将声明的变量放在与定义资源相同的目录中：

# variables.tf
variable "vpc_name" {
  description = "Name of the VPC"
  type = string
}

步骤 3：调用模块时传递值

在调用模块时，传递变量值：

module "vpc_dev" {
  source = "./modules/vpc"
  vpc_name = "dev-vpc"
}
module "vpc_prod" {
  source = "./modules/vpc"
  vpc_name = "prod-vpc"
}

注意：与根配置不同，您不能在 Terraform 运行时向模块变量传递值。

模块输出值

要将资源参数从一个模块传递到另一个模块，必须将该参数配置为输出值。

为什么需要输出值？

在模块间传递资源属性
暴露必要的资源信息
支持模块间的依赖关系

定义和使用输出值

在源模块中定义输出

# modules/vpc/outputs.tf
output "vpc_id" {
  description = "ID of the created VPC"
  value       = alicloud_vpc.main.id
}

output "vswitch_ids" {
  description = "IDs of the created vswitches"
  value       = alicloud_vswitch.vswitches[*].id
}

在目标模块中使用输出值

# modules/ecs/main.tf
module "vpc" {
  source = "../vpc"
}

resource "alicloud_instance" "example" {
  vswitch_id = module.vpc.vswitch_ids[0]
}

应用示例

网络模块与服务器模块交互

# modules/network/main.tf
resource "alicloud_vpc" "main" {
  vpc_name   = var.vpc_name
  cidr_block = var.vpc_cidr
}

# modules/network/outputs.tf
output "vpc_id" {
  value = alicloud_vpc.main.id
}

# modules/ecs/variables.tf
variable "vpc_id" {
  description = "ID of the VPC"
  type        = string
}

# root main.tf
module "network" {
  source = "./modules/network"
  
  vpc_name = "example-vpc"
  vpc_cidr = "172.16.0.0/16"
}

module "ecs" {
  source = "./modules/ecs"
  
  vpc_id = module.network.vpc_id
}

多环境配置示例

# environments/dev.tfvars
environment     = "dev"
instance_type   = "ecs.g6.small"
instance_count  = 1

# environments/prod.tfvars
environment     = "prod"
instance_type   = "ecs.g6.2xlarge"
instance_count  = 3

# 使用不同环境配置
terraform apply -var-file="environments/dev.tfvars"

最佳实践

变量设计
- 为所有可配置项定义变量
- 提供合理的默认值
- 使用变量验证（validation）确保输入正确
- 添加清晰的变量描述
输出设计
- 只暴露必要的输出值
- 为输出值提供描述
- 考虑下游模块的需求
环境管理
- 使用工作空间分离环境
- 为不同环境创建专门的变量文件
- 使用条件表达式处理环境差异
注意事项
- 模块变量不支持运行时输入
- 每次修改模块后需要运行 terraform init
- 注意变量值的类型匹配