Setup

Make sure you have gcloud installed and configured (gcloud auth list to check, gcloud auth login to authenticate). You may want to update old installations (gcloud components update).

Building:

$ go get github.com/cockroachlabs/roachprod

Synopsis

roachprod manages per-user clusters under the cockroach-ephemeral GCE project.

Simple workflow:

Create a cluster:

$ roachprod create foo
Creating cluster marc-foo with 3 nodes
OK
marc-foo: 23h59m42s remaining
  marc-foo-0000   [marc-foo-0000.us-east1-b.cockroach-ephemeral]
  marc-foo-0001   [marc-foo-0001.us-east1-b.cockroach-ephemeral]
  marc-foo-0002   [marc-foo-0002.us-east1-b.cockroach-ephemeral]
Syncing...

Interact using crl-prod tools

roachprod populates hosts files in ~/.roachprod/hosts. These are used by crl-prod tools to map clusters to node addresses.

$ crl-ssh marc-foo all df -h /
1: marc-foo-0000.us-east1-b.cockroach-ephemeral
Filesystem      Size  Used Avail Use% Mounted on
/dev/sda1        49G  1.2G   48G   3% /

2: marc-foo-0001.us-east1-b.cockroach-ephemeral
Filesystem      Size  Used Avail Use% Mounted on
/dev/sda1        49G  1.2G   48G   3% /

3: marc-foo-0002.us-east1-b.cockroach-ephemeral
Filesystem      Size  Used Avail Use% Mounted on
/dev/sda1        49G  1.2G   48G   3% /

Interact using `roachperf`

roachperf consumes ~/.roachprod/hosts.

# Add ssh-key
$ ssh-add ~/.ssh/google_compute_engine

$ roachperf marc-foo status
marc-foo: status 3/3
   1: not running
   2: not running
   3: not running

SSH into hosts

roachprod uses gcloud to sync the list of hostnames to ~/.ssh/config and setup keys.

$ ssh marc-foo-0000.us-east1-b.cockroach-ephemeral

List clusters

$ roachprod list
marc-foo: 23h58m27s remaining
  marc-foo-0000
  marc-foo-0001
  marc-foo-0002
Syncing...

Destroy cluster

$ roachprod destroy foo
Destroying cluster marc-foo with 3 nodes
OK

See roachprod help <command> for further details.

Setting up a cluster using roachprod/roachperf

# Create cluster with 4 nodes and local SSD (last node is used as load generator by roachperf)
$ roachprod create test -n 4 --local-ssd
Creating cluster marc-test with 4 nodes
OK.
  marc-test-0001	marc-test-0001.us-east1-b.cockroach-ephemeral	10.142.0.8	35.196.94.196
  marc-test-0002	marc-test-0002.us-east1-b.cockroach-ephemeral	10.142.0.5	35.196.95.207
  marc-test-0003	marc-test-0003.us-east1-b.cockroach-ephemeral	10.142.0.7	35.196.151.250
  marc-test-0004	marc-test-0004.us-east1-b.cockroach-ephemeral	10.142.0.6	35.196.194.230
Syncing...

# Add gcloud SSH key
$ ssh-add ~/.ssh/google_compute_engine

# Stage scripts and binaries using crl-prod
$ crl-stage-binaries marc-test all scripts
$ crl-stage-binaries marc-test all cockroach

# Or using roachperf (eg: for your locally-built binary)
$ roachperf marc-test put cockroach

# Start cluster using roachperf.
$ roachperf marc-test start
marc-test: starting 3/3
marc-test: initializing cluster settings 1/1
SET CLUSTER SETTING

# Check the admin UI
# http://35.196.94.196:8080

# Destroy cluster
$ roachprod destroy test
Destroying cluster marc-test with 4 nodes
OK

Future improvements

more configurable: zones, bigger loadgen VM (last instance)

dt/roachprod