Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hieven/terraform-visual
Terraform Visual is an interactive way of visualizing your Terraform plan
https://github.com/hieven/terraform-visual
terraform terraform-graph terraform-plans terraform-visual visual
Last synced: 4 days ago
JSON representation
Terraform Visual is an interactive way of visualizing your Terraform plan
- Host: GitHub
- URL: https://github.com/hieven/terraform-visual
- Owner: hieven
- License: mit
- Created: 2020-05-23T08:29:46.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-10-26T14:29:14.000Z (about 1 year ago)
- Last Synced: 2024-04-24T05:15:25.325Z (8 months ago)
- Topics: terraform, terraform-graph, terraform-plans, terraform-visual, visual
- Language: TypeScript
- Homepage: https://hieven.github.io/terraform-visual
- Size: 25.6 MB
- Stars: 583
- Watchers: 19
- Forks: 50
- Open Issues: 33
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-cloud-security - 地址 - visual) (0x02 工具 :hammer_and_wrench: / 2 云原生工具)
- awesome-tf - Terraform-Visual - A simple but powerful tool to visualize Terraform plan. (Tools / Community providers)
- jimsghstars - hieven/terraform-visual - Terraform Visual is an interactive way of visualizing your Terraform plan (TypeScript)
README
# [Terraform Visual](https://hieven.github.io/terraform-visual/)
Terraform Visual is a simple but powerful tool to help you understand your Terraform plan easily.
# How to use it
### Using [Terraform Visual](https://hieven.github.io/terraform-visual/)
For people who want to quickly experience how Terraform Visual looks like
1. Generate Terraform plan in JSON format
```shell
$ terraform plan -out=plan.out # Run plan and output as a file
$ terraform show -json plan.out > plan.json # Read plan file and output it in JSON format
```
2. Visit [Terraform Visual](https://hieven.github.io/terraform-visual/)
3. Upload Terraform JSON to the platform
### Using [CLI](https://www.npmjs.com/package/@terraform-visual/cli)
For people who don't like to upload Terraform plan to public internet. You could install the CLI tool via NPM.
Please refer to [@terraform-visual/cli](https://www.npmjs.com/package/@terraform-visual/cli) for more details
1. Install CLI
```sh
# Using Yarn
$ yarn global add @terraform-visual/cli
# Using NPM
$ npm install -g @terraform-visual/cli
```
2. Convert Terraform Plan into JSON File
```sh
$ terraform plan -out=plan.out # Run plan and output as a file
$ terraform show -json plan.out > plan.json # Read plan file and output it in JSON format
```
3. Create Terraform Visual Report
```sh
$ terraform-visual --plan plan.json
```
4. Browse The Report
```sh
$ open terraform-visual-report/index.html
```
### Using [Docker](https://hub.docker.com/r/hieven/terraform-visual-cli)
For people who likes Terraform Visual and wanto to integrate it into existing CI/CD pipeline.
The Docker image is on top of offical Terraform + Terraform Visual CLI.
You can simply replace the Terraform image in your CI/CD piepline with this one and enjoy the benefit of both command line tools.
For more details, please refer to [Docker: Terraform-Visual](https://hub.docker.com/r/hieven/terraform-visual-cli)