Skip to content
This repository was archived by the owner on May 6, 2020. It is now read-only.

Commit f4574e8

Browse files
author
Matthew Fisher
committed
docs(installing-deis): document installation process for alpha
1 parent c03e910 commit f4574e8

File tree

2 files changed

+21
-68
lines changed

2 files changed

+21
-68
lines changed
Lines changed: 20 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -1,83 +1,36 @@
11
# Installing the Deis Platform
22

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

5-
First check that you have `deisctl` installed and the version is correct.
7+
First check that you have `helm` installed and the version is correct.
68

7-
$ deisctl --version
8-
1.12.1
9+
$ helm --version
10+
0.2.0
911

10-
If not, follow instructions to [install deisctl][].
11-
12-
Ensure your SSH agent is running and select the private key that corresponds to the SSH key added
13-
to your CoreOS nodes:
14-
15-
$ eval `ssh-agent -s`
16-
$ ssh-add ~/.ssh/deis
17-
18-
!!! note
19-
For Vagrant clusters: `ssh-add ~/.vagrant.d/insecure_private_key`
20-
21-
Find the public IP address of one of your nodes, and export it to the DEISCTL_TUNNEL environment
22-
variable (substituting your own IP address):
23-
24-
$ export DEISCTL_TUNNEL=104.131.93.162
25-
26-
If you set up the "convenience" DNS records, you can just refer to them via
27-
28-
$ export DEISCTL_TUNNEL="deis-1.example.com"
29-
30-
!!! note
31-
For Vagrant clusters: `export DEISCTL_TUNNEL=172.17.8.100`
32-
33-
This is the IP address where deisctl will attempt to communicate with the cluster. You can test
34-
that it is working properly by running `deisctl list`. If you see a single line of output, the
35-
control utility is communicating with the nodes.
36-
37-
Before provisioning the platform, we'll need to add the SSH key to Deis so it can connect to remote
38-
hosts during `deis run`:
39-
40-
$ deisctl config platform set sshPrivateKey=~/.ssh/deis
41-
42-
!!! note
43-
For Vagrant clusters: `deisctl config platform set sshPrivateKey=${HOME}/.vagrant.d/insecure_private_key`
44-
45-
We'll also need to tell the controller which domain name we are deploying applications under:
46-
47-
$ deisctl config platform set domain=example.com
48-
49-
!!! note
50-
For Vagrant clusters: `deisctl config platform set domain=local3.deisapp.com`
12+
Ensure your kubectl client is installed and ensure it can connect to your kubernetes cluster. This
13+
is where `helm` will attempt to communicate with the cluster. You can test that it is working
14+
properly by running `kubectl get nodes`. If you see a list of available nodes, kubectl is
15+
communicating with the nodes.
5116

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

54-
$ deisctl install platform
55-
56-
You will see output like the following, which indicates that the units required to run Deis have
57-
been loaded on the CoreOS cluster:
58-
59-
● ▴ ■
60-
■ ● ▴ Installing Deis...
61-
▴ ■ ●
62-
63-
Scheduling data containers...
64-
...
65-
Deis installed.
66-
Please run `deisctl start platform` to boot up Deis.
67-
68-
Run this command to start the Deis platform:
69-
70-
$ deisctl start platform
19+
$ helm repo add deis https://github.com/deis/charts
20+
$ helm install deis/deis
7121

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

75-
$ deisctl list
24+
```
25+
$ kubectl get pods --namespace=deis
26+
```
7627

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

79-
Now that you've finished provisioning a cluster, start [Using Deis][] to deploy your first application on Deis.
30+
Now that you've finished provisioning a cluster, start [Using Deis][] to deploy your first
31+
application on Deis.
8032

8133
[install deisctl]: installing-deisctl.md
34+
[installing helm]: http://helm.sh/
8235
[helm]: http://helm.sh
8336
[using deis]: ../using-deis/deploying-an-application.md

docs/src/installing-deis/quickstart.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ The Deis provision scripts default to a machine size which should be adequate to
88

99
## Choose a Provider
1010

11-
Choose one of the following providers and deploy a new cluster:
11+
Choose one of the following providers and deploy a new kubernetes cluster:
1212

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

0 commit comments

Comments
 (0)