Generate a terraform graph for the project, modules, and examples

[displague]

One way we want to improve our Terraform modules is through the consistent use of visualizations.

Adding a diagram to modules with our template project, we can standardize that practice.

For example, with a GH Action (like the one we use to generate documentation), we could provide a generated visualization in a stand-alone commit and update this with each change.

Projects would be encouraged to put in manually created (or alternatively generated) diagrams because the generated graphs may be crude. The generated graph could remain a part of the project whether or not the project keeps it in the README.md.

https://skeltonthatcher.com/2017/10/05/auto-generated-infrastructure-graphs-terraform-plans/
This is old but seems like it is still accurate. It's worth seeing if terraform graph has more options for generating images directly since then.

It’s possible that some of our modules may not pass a terraform validate or be usable in terraform graph because we don’t include the provider block. In this case, the generating graph within examples/simple could be included in the root README.

[ocobles]

Some alternative tools that may be worth checking out

https://github.com/cycloidio/inframap
https://github.com/im2nguyen/rover

[displague]

Inframap issue for Equinix resource awareness: cycloidio/inframap#220