terraform-docs

packaged by Chainguard

Chainguard Container for terraform-docs

terraform-docs generates documentation from Terraform modules in various output formats.

Chainguard Containers are regularly-updated, secure-by-default container images.

Download this Container Image

For those with access, this container image is available on cgr.dev:

docker pull cgr.dev/ORGANIZATION/terraform-docs:latest

Be sure to replace the ORGANIZATION placeholder with the name used for your organization's private repository within the Chainguard Registry.

Compatibility Notes

This image is built from the Wolfi terraform-docs package, a static Go binary installed at /usr/bin/terraform-docs. As with the upstream quay.io/terraform-docs/terraform-docs image, terraform-docs is the entrypoint, so any arguments you pass to docker run are forwarded to the CLI. The default working directory is /.

Unlike the upstream image, which runs as root, this image runs as the nonroot user (UID 65532) by default and does not include a shell or package manager. The image includes ca-certificates-bundle for HTTPS access.

Getting Started

Check the installed version:

docker run --rm cgr.dev/ORGANIZATION/terraform-docs:latest version

Generate a Markdown table of inputs and outputs for a Terraform module in the current directory:

docker run --rm -v "$(pwd)":/data cgr.dev/ORGANIZATION/terraform-docs:latest markdown table /data

Produce machine-readable JSON output:

docker run --rm -v "$(pwd)":/data cgr.dev/ORGANIZATION/terraform-docs:latest json /data

Updating a README in place

A common CI/CD use case is injecting generated documentation into a module's README.md between <!-- BEGIN_TF_DOCS --> and <!-- END_TF_DOCS --> markers. Because this writes to the mounted directory, the directory must be writable by the container user. Either run the container with your own UID, or make the directory writable by UID 65532:

docker run --rm -u "$(id -u)" -v "$(pwd)":/data \
  cgr.dev/ORGANIZATION/terraform-docs:latest \
  markdown table --output-file README.md --output-mode inject /data

Configuration

terraform-docs reads a .terraform-docs.yml configuration file from the module directory, or from a path passed with -c:

docker run --rm -v "$(pwd)":/data cgr.dev/ORGANIZATION/terraform-docs:latest -c /data/.terraform-docs.yml /data

When generated output goes to stdout, the image works with a read-only root filesystem and a read-only module mount (--read-only -v "$(pwd)":/data:ro).

Documentation and Resources

• terraform-docs documentation
• terraform-docs on GitHub

terraform-docs is licensed under the MIT License.

What are Chainguard Containers?

Chainguard's free tier of Starter container images are built with Wolfi, our minimal Linux undistro.

All other Chainguard Containers are built with Chainguard OS, Chainguard's minimal Linux operating system designed to produce container images that meet the requirements of a more secure software supply chain.

The main features of Chainguard Containers include:

• Minimal design, without unnecessary software bloat
• Daily builds to ensure container images are up-to-date with available security patches
• High quality build-time SBOMs attesting to the provenance of all artifacts within the image
• Verifiable signatures provided by Sigstore
• Reproducible builds with Cosign and apko (read more about reproducibility)

For cases where you need container images with shells and package managers to build or debug, most Chainguard Containers come paired with a development, or -dev, variant.

In all other cases, including Chainguard Containers tagged as :latest or with a specific version number, the container images include only an open-source application and its runtime dependencies. These minimal container images typically do not contain a shell or package manager.

Although the -dev container image variants have similar security features as their more minimal versions, they include additional software that is typically not necessary in production environments. We recommend using multi-stage builds to copy artifacts from the -dev variant into a more minimal production image.

Need additional packages?

To improve security, Chainguard Containers include only essential dependencies. Need more packages? Chainguard customers can use Custom Assembly to add packages, either through the Console, chainctl, or API.

To use Custom Assembly in the Chainguard Console: navigate to the image you'd like to customize in your Organization's list of images, and click on the Customize image button at the top of the page.

Learn More

Refer to our Chainguard Containers documentation on Chainguard Academy. Chainguard also offers VMs and Libraries — contact us for access.

Trademarks

This software listing is packaged by Chainguard. The trademarks set forth in this offering are owned by their respective companies, and use of them does not imply any affiliation, sponsorship, or endorsement by such companies.