Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Generate the wiki as part of the generated project #201

Open
longnd opened this issue Jun 29, 2023 · 0 comments
Open

Generate the wiki as part of the generated project #201

longnd opened this issue Jun 29, 2023 · 0 comments
Assignees
Labels
type : feature New feature or request

Comments

@longnd
Copy link
Contributor

longnd commented Jun 29, 2023

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:

  • 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
@longnd longnd added the type : feature New feature or request label Jun 29, 2023
@longnd longnd self-assigned this Jun 29, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type : feature New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant