Website: https://camptocamp.github.io/terraboard
🌍 📋 A web dashboard to inspect Terraform States
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.
The overview presents all the state files in the S3 bucket, by most recent modification date.
The search view allows to find resources by various criteria.
The state view presents details of a Terraform state at a given version.
From the state view, you can compare the current state version with another version.
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
.tfstatesuffix - AWS credentials with the following rights on the bucket:
s3:GetObjects3:ListBuckets3:ListBucketVersionss3: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:Scanaccess to that table.
Terraboard currently supports configuration in three different ways:
- Environment variables
- CLI parameters
- 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.
| 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 | - |
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:latestThen 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.
Camptocamp's Rancher Catalog contains a Terraboard template to automate its installation in Cattle.
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.
$ go get github.com/camptocamp/terraboard| 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 |
Terraboard is made of two components:
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.
The UI is an AngularJS application served from index.html. All the UI code
can be found in the static/ directory.
$ docker-compose build && docker-compose up -d
# Point your browser to http://localhostSee CONTRIBUTING.md
The Terraboard logo is based on an image by Daniel R. Strebe, CC BY-SA 3.0, 15 August 2011
