This repository is a template to create other Terraform AWS repositories following some standard best practices.
The following files are expected:
main.tfvariables.tfoutputs.tfterraform.tfvars.example.tflint.hcl
The section below details the actual template for the README:
Provide a short description of the module.
Quick notes and reference on how to begin interacting with the resources can be added here.
Creation time: ? minutes
Destruction time: ? minutes
Any miscellaneous points or interesting observations can be added here.
General troubleshooting guide information should be added here.
- Cloud-init executes scripts in alphabetical order
- For simplicity, label the created scripts with numbers according to execution order
- Take note that this is related to how cloud-init works specifically and even the content type can also affect the execution order
- Note that you need sudo permissions
- Find the logs in
/var/log, specifically/var/log/cloud-init-output.log - Find the scripts in
/var/lib/cloud/instance/scripts
Info and solutions (if any) for specific issues should have their own dedicated section.
- Bulleted list of items that could be worked on.
To easily generate out the list of requirements, outputs, etc, use terraform-docs to create the documentation: terraform-docs markdown --output-file README.md .
...