Skip to content
This repository was archived by the owner on Nov 30, 2021. It is now read-only.

Commit 3e65eba

Browse files
author
Matthew Fisher
committed
ref(quickstart): use markdown-include to de-duplicate quickstart info
1 parent 954f425 commit 3e65eba

6 files changed

Lines changed: 73 additions & 202 deletions

File tree

‎mkdocs.yml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -109,6 +109,8 @@ theme_dir: themes/deis
109109
docs_dir: src
110110
markdown_extensions:
111111
- markdown_checklist.extension
112+
- markdown_include.include:
113+
base_path: src/_includes
112114
- admonition
113115
- codehilite
114116
- toc:

‎requirements.txt‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
mkdocs==0.15.3
22
markdown-checklist==0.4.1
3+
markdown-include==0.5.1

‎src/_includes/install-workflow.md‎

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
## Check Your Setup
2+
3+
First check that the `helm` command is available and the version is v2.1.3 or newer.
4+
5+
```
6+
$ helm version
7+
Client: &version.Version{SemVer:"v2.1.3", GitCommit:"5cbc48fb305ca4bf68c26eb8d2a7eb363227e973", GitTreeState:"clean"}
8+
Server: &version.Version{SemVer:"v2.1.3", GitCommit:"5cbc48fb305ca4bf68c26eb8d2a7eb363227e973", GitTreeState:"clean"}
9+
```
10+
11+
Ensure the `kubectl` client is installed and can connect to your Kubernetes cluster.
12+
13+
## Add the Deis Chart Repository
14+
15+
The Deis Chart Repository contains everything needed to install Deis Workflow onto a Kubernetes cluster, with a single `helm install deis/workflow --namespace deis` command.
16+
17+
Add this repository to Helm:
18+
19+
```
20+
$ helm repo add deis https://charts.deis.com/workflow
21+
```
22+
23+
## Install Deis Workflow
24+
25+
Now that Helm is installed and the repository has been added, install Workflow by running:
26+
27+
```
28+
$ helm install deis/workflow --namespace deis
29+
```
30+
31+
Helm will install a variety of Kubernetes resources in the `deis` namespace.
32+
Wait for the pods that Helm launched to be ready. Monitor their status by running:
33+
34+
```
35+
$ kubectl --namespace=deis get pods
36+
```
37+
38+
If it's preferred to have `kubectl` automatically update as the pod states change, run (type Ctrl-C to stop the watch):
39+
40+
```
41+
$ kubectl --namespace=deis get pods -w
42+
```
43+
44+
Depending on the order in which the Workflow components initialize, some pods may restart. This is common during the
45+
installation: if a component's dependencies are not yet available, that component will exit and Kubernetes will
46+
automatically restart it.
47+
48+
Here, it can be seen that the controller, builder and registry all took a few loops before they were able to start:
49+
50+
```
51+
$ kubectl --namespace=deis get pods
52+
NAME READY STATUS RESTARTS AGE
53+
deis-builder-hy3xv 1/1 Running 5 5m
54+
deis-controller-g3cu8 1/1 Running 5 5m
55+
deis-database-rad1o 1/1 Running 0 5m
56+
deis-logger-fluentd-1v8uk 1/1 Running 0 5m
57+
deis-logger-fluentd-esm60 1/1 Running 0 5m
58+
deis-logger-sm8b3 1/1 Running 0 5m
59+
deis-minio-4ww3t 1/1 Running 0 5m
60+
deis-registry-asozo 1/1 Running 1 5m
61+
deis-router-k1ond 1/1 Running 0 5m
62+
deis-workflow-manager-68nu6 1/1 Running 0 5m
63+
```
64+
65+
Once all of the pods are in the `READY` state, Deis Workflow is up and running!
66+
67+
Next, [configure dns](dns.md) so you can register your first user and deploy an application.

‎src/quickstart/provider/aws/install-aws.md‎

Lines changed: 1 addition & 68 deletions
Original file line numberDiff line numberDiff line change
@@ -1,71 +1,6 @@
11
# Installing Deis Workflow on Amazon Web Services
22

