Skip to content
Interactive visualizations of Terraform dependency graphs using d3.js
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci
bin change from port arg from positional to explicit Apr 10, 2018
blastradius update categories.json, terraform; bump version Mar 12, 2019
doc documentation updates Feb 11, 2018
utilities/providers (provider-category-json.py) sort keys, hopefully make output somewhat… Jan 8, 2019
.gitignore
Dockerfile update categories.json, terraform; bump version Mar 12, 2019
LICENSE Initial commit Nov 7, 2017
MANIFEST.in add bootstrap4, jquery Jan 26, 2018
Makefile
README.md add circleci badge May 15, 2018
docker-build.sh
docker-entrypoint.sh change tf-get/init logic, fix when args < 2 Feb 10, 2018
setup.py update categories.json, terraform; bump version Mar 12, 2019

README.md

Blast Radius

PyPI version CircleCI

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.

Quickstart

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)

Docker

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.

Additional note: 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 --serve argument).

[...]$ 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

Embedded Figures

You may wish to embed figures produced with Blast Radius in other documents. You will need the following:

  1. an svg file and json document representing the graph and its layout.
  2. javascript and css found in .../blastradius/server/static
  3. a uniquely identified DOM element, where the <svg> should appear.

Further details available here.

Implementation Details

Blast Radius uses the Graphviz package to layout graph diagrams, PyHCL to parse Terraform configurations, and d3.js to implement interactive features and animations.

Further Reading

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.

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.

You can’t perform that action at this time.