Skip to content

Commit 540c4ec

Browse files
committed
feat(update): update docs to reflect v2.3.0
1 parent de0e498 commit 540c4ec

11 files changed

Lines changed: 33 additions & 33 deletions

File tree

_scripts/deploy.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
cd "$(dirname "$0")" || exit 1
77

8-
export IMAGE_PREFIX=deisci VERSION=v2.2.0
8+
export IMAGE_PREFIX=deisci VERSION=v2.3.0
99
docker login -e="$DOCKER_EMAIL" -u="$DOCKER_USERNAME" -p="$DOCKER_PASSWORD"
1010
DEIS_REGISTRY='' make -C .. docker-build docker-push
1111
docker login -e="$QUAY_EMAIL" -u="$QUAY_USERNAME" -p="$QUAY_PASSWORD" quay.io

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-v2.2.0`
20+
* **Step 3:** If you haven't already fetched the helm classic chart, do so with `helmc fetch deis/workflow-v2.3.0`
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.
@@ -48,14 +48,14 @@ The helm classic chart for Deis Workflow can be easily configured to connect Wor
4848
* To specify tenant set `SWIFT_TENANT` if the auth version is 2 or more.
4949

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

58-
You are now ready to `helmc install workflow-v2.2.0` using your desired object storage.
58+
You are now ready to `helmc install workflow-v2.3.0` using your desired object storage.
5959

6060
## Object Storage Configuration and Credentials
6161

src/installing-workflow/configuring-postgres.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ $ psql -h <host> -p <port> -d postgres -U <"postgres" or your own username>
3131

3232
The Helm Classic chart for Deis Workflow can be easily configured to connect the Workflow controller component to an off-cluster PostgreSQL database.
3333

34-
* **Step 1:** If you haven't already fetched the Helm Classic chart, do so with `helmc fetch deis/workflow-v2.2.0`
34+
* **Step 1:** If you haven't already fetched the Helm Classic chart, do so with `helmc fetch deis/workflow-v2.3.0`
3535
* **Step 2:** Update database connection details either by setting the appropriate environment variables _or_ by modifying the template file `tpl/generate_params.toml`. Note that environment variables take precedence over settings in `tpl/generate_params.toml`.
3636
* **1.** Using environment variables:
3737
* Set `DATABASE_LOCATION` to `off-cluster`.
@@ -41,18 +41,18 @@ The Helm Classic chart for Deis Workflow can be easily configured to connect the
4141
* Set `DATABASE_USERNAME` to the username of the database user that owns the database-- typically `deis`.
4242
* Set `DATABASE_PASSWORD` to the password for the database user that owns the database.
4343
* **2.** Using template file `tpl/generate_params.toml`:
44-
* Open the Helm Classic chart with `helmc edit workflow-v2.2.0` and look for the template file `tpl/generate_params.toml`
44+
* Open the Helm Classic chart with `helmc edit workflow-v2.3.0` and look for the template file `tpl/generate_params.toml`
4545
* Update the `database_location` parameter to `off-cluster`.
4646
* Update the values in the `[database]` configuration section to properly reflect all connection details.
4747
* Save your changes.
4848
* Note: Whether using environment variables or `tpl/generate_params.toml`, you do not need to (and must not) base64 encode any values, as the Helm Classic chart will automatically handle encoding as necessary.
49-
* **Step 3:** Re-generate the Helm Classic chart by running `helmc generate -x manifests workflow-v2.2.0`
49+
* **Step 3:** Re-generate the Helm Classic chart by running `helmc generate -x manifests workflow-v2.3.0`
5050
* **Step 4:** Check the generated files in your `manifests` directory. You should see:
5151
* `deis-controller-rc.yaml` contains relevant connection details.
5252
* `deis-database-secret-creds.yaml` exists and contains base64 encoded database username and password.
5353
* No other database-related Kubernetes resources are defined. i.e. none of `database-database-service-account.yaml`, `database-database-service.yaml`, or `database-database-rc.yaml` exist.
5454

55-
You are now ready to `helmc install workflow-v2.2.0` [as usual][installing].
55+
You are now ready to `helmc install workflow-v2.3.0` [as usual][installing].
5656

5757
[database]: ../understanding-workflow/components.md#database
5858
[object storage]: configuring-object-storage.md

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-v2.2.0 # fetches the chart into a
57+
$ helmc fetch deis/workflow-v2.3.0 # fetches the chart into a
5858
# local workspace
59-
$ helmc generate -x manifests workflow-v2.2.0 # generates various secrets
60-
$ helmc install workflow-v2.2.0 # injects resources into
59+
$ helmc generate -x manifests workflow-v2.3.0 # generates various secrets
60+
$ helmc install workflow-v2.3.0 # injects resources into
6161
# your cluster
6262
```
6363

