Skip to content
🌍 📋 A web dashboard to inspect Terraform States
Branch: master
Clone or download
Latest commit 94fb27d Jan 15, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
api Get headers from proxy and use them for user info Aug 9, 2017
auth Get headers from proxy and use them for user info Aug 9, 2017
compare Correct Travis fail (#55) Dec 10, 2018
config Add option to change state file extension (#38) Nov 23, 2017
db Use sirupsen instead of Sirupsen Oct 3, 2017
hugo Rename conplicity to bivac May 2, 2018
logo Improve logo Aug 4, 2017
s3 Detect if state is nil (#40) Nov 30, 2017
screenshots Update screenshots Aug 8, 2017
static Get headers from proxy and use them for user info Aug 9, 2017
types Fix json field for value (#41) Dec 7, 2017
util Lint code [WIP] (#28) Aug 4, 2017
.dockerignore Add missing files and README instructions Jul 19, 2017
.gitignore Ignore hugo/public dir Mar 1, 2018
.gitmodules Switch submodule hugo-elate-theme to https (#53) Dec 5, 2018
.travis.yml Bring Go to 1.11 (#52) Dec 4, 2018
CHANGELOG.md Release 0.14.3 Dec 7, 2017
CONTRIBUTING.md Create CONTRIBUTING.md Aug 2, 2017
Dockerfile Bring Go to 1.11 (#52) Dec 4, 2018
Dockerfile.dev Bring Go to 1.11 (#52) Dec 4, 2018
Gopkg.lock Update deps Jan 15, 2019
Gopkg.toml Use sirupsen instead of Sirupsen Oct 3, 2017
LICENSE Initial commit Jul 19, 2017
Makefile Run dep ensure before build Jan 15, 2019
README.md Add website Mar 1, 2018
TODO.md Update TODO Jul 24, 2017
docker-compose.yml Remove deprecated links, use compose default network (#46) Feb 23, 2018
main.go Use sirupsen instead of Sirupsen Oct 3, 2017
main_test.go Correct Travis fail (#54) Dec 5, 2018

README.md

Terraboard

Website: https://camptocamp.github.io/terraboard

Terraboard Logo

🌍 📋 A web dashboard to inspect Terraform States

Docker Pulls Go Report Card Gitter Build Status Coverage Status By Camptocamp

What is it?

Terraboard is a web dashboard to visualize and query Terraform states. It currently features:

  • an overview page listing the most recently updated state files with their activity
  • a state page with state file details, including versions and resource attributes
  • a search interface to query resources by type, name or attributes
  • a diff interface to compare state between versions

It currently only supports S3 as a remote state backend, and dynamoDB for retrieving lock informations.

Overview

The overview presents all the state files in the S3 bucket, by most recent modification date.

Screenshot Overview

Search

The search view allows to find resources by various criteria.

Screenshot Search

State

The state view presents details of a Terraform state at a given version.

Screenshot State

Compare

From the state view, you can compare the current state version with another version.

Screenshot Compare

Requirements

Terraboard currently supports getting the Terraform states from AWS S3. It requires:

  • A versioned S3 bucket name with one or more Terraform states, named with a .tfstate suffix
  • AWS credentials with the following rights on the bucket:
    • s3:GetObject
    • s3:ListBucket
    • s3:ListBucketVersions
    • s3:GetObjectVersion
  • A running PostgreSQL database
  • If you want to retrieve lock states from a dynamoDB table, you need to make sure the provided AWS credentials have dynamodb:Scan access to that table.

Use with Docker

Either use the included docker-compose file, or run two containers from the commandline: the app itself and a PostgreSQL database for it to store information in.

# Set AWS credentials as environment variables:
export AWS_ACCESS_KEY_ID=<access_key>
export AWS_SECRET_ACCESS_KEY=<access_secret>
# Spin up the two containers and a network for them to communciate on:
docker network create terranet
docker run --name db \
  -e POSTGRES_USER=gorm \
  -e POSTGRES_DB=gorm \
  -e POSTGRES_PASSWORD="<mypassword>" \
   --net terranet \
  --restart=always postgres -d
docker run -p 8080:8080 \
 -e AWS_REGION="<region>" \
 -e AWS_ACCESS_KEY_ID="${AWS_ACCESS_KEY_ID}" \
 -e AWS_SECRET_ACCESS_KEY="${AWS_SECRET_ACCESS_KEY}" \
 -e AWS_BUCKET="<bucket>" \
 -e AWS_DYNAMODB_TABLE="<table>" \
 -e DB_PASSWORD="<mypassword>" \
 --net terranet \
 camptocamp/terraboard:latest

Then point your browser to http://localhost:8080.

To use the included compose file, you will need to configure an OAuth application.

Use with Rancher

Camptocamp's Rancher Catalog contains a Terraboard template to automate its installation in Cattle.

Authentication and base URL

Terraboard does not implement authentication. Instead, it is recommended to use an authentication proxy such as oauth2_proxy.

If you need to set a route path for Terraboard, you can set a base URL by passing it as the BASE_URL environment variable.

When using an authentication proxy, Terraboard will retrieve the logged in user and email from the headers passed by the proxy. You can also pass a TERRABOARD_LOGOUT_URL parameter to allow users to sign out of the proxy.

Install from source

$ go get github.com/camptocamp/terraboard

Development

Architecture

Terraboard is made of two components:

A server process

The server is written in go and runs a web server which serves:

  • the API on known access points, taking the data from the PostgreSQL database
  • the index page (from static/index.html) on all other URLs

The server also has a routine which regularly (every 1 minute) feeds the PostgreSQL database from the S3 bucket.

A web UI

The UI is an AngularJS application served from index.html. All the UI code can be found in the static/ directory.

Testing

$ docker-compose build && docker-compose up -d
# Point your browser to http://localhost

Contributing

See CONTRIBUTING.md

Terraboard Logo

The Terraboard logo is based on an image by Daniel R. Strebe, CC BY-SA 3.0, 15 August 2011

You can’t perform that action at this time.