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

Commit

Permalink
docs(various): update 'beta4' occurrences to 'rc1'
Browse files Browse the repository at this point in the history
  • Loading branch information
Vaughn Dice committed May 25, 2016
1 parent 539a80c commit 7ef70d2
Show file tree
Hide file tree
Showing 9 changed files with 33 additions and 30 deletions.
8 changes: 4 additions & 4 deletions src/installing-workflow/configuring-object-storage.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ The helm classic chart for Deis Workflow can be easily configured to connect Wor
* Note: Depending on your chosen object storage you may need to provide globally unique bucket names.
* Note: If you provide credentials with sufficient access to the underlying storage, Workflow components will create the buckets if they do not exist.
* **Step 2:** If applicable, generate credentials that have write access to the storage buckets created in Step 1
* **Step 3:** If you haven't already fetched the helm classic chart, do so with `helmc fetch deis/workflow-beta4`
* **Step 3:** If you haven't already fetched the helm classic chart, do so with `helmc fetch deis/workflow-rc1`
* **Step 4:** Update storage details either by setting the appropriate environment variables or by modifying the template file `tpl/generate_params.toml`
* **1.** Using environment variables:
* Set `STORAGE_TYPE` to `s3`, `azure` or `gcs`, then set the following environment variables accordingly.
Expand All @@ -40,14 +40,14 @@ The helm classic chart for Deis Workflow can be easily configured to connect Wor
```

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

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

## Object Storage Configuration and Credentials

Expand Down
6 changes: 3 additions & 3 deletions src/installing-workflow/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,10 +54,10 @@ $ helmc repo add deis https://github.com/deis/charts
Now that you have Helm Classic installed and have added the Deis Chart Repository, install Workflow by running:

```
$ helmc fetch deis/workflow-beta4 # fetches the chart into a
$ helmc fetch deis/workflow-rc1 # fetches the chart into a
# local workspace
$ helmc generate -x manifests workflow-beta4 # generates various secrets
$ helmc install workflow-beta4 # injects resources into
$ helmc generate -x manifests workflow-rc1 # generates various secrets
$ helmc install workflow-rc1 # injects resources into
# your cluster
```

Expand Down
4 changes: 2 additions & 2 deletions src/managing-workflow/component-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ or service. Helm is heavily influenced by [Homebrew](http://brew.sh/), including
[formula model](https://github.com/Homebrew/homebrew-core). A Helm chart is to Helm as a Formula
is to Homebrew.

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

Expand Down
12 changes: 6 additions & 6 deletions src/managing-workflow/upgrading-workflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
To upgrade to a newer version of Workflow, run the following:

```
$ helmc uninstall workflow-beta3 -n deis
$ helmc fetch deis/workflow-beta4
$ helmc generate -x manifests workflow-beta4
$ cp `helmc home`/workspace/charts/workflow-beta3/manifests/deis-database-secret-creds.yaml \
`helmc home`/workspace/charts/workflow-beta4/manifests/
$ helmc install workflow-beta4
$ helmc uninstall workflow-beta4 -n deis
$ helmc fetch deis/workflow-rc1
$ helmc generate -x manifests workflow-rc1
$ cp `helmc home`/workspace/charts/workflow-beta4/manifests/deis-database-secret-creds.yaml \
`helmc home`/workspace/charts/workflow-rc1/manifests/
$ helmc install workflow-rc1
```

Make sure to copy the existing `deis-database-secret-creds.yaml` manifest into the new chart
Expand Down
6 changes: 3 additions & 3 deletions src/quickstart/provider/aws/install-aws.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,10 +42,10 @@ $ helmc repo add deis https://github.com/deis/charts
Now that you have Helm Classic installed and have added the Deis Chart Repository, install Workflow by running:

```
$ helmc fetch deis/workflow-beta4 # fetches the chart into a
$ helmc fetch deis/workflow-rc1 # fetches the chart into a
# local workspace
$ helmc generate -x manifests workflow-beta4 # generates various secrets
$ helmc install workflow-beta4 # injects resources into
$ helmc generate -x manifests workflow-rc1 # generates various secrets
$ helmc install workflow-rc1 # injects resources into
# your cluster
```

Expand Down
6 changes: 3 additions & 3 deletions src/quickstart/provider/gke/install-gke.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,10 +40,10 @@ $ helmc repo add deis https://github.com/deis/charts
Now that you have Helm installed and have added the Deis Chart Repository, install Workflow by running:

```
$ helmc fetch deis/workflow-beta4 # fetches the chart into a
$ helmc fetch deis/workflow-rc1 # fetches the chart into a
# local workspace
$ helmc generate -x manifests workflow-beta4 # generates various secrets
$ helmc install workflow-beta4 # injects resources into
$ helmc generate -x manifests workflow-rc1 # generates various secrets
$ helmc install workflow-rc1 # injects resources into
# your cluster
```

Expand Down
6 changes: 3 additions & 3 deletions src/quickstart/provider/vagrant/install-vagrant.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,10 +40,10 @@ $ helmc repo add deis https://github.com/deis/charts
Now that you have Helm installed and have added the Deis Chart Repository, install Workflow by running:

```
$ helmc fetch deis/workflow-beta4 # fetches the chart into a
$ helmc fetch deis/workflow-rc1 # fetches the chart into a
# local workspace
$ helmc generate -x manifests workflow-beta4 # generates various secrets
$ helmc install workflow-beta4 # injects resources into
$ helmc generate -x manifests workflow-rc1 # generates various secrets
$ helmc install workflow-rc1 # injects resources into
# your cluster
```

Expand Down
13 changes: 8 additions & 5 deletions src/roadmap/release-checklist.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ The below sections present a step-by-step guide to publish a new Workflow releas
of the examples, we'll be assuming that the below two environment variables are present in wherever
you're working. Make sure to set them (e.g. by `export`ing them) before you get started.

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

# What's a Release?

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

# Step 1: Create New Helm Classic Charts

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

Also, note there may be an occurrence of the previous oldest release (prior to `$WORKFLOW_OLD_RELEASE`) in
`upgrading-workflow.md`. This should be changed to `$WORKFLOW_OLD_RELEASE`.

# Step 4: Manual Testing

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

Expand Down
2 changes: 1 addition & 1 deletion src/troubleshooting/kubectl.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ This document describes how one can use `kubectl` to debug any issues with the c

## Diving into the Components

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

Expand Down

0 comments on commit 7ef70d2

Please sign in to comment.