src/managing-workflow/platform-logging.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ Error: There are currently no log messages. Please check the following things:
5454
## Default Configuration
5555
By default the Fluentd pod can be configured to talk to numerous syslog endpoints. So for example it is possible to have Fluentd send log messages to both the Logger component and [Papertrail](https://papertrailapp.com/). This allows production deployments of Deis to satisfy stringent logging requirements such as offsite backups of log data.
5656

57-
Configuring Fluentd to talk to multiple syslog endpoints means adding the following stanzas to the [Fluentd daemonset manifest](https://github.com/deis/charts/blob/master/workflow-v2.2.0/tpl/deis-logger-fluentd-daemon.yaml) -
57+
Configuring Fluentd to talk to multiple syslog endpoints means adding the following stanzas to the [Fluentd daemonset manifest](https://github.com/deis/charts/blob/master/workflow-v2.3.0/tpl/deis-logger-fluentd-daemon.yaml) -
5858

5959
```
6060
env:

src/managing-workflow/upgrading-workflow.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -59,27 +59,27 @@ $ kubectl --namespace=deis get secret database-creds -o yaml > ~/active-deis-dat
5959
$ kubectl --namespace=deis get secret builder-ssh-private-keys -o yaml > ~/active-deis-builder-secret-ssh-private-keys.yaml
6060
6161
# fetch new chart
62-
$ helmc fetch deis/workflow-v2.2.0
62+
$ helmc fetch deis/workflow-v2.3.0
6363
6464
# update your off-cluster storage configuration
65-
$ $EDITOR $(helmc home)/workspace/charts/workflow-v2.2.0/tpl/generate_params.toml
65+
$ $EDITOR $(helmc home)/workspace/charts/workflow-v2.3.0/tpl/generate_params.toml
6666
6767
# generate new templates
68-
$ helmc generate -x manifests workflow-v2.2.0
68+
$ helmc generate -x manifests workflow-v2.3.0
6969
7070
# copy your active database secrets into the helmc workspace
7171
$ cp ~/active-deis-database-secret-creds.yaml \
72-
$(helmc home)/workspace/charts/workflow-v2.2.0/manifests/deis-database-secret-creds.yaml
72+
$(helmc home)/workspace/charts/workflow-v2.3.0/manifests/deis-database-secret-creds.yaml
7373
7474
# copy your active builder ssh keys into the helmc workspace
7575
$ cp ~/active-deis-builder-secret-ssh-private-keys.yaml \
76-
$(helmc home)/workspace/charts/workflow-v2.2.0/manifests/deis-builder-secret-ssh-private-keys.yaml
76+
$(helmc home)/workspace/charts/workflow-v2.3.0/manifests/deis-builder-secret-ssh-private-keys.yaml
7777
7878
# uninstall workflow
7979
$ helmc uninstall workflow-v2.1.0 -n deis
8080
81-
# install workflow v2.2.0
82-
$ helmc install workflow-v2.2.0
81+
# install workflow v2.3.0
82+
$ helmc install workflow-v2.3.0
8383
```
8484

8585
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-v2.2.0 # fetches the chart into a
45+
$ helmc fetch deis/workflow-v2.3.0 # fetches the chart into a
4646
# local workspace
47-
$ helmc generate -x manifests workflow-v2.2.0 # generates various secrets
48-
$ helmc install workflow-v2.2.0 # injects resources into
47+
$ helmc generate -x manifests workflow-v2.3.0 # generates various secrets
48+
$ helmc install workflow-v2.3.0 # 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-v2.2.0 # fetches the chart into a
43+
$ helmc fetch deis/workflow-v2.3.0 # fetches the chart into a
4444
# local workspace
45-
$ helmc generate -x manifests workflow-v2.2.0 # generates various secrets
46-
$ helmc install workflow-v2.2.0 # injects resources into
45+
$ helmc generate -x manifests workflow-v2.3.0 # generates various secrets
46+
$ helmc install workflow-v2.3.0 # 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-v2.2.0 # fetches the chart into a
43+
$ helmc fetch deis/workflow-v2.3.0 # fetches the chart into a
4444
# local workspace
45-
$ helmc generate -x manifests workflow-v2.2.0 # generates various secrets
46-
$ helmc install workflow-v2.2.0 # injects resources into
45+
$ helmc generate -x manifests workflow-v2.3.0 # generates various secrets
46+
$ helmc install workflow-v2.3.0 # injects resources into
4747
# your cluster
4848
```
4949

src/roadmap/releases.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ specific commits from master.
114114
Export two environment variables that will be used in later steps:
115115

116116
```bash
117-
export WORKFLOW_RELEASE=v2.3.0 WORKFLOW_PREV_RELEASE=v2.2.0 # for example
117+
export WORKFLOW_RELEASE=v2.4.0 WORKFLOW_PREV_RELEASE=v2.3.0 # for example
118118
```
119119

120120
### Step 2: Update Jenkins Jobs
@@ -278,8 +278,8 @@ Post a message to the #company channel on Slack. Include a link to the released
278278
master CHANGELOG:
279279

280280
```
281-
@here Deis Workflow v2.3.0 is now live!
282-
Release notes: https://github.com/deis/charts/releases/tag/v2.3.0
281+
@here Deis Workflow v2.4.0 is now live!
282+
Release notes: https://github.com/deis/charts/releases/tag/v2.4.0
283283
Master CHANGELOG: https://gist.github.com/mboersma/dcb300c1530552dc612b19f418731234
284284
```
285285

0 commit comments

Comments
 (0)