The infrastructure-template is a useful tool for generating infrastructure code for a new project. However, there is no documentation comes with a new generated project. For example, users may not know:
How to use the newly generated project to set up different environments (using different Terraform Cloud workspaces to map to the same working directory).
How to start provisioning infrastructure and creating IAM accounts, including the need to use a dummy bot account first.
And so on.
A wiki should be generated as part of the project, it should contain common information, including (but not limited to) the following:
[ ] The infrastructure diagram.
[ ] Instructions for using Terraform Cloud to provide infrastructure for different environments.
[ ] Instructions for setting up a bot and IAM accounts.
[ ] Instructions for changing application configurations, environment variables (using Terraform locals instead of Terraform cloud variables), and secrets.
[ ] Instruction for connecting to remote DB using bastion server.
Who Benefits?
The project squads can setup a new infrastructure faster, there is less unknown.
The client has clear documentation to maintain the project
Why
The infrastructure-template is a useful tool for generating infrastructure code for a new project. However, there is no documentation comes with a new generated project. For example, users may not know:
A wiki should be generated as part of the project, it should contain common information, including (but not limited to) the following:
Who Benefits?