Document the Terraform Modules 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 modules inside of terraform-modules.

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 modules in terraform-modules.
  • acm
  • applicationlb
  • bastion
  • cheap-secrets
  • cicd_integration
  • database
  • ecr
  • ecs-task
  • ecs
  • multi-container-service
  • multi-tenant-database
  • network
  • private-dns
  • project-zone
  • r53
  • rds
  • redis
  • service
• 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 .
  • acm
  • applicationlb
  • bastion
  • cheap-secrets
  • cicd_integration
  • database
  • ecr
  • ecs-task
  • ecs
  • multi-container-service
  • multi-tenant-database
  • network
  • private-dns
  • project-zone
  • r53
  • rds
  • redis
  • service

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.

[chelseybeck]

This issue can (and maybe should?) be split between two people

[robinglov]

Does having one issue for the README.md and one for the .terraform.docs.yml make sense as a split?