Skip to content
🌍 📋 A web dashboard to inspect Terraform States
Go HTML JavaScript CSS Other
Branch: master
Clone or download

Latest commit

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
api Implemented support for Terraform Enterprise as state provider Jan 14, 2020
auth feat: Support read config from file Oct 29, 2019
compare Correct Travis fail (#55) Dec 10, 2018
config Make database sslmode default to require (#78) Feb 4, 2020
db Add setting for DB sslmode (#70) Jan 20, 2020
hugo Rename conplicity to bivac May 2, 2018
logo Make logo a bit larger Jan 20, 2020
screenshots Update screenshots Aug 8, 2017
state Implemented support for Terraform Enterprise as state provider Jan 14, 2020
static Regenerate static logo Jan 20, 2020
types Fix json field for value (#41) Dec 7, 2017
util refactor: Rename basePath-related functions Oct 29, 2019
.dockerignore Add missing files and README instructions Jul 19, 2017
.gitignore feat: Database port should be configurable Oct 29, 2019
.gitmodules
.travis.yml Bumped go version to 1.13 Jan 14, 2020
CHANGELOG.md Release 0.19.0 Jan 24, 2020
CONTRIBUTING.md Create CONTRIBUTING.md Aug 2, 2017
Dockerfile Use golang:1.12 in Dockerfile Oct 24, 2019
Dockerfile.dev Use go modules instead of dep Oct 23, 2019
LICENSE Initial commit Jul 19, 2017
Makefile fix: make test fails due to golint changes! Oct 29, 2019
README.md update to use terraform 0.12.24 (#88) Apr 14, 2020
TODO.md Update TODO Jul 24, 2017
docker-compose.yml Remove deprecated links, use compose default network (#46) Feb 23, 2018
example.yml feat: Add short CLI param to config-file Oct 29, 2019
go.mod update to use terraform 0.12.24 (#88) Apr 14, 2020
go.sum update to use terraform 0.12.24 (#88) Apr 14, 2020
main.go Output Terraform lib version in version string (#75) Jan 24, 2020
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 supports S3 as a remote state backend, and dynamoDB for retrieving lock informations. Also supports Terraform Cloud (in past Terraform Enterprise more)

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 and Terraform Cloud (in past Terraform Enterprise more). It requires:

  • Terraform states from AWS S3:
    • 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
    • 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.
  • Terraform states from Terraform Cloud:
    • Account on Terraform Cloud
    • Existing organization
    • Token assigned to an organization
  • A running PostgreSQL database

Configuration

Terraboard currently supports configuration in three different ways:

  1. Environment variables
  2. CLI parameters
  3. Configuration file (YAML). A configuration file example can be found in the root directory of this repository.

The precedence of configurations is as described below.

Available parameters

CLI ENV YAML Description Default
-V or --version - - Prints version -
-p or --port TERRABOARD_PORT web.port Port to listen on 8080
-c or --config-file CONFIG_FILE - Config File path -
-l or --log-level TERRABOARD_LOG_LEVEL log.level Set log level (debug, info, warn, error, fatal, panic) info
--log-format TERRABOARD_LOG_FORMAT log.format Set log format (plain, json) plain
--db-host DB_HOST db.host Database host db
--db-port DB_PORT db.port Database port 5432
--db-user DB_USER db.user Database user gorm
--db-password DB_PASSWORD db.password Database password -
--db-name DB_NAME db.name Database name gorm
--db-sslmode DB_SSLMODE db.sslmode SSL mode enforced for database access (require, verify-full, verify-ca, disable) require
--no-sync - db.no-sync Do not sync database false
--sync-interval - db.sync-interval DB sync interval (in minutes) 1
--dynamodb-table AWS_DYNAMODB_TABLE aws.dynamodb-table AWS DynamoDB table for locks -
--s3-bucket AWS_BUCKET aws.bucket AWS S3 bucket -
--key-prefix AWS_KEY_PREFIX aws.key-prefix AWS Key Prefix -
--file-extension AWS_FILE_EXTENSION aws.file-extension File extension of state files .tfstate
--base-url TERRABOARD_BASE_URL web.base-url Base URL /
--logout-url TERRABOARD_LOGOUT_URL web.logout-url Logout URL -
--tfe-address TFE_ADDRESS tfe.tfe-address Terraform Enterprise address for states access -
--tfe-token TFE_TOKEN tfe.tfe-token Terraform Enterprise token for states access -
--tfe-organization TFE_ORGANIZATION tfe.tfe-organization Terraform Enterprise organization for states access -

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.

Configuration file can be provided to the container using a volume or a configuration.

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

Compatibility Matrix

Terraboard Max Terraform version
0.15.0 0.12.7
0.16.0 0.12.7
0.17.0 0.12.18
0.18.0 0.12.18
0.19.0 0.12.20
0.20.0 0.12.24

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.