Skip to content

Commit

Permalink
Write a User's Guide for deploying spilo.
Browse files Browse the repository at this point in the history
Mainly copying information from the README into the User's guide.
  • Loading branch information
feikesteenbergen committed May 6, 2015
1 parent 855e894 commit 3230d78
Showing 1 changed file with 30 additions and 12 deletions.
42 changes: 30 additions & 12 deletions docs/User's Guide/Deployment.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,8 @@
Prerequisites
=============

AWS
---
You will need a VPC and be allowed to create new infrastructure.

Stups
-------------
To deploy spilo to AWS you will need the tooling from [stups](http://stups.readthedocs.org/en/latest).
The gist of it is to:

Expand All @@ -21,27 +17,49 @@ Deploying etcd using senza
==========================

Deploying etcd should be a once in a VPC-lifetime thing. We can use `senza` to deploy the etcd appliance.
If you already have other spilo-instances running, you may reuse the already running etcd-appliance.

The following prerequisites need to be met.

Prerequisites
--------
* `stups-senza`
* A [Senza Definition](http://stups.readthedocs.org/en/latest/components/senza.html#senza-definition), use the provided `etcd-appliance` as an example.
* The Security Group defined in the Senza Definition needs to be created

Create and execute
---------
To deploy the etcd-appliance, use the following:

senza create [OPTIONS] DEFINITION VERSION HostedZone DockerImage
senza create [OPTIONS] DEFINITION VERSION HOSTED_ZONE DOCKER_IMAGE:IMAGE_TAG

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

Example:

Argument | Value
----------------|-------
HostedZone | acid.example.com
Hosted zone | acid.example.com
Version | 1
DockerImage | etcd-appliance
DockerRevision | 0.1
Docker image | etcd-appliance
Image tag | 0.1
Definition | etcd-appliance.yaml

senza create etcd-cluster.yaml 1 acid.example.com etcd-appliance:0.1

Deploying Spilo using senza
===========================

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

senza create [OPTIONS] CLUSTER_NAME ETCD_DISCOVERY_URL DOCKER_IMAGE:IMAGE_TAG

The `ETCD_DISCOVERY_URL` should point to `HOSTED_ZONE` from the etcd-appliance that you want to use.

Example:

Argument | Value
-------------------|-------
Cluster Name | pompeii
etcd discovery url | acid.example.com
Docker image | spilo
Image tag | 0.6-SNAPSHOT

senza create spilo.yaml pompeii etcd.acid.example.com spilo:0.6-SNAPSHOT

0 comments on commit 3230d78

Please sign in to comment.