gotthard 1.11

Installation

$ sudo pip3 install --upgrade gotthard

Configuration

Gotthard does not have its own configuration. It uses the piu configuration file.

Usage

Gotthard can provide help with the commands itself:

$ gotthard --help

Gotthard can run in two basic modes: in the foreground and in the background.

When running in the background, gotthard establishes a tunnel and keeps the tunnel running in the background.

$ gotthard shipping.logistics.db.example.com

When running in the foreground, the tunnel is established and the command you specify is executed. Once your command finishes, the tunnel is closed. If you need to pass options to the command, you will have to add the -- to signify that the following options should not be interpreted by gotthard.

$ gotthard shipping.logistics.db.example.com psql
$ gotthard shipping.logistics.db.example.com -- psql -U myusername

$ gotthard shipping.logistics.db.example.com --reason="Investigating INCIDENT-123" psql

$ gotthard shippinglogistics psql

How does it actually work

The way Gotthard works is by setting up an ssh tunnel to the bastion host. It chooses the local port specified a free local port to tunnel the requests to remote side to port 5432.

When running in the background, it’s task is done: It will report back the details of the tunnel.

When running in the foregroed, Gotthard will export the PostgreSQL related Environment Variables to the process it needs to run. Most PostgreSQL client tools will use these environment variables to connect, most of your python or perl scripts should adhere to these variables as well.

$ gotthard shippinglogistics env | grep PG
PGUSER=username
PGHOST=localhost
PGDATABASE=postgres
PGPORT=52296
PGSSLMODE=require

Examples

$ gotthard shipping.logistics.db.example.com --reason="FEATURE-123" -- pg_dump -d fancydb -Fc -f fancydb.dump

$ query="SELECT pg_database_size(CURRENT_CATALOG)"
$ gotthard example.us-west-2.rds.amazonaws.com -- psql -U rds_admin -d featuredb -c "$query"

$ gotthard shippinglogistics -- pg_basebackup -D /postgres/mydata