3-
## Check Your Setup
4-
5-
First check that the `helm` command is available and the version is v2.1.0 or newer.
6-
7-
```
8-
$ helm version
9-
Client: &version.Version{SemVer:"v2.1.0", GitCommit:"b7b648456ba15d3d190bb84b36a4bc9c41067cf3", GitTreeState:"clean"}
10-
Server: &version.Version{SemVer:"v2.1.0", GitCommit:"b7b648456ba15d3d190bb84b36a4bc9c41067cf3", GitTreeState:"clean"}
11-
```
12-
13-
Ensure the `kubectl` client is installed and can connect to your Kubernetes cluster.
14-
15-
## Add the Deis Chart Repository
16-
17-
The Deis Chart Repository contains everything you need to install Workflow onto your Kubernetes
18-
cluster, with a single `helm install deis/workflow --namespace deis` command.
19-
20-
Run the following command to add this repository to Helm:
21-
22-
```
23-
$ helm repo add deis https://charts.deis.com/workflow
24-
```
25-
26-
## Install Deis Workflow
27-
28-
Now that Helm is installed and the repository has been added, install Workflow by running:
29-
30-
```
31-
$ helm install deis/workflow --namespace deis
32-
```
33-
34-
Helm will install a variety of Kubernetes resources in the `deis` namespace.
35-
Wait for the pods that Helm launched to be ready. Monitor their status by running:
36-
37-
```
38-
$ kubectl --namespace=deis get pods
39-
```
40-
41-
If it's preferred to have `kubectl` automatically update as the pod states change, run (type Ctrl-C to stop the watch):
42-
43-
```
44-
$ kubectl --namespace=deis get pods -w
45-
```
46-
47-
Depending on the order in which the Workflow components initialize, some pods may restart. This is common during the
48-
installation: if a component's dependencies are not yet available, that component will exit and Kubernetes will
49-
automatically restart it.
50-
51-
Here, it can be seen that the controller, builder and registry all took a few loops before they were able to start:
52-
53-
```
54-
$ kubectl --namespace=deis get pods
55-
NAME READY STATUS RESTARTS AGE
56-
deis-builder-hy3xv 1/1 Running 5 5m
57-
deis-controller-g3cu8 1/1 Running 5 5m
58-
deis-database-rad1o 1/1 Running 0 5m
59-
deis-logger-fluentd-1v8uk 1/1 Running 0 5m
60-
deis-logger-fluentd-esm60 1/1 Running 0 5m
61-
deis-logger-sm8b3 1/1 Running 0 5m
62-
deis-minio-4ww3t 1/1 Running 0 5m
63-
deis-registry-asozo 1/1 Running 1 5m
64-
deis-router-k1ond 1/1 Running 0 5m
65-
deis-workflow-manager-68nu6 1/1 Running 0 5m
66-
```
67-
68-
Once all of the pods are in the `READY` state, Deis Workflow is up and running!
3+
{!install-workflow.md!}
694

705
## Configure your AWS Load Balancer
716

