Skip to content

terraform-docs

Generate documentation from Terraform modules in various output formats

Utility to generate documentation from Terraform modules in various output formats.

devops

https://terraform-docs.io

amd64 arm64 armhf

Installation

1. Add WakeMeOps repository

curl -sSL https://raw.githubusercontent.com/upciti/wakemeops/main/assets/install_repository | sudo bash

2. Install terraform-docs

sudo apt install terraform-docs

Snippets

FROM wakemeops/minideb:bullseye

RUN install_packages \
    terraform-docs=0.16.0*

USER 1001

- name: Install dependencies
  uses: upciti/wakemeops-action@v1
  with:
    packages: |
      terraform-docs=0.16.0*

Download URLs

Version SHA256 Size (KB)
0.16.0 fbc2c29dc46e07909986d9694e7b30dc7f5202e71f11c7cfde883a06a854331b 4158
Version SHA256 Size (KB)
0.16.0 9a9eb60f9a1bb53b876d04aa4a9699a1ba4d1d9d3e76e97d8a6a49a9b6afefb2 3522
Version SHA256 Size (KB)
0.16.0 e77dd51bcbc0df2b870cea80af6ca3aadb7a3352c6550892e0bb37fa01b46624 3543

Blueprints

Debian packages listed on this page are generated from op2deb YAML blueprints. Blueprints for terraform-docs are versioned here.

Click here to see terraform-docs ops2deb blueprints
https://github.com/upciti/wakemeops/blob/main/blueprints/devops/terraform-docs/ops2deb.yml
- name: terraform-docs
  version: 0.16.0
  homepage: https://terraform-docs.io
  summary: generate documentation from Terraform modules in various output formats
  description: |-
    Utility to generate documentation from Terraform modules in various output
    formats.
  fetch: https://github.com/terraform-docs/terraform-docs/releases/download/v{{version}}/terraform-docs-v{{version}}-linux-amd64.tar.gz
  script:
    - mv terraform-docs {{src}}/usr/bin/terraform-docs

- name: terraform-docs
  matrix:
    architectures:
      - arm64
      - armhf
  version: 0.16.0
  homepage: https://terraform-docs.io
  summary: generate documentation from Terraform modules in various output formats
  description: |-
    Utility to generate documentation from Terraform modules in various output
    formats.
  fetch: https://github.com/terraform-docs/terraform-docs/releases/download/v{{version}}/terraform-docs-v{{version}}-linux-{{goarch}}.tar.gz
  script:
    - mv terraform-docs {{src}}/usr/bin/terraform-docs

The blueprint fetch keyword contains a URL template pointing to terraform-docs releases. Downloaded files are locked in a lockfile versioned here.

Click here to see terraform-docs release hashes
https://github.com/upciti/wakemeops/blob/main/blueprints/devops/terraform-docs/ops2deb.lock.yml
- url: https://github.com/terraform-docs/terraform-docs/releases/download/v0.16.0/terraform-docs-v0.16.0-linux-amd64.tar.gz
  sha256: 328c16cd6552b3b5c4686b8d945a2e2e18d2b8145b6b66129cd5491840010182
  timestamp: 2022-01-20 15:04:08+00:00
- url: https://github.com/terraform-docs/terraform-docs/releases/download/v0.16.0/terraform-docs-v0.16.0-linux-arm.tar.gz
  sha256: 8b2ba1a0ffefe4cb05c3a7a4cc9203da2f64331ee4062ca1a4ec8226cc1651de
  timestamp: 2022-01-30 16:22:16+00:00
- url: https://github.com/terraform-docs/terraform-docs/releases/download/v0.16.0/terraform-docs-v0.16.0-linux-arm64.tar.gz
  sha256: 8208c19c7dc01660e6caefe32e33ac02e0e03fdc2e2ade0bb37abb6349153d25
  timestamp: 2022-01-30 16:22:16+00:00

Badge

WakeMeOps

[![WakeMeOps](https://docs.wakemeops.com/badges/terraform-docs.svg)](https://docs.wakemeops.com/packages/terraform-docs)

<a href="https://docs.wakemeops.com/packages/terraform-docs">
  <img src="https://docs.wakemeops.com/badges/terraform-docs.svg"/>
</a>

.. image:: https://docs.wakemeops.com/badges/terraform-docs.svg
:target: https://docs.wakemeops.com/packages/terraform-docs