Terragrunt Atlantis Config locals配置详解：自定义工作流、应用要求与依赖管理

Terragrunt Atlantis Config locals配置详解：自定义工作流、应用要求与依赖管理

【免费下载链接】terragrunt-atlantis-configGenerate Atlantis config for Terragrunt projects.项目地址: https://gitcode.com/gh_mirrors/te/terragrunt-atlantis-config

Terragrunt Atlantis Config是一款专为Terragrunt项目生成Atlantis配置的实用工具，能帮助开发者轻松管理基础设施即代码的工作流。通过locals配置，你可以灵活定义工作流、设置应用要求和管理依赖关系，提升团队协作效率和部署质量。

一、locals配置基础：什么是locals及核心作用

在Terragrunt配置中，locals块用于定义可复用的变量和表达式，是实现配置逻辑复用的核心机制。通过locals，你可以集中管理Atlantis工作流相关的配置参数，实现配置的模块化和标准化。

典型的locals定义格式如下：

locals { # 配置参数定义 parameter_name = value_expression }

在项目中，locals配置文件通常与terragrunt.hcl一同存放在模块目录中，例如test_examples/project_hcl_with_atlantis_locals/terragrunt.hcl。

二、自定义工作流：使用atlantis_workflow控制部署流程

2.1 工作流定义基础

通过atlantis_workflow局部变量，你可以为不同环境或模块指定自定义工作流，实现差异化的部署流程控制。这对于多环境部署场景尤为重要，例如生产环境可能需要更严格的审批流程，而开发环境则可以简化流程以提高迭代速度。

2.2 父模块定义与子模块继承

工作流配置支持继承机制，你可以在父模块中定义通用工作流，子模块根据需要继承或覆盖。这种设计极大地提高了配置的复用性和维护性。

父模块定义工作流：

locals { atlantis_workflow = "workflowSpecifiedInParent" }

示例来源：test_examples/parent_with_workflow_local/terragrunt.hcl

子模块继承工作流： 子模块只需通过include块引用父模块配置，即可继承父模块定义的工作流，无需重复编写配置代码。

三、应用要求配置：使用atlantis_apply_requirements控制部署条件

3.1 应用要求基础配置

atlantis_apply_requirements局部变量用于定义应用部署前必须满足的条件，是保障部署安全的重要机制。通过配置不同的要求，你可以控制Atlantis在什么条件下允许执行apply操作。

3.2 常用应用要求参数

Atlantis支持多种应用要求参数，常用的包括：

• mergeable：要求PR必须可合并（无冲突）
• approved：要求PR必须经过审批
• plan_success：要求计划执行成功

3.3 子模块覆盖父模块要求

子模块可以根据自身需求覆盖父模块定义的应用要求，实现更细粒度的控制。例如，生产环境模块可以增加审批要求，而开发环境模块可以简化要求以提高效率。

子模块覆盖示例：

locals { atlantis_apply_requirements = ["mergeable"] }

示例来源：test_examples/apply_requirements_overrides/child_that_overrides/terragrunt.hcl

四、依赖管理：使用extra_atlantis_dependencies定义模块依赖

4.1 依赖管理的重要性

在复杂的基础设施项目中，模块之间往往存在依赖关系。正确定义依赖关系可以确保Atlantis按正确顺序执行计划和应用操作，避免因依赖未满足而导致的部署失败。

4.2 定义依赖的方法

通过extra_atlantis_dependencies局部变量，你可以明确指定当前模块依赖的其他配置文件或模块。Terragrunt会自动处理这些依赖关系，确保部署顺序的正确性。

依赖定义示例：

locals { extra_atlantis_dependencies = [ find_in_parent_folders("account.hcl"), find_in_parent_folders("region.hcl"), find_in_parent_folders("env.hcl"), ] }

示例来源：test_examples/project_hcl_with_atlantis_locals/terragrunt.hcl

4.3 依赖文件的加载与使用

定义依赖后，你可以通过read_terragrunt_config函数加载依赖文件中的配置，并在当前模块中引用这些配置值，实现配置的集中管理和复用。

加载依赖配置示例：

locals { # 自动加载账户级变量 account_vars = read_terragrunt_config(find_in_parent_folders("account.hcl")) # 提取所需变量以便轻松访问 account_name = local.account_vars.locals.account_name account_id = local.account_vars.locals.aws_account_id }

示例来源：test_examples/project_hcl_with_atlantis_locals/terragrunt.hcl

五、实战技巧：locals配置最佳实践

5.1 配置分层与继承

建议采用分层配置策略，在不同层级（如账户、区域、环境）的父模块中定义通用locals配置，子模块通过继承机制复用这些配置。这种方式可以减少重复代码，提高配置的一致性和可维护性。

5.2 变量命名规范

为提高代码可读性，建议为locals变量采用清晰的命名规范，例如：

• 以atlantis_为前缀的变量专用于Atlantis配置
• 使用描述性名称，明确变量用途
• 采用小写字母和下划线的命名风格

5.3 常用配置组合示例

完整配置示例：

locals { # 工作流配置 atlantis_workflow = "production" # 应用要求 atlantis_apply_requirements = ["mergeable", "approved", "plan_success"] # 依赖管理 extra_atlantis_dependencies = [ find_in_parent_folders("account.hcl"), find_in_parent_folders("region.hcl"), find_in_parent_folders("env.hcl"), ] # 变量加载与提取 account_vars = read_terragrunt_config(find_in_parent_folders("account.hcl")) region_vars = read_terragrunt_config(find_in_parent_folders("region.hcl")) environment_vars = read_terragrunt_config(find_in_parent_folders("env.hcl")) account_name = local.account_vars.locals.account_name aws_region = local.region_vars.locals.aws_region }

六、总结：提升Terragrunt与Atlantis协作效率

通过灵活配置locals块，你可以充分发挥Terragrunt与Atlantis的协同优势，实现工作流自定义、应用要求控制和依赖管理的精细化配置。合理的locals配置不仅能提高部署效率，还能增强基础设施代码的可维护性和安全性。

建议从项目初期就建立清晰的locals配置策略，充分利用配置继承和模块化特性，为后续的扩展和维护奠定良好基础。随着项目复杂度的增长，这些配置将成为保障基础设施稳定部署的关键因素。

要开始使用Terragrunt Atlantis Config，你可以通过以下命令克隆仓库：

git clone https://gitcode.com/gh_mirrors/te/terragrunt-atlantis-config

【免费下载链接】terragrunt-atlantis-configGenerate Atlantis config for Terragrunt projects.项目地址: https://gitcode.com/gh_mirrors/te/terragrunt-atlantis-config