尧图网页设计 
Terragrunt exec 命令完全指南在 OpenTofu/Terraform 工作流中编排任意命令【免费下载链接】terragruntTerragrunt is a flexible orchestration tool that allows Infrastructure as Code written in OpenTofu/Terraform to scale.项目地址: https://gitcode.com/GitHub_Trending/te/terragrunt导读terragrunt exec是 Terragrunt 提供的一个高度灵活的命令它允许你在不强制调用 OpenTofu/Terraform 的前提下将任意命令包一层交由 Terragrunt 编排执行。通过它你既能保留 Terragrunt 的依赖解析dependency resolution、inputs 注入等核心能力又能完全掌控被编排的进程本身。读完本文你将掌握exec与run的差异、命令的基本与进阶用法、全部相关命令行参数以及它背后的源码执行链路。一、命令定位与核心差异execvsrun1.1 为什么需要execTerragrunt 官方文档exec.mdx对这一命令的定位描述得非常清晰与run命令始终会调用 OpenTofu/Terraform 不同exec命令允许通过 Terragrunt 执行任意命令。这种差异带来的核心价值在于当你需要编排的并不是一次 IaC 操作而是一个自定义脚本、一个 CLI 工具如aws s3 ls、或者一条文件检查命令时exec让你可以在不退出 Terragrunt 上下文的情况下完成这些操作同时依然享受 Terragrunt 的配置解析、inputs 注入、依赖解析等能力。1.2 适用场景从源码与文档中可以归纳出exec的典型使用场景在 Unit 目录下执行任意 CLI 工具如 AWS CLI复用 Terragrunt 解析出的环境上下文检查/调试模块下载目录中的真实源码文件配合--in-download-dir在依赖解析完成后、目标命令执行前运行自定义的编排逻辑将 Terragrunt 视为一个带 IaC 上下文的进程编排器完全控制被编排进程。二、基本用法与命令行参数2.1 语法exec命令的语法定义于 cli.go为terragrunt exec [options] -- command命令本身提供了两个官方示例见 exec.mdx# 通过 Terragrunt 执行 echo terragrunt exec -- echo Hello, Terragrunt! # 查看模块对应 Unit 的 main.tf 文件在下载目录中执行 terragrunt exec --in-download-dir -- cat main.tf2.2--分隔符与省略形式从 cli.go 的实现可以看到参数解析逻辑用户显式使用--BuiltinCmdSep分隔 Terragrunt 自身参数与目标命令若未提供--例如terragrunt exec lsTerragrunt 会将剩余的未指定参数全部当作目标命令若最终没有任何命令参数则展示命令帮助信息ShowCommandHelp。也就是说--是推荐的、无歧义的写法但省略--的简写形式同样受支持。2.3 支持的 Flags 总览根据 exec.mdx 的声明exec命令支持以下 FlagsFlag类型说明--auth-provider-cmdstring认证提供方命令用于发现云厂商认证如 AWS--configstring指定 Terragrunt 配置文件路径--download-dirstring模块下载目录路径--iam-assume-rolestring执行命令时扮演的 IAM 角色 ARN--iam-assume-role-durationstring角色会话持续时间--iam-assume-role-session-namestring角色会话名称--iam-assume-role-web-identity-tokenstring用于角色扮演的 Web 身份令牌--in-download-dirbool在下载目录中执行命令--inputs-debugbool调试 inputs 的传递与解析这些 Flags 的注册逻辑位于 cli.go其中--config、--download-dir、--tf-path、--auth-provider-cmd、--inputs-debug以及一组 IAM Assume Role 相关的 Flag 来自共享 Flagshared包而--in-download-dir是exec命令独有的布尔 Flag对应内部结构体字段Options.InDownloadDir见 options.go。2.4 环境变量支持文档体系中的 Flag 均支持通过环境变量覆盖。以--in-download-dir为例其对应环境变量为TG_IN_DOWNLOAD_DIR见 in-download-dir.mdx。同样地exec使用的其余共享 Flag 也遵循TG_*环境变量命名惯例由cli.go中的tgPrefix.EnvVars(...)机制生成方便在 CI/CD 流水线中通过环境变量注入参数。三、核心特性一与配置交互inputs 注入3.1 与run几乎一致的配置上下文官方文档exec.mdx明确说明使用exec时你将获得与run几乎完全一致的配置上下文包括 inputs。这意味着terragrunt.hcl中定义的所有inputs都会被转换为TF_VAR_*环境变量注入到目标命令的环境中。配置示例# terragrunt.hcl inputs { message Hello, Terragrunt! }运行以下命令即可验证message输入已注入目标命令$ terragrunt exec -- env | grep TF_VAR_message TF_VAR_messageHello, Terragrunt!3.2 源码级验证inputs 的注入链路这一行为在源码中有完整的实现链路。在 exec.go 的Run函数中exec按顺序执行如下准备阶段prepare.PrepareConfig解析并合并 Terragrunt 配置含依赖的inputsprepare.PrepareSource如有source配置则下载源码prepare.PrepareGenerate生成渲染配置把模板化的 HCL 展开为最终形态根据是否使用--in-download-dir分岔未指定时PrepareInputsAsEnvVars将 inputs 设置为环境变量见 prepare.go 中的SetTerragruntInputsAsEnvVars指定时走PrepareInit路径除注入 inputs 外还会按需执行terraform init见 prepare.go。正是因为PrepareInputsAsEnvVars的存在exec才能让目标命令像run一样直接读取到TF_VAR_*环境变量这是exec与裸执行 shell 命令最本质的区别。四、核心特性二--in-download-dir深入解析4.1 行为差异--in-download-dir是exec最实用的独有参数。根据 in-download-dir.mdx 的说明启用后 Terragrunt 会在模块被缓存的临时下载目录中执行命令而不是当前工作目录。这特别适用于检查下载后的模块内容针对实际模块源码执行命令调试下载模块时遇到的问题。官方补充示例# 查看下载模块中的 main.tf 内容 terragrunt exec --in-download-dir -- cat main.tf # 列出下载模块中的所有文件 terragrunt exec --in-download-dir -- ls -la4.2 源码级验证工作目录与 init 行为在 exec.go 的runTargetCommand中工作目录的选择逻辑一目了然指定--in-download-dir时目标命令在opts.WorkingDir即模块下载/缓存目录中执行未指定时在opts.RootWorkingDir根工作目录中执行。同时正如上文 3.2 节所述是否指定该 Flag 还直接决定了准备阶段是否执行terraform init指定时走PrepareInit会先CheckFolderContainsTerraformCode校验目录包含 Terraform 代码再执行SetTerragruntInputsAsEnvVars与PrepareNonInitCommand完成 init未指定时则跳过 init仅注入环境变量。因此如果你要在下载目录中对真实模块源码执行操作如cat main.tf、ls -la--in-download-dir是必要前提——它保证了模块源码已就位且依赖已初始化。五、目标命令的执行方式与 Hooks 支持5.1 基于 shell 的真实进程执行exec不是模拟命令而是真正派生一个 shell 子进程来运行目标命令。在 exec.go 中目标命令通过shell.RunCommandWithOutput执行参数包括目标命令名称args.CommandName()与后续参数args.Tail()目标工作目录完整环境v.Env与 Terragrunt 选项转换出的 shell 运行参数configbridge.ShellRunOptsFromOpts。执行出错时返回的错误会带上目标目录信息failed to run command in directory %s便于定位问题。5.2 与 Hooks / after-hooks 的协作值得注意的实现细节是runTargetCommand最终通过run.RunActionWithHooks来运行目标命令。这意味着exec的执行同样会经过 Terragrunt 的 Hooks 机制包括 before/after hooks 的编排你为 Unit 配置的 hooks 在exec场景下依然生效从而保证命令执行前后的钩子行为与run保持一致。5.3 错误处理与退出码当目标命令执行失败时exec会包装错误并向上返回该错误最终由 Terragrunt 的 CLI 错误处理机制统一呈现。此外由于exec是真实进程执行目标命令自身的退出状态会通过 Terragrunt 的退出码体系传播给调用方便于在 CI 脚本中直接根据退出码判断成败。六、完整实战示例6.1 读取 inputs 并执行自定义命令# terragrunt.hcl inputs { message Hello, Terragrunt! } # 查看注入的变量 terragrunt exec -- env | grep TF_VAR_message # TF_VAR_messageHello, Terragrunt! # 在依赖解析后的环境中运行 AWS CLI terragrunt exec -- aws s3 ls6.2 调试下载的模块源码# 查看当前 Unit 实际下载的模块的 main.tf terragrunt exec --in-download-dir -- cat main.tf # 列出模块下载目录内容 terragrunt exec --in-download-dir -- ls -la6.3 简化写法省略--# 等价于 terragrunt exec -- echo hi terragrunt exec echo hi七、延伸阅读若希望继续深入了解相关机制可以在本仓库中查看以下资源命令声明与 Flags 注册internal/cli/commands/exec/cli.go执行链路核心实现internal/cli/commands/exec/exec.go配置准备与 inputs 注入PrepareConfig/PrepareSource/PrepareGenerate/PrepareInputsAsEnvVars/PrepareInit均位于 internal/prepare/prepare.go命令文档数据源docs/src/data/commands/exec.mdx 与 docs/src/data/flags/in-download-dir.mdx与exec对照理解的run命令文档位于docs/src/data/commands/目录下同名文件中。总结terragrunt exec是 Terragrunt 中编排任意命令的入口它复用 Terragrunt 的配置解析、依赖解析、inputs 注入与 Hooks 机制却把进程本身的选择权完全交还给用户。无论是读取注入的TF_VAR_*环境变量、在模块下载目录中调试真实源码还是在 IaC 上下文中运行自定义 CLI 工具exec都提供了比run更灵活、比裸 shell 更懂 Terragrunt的中间地带。掌握它你的 Terragrunt 工作流将不再局限于 OpenTofu/Terraform 本身。【免费下载链接】terragruntTerragrunt is a flexible orchestration tool that allows Infrastructure as Code written in OpenTofu/Terraform to scale.项目地址: https://gitcode.com/GitHub_Trending/te/terragrunt创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考 Terragrunt exec 命令完全指南：在 OpenTofu/Terraform 工作流中编排任意命令
Terragrunt exec 命令完全指南在 OpenTofu/Terraform 工作流中编排任意命令【免费下载链接】terragruntTerragrunt is a flexible orchestration tool that allows Infrastructure as Code written in OpenTofu/Terraform to scale.项目地址: https://gitcode.com/GitHub_Trending/te/terragrunt导读terragrunt exec是 Terragrunt 提供的一个高度灵活的命令它允许你在不强制调用 OpenTofu/Terraform 的前提下将任意命令包一层交由 Terragrunt 编排执行。通过它你既能保留 Terragrunt 的依赖解析dependency resolution、inputs 注入等核心能力又能完全掌控被编排的进程本身。读完本文你将掌握exec与run的差异、命令的基本与进阶用法、全部相关命令行参数以及它背后的源码执行链路。一、命令定位与核心差异execvsrun1.1 为什么需要execTerragrunt 官方文档exec.mdx对这一命令的定位描述得非常清晰与run命令始终会调用 OpenTofu/Terraform 不同exec命令允许通过 Terragrunt 执行任意命令。这种差异带来的核心价值在于当你需要编排的并不是一次 IaC 操作而是一个自定义脚本、一个 CLI 工具如aws s3 ls、或者一条文件检查命令时exec让你可以在不退出 Terragrunt 上下文的情况下完成这些操作同时依然享受 Terragrunt 的配置解析、inputs 注入、依赖解析等能力。1.2 适用场景从源码与文档中可以归纳出exec的典型使用场景在 Unit 目录下执行任意 CLI 工具如 AWS CLI复用 Terragrunt 解析出的环境上下文检查/调试模块下载目录中的真实源码文件配合--in-download-dir在依赖解析完成后、目标命令执行前运行自定义的编排逻辑将 Terragrunt 视为一个带 IaC 上下文的进程编排器完全控制被编排进程。二、基本用法与命令行参数2.1 语法exec命令的语法定义于 cli.go为terragrunt exec [options] -- command命令本身提供了两个官方示例见 exec.mdx# 通过 Terragrunt 执行 echo terragrunt exec -- echo Hello, Terragrunt! # 查看模块对应 Unit 的 main.tf 文件在下载目录中执行 terragrunt exec --in-download-dir -- cat main.tf2.2--分隔符与省略形式从 cli.go 的实现可以看到参数解析逻辑用户显式使用--BuiltinCmdSep分隔 Terragrunt 自身参数与目标命令若未提供--例如terragrunt exec lsTerragrunt 会将剩余的未指定参数全部当作目标命令若最终没有任何命令参数则展示命令帮助信息ShowCommandHelp。也就是说--是推荐的、无歧义的写法但省略--的简写形式同样受支持。2.3 支持的 Flags 总览根据 exec.mdx 的声明exec命令支持以下 FlagsFlag类型说明--auth-provider-cmdstring认证提供方命令用于发现云厂商认证如 AWS--configstring指定 Terragrunt 配置文件路径--download-dirstring模块下载目录路径--iam-assume-rolestring执行命令时扮演的 IAM 角色 ARN--iam-assume-role-durationstring角色会话持续时间--iam-assume-role-session-namestring角色会话名称--iam-assume-role-web-identity-tokenstring用于角色扮演的 Web 身份令牌--in-download-dirbool在下载目录中执行命令--inputs-debugbool调试 inputs 的传递与解析这些 Flags 的注册逻辑位于 cli.go其中--config、--download-dir、--tf-path、--auth-provider-cmd、--inputs-debug以及一组 IAM Assume Role 相关的 Flag 来自共享 Flagshared包而--in-download-dir是exec命令独有的布尔 Flag对应内部结构体字段Options.InDownloadDir见 options.go。2.4 环境变量支持文档体系中的 Flag 均支持通过环境变量覆盖。以--in-download-dir为例其对应环境变量为TG_IN_DOWNLOAD_DIR见 in-download-dir.mdx。同样地exec使用的其余共享 Flag 也遵循TG_*环境变量命名惯例由cli.go中的tgPrefix.EnvVars(...)机制生成方便在 CI/CD 流水线中通过环境变量注入参数。三、核心特性一与配置交互inputs 注入3.1 与run几乎一致的配置上下文官方文档exec.mdx明确说明使用exec时你将获得与run几乎完全一致的配置上下文包括 inputs。这意味着terragrunt.hcl中定义的所有inputs都会被转换为TF_VAR_*环境变量注入到目标命令的环境中。配置示例# terragrunt.hcl inputs { message Hello, Terragrunt! }运行以下命令即可验证message输入已注入目标命令$ terragrunt exec -- env | grep TF_VAR_message TF_VAR_messageHello, Terragrunt!3.2 源码级验证inputs 的注入链路这一行为在源码中有完整的实现链路。在 exec.go 的Run函数中exec按顺序执行如下准备阶段prepare.PrepareConfig解析并合并 Terragrunt 配置含依赖的inputsprepare.PrepareSource如有source配置则下载源码prepare.PrepareGenerate生成渲染配置把模板化的 HCL 展开为最终形态根据是否使用--in-download-dir分岔未指定时PrepareInputsAsEnvVars将 inputs 设置为环境变量见 prepare.go 中的SetTerragruntInputsAsEnvVars指定时走PrepareInit路径除注入 inputs 外还会按需执行terraform init见 prepare.go。正是因为PrepareInputsAsEnvVars的存在exec才能让目标命令像run一样直接读取到TF_VAR_*环境变量这是exec与裸执行 shell 命令最本质的区别。四、核心特性二--in-download-dir深入解析4.1 行为差异--in-download-dir是exec最实用的独有参数。根据 in-download-dir.mdx 的说明启用后 Terragrunt 会在模块被缓存的临时下载目录中执行命令而不是当前工作目录。这特别适用于检查下载后的模块内容针对实际模块源码执行命令调试下载模块时遇到的问题。官方补充示例# 查看下载模块中的 main.tf 内容 terragrunt exec --in-download-dir -- cat main.tf # 列出下载模块中的所有文件 terragrunt exec --in-download-dir -- ls -la4.2 源码级验证工作目录与 init 行为在 exec.go 的runTargetCommand中工作目录的选择逻辑一目了然指定--in-download-dir时目标命令在opts.WorkingDir即模块下载/缓存目录中执行未指定时在opts.RootWorkingDir根工作目录中执行。同时正如上文 3.2 节所述是否指定该 Flag 还直接决定了准备阶段是否执行terraform init指定时走PrepareInit会先CheckFolderContainsTerraformCode校验目录包含 Terraform 代码再执行SetTerragruntInputsAsEnvVars与PrepareNonInitCommand完成 init未指定时则跳过 init仅注入环境变量。因此如果你要在下载目录中对真实模块源码执行操作如cat main.tf、ls -la--in-download-dir是必要前提——它保证了模块源码已就位且依赖已初始化。五、目标命令的执行方式与 Hooks 支持5.1 基于 shell 的真实进程执行exec不是模拟命令而是真正派生一个 shell 子进程来运行目标命令。在 exec.go 中目标命令通过shell.RunCommandWithOutput执行参数包括目标命令名称args.CommandName()与后续参数args.Tail()目标工作目录完整环境v.Env与 Terragrunt 选项转换出的 shell 运行参数configbridge.ShellRunOptsFromOpts。执行出错时返回的错误会带上目标目录信息failed to run command in directory %s便于定位问题。5.2 与 Hooks / after-hooks 的协作值得注意的实现细节是runTargetCommand最终通过run.RunActionWithHooks来运行目标命令。这意味着exec的执行同样会经过 Terragrunt 的 Hooks 机制包括 before/after hooks 的编排你为 Unit 配置的 hooks 在exec场景下依然生效从而保证命令执行前后的钩子行为与run保持一致。5.3 错误处理与退出码当目标命令执行失败时exec会包装错误并向上返回该错误最终由 Terragrunt 的 CLI 错误处理机制统一呈现。此外由于exec是真实进程执行目标命令自身的退出状态会通过 Terragrunt 的退出码体系传播给调用方便于在 CI 脚本中直接根据退出码判断成败。六、完整实战示例6.1 读取 inputs 并执行自定义命令# terragrunt.hcl inputs { message Hello, Terragrunt! } # 查看注入的变量 terragrunt exec -- env | grep TF_VAR_message # TF_VAR_messageHello, Terragrunt! # 在依赖解析后的环境中运行 AWS CLI terragrunt exec -- aws s3 ls6.2 调试下载的模块源码# 查看当前 Unit 实际下载的模块的 main.tf terragrunt exec --in-download-dir -- cat main.tf # 列出模块下载目录内容 terragrunt exec --in-download-dir -- ls -la6.3 简化写法省略--# 等价于 terragrunt exec -- echo hi terragrunt exec echo hi七、延伸阅读若希望继续深入了解相关机制可以在本仓库中查看以下资源命令声明与 Flags 注册internal/cli/commands/exec/cli.go执行链路核心实现internal/cli/commands/exec/exec.go配置准备与 inputs 注入PrepareConfig/PrepareSource/PrepareGenerate/PrepareInputsAsEnvVars/PrepareInit均位于 internal/prepare/prepare.go命令文档数据源docs/src/data/commands/exec.mdx 与 docs/src/data/flags/in-download-dir.mdx与exec对照理解的run命令文档位于docs/src/data/commands/目录下同名文件中。总结terragrunt exec是 Terragrunt 中编排任意命令的入口它复用 Terragrunt 的配置解析、依赖解析、inputs 注入与 Hooks 机制却把进程本身的选择权完全交还给用户。无论是读取注入的TF_VAR_*环境变量、在模块下载目录中调试真实源码还是在 IaC 上下文中运行自定义 CLI 工具exec都提供了比run更灵活、比裸 shell 更懂 Terragrunt的中间地带。掌握它你的 Terragrunt 工作流将不再局限于 OpenTofu/Terraform 本身。【免费下载链接】terragruntTerragrunt is a flexible orchestration tool that allows Infrastructure as Code written in OpenTofu/Terraform to scale.项目地址: https://gitcode.com/GitHub_Trending/te/terragrunt创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考