@@ -104,5 +39,3 @@ $ aws elb modify-load-balancer-attributes \
10439
abce0d48217d311e69a470643b4d9062
10540
CONNECTIONSETTINGS 1200
10641
```
107-
108-
Next, [configure dns](dns.md) so you can register your first user and deploy an application.

‎src/quickstart/provider/gke/install-gke.md‎

Lines changed: 1 addition & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -1,69 +1,3 @@
11
# Install Deis Workflow on Google Compute Engine
22

3-
## Check Your Setup
4-
5-
First check that the `helm` command is available and the version is v2.1.0 or newer.
6-
7-
```
8-
$ helm version
9-
Client: &version.Version{SemVer:"v2.1.0", GitCommit:"b7b648456ba15d3d190bb84b36a4bc9c41067cf3", GitTreeState:"clean"}
10-
Server: &version.Version{SemVer:"v2.1.0", GitCommit:"b7b648456ba15d3d190bb84b36a4bc9c41067cf3", GitTreeState:"clean"}
11-
```
12-
13-
Ensure the `kubectl` client is installed and can connect to your Kubernetes cluster.
14-
15-
## Add the Deis Chart Repository
16-
17-
The Deis Chart Repository contains everything needed to install Deis Workflow onto a Kubernetes cluster, with a single `helm install deis/workflow --namespace deis` command.
18-
19-
Add this repository to Helm:
20-
21-
```
22-
$ helm repo add deis https://charts.deis.com/workflow
23-
```
24-
25-
## Install Deis Workflow
26-
27-
Now that Helm is installed and the repository has been added, install Workflow by running:
28-
29-
```
30-
$ helm install deis/workflow --namespace deis
31-
```
32-
33-
Helm will install a variety of Kubernetes resources in the `deis` namespace.
34-
Wait for the pods that Helm launched to be ready. Monitor their status by running:
35-
36-
```
37-
$ kubectl --namespace=deis get pods
38-
```
39-
40-
If it's preferred to have `kubectl` automatically update as the pod states change, run (type Ctrl-C to stop the watch):
41-
42-
```
43-
$ kubectl --namespace=deis get pods -w
44-
```
45-
46-
Depending on the order in which the Workflow components initialize, some pods may restart. This is common during the
47-
installation: if a component's dependencies are not yet available, that component will exit and Kubernetes will
48-
automatically restart it.
49-
50-
Here, it can be seen that the controller, builder and registry all took a few loops before they were able to start:
51-
52-
```
53-
$ kubectl --namespace=deis get pods
54-
NAME READY STATUS RESTARTS AGE
55-
deis-builder-hy3xv 1/1 Running 5 5m
56-
deis-controller-g3cu8 1/1 Running 5 5m
57-
deis-database-rad1o 1/1 Running 0 5m
58-
deis-logger-fluentd-1v8uk 1/1 Running 0 5m
59-
deis-logger-fluentd-esm60 1/1 Running 0 5m
60-
deis-logger-sm8b3 1/1 Running 0 5m
61-
deis-minio-4ww3t 1/1 Running 0 5m
62-
deis-registry-asozo 1/1 Running 1 5m
63-
deis-router-k1ond 1/1 Running 0 5m
64-
deis-workflow-manager-68nu6 1/1 Running 0 5m
65-
```
66-
67-
Once all of the pods are in the `READY` state, Deis Workflow is up and running!
68-
69-
Next, [configure dns](dns.md) so you can register your first user and deploy an application.
3+
{!install-workflow.md!}

‎src/quickstart/provider/vagrant/install-vagrant.md‎

Lines changed: 1 addition & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -1,69 +1,3 @@
11
# Install Deis Workflow on Vagrant
22

3-
## Check Your Setup
4-
5-
First check that the `helm` command is available and the version is v2.1.0 or newer.
6-
7-
```
8-
$ helm version
9-
Client: &version.Version{SemVer:"v2.1.0", GitCommit:"b7b648456ba15d3d190bb84b36a4bc9c41067cf3", GitTreeState:"clean"}
10-
Server: &version.Version{SemVer:"v2.1.0", GitCommit:"b7b648456ba15d3d190bb84b36a4bc9c41067cf3", GitTreeState:"clean"}
11-
```
12-
13-
Ensure the `kubectl` client is installed and can connect to your Kubernetes cluster.
14-
15-
## Add the Deis Chart Repository
16-
17-
The Deis Chart Repository contains everything needed to install Deis Workflow onto a Kubernetes cluster, with a single `helm install deis/workflow --namespace deis` command.
18-
19-
Add this repository to Helm:
20-
21-
```
22-
$ helm repo add deis https://charts.deis.com/workflow
23-
```
24-
25-
## Install Deis Workflow
26-
27-
Now that Helm is installed and the repository has been added, install Workflow by running:
28-
29-
```
30-
$ helm install deis/workflow --namespace deis
31-
```
32-
33-
Helm will install a variety of Kubernetes resources in the `deis` namespace.
34-
Wait for the pods that Helm launched to be ready. Monitor their status by running:
35-
36-
```
37-
$ kubectl --namespace=deis get pods
38-
```
39-
40-
If it's preferred to have `kubectl` automatically update as the pod states change, run (type Ctrl-C to stop the watch):
41-
42-
```
43-
$ kubectl --namespace=deis get pods -w
44-
```
45-
46-
Depending on the order in which the Workflow components initialize, some pods may restart. This is common during the
47-
installation: if a component's dependencies are not yet available, that component will exit and Kubernetes will
48-
automatically restart it.
49-
50-
Here, it can be seen that the controller, builder and registry all took a few loops before they were able to start:
51-
52-
```
53-
$ kubectl --namespace=deis get pods
54-
NAME READY STATUS RESTARTS AGE
55-
deis-builder-hy3xv 1/1 Running 5 5m
56-
deis-controller-g3cu8 1/1 Running 5 5m
57-
deis-database-rad1o 1/1 Running 0 5m
58-
deis-logger-fluentd-1v8uk 1/1 Running 0 5m
59-
deis-logger-fluentd-esm60 1/1 Running 0 5m
60-
deis-logger-sm8b3 1/1 Running 0 5m
61-
deis-minio-4ww3t 1/1 Running 0 5m
62-
deis-registry-asozo 1/1 Running 1 5m
63-
deis-router-k1ond 1/1 Running 0 5m
64-
deis-workflow-manager-68nu6 1/1 Running 0 5m
65-
```
66-
67-
Once all of the pods are in the `READY` state, Deis Workflow is up and running!
68-
69-
Next, [configure dns](dns.md) so you can register your first user and deploy an application.
3+
{!install-workflow.md!}

0 commit comments

Comments
 (0)