Read your tfstate or HCL to generate a graph specific for each provider, showing only the resources that are most important/relevant.
We support all cloud providers, but we have some (listed below) that we have specific logic that allows us to better represent information that comes from these providers.
For the other providers the resulting representation will simply be all resources present without any simplification or refinement.
For TFState generations we are limited to versions 3 and 4.
| Provider | State | HCL | Grouping1 | External Nodes2 | IAM3 |
|---|---|---|---|---|---|
 |
✔️ | ✔️ | WIP | ✔️ | ✖️ (cycloidio#11) |
 |
✔️ | ✔️ | ✖️ | ✖️ | ✖️ |
 |
✔️ | ✔️ | ✖️ | ✖️ | ✖️ |
 |
✔️ | ✔️ | ✖️ | ✖️ | ✖️ |
 |
✔️ | ✔️ | ✖️ | ✖️ | ✖️ |
- Grouping: Group elements that belong to the same group like VPCs or regions
- External Nodes: Show the ingress of the Nodes if any
- IAM: Connections based on IAM (Identity Access Management)
To install the latest release of Inframap, you can pick one of this methods:
- pull the latest release from the Releases page
- pull the latest docker image from the Docker hub
- use your Linux package manager (only AUR at the moment)
You can build and install with the latest sources, you will enjoy the new features and bug fixes. It uses Go Modules (1.13+)
$ git clone https://github.com/cycloidio/inframap
$ cd inframap
$ go mod download
$ make buildIf you're macOS user and using Homebrew, you can install via brew command:
$ brew install inframapThe inframap --help will show you the basics.
The most important subcommands are:
generate: generates the graph from STDIN or file.prune: removes all unnecessary information from the state or HCL (not supported yet) so it can be shared without any security concerns
Visualizing with dot
$ inframap generate state.tfstate | dot -Tpng > graph.pngor from the terminal itself with graph-easy
$ inframap generate state.tfstate | graph-easyor from HCL
$ inframap generate config.tf | graph-easyor HCL module
$ inframap generate ./my-module/ | graph-easyusing docker image (assuming that your Terraform files are in the working directory)
$ docker run --rm -v ${PWD}:/opt cycloid/inframap generate /opt/terraform.tfstateNote: InfraMap will guess the type of the input (HCL or TFState) by validating if it's a JSON and if it fails then we fallback
to HCL (except if you send a directory on args, the it'll use HCL directly), to force one specific type you can use --hcl or --tfstate flags.
Terraform Graph outputs a dependency graph of all the resources on the tfstate/HCL. We try to go one step further, by trying to make it human-readable.
If the provider is not supported, the output will be closer to the Terraform Graph version (without displaying provider / variable nodes)
Taking https://github.com/cycloid-community-catalog/stack-magento/ as a reference this is the difference in output:
With terraform graph:
With inframap generate ./terraform/module-magento/ | dot -Tpng > inframap.png:
With inframap generate --connections=false ./terraform/module-magento/ | dot -Tpng > inframapconnections.png:
With inframap generate ./terraform/module-magento/ --raw | dot -Tpng > inframapraw.png:
For each provider, we support specific types of connections; we have a static list of resources that can be nodes or edges. Once we identify the edges, we try to create one unique edge from the resources they connect.
For a state file, we rely on the dependencies key (for the <0.13 we replace all depends_on for dependencies so we support them) and, for HCL we rely on interpolation to create the base graph one which we then
apply specific provider logic if supported. If not supported, then basic graph is returned.
If a graph is returned empty, it means that we support one of the providers you are using on your HCL/TFState but we do not recognize any connection or relevant node.
To show the configuration without any InfraMap applied logic you can use the --raw flag logic and print everything that we read.
If it works, it would be good to try to know why it was empty before so we can take a look
at it as it could potentially be an issue on InfraMap (open an issue if you want us to take a look).
By default unconnected nodes are removed, you can use --clean=false to prevent that.
Terraform allows users to use backends (S3, Google Cloud Storage, Swift, etc.) in order to store the terraform.state. We currently do not support graph generation from tfstate stored in such backends. As mentioned in this issue, it is possible to play around stdin/out to generate graph from Terraform backends.
| backend | command |
|---|---|
| S3 | aws s3 cp s3://bucket/path/to/your/file.tfstate - | inframap generate |
| GCS | gsutil cat gs://bucket/path/to/your/file.tfstate | inframap generate |
Please see the MIT LICENSE file.
All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
Cycloid is a hybrid cloud DevOps collaboration platform providing end-to-end frameworks to accelerate and industrialize software delivery.
As of now, we have three open-source tools:
- TerraCognita: Read from your existing cloud providers and generate IaC in Terraform
- InfraMap: Reads .tfstate or HCL to generate a graph specific for each provider
- TerraCost: Cloud cost estimation for Terraform in the CLI
...and the functionality of each is also embedded in our DevOps solution, which you can find out more about here.