Document the Terraform Projects using Terraform Docs

[chelseybeck]

Overview

One of the benefits of infrastructure as code (IaC) is that it is self-documenting. Terraform Docs facilitates easy documentation of resources. Install Terraform Docs and create corresponding files for projects inside of terraform-incubator.

We can expand on the projects to projects not yet in terraform later, if desired, but let's start here.

Action Items

• Read over the Terraform Docs documentation to understand how the templates are used to generate README.md files
• Install Terraform Docs on your local machine
• Create .terraform.docs.yml files for each of the projects in terraform-incubator. If there are subdirectories (i.e. dev, staging), this needs to be added to each subdirectory
  • access-the-data
  • people-depot/project
  • vrms-backend
    • dev
    • prod
    • project
• Create README.md files for each of the projects in terraform-incubator by changing into the project directory where the terraform files are located and running this command terraform-docs -c .terraform.docs.yml .
  • access-the-data
  • people-depot/project
  • vrms-backend
    • dev
    • prod
    • project

Resources/Instructions

Terraform Docs documentation
Here is an example of Terraform Docs in practice. Note how clear it is now which resources this module creates.