grubertech/blast-radius repository overview

⁠Blast Radius

⁠Important: Pending PR⁠

⁠Quickstart

The fastest way to get up and running with Blast Radius is execute using Docker on your Terraform folder:

 docker run --rm -it -p 5000:5000 \
    -v $(pwd):/data:ro \
    --security-opt apparmor:unconfined \
    --cap-add=SYS_ADMIN \
    grubertech/blast-radius

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 providers through real examples⁠
• Document your infrastructure
• Reason about relationships between resources and evaluate changes to them
• Interact with the diagram below (and many others) in the docs⁠

⁠Prerequisites

• Graphviz⁠
• Python⁠ 3.7 or newer

⁠Docker configurations

Terraform module links are saved as absolute paths in relative to the project root (note .terraform/modules/<uuid>). Given these paths will vary betwen Docker and the host, we mount the volume as read-only, assuring we don't ever interfere with your real environment.

However, in order for Blast Radius to actually work with Terraform, it needs to be initialized. To accomplish this, the container creates an [overlayfs][] that exists within the container, overlaying your own, so that it can operate independently. To do this, certain runtime privileges are required -- specifically --cap-add=SYS_ADMIN.

For more information on how this works and what it means for your host, check out the [runtime privileges][privileges] documentation.

⁠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.

You can read more details in the documentation⁠

⁠Implementation Details

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