Skip to content

Commit 7ef70d2

Browse files
author
Vaughn Dice
committed
docs(various): update 'beta4' occurrences to 'rc1'
1 parent 539a80c commit 7ef70d2

9 files changed

Lines changed: 33 additions & 30 deletions

File tree

src/installing-workflow/configuring-object-storage.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ The helm classic chart for Deis Workflow can be easily configured to connect Wor
1717
* Note: Depending on your chosen object storage you may need to provide globally unique bucket names.
1818
* Note: If you provide credentials with sufficient access to the underlying storage, Workflow components will create the buckets if they do not exist.
1919
* **Step 2:** If applicable, generate credentials that have write access to the storage buckets created in Step 1
20-
* **Step 3:** If you haven't already fetched the helm classic chart, do so with `helmc fetch deis/workflow-beta4`
20+
* **Step 3:** If you haven't already fetched the helm classic chart, do so with `helmc fetch deis/workflow-rc1`
2121
* **Step 4:** Update storage details either by setting the appropriate environment variables or by modifying the template file `tpl/generate_params.toml`
2222
* **1.** Using environment variables:
2323
* Set `STORAGE_TYPE` to `s3`, `azure` or `gcs`, then set the following environment variables accordingly.
@@ -40,14 +40,14 @@ The helm classic chart for Deis Workflow can be easily configured to connect Wor
4040
```
4141

4242
* **2.** Using template file `tpl/generate_params.toml`:
43-
* Open the helm classic chart with `helmc edit workflow-beta4` and look for the template file `tpl/generate_params.toml`
43+
* Open the helm classic chart with `helmc edit workflow-rc1` and look for the template file `tpl/generate_params.toml`
4444
* Update the `storage` parameter to reference the storage platform you are using: `s3`, `azure`, `gcs`
4545
* Update the values in the section which corresponds to your storage type, including region, bucket names and access credentials
4646
* Note: you do not need to base64 encode any of these values as Helm Classic will handle encoding automatically
47-
* **Step 5:** Save your changes and re-generate the helm classic chart by running `helmc generate -x manifests workflow-beta4`
47+
* **Step 5:** Save your changes and re-generate the helm classic chart by running `helmc generate -x manifests workflow-rc1`
4848
* **Step 6:** Check the generated file in your manifests directory, you should see `deis-objectstorage-secret.yaml`
4949

50-
You are now ready to `helmc install workflow-beta4` using your desired object storage.
50+
You are now ready to `helmc install workflow-rc1` using your desired object storage.
5151

5252
## Object Storage Configuration and Credentials
5353

src/installing-workflow/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -54,10 +54,10 @@ $ helmc repo add deis https://github.com/deis/charts
5454
Now that you have Helm Classic installed and have added the Deis Chart Repository, install Workflow by running:
5555

5656
```
57-
$ helmc fetch deis/workflow-beta4 # fetches the chart into a
57+
$ helmc fetch deis/workflow-rc1 # fetches the chart into a
5858
# local workspace
59-
$ helmc generate -x manifests workflow-beta4 # generates various secrets
60-
$ helmc install workflow-beta4 # injects resources into
59+
$ helmc generate -x manifests workflow-rc1 # generates various secrets
60+
$ helmc install workflow-rc1 # injects resources into
6161
# your cluster
6262
```
6363

src/managing-workflow/component-configuration.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ or service. Helm is heavily influenced by [Homebrew](http://brew.sh/), including
55
[formula model](https://github.com/Homebrew/homebrew-core). A Helm chart is to Helm as a Formula
66
is to Homebrew.
77

8-
When you run `helmc fetch deis/workflow-beta4`, you can customize the chart with
9-
`helmc edit workflow-beta4`. To customize the respective component, edit
8+
When you run `helmc fetch deis/workflow-rc1`, you can customize the chart with
9+
`helmc edit workflow-rc1`. To customize the respective component, edit
1010
`manifests/deis-<component>-rc.yaml` and modify the `env` section of the component to tune these
1111
settings.
1212

src/managing-workflow/upgrading-workflow.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,12 @@
33
To upgrade to a newer version of Workflow, run the following:
44

55
```
6-
$ helmc uninstall workflow-beta3 -n deis
7-
$ helmc fetch deis/workflow-beta4
8-
$ helmc generate -x manifests workflow-beta4
9-
$ cp `helmc home`/workspace/charts/workflow-beta3/manifests/deis-database-secret-creds.yaml \
10-
`helmc home`/workspace/charts/workflow-beta4/manifests/
11-
$ helmc install workflow-beta4
6+
$ helmc uninstall workflow-beta4 -n deis
7+
$ helmc fetch deis/workflow-rc1
8+
$ helmc generate -x manifests workflow-rc1
9+
$ cp `helmc home`/workspace/charts/workflow-beta4/manifests/deis-database-secret-creds.yaml \
10+
`helmc home`/workspace/charts/workflow-rc1/manifests/
11+
$ helmc install workflow-rc1
1212
```
1313

1414
Make sure to copy the existing `deis-database-secret-creds.yaml` manifest into the new chart

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,10 +42,10 @@ $ helmc repo add deis https://github.com/deis/charts
4242
Now that you have Helm Classic installed and have added the Deis Chart Repository, install Workflow by running:
4343

4444
```
45-
$ helmc fetch deis/workflow-beta4 # fetches the chart into a
45+
$ helmc fetch deis/workflow-rc1 # fetches the chart into a
4646
# local workspace
47-
$ helmc generate -x manifests workflow-beta4 # generates various secrets
48-
$ helmc install workflow-beta4 # injects resources into
47+
$ helmc generate -x manifests workflow-rc1 # generates various secrets
48+
$ helmc install workflow-rc1 # injects resources into
4949
# your cluster
5050
```
5151

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,10 +40,10 @@ $ helmc repo add deis https://github.com/deis/charts
4040
Now that you have Helm installed and have added the Deis Chart Repository, install Workflow by running:
4141

4242
```
43-
$ helmc fetch deis/workflow-beta4 # fetches the chart into a
43+
$ helmc fetch deis/workflow-rc1 # fetches the chart into a
4444
# local workspace
45-
$ helmc generate -x manifests workflow-beta4 # generates various secrets
46-
$ helmc install workflow-beta4 # injects resources into
45+
$ helmc generate -x manifests workflow-rc1 # generates various secrets
46+
$ helmc install workflow-rc1 # injects resources into
4747
# your cluster
4848
```
4949

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,10 +40,10 @@ $ helmc repo add deis https://github.com/deis/charts
4040
Now that you have Helm installed and have added the Deis Chart Repository, install Workflow by running:
4141

4242
```
43-
$ helmc fetch deis/workflow-beta4 # fetches the chart into a
43+
$ helmc fetch deis/workflow-rc1 # fetches the chart into a
4444
# local workspace
45-
$ helmc generate -x manifests workflow-beta4 # generates various secrets
46-
$ helmc install workflow-beta4 # injects resources into
45+
$ helmc generate -x manifests workflow-rc1 # generates various secrets
46+
$ helmc install workflow-rc1 # injects resources into
4747
# your cluster
4848
```
4949

src/roadmap/release-checklist.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ The below sections present a step-by-step guide to publish a new Workflow releas
77
of the examples, we'll be assuming that the below two environment variables are present in wherever
88
you're working. Make sure to set them (e.g. by `export`ing them) before you get started.
99

10-
- `$WORKFLOW_RELEASE` - the full name of this version. For example, `v2.0.0-beta4`
11-
- `$WORKFLOW_RELEASE_SHORT` - The short name of this version. For example, `beta4`
10+
- `$WORKFLOW_RELEASE` - the full name of this version. For example, `v2.0.0-rc1`
11+
- `$WORKFLOW_RELEASE_SHORT` - The short name of this version. For example, `rc1`
1212

1313
# What's a Release?
1414

@@ -31,8 +31,8 @@ A release consists of the following artifacts:
3131
- [workflow-manager](https://github.com/deis/workflow-manager)
3232
- [workflow-cli](https://github.com/deis/workflow-cli)
3333
2. A new [Helm Classic chart for Workflow](https://github.com/deis/charts) that references all of the new
34-
images referenced above. For example, if `$WORKFLOW_RELEASE` is `2.0.0-beta4`, the new chart would
35-
be in a new directory called `workflow-beta4`.
34+
images referenced above. For example, if `$WORKFLOW_RELEASE` is `2.0.0-rc1`, the new chart would
35+
be in a new directory called `workflow-rc1`.
3636

3737
# Step 1: Create New Helm Classic Charts
3838

@@ -71,10 +71,13 @@ As of this writing, the e2e tests in this job are run on a GKE cluster using def
7171
Create a new pull request against deis/workflow, updating all references of the old release to
7272
`$WORKFLOW_RELEASE`. Use `git grep $WORKFLOW_OLD_RELEASE` to find any references.
7373

74+
Also, note there may be an occurrence of the previous oldest release (prior to `$WORKFLOW_OLD_RELEASE`) in
75+
`upgrading-workflow.md`. This should be changed to `$WORKFLOW_OLD_RELEASE`.
76+
7477
# Step 4: Manual Testing
7578

7679
After the chart is created with the immutable Docker image tags that represent the final images
77-
(i.e. the ones that will be re-tagged to the immutable release tag, such as `2.0.0-beta4`), it
80+
(i.e. the ones that will be re-tagged to the immutable release tag, such as `2.0.0-rc1`), it
7881
should be manually tested by as many people as possible. Special attention should be paid to the
7982
user experience, both from an operator and developer perspective.
8083

src/troubleshooting/kubectl.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This document describes how one can use `kubectl` to debug any issues with the c
44

55
## Diving into the Components
66

7-
Using `kubectl`, one can inspect the cluster's current state. When `helmc install workflow-beta4`
7+
Using `kubectl`, one can inspect the cluster's current state. When `helmc install workflow-rc1`
88
is invoked, Workflow is installed into the `deis` namespace. To inspect if Workflow is running,
99
run:
1010

0 commit comments

Comments
 (0)