draws

Web application for accessing and reading AWS Resources using Sinatra and aws-sdk for ruby.

This application aims to provide a better User Experience in terms of Overview, Accessibility etc. for AWS Resources like VPCs, Subnets, Instances etc.

AWS Resources are pulled using the /reload endpoint and stored in a sqlite database for caching purposes.

Configuration

The application is configured with ENVIRONMENT variables.

One can create a draws.env file with the ENVIRONMENT variables listed below and export them using

vi draws.env
export $(cat draws.env | xargs)

AWS Credentials

AWS_REGION=eu-central-1
AWS_ACCESS_KEY_ID=XXX
AWS_SECRET_ACCESS_KEY=XXX

You need to configure :credentials and a :region to make API calls. It is recommended that you provide these via your environment. This makes it easier to rotate credentials and it keeps your secrets out of source control.

https://github.com/aws/aws-sdk-ruby#configuration

draws Configuration (optional)

draws can be configured optionally to use HTTP Basic Auth (default off).

DRAWS_ENABLE_BASIC_AUTH=[true|false]
DRAWS_USERNAME=draws
DRAWS_USER_PASSWORD=secure_password_please

DRAWS_TAG_FILTER=Project,Stage

DRAWS_TAG_FILTER (default: Project,Stage) is used in the instance overview to save some space in the table if you have many Tags on the Resources. Don't bother: you can search on all Tags and make them visible ;)

Run locally

ruby app.rb -p 3000

Visit http://localhost:3000 or http://localhost:3000/reload if you want to refresh the AWS Resources cache.

Features

Reload AWS resources: flush db and pull AWS Resources into cache

get '/reload'
VPCs List

get '/'
VPCs & Subnets including Instances Show

get '/vpcs/:vid'
Instances List

get '/instances'
Instance Show

get 'instances/:iid'

Deployment

Deployment instructions using various platforms.

Dokku

Dokku Dockerfile Deployment

Local

a. git remote add dokku dokku@<dokku-server>:draws

b. git push dokku master
Remote dokku server

a. Automatically retrieve and install Lets Encrypt certificates

dokku letsencrypt draws

b. AWS Credentials

dokku config:set draws AWS_ACCESS_KEY_ID=XXX AWS_SECRET_ACCESS_KEY=XXX

c. Optional: AWS Region (default: 'eu-central-1')

dokku config:set draws AWS_REGION=<aws-region>

d. Optional: Enable HTTP Basic auth

dokku config:set draws DRAWS_ENABLE_BASIC_AUTH=true DRAWS_USERNAME=admin DRAWS_USER_PASSWORD=XXX

e. Optional: Use Tag filter

dokku config:set draws DRAWS_TAG_FILTER=Owner,Stage,Project
Open in browser

http://draws.dokku-server.tld

Kubernetes

You have to build the image and make it accessible in a Docker registry.

Further instructions including Helm Chart coming soon.

Development environment

Start

# using sinatra/reloader?
ruby app.rb -p 3000 -o 0.0.0.0

# alternatively
shotgun app.rb -p 3000 -o 0.0.0.0

Load sample data

cat sample_data/schema.sql | sqlite3 cache-db.sqlite
cat sample_data/dump.sql | sqlite3 cache-db.sqlite

Maintainer

bro

rbojan/draws