hashicorp / terraform

Terraform enables you to safely and predictably create, change, and improve infrastructure. It is a source-available tool that codifies APIs into declarative configuration files that can be shared amongst team members, treated as code, edited, reviewed, and versioned.
https://www.terraform.io
Other
42.83k stars 9.57k forks source link

Support mermaid format in terraform graph #30519

Open fishpen0 opened 2 years ago

fishpen0 commented 2 years ago

Use-cases

Github now natively supports mermaid diagrams in its markdown syntax. It would be useful for terraform graph to be able to natively export these for use in repository documentation.

Proposal

Add native support for the mermaid diagramming format in the terraform graph command

Workarounds

It looks like there is one very old project that tries to make this work externally: https://github.com/hmalphettes/terramer

References

https://github.blog/2022-02-14-include-diagrams-markdown-files-mermaid/

crw commented 2 years ago

Hi @fishpen0, thanks for the enhancement request!

arizonawayfarer commented 1 year ago

Graphviz is not good for large deployments :(

fschlz commented 11 months ago

would be great to see mermaid support here 👍

trallnag commented 3 weeks ago

In my research I came across two existing options: