Skip to content

Commit 447ffd0

Browse files
author
Jason Hansen
committed
Merge pull request #35 from slack/platform-to-workflow
Start massaging Workflow into docs
2 parents 8723ccf + 49dc34d commit 447ffd0

6 files changed

Lines changed: 83 additions & 71 deletions

File tree

mkdocs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ pages:
1212
- Installing Deis:
1313
- Quick Start: installing-deis/quickstart.md
1414
- System Requirements: installing-deis/system-requirements.md
15-
- Installing the Deis Platform: installing-deis/installing-the-deis-platform.md
15+
- Installing Deis Workflow: installing-deis/installing-deis-workflow.md
1616
- Using Deis:
1717
- Installing the Client: using-deis/installing-the-client.md
1818
- Registering a User: using-deis/registering-a-user.md

src/index.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
1-
# Welcome
1+
# Welcome to Deis Workflow
22

3-
Deis (pronounced DAY-iss) is an open source PaaS that makes it easy to deploy and manage applications on your own servers. Deis builds upon Kubernetes to provide a lightweight PaaS with a Heroku-inspired workflow.
3+
Deis (pronounced DAY-iss) Workflow is an open source PaaS that makes it easy to deploy and manage applications on your own servers. Deis Workflow adds a developer-friendly Platform as a Service (PaaS) layer to any Kubernetes cluster, including: a simple REST API, application log aggregation, release and rollback, edge routing, git-push-to-container image, and authentication and authorization.
44

5-
To get started with Deis, first read the [Architecture][arch] and [Concepts][concepts] of Deis, then use [the QuickStart documentation][quickstart] to start provisioning your cluster.
5+
To get started with Workflow, follow our [Quick Start][quickstart] guide.
6+
7+
For more detailed information about Workflow view the [Architecture][arch] and [Concepts][concepts] sections.
68

79
[arch]: understanding-deis/architecture.md
810
[concepts]: understanding-deis/concepts.md
Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
# Installing Deis Workflow
2+
3+
We will use the `helm` utility to install Deis Workflow onto a Kubernetes cluster. If you don't
4+
have `helm` installed, see [installing helm][helm] for more info.
5+
6+
## Check Your Setup
7+
8+
First check that you have `helm` installed and the version is correct.
9+
10+
```
11+
$ helm --version
12+
0.4.0
13+
```
14+
15+
Ensure your kubectl client is installed and ensure it can connect to your Kubernetes cluster. This
16+
is where `helm` will attempt to communicate with the cluster. You can test that it is working
17+
properly by running:
18+
19+
```
20+
$ helm target
21+
Kubernetes master is running at https://10.245.1.2
22+
Heapster is running at https://10.245.1.2/api/v1/proxy/namespaces/kube-system/services/heapster
23+
KubeDNS is running at https://10.245.1.2/api/v1/proxy/namespaces/kube-system/services/kube-dns
24+
KubeUI is running at https://10.245.1.2/api/v1/proxy/namespaces/kube-system/services/kube-ui
25+
Grafana is running at https://10.245.1.2/api/v1/proxy/namespaces/kube-system/services/monitoring-grafana
26+
InfluxDB is running at https://10.245.1.2/api/v1/proxy/namespaces/kube-system/services/monitoring-influxdb
27+
```
28+
29+
If you see a list of targets like the one above, 'helm' can communicate with the kubernetes master.
30+
31+
## Get the Helm Chart
32+
33+
The [Deis Chart Repository](https://github.com/deis/charts) contains everything you
34+
need to install Deis onto your Kubernetes cluster, with a single `helm install` command.
35+
36+
Run the following commands to set up your Helm environment and install the chart:
37+
38+
```
39+
$ helm update
40+
$ helm repo add deis https://github.com/deis/charts
41+
$ helm fetch deis/deis
42+
```
43+
44+
## Install Deis Workflow
45+
46+
Now that you have Helm installed and added the Deis Chart Repository, install Workflow by running:
47+
48+
```
49+
$ helm install deis/deis --namespace=deis
50+
```
51+
52+
Helm will install a variety of Kubernetes resources in the `deis` namespace.
53+
You'll need to wait for the pods that it launched to be ready. Monitor their status
54+
by running:
55+
56+
```
57+
$ kubectl get pods --namespace=deis
58+
```
59+
60+
If you would like `kubectl` to automatically update as the pod states change, run (type Ctrl-C to stop the watch):
61+
```
62+
$ kubectl get pods --namespace=deis -w
63+
```
64+
65+
Once you see all of the pods in the `READY` state, Deis Workflow is up and running!
66+
67+
Next, [configure dns][] so you can register your first user.
68+
69+
[helm]: http://helm.sh
70+
[using deis]: ../using-deis/deploying-an-application.md
71+
[configure dns]: ../managing-deis/configuring-dns.md

src/installing-deis/installing-the-deis-platform.md

Lines changed: 0 additions & 61 deletions
This file was deleted.

src/installing-deis/quickstart.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Quick Start
22

3-
These steps will help you provision a Deis cluster.
3+
These steps will help you install and configure Deis Workflow on a Kubernetes cluster.
44

55
## Check System Requirements
66

@@ -16,23 +16,23 @@ Choose one of the following providers and deploy a new Kubernetes cluster:
1616

1717
Reference [this table](http://kubernetes.io/v1.1/docs/getting-started-guides/#table-of-solutions) in the official Kubernetes documentation for a more extensive (but still non-exhaustive) list of Kubernetes provisioning options supported by the project or the community.
1818

19-
## Install Deis Platform
19+
## Install Deis Workflow
2020

21-
Now that you've finished provisioning a cluster, please [Install the Deis Platform][install deis].
21+
Now that you've finished provisioning a cluster, please [Install Deis Workflow][install deis].
2222

2323
## Configure DNS
2424

2525
See [Configuring DNS][] for more information on properly setting up your DNS records with Deis.
2626

2727
## Register a User
2828

29-
Once your cluster has been provisioned and the Deis Platform has been installed, you can
29+
Once your cluster has been provisioned and Deis Workflow has been installed, you can
3030
[install the client][client] and [register your first user][register]!
3131

3232

3333
[client]: ../using-deis/installing-the-client.md
3434
[configuring object storage]: configuring-object-storage.md
3535
[configuring dns]: ../managing-deis/configuring-dns.md
36-
[install deis]: installing-the-deis-platform.md
36+
[install deis]: installing-deis-workflow.md
3737
[register]: ../using-deis/registering-a-user.md
3838
[system requirements]: system-requirements.md

src/reference-guide/terms.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ The Controller stack includes:
5555

5656
- Django API Server for handling API calls
5757

58-
Follow the [Installing Deis](../installing-deis/installing-the-deis-platform.md) guide to create your own private Deis controller.
58+
Follow the [Installing Deis](../installing-deis/installing-deis-workflow.md) guide to create your own private Deis controller.
5959

6060

6161
## Key

0 commit comments

Comments
 (0)