Git Product home page Git Product logo

blast-radius's Introduction

Blast Radius

PyPI version

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.

blast-radius's People

Contributors

28mm avatar bucrogers avatar davewongillies avatar tiddnet avatar

Watchers

James Cloos avatar Sunil Pentapati avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.