如何减少Terraform模块中的样板式配置？多执行步骤场景优化

针对你遇到的两个Terraform模块几乎完全一致、仅差一个远程执行步骤的问题，这里有几个高效的方法来消除样板式重复代码：

1. 用可选变量控制额外执行步骤 #

把Module A改造为通用基础模块，新增变量来控制是否添加额外脚本，这样Module B无需单独维护，直接复用Module A的逻辑即可。

改造后的Module A配置 #

# 新增可选变量，默认不启用额外步骤
variable "enable_extra_script" {
  type        = bool
  default     = false
  description = "是否运行额外的远程执行脚本"
}

variable "extra_script_command" {
  type        = string
  default     = ""
  description = "启用额外步骤时要执行的命令"
}

provisioner "remote-exec" {
  inline = concat(
    [
      "sudo chmod 777 -R ${var.setup_files_destination}",
      "sudo ${var.setup_files_destination}/scripts/setup.sh ${var.setup_files_destination}",
    ],
    # 根据变量决定是否追加额外命令
    var.enable_extra_script ? [var.extra_script_command] : []
  )
  connection {
    user        = "ec2-user"
    private_key = file(var.private_key_location)
  }
}

使用方式 #

• 调用原Module A功能时，直接使用模块即可：

  module "module_a" {
    source = "./path/to/module_a"
    # 传入其他必要变量...
  }
  

• 实现Module B功能时，启用额外脚本并传入对应命令：

  module "module_b" {
    source = "./path/to/module_a"
    enable_extra_script = true
    extra_script_command = "sudo ${var.setup_files_destination}/scripts/your_extra_script.sh"
    # 传入其他必要变量...
  }
  

2. 提取公共配置到独立子模块 #

把两个模块中完全相同的部分（比如基础执行命令、连接配置）提取到公共子模块，Module A和Module B分别调用这个公共模块，再各自补充差异部分。

公共子模块（示例：modules/remote_exec_base） #

variable "setup_files_destination" {
  type = string
}

variable "private_key_location" {
  type = string
}

output "base_commands" {
  type = list(string)
  value = [
    "sudo chmod 777 -R ${var.setup_files_destination}",
    "sudo ${var.setup_files_destination}/scripts/setup.sh ${var.setup_files_destination}",
  ]
}

output "connection_config" {
  type = object({
    user        = string
    private_key = string
  })
  value = {
    user        = "ec2-user"
    private_key = file(var.private_key_location)
  }
}

Module A的配置 #

module "remote_exec_base" {
  source = "./remote_exec_base"
  setup_files_destination = var.setup_files_destination
  private_key_location = var.private_key_location
}

provisioner "remote-exec" {
  inline = module.remote_exec_base.base_commands
  connection = module.remote_exec_base.connection_config
}

Module B的配置 #

module "remote_exec_base" {
  source = "./remote_exec_base"
  setup_files_destination = var.setup_files_destination
  private_key_location = var.private_key_location
}

provisioner "remote-exec" {
  inline = concat(
    module.remote_exec_base.base_commands,
    ["sudo ${var.setup_files_destination}/scripts/your_extra_script.sh"]
  )
  connection = module.remote_exec_base.connection_config
}

3. 动态块扩展（适合未来有更多差异化步骤的场景） #

如果之后可能需要添加更多不同的执行步骤，可以用Terraform的动态块来生成多个remote-exec配置，灵活扩展。

示例配置 #

variable "extra_scripts" {
  type        = list(string)
  default     = []
  description = "基础配置完成后要执行的额外命令列表"
}

# 基础远程执行步骤
provisioner "remote-exec" {
  inline = [
    "sudo chmod 777 -R ${var.setup_files_destination}",
    "sudo ${var.setup_files_destination}/scripts/setup.sh ${var.setup_files_destination}",
  ]
  connection {
    user        = "ec2-user"
    private_key = file(var.private_key_location)
  }
}

# 动态生成额外的远程执行步骤
dynamic "provisioner" {
  for_each = var.extra_scripts
  content {
    remote-exec {
      inline = [provisioner.value]
      connection {
        user        = "ec2-user"
        private_key = file(var.private_key_location)
      }
    }
  }
}

调用时只需传入额外命令列表即可实现Module B的功能：

module "module_b" {
  source = "./path/to/module"
  extra_scripts = ["sudo ${var.setup_files_destination}/scripts/your_extra_script.sh"]
  # 传入其他必要变量...
}

内容的提问来源于stack exchange，提问作者Shiraaz.M