Version 1

This documentation is for Deis v1 PaaS. For Workflow (v2) documentation visit https://deis.com/docs/workflow/.

Quick Start

These steps will help you provision a Deis cluster.

Get the Source

The source code for Deis must be on your workstation to run the commands in this documentation. Download an archive file from the releases page, or use git to clone the repository:

$ git clone https://github.com/deis/deis.git
$ cd deis
$ git checkout v1.13.4

Check out the latest Deis release, rather than using the default (master).

If you contribute to Deis or build components locally, use go get instead to clone the source code into your $GOPATH:

$ go get -u -v github.com/deis/deis
$ cd $GOPATH/src/github.com/deis/deis

Additionally, you’ll need the deisctl CLI tool. If you don’t already have it, install instructions are here.

Generate SSH Key

The deisctl utility communicates with remote machines over an SSH tunnel. If you don’t already have an SSH key, the following command will generate a new keypair named “deis”:

$ ssh-keygen -q -t rsa -f ~/.ssh/deis -N '' -C deis

Generate a New Discovery URL

A discovery URL links etcd instances together by storing their peer addresses and metadata under a unique identifier. Run this command from the root of the repository to generate a contrib/coreos/user-data file with a new discovery URL:

$ make discovery-url

Required scripts are supplied in this user-data file, so do not provision a Deis cluster without running make discovery-url.

Check System Requirements

The Deis provision scripts default to a machine size which should be adequate to run Deis, but this can be customized. Please refer to System Requirements for resource considerations when choosing a machine size to run Deis.

Choose a Provider

Choose one of the following providers and deploy a new cluster:

Configure DNS

See Configure DNS for more information on properly setting up your DNS records with Deis.

Install Deis Platform

Now that you’ve finished provisioning a CoreOS cluster, please Install the Deis Platform.