Skip to content

Commit 9c81a03

Browse files
authored
Merge pull request #539 from bacongobbler/add-followup-link
docs(installing-workflow): add followup link to register a user
2 parents 3ad28eb + 3139333 commit 9c81a03

1 file changed

Lines changed: 19 additions & 16 deletions

File tree

src/installing-workflow/index.md

Lines changed: 19 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Installing Deis Workflow
22

33
This document is aimed at those who have already provisioned a [Kubernetes v1.2 or v1.3.4+][] cluster
4-
and want to install Deis Workflow. If you are just getting started with Kubernetes and
5-
Deis Workflow, follow our [quickstart guide](../quickstart/index.md) for help.
4+
and want to install Deis Workflow. If help is required getting started with Kubernetes and
5+
Deis Workflow, follow the [quickstart guide](../quickstart/index.md) for assistance.
66

77
## Prerequisites
88

@@ -18,10 +18,10 @@ $ helmc --version
1818
helmc version 0.8.1+a9c55cf
1919
```
2020

21-
Ensure the `kubectl` client is installed and can connect to your Kubernetes cluster. `helmc` uses `kubectl` to interact
22-
with your Kubernetes cluster.
21+
Ensure the `kubectl` client is installed and can connect to the Kubernetes cluster. `helmc` uses `kubectl` to interact
22+
with the Kubernetes cluster.
2323

24-
You can test that `helmc` and `kubectl` are working properly by running:
24+
`helmc` can be verified it is working properly by running:
2525

2626
```
2727
$ helmc target
@@ -35,27 +35,27 @@ Grafana is running at https://52.9.206.49/api/v1/proxy/namespaces/kube-system/se
3535
InfluxDB is running at https://52.9.206.49/api/v1/proxy/namespaces/kube-system/services/monitoring-influxdb
3636
```
3737

38-
If you see a list of targets like the one above, `helmc` can communicate with the Kubernetes master. Double check that
38+
If `helmc target` shows a list of targets like the one above, `helmc` can communicate with the Kubernetes master. Double check that
3939
the master returned by `helmc target` matches the expected cluster.
4040

4141
## Choose Your Deployment Strategy
4242

4343
Deis Workflow includes everything it needs to run out of the box. However, these defaults are aimed at simplicity rather than
4444
production readiness. Production and staging deployments of Workflow should, at a minimum, use off-cluster storage.
4545
Which is used by Workflow components to store and backup critical data. Should an operator need to completely re-install
46-
Workflow, the required components can recover from off-cluster storage. See our documentation for [configuring object
46+
Workflow, the required components can recover from off-cluster storage. See the documentation for [configuring object
4747
storage](configuring-object-storage.md) for more details.
4848

4949
Workflow may also be configured to use off-cluster persistence for [Postgres](configuring-postgres.md) and
50-
Redis. A deployment strategy that mirrors the "stateless" clusters from Deis v1 PaaS.
50+
Redis; a deployment strategy that mirrors the "stateless" clusters from the Deis v1 PaaS.
5151

5252
Last but not least, Workflow may also use a dedicated off-cluster image registry, including Docker Hub, Quay.io, ECR or
5353
GCR for all container images. Read more about [configuring your registry](configuring-registry.md).
5454

5555
## Add the Deis Chart Repository
5656

57-
The [Deis Chart Repository](https://github.com/deis/charts) contains everything you need to install Deis Workflow onto
58-
your Kubernetes cluster, with a single `helmc install` command.
57+
The [Deis Chart Repository](https://github.com/deis/charts) contains everything needed to install Deis Workflow onto
58+
a Kubernetes cluster, with a single `helmc install` command.
5959

6060
Add this repository to Helm Classic:
6161

@@ -65,7 +65,7 @@ $ helmc repo add deis https://github.com/deis/charts
6565

6666
## Install Deis Workflow
6767

68-
Now that you have Helm Classic installed and have added the Deis Chart Repository, install Workflow by running:
68+
Now that Helm Classic is installed and the Deis Chart Repository has been added, install Workflow by running:
6969

7070
```
7171
$ helmc fetch deis/workflow-v2.6.0 # fetches the chart into a
@@ -76,14 +76,14 @@ $ helmc install workflow-v2.6.0 # injects resources into
7676
```
7777

7878
Helm Classic will install a variety of Kubernetes resources in the `deis` namespace.
79-
You'll need to wait for the pods that it launched to be ready. Monitor their status
80-
by running:
79+
Wait for the pods that Helm Classic launched to be ready. Monitor their status by running:
8180

8281
```
8382
$ kubectl --namespace=deis get pods
8483
```
8584

86-
If you would like `kubectl` to automatically update as the pod states change, run (type Ctrl-C to stop the watch):
85+
If it's preferred to have `kubectl` automatically update as the pod states change, run (type Ctrl-C to stop the watch):
86+
8787
```
8888
$ kubectl --namespace=deis get pods -w
8989
```
@@ -92,7 +92,8 @@ Depending on the order in which the Workflow components initialize, some pods ma
9292
installation: if a component's dependencies are not yet available, that component will exit and Kubernetes will
9393
automatically restart it.
9494

95-
Here, you can see that controller, builder and registry all took a few loops before there were able to start:
95+
Here, it can be seen that the controller, builder and registry all took a few loops before they were able to start:
96+
9697
```
9798
$ kubectl --namespace=deis get pods
9899
NAME READY STATUS RESTARTS AGE
@@ -108,6 +109,8 @@ deis-router-k1ond 1/1 Running 0 5m
108109
deis-workflow-manager-68nu6 1/1 Running 0 5m
109110
```
110111

111-
Once you see all of the pods in the `READY` state, Deis Workflow is up and running!
112+
Once all of the pods are in the `READY` state, Deis Workflow is up and running!
113+
114+
After installing Workflow, [register a user and deploy an application](../quickstart/deploy-an-app.md).
112115

113116
[Kubernetes v1.2 or v1.3.4+]: system-requirements.md#kubernetes-versions

0 commit comments

Comments
 (0)