Skip to content

Commit

Permalink
Update User's Guide with deploment documentation.
Browse files Browse the repository at this point in the history
Implement senza init into the User's Guide, update some variable (names) to reflect reality.
Test the spilo bit a couple of times.
  • Loading branch information
feikesteenbergen committed May 15, 2015
1 parent 650cf7a commit 354f3c3
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 17 deletions.
56 changes: 40 additions & 16 deletions docs/User's Guide/Deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,41 +27,65 @@ The following prerequisites need to be met.

To deploy the etcd-appliance, use the following:

senza create [OPTIONS] DEFINITION VERSION HOSTED_ZONE DOCKER_IMAGE:IMAGE_TAG
senza create DEFINITION.yaml VERSION HOSTED_ZONE DOCKER_IMAGE

This will create and execute a cloud formation template for you.

Example:

Argument | Value
----------------|-------
Hosted zone | acid.example.com
Version | 1
Docker image | etcd-appliance
Image tag | 0.1
Definition | etcd-appliance.yaml
Argument | Value
-------------------|-------
Definition | etcd-appliance.yaml
Hosted zone | acid.example.com
Version | 1
Docker repository | pierone.stups.zalan.do
Docker image | acid/etcd-appliance
Image tag | 0.2-SNAPSHOT

This comment has been minimized.

Copy link
@valgog

valgog May 15, 2015

Member

This table can look nice also in the text mode 😄


senza create etcd-cluster.yaml 1 acid.example.com etcd-appliance:0.1
senza create etcd-cluster.yaml 1 acid.example.com pierone.stups.zalan.do/acid/etcd-appliance:0.2-SNAPSHOT

This comment has been minimized.

Copy link
@valgog

valgog May 15, 2015

Member

is it ok to mention stups.zalan.do here?


Deploying Spilo using senza

This comment has been minimized.

Copy link
@valgog

valgog May 15, 2015

Member

mixed capitalization does not look like stackenblochen to me :)

===========================

* Have some global idea about the usage characteristics of the appliance
* Have unique name for the cluster

To deploy the appliance using senza, do the following:
You can use senza init to create a senza definition for the spilo appliance,
the `ETCD_DISCOVERY_URL` should point to `HOSTED_ZONE` from the etcd-appliance that you want to use.

senza init DEFINITION.yaml

senza create [OPTIONS] CLUSTER_NAME ETCD_DISCOVERY_URL DOCKER_IMAGE:IMAGE_TAG
Choose postgresapp as the template, senza will now prompt you for some information, you may want to override the defaults.

This comment has been minimized.

Copy link
@valgog

valgog May 15, 2015

Member

it always makes sense to add some markdown to special words

This comment has been minimized.

Copy link
@valgog

valgog May 15, 2015

Member

is postgresapp some special option in senza?


The `ETCD_DISCOVERY_URL` should point to `HOSTED_ZONE` from the etcd-appliance that you want to use.
If you want, now is the time to edit `DEFINITION.yaml` to your needs.

To deploy the appliance using senza, do the following (we use `CLUSTER_NAME` for the `VERSION` that senza requires):

senza create [OPTIONS] DEFINITION.yaml CLUSTER_NAME DOCKER_IMAGE

Example:

Argument | Value
-------------------|-------
Definition | spilo.yaml

This comment has been minimized.

Copy link
@valgog

valgog May 15, 2015

Member

Nein Stackenblochen!

Cluster Name | pompeii
etcd discovery url | acid.example.com
Docker image | spilo
Image tag | 0.6-SNAPSHOT
Docker repository | pierone.stups.zalan.do
Docker image | acid/spilo
Image tag | 0.7-SNAPSHOT

senza create spilo.yaml pompeii pierone.stups.zalan.do/acid/spilo:0.7-SNAPSHOT

You can now monitor the progress using:
senza watch -n 2 DEFINITION.yaml CLUSTER_NAME

Connecting to the master
========================
You can now try to connect to the cluster (internally) using the generated dns-name, CLUSTER\_NAME.example.com.

When using the odd bastion host, you could create a tunnel to connect to the cluster as follows

ssh -f -N -L 6543:CLUSTER_NAME.example.com:5432 odd.acid.zalan.do

You should be able to connect using psql locally:

senza create spilo.yaml pompeii etcd.acid.example.com spilo:0.6-SNAPSHOT
psql -h localhost -p 6543
2 changes: 1 addition & 1 deletion postgres-appliance/TODO
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Done:
Done:
run etcd proxy instead of full-scale etcd

Cancelled, since we are not going to use haproxye:
Cancelled, since we are not going to use haproxy:
configure haproxy to fetch information from
the etcd-proxy and point to the acting master

Expand Down

0 comments on commit 354f3c3

Please sign in to comment.