Skip to content

Commit ad27e4e

Browse files
committed
Merge pull request #259 from mboersma/upgrade-docs
docs(upgrading-workflow): describe "keeper" upgrade behavior
2 parents 9c14781 + 67ac340 commit ad27e4e

6 files changed

Lines changed: 35 additions & 10 deletions

File tree

src/installing-workflow/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,11 @@ You need to [install Helm Classic and Deis Workflow CLI before continuing](../qu
1111

1212
## Check Your Setup
1313

14-
Check that the `helmc` command is available and the version is 0.7 or newer.
14+
Check that the `helmc` command is available and the version is 0.8 or newer.
1515

1616
```
1717
$ helmc --version
18-
helmc version 0.7.0+20a7ed7
18+
helmc version 0.8.0+f3cafbc
1919
```
2020

2121
Ensure the `kubectl` client is installed and can connect to your Kubernetes cluster. `helmc` uses `kubectl` to interact

src/managing-workflow/upgrading-workflow.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,28 @@ $ helmc fetch deis/workflow-beta4
99
$ helmc generate -x manifests workflow-beta4
1010
$ helmc install workflow-beta4
1111
```
12+
13+
## Keeping Essential Pieces
14+
15+
!!! note
16+
"Keeper" upgrade behavior requires Helm Classic 0.8.0 or newer and the workflow-rc1
17+
or workflow-dev chart.
18+
19+
Helm Classic recognizes when a manifest inside a chart is marked as a "keeper" and will leave
20+
it alone during `helmc uninstall`.
21+
22+
The Workflow Chart marks the "deis" Kubernetes `Namespace` and the `Service` for the registry
23+
and for the router as keepers. This keeps the external `LoadBalancer` intact so that routing
24+
and DNS are preserved while reinstalling Workflow.
25+
26+
To remove Workflow completely from a Kubernetes cluster, run the following:
27+
28+
```
29+
$ helmc uninstall -n deis -y workflow-dev
30+
$ kubectl delete ns deis # Be sure you want to delete the
31+
# Namespace and all its contents!
32+
```
33+
34+
See the Helm Classic documentation for more detail about [keeper manifests].
35+
36+
[keeper manifests]: http://helm-classic.readthedocs.io/en/latest/awesome/#keeper-manifests

src/quickstart/install-cli-tools.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,9 +35,9 @@ Install the latest `helmc` cli for Linux or Mac OS X with:
3535
Check your work by running `helmc version`:
3636

3737
$ helmc version
38-
helmc version 0.7.0+20a7ed7
38+
helmc version 0.8.0+f3cafbc
3939

40-
Make sure you are running at least version 0.7.0 or newer.
40+
Make sure you are running at least version 0.8.0 or newer.
4141

4242
## Step 2: Boot a Kubernetes Cluster and Install Deis Workflow
4343

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22

33
## Check Your Setup
44

5-
First check that the `helmc` command is available and the version is 0.7 or newer.
5+
First check that the `helmc` command is available and the version is 0.8 or newer.
66

77
```
88
$ helmc --version
9-
helmc version 0.7.0+20a7ed7
9+
helmc version 0.8.0+f3cafbc
1010
```
1111

1212
Ensure the `kubectl` client is installed and can connect to your Kubernetes cluster. `helmc` will

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22

33
## Check Your Setup
44

5-
First check that the `helm` command is available and the version is 0.7 or newer.
5+
First check that the `helm` command is available and the version is 0.8 or newer.
66

77
```
88
$ helmc --version
9-
helmc version 0.7.0+20a7ed7
9+
helmc version 0.8.0+f3cafbc
1010
```
1111

1212
Ensure the `kubectl` client is installed and can connect to your Kubernetes cluster. `helm` will

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22

33
## Check Your Setup
44

5-
First check that the `helm` command is available and the version is 0.7 or newer.
5+
First check that the `helm` command is available and the version is 0.8 or newer.
66

77
```
88
$ helmc --version
9-
helmc version 0.7.0+20a7ed7
9+
helmc version 0.8.0+f3cafbc
1010
```
1111

1212
Ensure the `kubectl` client is installed and can connect to your Kubernetes cluster. `helm` will

0 commit comments

Comments
 (0)