Terramate 项目中的脚本执行功能实践指南

前言

在多订阅架构的云环境中管理基础设施时，经常需要在执行Terraform命令前切换云服务商上下文。本文将介绍如何利用Terramate项目的脚本功能优雅地解决这一问题。

核心需求场景

假设我们有一个多订阅的Azure环境，目录结构如下：

envs/dev/terraform_init/stack.tm.hcl
envs/prod/terraform_init/stack.tm.hcl

传统做法需要手动切换订阅上下文后再执行命令，操作繁琐且容易出错。Terramate的脚本功能可以自动化这一流程。

Terramate脚本功能详解

Terramate提供了实验性的脚本功能，允许在stack配置中定义预执行脚本。其核心语法结构为：

script "脚本分类" "脚本名称" {
  description = "脚本描述"
  
  job {
    commands = [
      ["命令1", "参数1", "参数2"],
      ["命令2", "参数1"]
    ]
  }
}

实际应用示例

基础订阅切换实现

以下配置展示了如何为不同环境设置订阅并执行Terraform初始化：

script "terraform" "init" {
  description = "设置订阅并执行terraform init"

  job {
    commands = [
      ["az", "account", "set", "--subscription", global.az.subscription_id],
      ["terraform", "init"]
    ]
  }
}

完整工作流实现

我们可以扩展脚本功能来实现完整的Terraform工作流：

script "terraform" "apply" {
  description = "完整Terraform工作流"

  job {
    commands = [
      ["az", "account", "set", "--subscription", global.az.subscription_id],
      ["terraform", "init"],
      ["terraform", "plan"],
      ["terraform", "apply", "-auto-approve"]
    ]
  }
}

全局变量配置

为了使脚本更具通用性，建议使用全局变量来管理订阅ID：

globals "az" {
  subscription_id = "your-subscription-id"
}

注意事项

1. 该功能目前处于实验阶段，API可能会发生变化
2. 对于需要动态生成环境变量的场景，可能需要等待后续版本的环境变量配置功能
3. 建议在测试环境中充分验证后再投入生产使用

最佳实践建议

1. 将常用脚本集中管理在根目录的脚本文件中
2. 为不同环境创建独立的全局变量配置
3. 在团队内部建立脚本命名规范
4. 为复杂脚本添加详细的描述信息

通过合理使用Terramate的脚本功能，可以显著提升多云环境下的基础设施管理效率，减少人为操作错误。