cytopia/terraform-docs

Docker镜像：terraform-docs

镜像概述和主要用途

基于Alpine Linux的轻量级多阶段构建Docker镜像，包含https://github.com/terraform-docs/terraform-docs%E5%B7%A5%E5%85%B7%E5%8F%8A%E5%85%B6%E6%89%A9%E5%B1%95%E5%8A%9F%E8%83%BD%60terraform-docs-replace%60%E3%80%82%E8%AF%A5%E5%B7%A5%E5%85%B7%E7%94%A8%E4%BA%8E%E7%94%9F%E6%88%90Terraform%E6%A8%A1%E5%9D%97%E7%9A%84%E6%96%87%E6%A1%A3%EF%BC%8C%E5%B9%B6%E8%83%BD%E5%9C%A8%E6%96%87%E4%BB%B6%E4%B8%AD%E8%87%AA%E5%8A%A8%E5%AE%89%E5%85%A8%E5%9C%B0%E6%9B%BF%E6%8D%A2%E7%94%9F%E6%88%90%E7%9A%84%E6%96%87%E6%A1%A3%E5%86%85%E5%AE%B9%E3%80%82%E9%95%9C%E5%83%8F%E6%94%AF%E6%8C%81%E5%A4%9A%E6%9E%B6%E6%9E%84%EF%BC%8C%E6%8F%90%E4%BE%9B%E5%A4%9A%E4%B8%AA%E7%A8%B3%E5%AE%9A%E7%89%88%E6%9C%AC%EF%BC%8C%E6%AF%8F%E6%97%A5%E6%9E%84%E5%BB%BA%E5%B9%B6%E6%8E%A8%E9%80%81%E5%88%B0Docker Hub，兼容Terraform >=0.12，适用于CI/CD和自动化文档生成场景。

核心功能和特性

• 轻量级基础：基于Alpine Linux，镜像体积小，资源占用低
• 多架构支持：兼容amd64、i386、arm64、arm/v7、arm/v6（不同版本架构支持可能不同）
• 多版本支持：提供多个terraform-docs版本标签，满足不同项目需求
• 自动替换功能：集成terraform-docs-replace，可在文件中指定分隔符之间自动更新文档块
• Terraform兼容性：支持Terraform >=0.12（通过terraform-docs-012命令）和旧版本（terraform-docs命令）

可用版本

滚动发布版本（每日更新）

固定发布版本（一次性构建）

环境变量

Docker挂载

容器内工作目录为/data/，需将本地Terraform模块所在目录挂载到此路径，以便工具访问模块文件：

bash
-v $(pwd):/data

使用方法

通用用法

bash
Usage: cytopia/terraform-docs terraform-docs <ARGS> .
       cytopia/terraform-docs terraform-docs-012 <ARGS> .

       cytopia/terraform-docs terraform-docs-replace <ARGS> <PATH-TO-FILE>
       cytopia/terraform-docs terraform-docs-replace-012 <ARGS> <PATH-TO-FILE>

terraform-docs              标准terraform-docs输出（适用于Terraform <0.12）
terraform-docs-012          适用于Terraform >=0.12的terraform-docs输出
terraform-docs-replace      在文件中替换文档块（适用于Terraform <0.12）
terraform-docs-replace-012  在文件中替换文档块（适用于Terraform >=0.12）
<ARGS>                      terraform-docs支持的所有参数
<PATH-TO-FILE>              要替换文档块的文件路径

输出到stdout

生成Markdown格式文档并输出到标准输出：

bash
# [Terraform < 0.12]
docker run --rm \
  -v $(pwd):/data \
  cytopia/terraform-docs \
  terraform-docs --sort-by-required md .

# [Terraform >= 0.12]
docker run --rm \
  -v $(pwd):/data \
  cytopia/terraform-docs \
  terraform-docs-012 --sort-by-required md .

存储到文件

将生成的文档保存到文件（如README.md）：

bash
# [Terraform < 0.12]
docker run --rm \
  -v $(pwd):/data \
  cytopia/terraform-docs \
  terraform-docs --sort-by-required md . > README.md

# [Terraform >= 0.12]
docker run --rm \
  -v $(pwd):/data \
  cytopia/terraform-docs \
  terraform-docs-012 --sort-by-required md . > README.md

替换文件中的文档块

在现有文件（如README.md）中替换文档块，需确保文件中包含默认分隔符：

markdown
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
## Inputs
...
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

执行替换命令：

bash
# [Terraform < 0.12]
docker run --rm \
  -v $(pwd):/data \
  cytopia/terraform-docs \
  terraform-docs-replace --sort-by-required md README.md

# [Terraform >= 0.12]
docker run --rm \
  -v $(pwd):/data \
  cytopia/terraform-docs \
  terraform-docs-replace-012 --sort-by-required md README.md

使用自定义分隔符

通过环境变量自定义分隔符，例如INFO.md中使用<!-- TFDOC_START -->和<!-- TFDOC_END -->：

bash
# [Terraform < 0.12]
docker run --rm \
  -v $(pwd):/data \
  -e DELIM_START='<!-- TFDOC_START -->' \
  -e DELIM_CLOSE='<!-- TFDOC_END -->' \
  cytopia/terraform-docs \
  terraform-docs-replace --sort-by-required md INFO.md

# [Terraform >= 0.12]
docker run --rm \
  -v $(pwd):/data \
  -e DELIM_START='<!-- TFDOC_START -->' \
  -e DELIM_CLOSE='<!-- TFDOC_END -->' \
  cytopia/terraform-docs \
  terraform-docs-replace-012 --sort-by-required md INFO.md

示例项目

以下项目展示了如何在CI中使用此镜像验证README.md是否更新了最新文档：

• https://github.com/cytopia/terraform-aws-rds/blob/master/Makefile
• https://github.com/Flaconi/terraform-aws-microservice/blob/master/Makefile

相关项目

Docker镜像

以下是相关的CI工具Docker镜像，可用于代码分析和自动化测试：