Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/coinbase/terraform-landscape

Improve Terraform's plan output to be easier to read and understand
https://github.com/coinbase/terraform-landscape

bash ruby terraform

Last synced: 6 days ago
JSON representation

Improve Terraform's plan output to be easier to read and understand

Awesome Lists containing this project

README

        

# Terraform Landscape

[![Gem Version](https://badge.fury.io/rb/terraform_landscape.svg)](http://badge.fury.io/rb/terraform_landscape)
[![CircleCI](https://circleci.com/gh/coinbase/terraform-landscape.svg?style=svg)](https://circleci.com/gh/coinbase/terraform-landscape)

Terraform Landscape is a tool for reformatting the output of `terraform plan`
to be easier to read and understand.

#### Before
Original Terraform plan output

### After
Improved Terraform plan output

* [Requirements](#requirements)
* [Installation](#installation)
* [Usage](#usage)

## Requirements

* Ruby 2.5+
* Terraform 0.11.x (see [#101](https://github.com/coinbase/terraform-landscape/issues/101) for details)

## Installation

The `landscape` executable is installed via [RubyGems](https://rubygems.org/).

```bash
gem install terraform_landscape
```

### macOS

Terraform Landscape is also available via [Homebrew](https://brew.sh/).

```bash
brew install terraform_landscape
```

## Usage

Pipe the output of `terraform plan` into `landscape` to reformat the output.

```bash
terraform plan ... | landscape
```

## Docker

Build the docker image using provided Dockerfile and use it directly:

```bash
docker build . -t landscape
terraform plan ... | docker run -i --rm landscape
```

## License

This project is released under the [Apache 2.0 license](LICENSE).