Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/im2nguyen/rover

Interactive Terraform visualization. State and configuration explorer.
https://github.com/im2nguyen/rover

diagram interactive-visualizations terraform visualization

Last synced: 3 days ago
JSON representation

Interactive Terraform visualization. State and configuration explorer.

Awesome Lists containing this project

README 

        
## Rover - Terraform Visualizer



Rover is a [Terraform](http://terraform.io/) visualizer.



In order to do this, Rover:



1. generates a [`plan`](https://www.terraform.io/docs/cli/commands/plan.html#out-filename) file and parses the configuration in the root directory or uses a provided plan.

1. parses the `plan` and configuration files to generate three items: the resource overview (`rso`), the resource map (`map`), and the resource graph (`graph`).

1. consumes the `rso`, `map`, and `graph` to generate an interactive configuration and state visualization hosts on `0.0.0.0:9000`.



Feedback (via issues) and pull requests are appreciated!



![Rover Screenshot](docs/rover-cropped-screenshot.png)



## Quickstart



The fastest way to get up and running with Rover is through Docker.



Run the following command in any Terraform workspace to generate a visualization. This command copies all the files in your current directory to the Rover container and exposes port `:9000`.



```

$ docker run --rm -it -p 9000:9000 -v $(pwd):/src im2nguyen/rover

2021/07/02 06:46:23 Starting Rover...

2021/07/02 06:46:23 Initializing Terraform...

2021/07/02 06:46:24 Generating plan...

2021/07/02 06:46:25 Parsing configuration...

2021/07/02 06:46:25 Generating resource overview...

2021/07/02 06:46:25 Generating resource map...

2021/07/02 06:46:25 Generating resource graph...

2021/07/02 06:46:25 Done generating assets.

2021/07/02 06:46:25 Rover is running on 0.0.0.0:9000

```



Once Rover runs on `0.0.0.0:9000`, navigate to it to find the visualization!



### Run on Terraform plan file



Use `-planJSONPath` to start Rover on Terraform plan file. The `plan.json` file should be in Linux version - Unix (LF), UTF-8.



First, generate the plan file in JSON format.



```

$ terraform plan -out plan.out

$ terraform show -json plan.out > plan.json

```



Then, run Rover on it.



```

$ docker run --rm -it -p 9000:9000 -v $(pwd)/plan.json:/src/plan.json im2nguyen/rover:latest -planJSONPath=plan.json

```



### Standalone mode



Standalone mode generates a `rover.zip` file containing all the static assets.



```

$ docker run --rm -it -p 9000:9000 -v "$(pwd):/src" im2nguyen/rover -standalone true

```



After all the assets are generated, unzip `rover.zip` and open `rover/index.html` in your favourite web browser.



### Set environment variables



Use `--env` or `--env-file` to set environment variables in the Docker container. For example, you can save your AWS credentials to a `.env` file.



```

$ printenv | grep "AWS" > .env

```



Then, add it as environment variables to your Docker container with `--env-file`.



```

$ docker run --rm -it -p 9000:9000 -v "$(pwd):/src" --env-file ./.env im2nguyen/rover

```



### Define tfbackend, tfvars and Terraform variables



Use `-tfBackendConfig` to define backend config files and `-tfVarsFile` or `-tfVar` to define variables. For example, you can run the following in the `example/random-test` directory to overload variables.



```

$ docker run --rm -it -p 9000:9000 -v "$(pwd):/src" im2nguyen/rover -tfBackendConfig test.tfbackend -tfVarsFile test.tfvars -tfVar max_length=4

```



### Image generation



Use `-genImage` to generate and save the visualization as a SVG image.



```

$ docker run --rm -it  -v "$(pwd):/src" im2nguyen/rover -genImage true

```



## Installation



You can download Rover binary specific to your system by visiting the [Releases page](https://github.com/im2nguyen/rover/releases). Download the binary, unzip, then move `rover` into your `PATH`.



- [rover zip — MacOS - intel](https://github.com/im2nguyen/rover/releases/download/v0.3.2/rover_0.3.2_darwin_amd64.zip)

- [rover zip — MacOS - Apple Silicon](https://github.com/im2nguyen/rover/releases/download/v0.3.2/rover_0.3.2_darwin_arm64.zip)

- [rover zip — Windows](https://github.com/im2nguyen/rover/releases/download/v0.3.2/rover_0.3.2_windows_amd64.zip)



### Build from source



You can build Rover manually by cloning this repository, then building the frontend and compiling the binary. It requires Go v1.21+ and `npm`.



#### Build frontend



First, navigate to the `ui`.



```

$ cd ui

```



Then, install the dependencies.



```

$ npm install

```



Finally, build the frontend.



```

$ npm run build

```



#### Compile binary



Navigate to the root directory.



```

$ cd ..

```



Compile and install the binary. Alternatively, you can use `go build` and move the binary into your `PATH`.



```

$ go install

```



### Build Docker image



First, compile the binary for `linux/amd64`.



```

$ env GOOS=linux GOARCH=amd64 go build .

```



Then, build the Docker image.



```

$ docker build . -t im2nguyen/rover --no-cache

```



## Basic usage



This repository contains two examples of Terraform configurations in `example`.



Navigate into `random-test` example configuration. This directory contains configuration that showcases a wide variety of features common in Terraform (modules, count, output, locals, etc) with the [`random`](https://registry.terraform.io/providers/hashicorp/random/latest) provider.



```

$ cd example/random-test

```



Run Rover. Rover will start running in the current directory and assume the Terraform binary lives in `/usr/local/bin/terraform` by default.



```

$ rover

2021/06/23 22:51:27 Starting Rover...

2021/06/23 22:51:27 Initializing Terraform...

2021/06/23 22:51:28 Generating plan...

2021/06/23 22:51:28 Parsing configuration...

2021/06/23 22:51:28 Generating resource overview...

2021/06/23 22:51:28 Generating resource map...

2021/06/23 22:51:28 Generating resource graph...

2021/06/23 22:51:28 Done generating assets.

2021/06/23 22:51:28 Rover is running on 0.0.0.0:9000

```



You can specify the working directory (where your configuration is living) and the Terraform binary location using flags.



```

$ rover -workingDir "example/eks-cluster" -tfPath "/Users/dos/terraform"

```



Once Rover runs on `0.0.0.0:9000`, navigate to it to find the visualization!