Blast Radius is a tool for reasoning about Terraform dependency graphs with interactive visualizations. Use Blast Radius to:
- Learn about Terraform or one of its cloud providers, through example configurations.
- Document your infrastructure
- Reason about relationships between resources, and evaluate changes to them.
- Interact with this diagram (and many others) here.
Install Blast Radius with pip, and Graphviz through your system's package manager.
[...]$ pip3 install BlastRadius [...]$ brew install graphviz
Point Blast Radius at an
init-ed Terraform project, and connect with your browser.
[...]$ blast-radius --serve /path/to/terraform-project * Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)
Alternatively, you can launch Blast Radius in a docker container. (In this example, the current working directory contains a Terraform project.)
[...]$ docker run --cap-add=SYS_ADMIN -it --rm -p 5000:5000 -v $(pwd):/workdir:ro 28mm/blast-radius
Please note: because terraform saves module links as absolute paths in .terraform/modules/ we mount the host's filesystem read-only and force terraform to update the modules path at start. This way we don't interfere with the real project. Thus docker has to be run with the
--cap-add=SYS_ADMIN flag to use the overlayFS see Docker's documentation.
If you organised your terraform directories with stacks and modules, please call Blast Radius from the root directory and give the stack's directory as argument (plus the
[...]$ tree -d /-- project |-- modules | |-- foo | |-- bar | `-- dead `-- stacks `-- beef `-- .terraform [...]$ cd project docker run --cap-add=SYS_ADMIN -it --rm -p 5000:5000 -v $(pwd):/workdir:ro 28mm/blast-radius --serve stacks/beef
You may wish to embed figures produced with Blast Radius in other documents. You will need the following:
jsondocument representing the graph and its layout.
- a uniquely identified DOM element, where the
Further details available here.
The development of Blast Radius is documented in a series of blog posts:
- part 1: motivations, d3 force-directed layouts vs. vanilla graphviz.
- part 2: d3-enhanced graphviz layouts, meaningful coloration, animations.
- part 3: limiting horizontal sprawl, supporting modules.
- part 4: search, pan/zoom, prune-to-selection, docker.
A catalog of example Terraform configurations, and their dependency graphs can be found here.
- AWS two-tier architecture
- AWS networking (featuring modules)
- Google two-tier architecture
- Azure load-balancing with 2 vms
These examples are drawn primarily from the
examples/ directory distributed with various Terraform providers, and aren't necessarily ideal. Additional examples, particularly demonstrations of best-practices, or of multi-cloud configurations strongly desired.