Terragrunt中run-all plan命令在子目录使用时的问题解析

问题背景

在基础设施即代码(IaC)工具Terragrunt的使用过程中，用户发现当在子目录(leaf directory)执行run-all plan命令并配合--terragrunt-out-dir参数时，会出现文件系统权限错误。这个问题特别值得关注，因为它影响了Terragrunt在多模块环境下的计划输出功能。

问题现象

当用户在Terragrunt项目结构的子目录中执行以下命令时：

terragrunt run-all plan --terragrunt-out-dir test

系统会报错：

Error: Failed to write plan file
The plan file could not be written: open github-actions-openid-connect-provider/tfplan.tfplan: no such file or directory.

这个问题不仅出现在子目录执行时，有用户报告在根目录执行类似命令也会遇到类似问题，只是错误路径稍有不同。

问题本质分析

经过深入分析，这个问题源于Terragrunt在处理相对路径和绝对路径时的行为不一致。具体表现为：

1. 路径解析不一致：当使用相对路径指定工作目录(--terragrunt-working-dir)时，Terragrunt会将所有模块的计划文件输出到同一个路径下，导致文件覆盖
2. 绝对路径行为正确：而当使用绝对路径指定工作目录时，Terragrunt能够正确地为每个模块创建独立的输出目录
3. 子目录执行问题：在子目录执行时，Terragrunt无法正确构建输出目录的相对路径结构

技术解决方案

针对这个问题，社区在Terragrunt v0.68.6版本中进行了修复。修复方案主要涉及：

1. 改进了路径处理逻辑，确保无论使用相对路径还是绝对路径，都能正确构建输出目录结构
2. 增强了错误处理机制，当路径解析出现问题时能给出更明确的错误提示
3. 确保在多模块环境下，每个模块的计划文件都能被正确输出到指定目录的相应子目录中

临时解决方案

在修复版本发布前，用户可以采用以下临时解决方案：

1. 使用绝对路径：在执行命令时，使用绝对路径指定工作目录和输出目录
2. 自定义输出路径：通过extra_arguments为每个模块指定明确的计划文件输出路径

extra_arguments "set_tf_plan_out" {
  commands = ["plan"]
  arguments = ["-out", "${get_repo_root()}/.terraform/terragrunt_plans/${basename(get_original_terragrunt_dir())}.tfplan"]
}

extra_arguments "set_tf_plan" {
  commands = ["apply"]
  arguments = ["${get_repo_root()}/.terraform/terragrunt_plans/${basename(get_original_terragrunt_dir())}.tfplan"]
}

最佳实践建议

1. 避免在子目录使用run-all：在单个模块目录下，直接使用terragrunt plan而非terragrunt run-all plan
2. 统一使用绝对路径：特别是在自动化脚本中，建议始终使用绝对路径指定工作目录和输出目录
3. 及时升级版本：使用v0.68.6或更高版本以获得修复后的稳定行为

总结

Terragrunt作为Terraform的包装工具，在处理复杂目录结构和多模块场景时提供了极大便利。这次遇到的问题提醒我们，在使用高级功能时需要注意路径解析的细节。通过理解问题本质、应用修复方案或临时解决方案，用户可以确保基础设施代码的计划和部署过程更加可靠。