Terragrunt Docker 镜像文档

镜像概述和主要用途

本镜像是 Terragrunt 工具的 Docker 化版本，由 toolhippie 项目维护。Terragrunt 是一款用于简化 Terraform 配置管理的工具，本镜像旨在提供便捷的 Terragrunt 运行环境，适用于各类脚本编写场景，支持基础设施即代码（IaC）相关的自动化任务。

核心功能与特性

• 内置 Terragrunt 工具：镜像预安装 Terragrunt，可直接执行其核心命令（如 init、plan、apply 等）。
• 轻量级基础：基于精简的基础镜像构建，减少资源占用。
• 版本化管理：通过 Docker 镜像标签区分不同版本，用户可按需选择特定版本（详见「版本信息」章节）。
• 灵活的脚本支持：支持挂载外部配置文件和脚本，适配各类自定义脚本编写需求。

使用场景与适用范围

• 基础设施即代码（IaC）管理：配合 Terraform 实现多环境、多模块的配置统一管理。
• 自动化脚本执行：用于编写和运行依赖 Terragrunt 的自动化脚本，简化本地环境配置。
• CI/CD 流程集成：在 CI/CD 管道中执行 Terragrunt 任务（如资源部署、状态检查等），确保环境一致性。
• 多版本隔离：通过不同镜像标签快速切换 Terragrunt 版本，避免本地环境版本冲突。

使用方法与配置说明

前提条件

• 已安装 Docker 引擎（推荐版本 19.03+）。
• 如需持久化数据或挂载配置文件，需准备本地目录或文件。

镜像拉取

可从 DockerHub 或 Quay.io 拉取镜像，默认标签为 latest（最新稳定版）：

# 从 DockerHub 拉取
docker pull toolhippie/terragrunt:latest

# 从 Quay.io 拉取
docker pull quay.io/toolhippie/terragrunt:latest

如需指定版本，将 latest 替换为具体标签（如 v0.45.0，标签列表见「版本信息」章节）。

基本运行命令

1. 检查 Terragrunt 版本

验证镜像是否正常工作：

docker run --rm toolhippie/terragrunt:latest terragrunt --version

2. 执行 Terragrunt 命令

挂载本地 Terraform/Terragrunt 配置文件目录，执行具体命令（如 init）：

# 假设本地配置文件位于当前目录（./terraform）
docker run --rm -v $(pwd)/terraform:/workspace -w /workspace toolhippie/terragrunt:latest terragrunt init

• -v $(pwd)/terraform:/workspace：将本地 ./terraform 目录挂载到容器内 /workspace 目录（工作目录）。
• -w /workspace：设置容器工作目录为 /workspace，确保命令在配置文件目录下执行。

Docker Compose 配置示例

如需在多容器环境中使用，可通过 docker-compose.yml 定义服务：

version: "3.8"
services:
  terragrunt:
    image: toolhippie/terragrunt:latest
    volumes:
      - ./terraform:/workspace  # 挂载本地配置目录
      - ~/.aws:/root/.aws        # 可选：挂载 AWS 凭证（如需云资源访问）
    working_dir: /workspace
    command: ["terragrunt", "plan"]  # 执行的 Terragrunt 命令

启动服务：

docker-compose up

配置说明

• 挂载目录：核心配置文件需通过 -v 挂载至容器内，建议将工作目录设为挂载目录（如示例中的 /workspace）。
• 环境变量：无特殊内置环境变量，可根据需求通过 -e 参数传递自定义变量（如 TF_VAR_* 用于 Terraform 变量）。
• 权限注意：容器内默认使用 root 用户运行，挂载目录需确保本地用户有读写权限，或通过 --user 参数指定用户 ID。

版本信息

镜像版本通过标签管理，所有可用版本可通过以下链接查看：

• DockerHub 标签
• Quay.io 标签

贡献指南

1. Fork 本项目仓库。
2. 提交代码修改（Patch）。
3. 推送（Push）至个人 Fork 仓库。
4. 提交 Pull Request 至原仓库。

作者与许可

作者

• Thomas Boerger (GitHub)

许可协议

本项目基于 MIT 许可证开源。

版权信息

Copyright (c) 2022 Thomas Boerger <[***]>