Terragrunt 嵌套栈生成失败问题分析与解决方案

问题现象

在使用 Terragrunt 的栈功能时，尝试生成一个三级嵌套的栈结构时遇到了问题。预期的目录结构应该是：

terragrunt.stack.hcl
    └── stack level 1
           └── stack level2
                   └── unit unit1

但在实际操作中，执行 terragrunt stack generate 命令时出现了以下问题：

1. 第一次运行时，命令错误地尝试创建多个重复的栈和单元
2. 第二次运行时，出现关于无法删除清单文件的警告
3. 第三次运行时，最终报错："Failed to copy... gob: bad data: field numbers out of bounds"

问题根源分析

经过深入研究，这个问题主要源于 Terragrunt 栈生成机制在处理嵌套栈时的两个关键问题：

1. 工作目录问题：当在项目根目录直接运行 terragrunt stack generate 时，Terragrunt 会尝试在当前目录下创建 .terragrunt-stack 文件夹，同时也会处理子目录中的栈定义，这导致了重复处理和路径冲突。

2. 清单文件清理不彻底：terragrunt stack clean 命令无法完全清理所有生成的栈文件，残留的文件会导致后续操作出现问题。

解决方案

正确的做法是将根栈定义文件（terragrunt.stack.hcl）放在一个单独的目录中（如 live 目录），然后在该目录中运行生成命令。这样修改后的目录结构如下：

.
├── live
│   ├── root.hcl
│   └── terragrunt.stack.hcl
├── stacks
│   ├── level1
│   │   └── terragrunt.stack.hcl
│   └── level2
│       └── terragrunt.stack.hcl
└── units
    └── unit1
        └── terragrunt.hcl

最佳实践建议

1. 分离配置和执行环境：始终将栈定义文件与实际基础设施代码分开存放，避免在包含实际代码的目录中直接运行栈命令。

2. 完全清理：在执行生成命令前，确保使用 find . -name .terragrunt-stack -exec rm -rf {} \; 命令彻底清理旧的栈文件，而不仅仅依赖 terragrunt stack clean。

3. 版本控制：将 .terragrunt-stack 目录添加到 .gitignore 文件中，避免将生成的栈文件提交到版本控制系统中。

4. 调试技巧：当遇到问题时，可以添加 --terragrunt-log-level debug 参数获取更详细的日志信息。

总结

Terragrunt 的栈功能为管理复杂的基础设施提供了强大的支持，但在使用嵌套栈时需要特别注意文件结构和执行环境。通过将栈定义文件放在独立目录中执行，可以避免路径冲突和重复处理问题，确保栈生成过程的稳定性和可靠性。