Skip to content
This repository was archived by the owner on May 6, 2020. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
85 changes: 18 additions & 67 deletions docs/src/installing-deis/installing-the-deis-platform.md
Original file line number Diff line number Diff line change
@@ -1,82 +1,33 @@
# Installing the Deis Platform

We will use the `deisctl` utility to provision the Deis platform from a CoreOS host or a workstation that has SSH access to CoreOS.
We will use the `helm` utility to provision the Deis platform to a kubernetes cluster. If you don't
have `helm` installed, see [installing helm][helm] for more info.

First check that you have `deisctl` installed and the version is correct.
First check that you have `helm` installed and the version is correct.

$ deisctl --version
1.12.1
$ helm --version
0.2.0

If not, follow instructions to [install deisctl][].

Ensure your SSH agent is running and select the private key that corresponds to the SSH key added
to your CoreOS nodes:

$ eval `ssh-agent -s`
$ ssh-add ~/.ssh/deis

!!! note
For Vagrant clusters: `ssh-add ~/.vagrant.d/insecure_private_key`

Find the public IP address of one of your nodes, and export it to the DEISCTL_TUNNEL environment
variable (substituting your own IP address):

$ export DEISCTL_TUNNEL=104.131.93.162

If you set up the "convenience" DNS records, you can just refer to them via

$ export DEISCTL_TUNNEL="deis-1.example.com"

!!! note
For Vagrant clusters: `export DEISCTL_TUNNEL=172.17.8.100`

This is the IP address where deisctl will attempt to communicate with the cluster. You can test
that it is working properly by running `deisctl list`. If you see a single line of output, the
control utility is communicating with the nodes.

Before provisioning the platform, we'll need to add the SSH key to Deis so it can connect to remote
hosts during `deis run`:

$ deisctl config platform set sshPrivateKey=~/.ssh/deis

!!! note
For Vagrant clusters: `deisctl config platform set sshPrivateKey=${HOME}/.vagrant.d/insecure_private_key`

We'll also need to tell the controller which domain name we are deploying applications under:

$ deisctl config platform set domain=example.com

!!! note
For Vagrant clusters: `deisctl config platform set domain=local3.deisapp.com`
Ensure your kubectl client is installed and ensure it can connect to your kubernetes cluster. This
is where `helm` will attempt to communicate with the cluster. You can test that it is working
properly by running `kubectl get nodes`. If you see a list of available nodes, kubectl is
communicating with the kubernetes master.

Once finished, run this command to provision the Deis platform:

$ deisctl install platform

You will see output like the following, which indicates that the units required to run Deis have
been loaded on the CoreOS cluster:

● ▴ ■
■ ● ▴ Installing Deis...
▴ ■ ●

Scheduling data containers...
...
Deis installed.
Please run `deisctl start platform` to boot up Deis.

Run this command to start the Deis platform:

$ deisctl start platform
$ helm repo add deis https://github.com/deis/charts
$ helm install deis/deis

Once you see "Deis started.", your Deis platform is running on a cluster! You may verify that all
of the Deis units are loaded and active by running the following command:
You can then monitor their status by running

$ deisctl list
```
$ kubectl get pods --namespace=deis
```

All of the units should be active.
Once you see all of the pods ready, your Deis platform is running on a cluster!

Now that you've finished provisioning a cluster, start [Using Deis][] to deploy your first application on Deis.
Now that you've finished provisioning a cluster, start [Using Deis][] to deploy your first
application on Deis.

[install deisctl]: installing-deisctl.md
[helm]: http://helm.sh
Expand Down
2 changes: 1 addition & 1 deletion docs/src/installing-deis/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ The Deis provision scripts default to a machine size which should be adequate to

## Choose a Provider

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

- [Amazon AWS](http://kubernetes.io/v1.1/docs/getting-started-guides/aws.html)
- [Bare Metal](bare-metal.md)
Expand Down