Skip to content
This repository has been archived by the owner on Jul 11, 2023. It is now read-only.

update example env for consistency #76

Open
ketzacoatl opened this issue Mar 14, 2018 · 1 comment
Open

update example env for consistency #76

ketzacoatl opened this issue Mar 14, 2018 · 1 comment
Labels

Comments

@ketzacoatl
Copy link
Contributor

ketzacoatl commented Mar 14, 2018

In this repo we have a collection of "example" (or "test") environments, seen here https://github.com/fpco/terraform-aws-foundation/blob/master/examples/. There are some inconsistencies with documentation and how to use the examples:

  • no README
  • no Makefile
  • in many cases, need to use -target when first deploying the network

I would recommend the follow updates:

  • add a Makefile if it is missing (see https://github.com/fpco/terraform-aws-foundation/blob/master/examples/cloud-dev-workspace/Makefile as a template to start with)
    • be sure to include the help target as a minimum in each Makefile, you do not need to add all targets that are sensible for all env
  • Review the VPC modules used, probably need to add a network target that uses terraform plan with -target and -out to generate a plan file to then apply.
  • Add a README.md if it is missing. Check main.tf in each example env, look for a block comment at the top of the file, and if present include those comments in the README.

Review each env as you work through them, if you have additional updates you would propose, let's discuss them and decide if they should go in this ticket or have a new ticket of their own.

@ketzacoatl
Copy link
Contributor Author

I updated a bunch of example env last night, but failed to mention this issue in those commits.. sorry. Roughly speaking, those commits were:

0f3f9f6
9b69a20
ed6559a
762426c
0fef729
9bc9d0b
f955d6e

More can be done in the following areas:

  • README
  • Makefile
  • full deploy and destroy works without issue

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

No branches or pull requests

3 participants