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

Commit

Permalink
feat(update): update docs to reflect v2.3.0
Browse files Browse the repository at this point in the history
  • Loading branch information
kmala committed Aug 4, 2016
1 parent de0e498 commit 540c4ec
Show file tree
Hide file tree
Showing 11 changed files with 33 additions and 33 deletions.
2 changes: 1 addition & 1 deletion _scripts/deploy.sh
Expand Up @@ -5,7 +5,7 @@

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

export IMAGE_PREFIX=deisci VERSION=v2.2.0
export IMAGE_PREFIX=deisci VERSION=v2.3.0
docker login -e="$DOCKER_EMAIL" -u="$DOCKER_USERNAME" -p="$DOCKER_PASSWORD"
DEIS_REGISTRY='' make -C .. docker-build docker-push
docker login -e="$QUAY_EMAIL" -u="$QUAY_USERNAME" -p="$QUAY_PASSWORD" quay.io
Expand Down
8 changes: 4 additions & 4 deletions src/installing-workflow/configuring-object-storage.md
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-v2.2.0`
* **Step 3:** If you haven't already fetched the helm classic chart, do so with `helmc fetch deis/workflow-v2.3.0`
* **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 Down Expand Up @@ -48,14 +48,14 @@ The helm classic chart for Deis Workflow can be easily configured to connect Wor
* To specify tenant set `SWIFT_TENANT` if the auth version is 2 or more.

* **2.** Using template file `tpl/generate_params.toml`:
* Open the helm classic chart with `helmc edit workflow-v2.2.0` and look for the template file `tpl/generate_params.toml`
* Open the helm classic chart with `helmc edit workflow-v2.3.0` 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-v2.2.0`
* **Step 5:** Save your changes and re-generate the helm classic chart by running `helmc generate -x manifests workflow-v2.3.0`
* **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-v2.2.0` using your desired object storage.
You are now ready to `helmc install workflow-v2.3.0` using your desired object storage.

## Object Storage Configuration and Credentials

Expand Down
8 changes: 4 additions & 4 deletions src/installing-workflow/configuring-postgres.md
Expand Up @@ -31,7 +31,7 @@ $ psql -h <host> -p <port> -d postgres -U <"postgres" or your own username>

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

* **Step 1:** If you haven't already fetched the Helm Classic chart, do so with `helmc fetch deis/workflow-v2.2.0`
* **Step 1:** If you haven't already fetched the Helm Classic chart, do so with `helmc fetch deis/workflow-v2.3.0`
* **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`.
* **1.** Using environment variables:
* Set `DATABASE_LOCATION` to `off-cluster`.
Expand All @@ -41,18 +41,18 @@ The Helm Classic chart for Deis Workflow can be easily configured to connect the
* Set `DATABASE_USERNAME` to the username of the database user that owns the database-- typically `deis`.
* Set `DATABASE_PASSWORD` to the password for the database user that owns the database.
* **2.** Using template file `tpl/generate_params.toml`:
* Open the Helm Classic chart with `helmc edit workflow-v2.2.0` and look for the template file `tpl/generate_params.toml`
* Open the Helm Classic chart with `helmc edit workflow-v2.3.0` and look for the template file `tpl/generate_params.toml`
* Update the `database_location` parameter to `off-cluster`.
* Update the values in the `[database]` configuration section to properly reflect all connection details.
* Save your changes.
* 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.
* **Step 3:** Re-generate the Helm Classic chart by running `helmc generate -x manifests workflow-v2.2.0`
* **Step 3:** Re-generate the Helm Classic chart by running `helmc generate -x manifests workflow-v2.3.0`
* **Step 4:** Check the generated files in your `manifests` directory. You should see:
* `deis-controller-rc.yaml` contains relevant connection details.
* `deis-database-secret-creds.yaml` exists and contains base64 encoded database username and password.
* 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.

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

[database]: ../understanding-workflow/components.md#database
[object storage]: configuring-object-storage.md
Expand Down
6 changes: 3 additions & 3 deletions src/installing-workflow/index.md
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-v2.2.0 # fetches the chart into a
$ helmc fetch deis/workflow-v2.3.0 # fetches the chart into a
# local workspace
$ helmc generate -x manifests workflow-v2.2.0 # generates various secrets
$ helmc install workflow-v2.2.0 # injects resources into
$ helmc generate -x manifests workflow-v2.3.0 # generates various secrets
$ helmc install workflow-v2.3.0 # injects resources into
# your cluster
```

Expand Down
2 changes: 1 addition & 1 deletion src/managing-workflow/platform-logging.md
Expand Up @@ -54,7 +54,7 @@ Error: There are currently no log messages. Please check the following things:
## Default Configuration
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.

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) -
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) -

```
env:
Expand Down
14 changes: 7 additions & 7 deletions src/managing-workflow/upgrading-workflow.md
Expand Up @@ -59,27 +59,27 @@ $ kubectl --namespace=deis get secret database-creds -o yaml > ~/active-deis-dat
$ kubectl --namespace=deis get secret builder-ssh-private-keys -o yaml > ~/active-deis-builder-secret-ssh-private-keys.yaml
# fetch new chart
$ helmc fetch deis/workflow-v2.2.0
$ helmc fetch deis/workflow-v2.3.0
# update your off-cluster storage configuration
$ $EDITOR $(helmc home)/workspace/charts/workflow-v2.2.0/tpl/generate_params.toml
$ $EDITOR $(helmc home)/workspace/charts/workflow-v2.3.0/tpl/generate_params.toml
# generate new templates
$ helmc generate -x manifests workflow-v2.2.0
$ helmc generate -x manifests workflow-v2.3.0
# copy your active database secrets into the helmc workspace
$ cp ~/active-deis-database-secret-creds.yaml \
$(helmc home)/workspace/charts/workflow-v2.2.0/manifests/deis-database-secret-creds.yaml
$(helmc home)/workspace/charts/workflow-v2.3.0/manifests/deis-database-secret-creds.yaml
# copy your active builder ssh keys into the helmc workspace
$ cp ~/active-deis-builder-secret-ssh-private-keys.yaml \
$(helmc home)/workspace/charts/workflow-v2.2.0/manifests/deis-builder-secret-ssh-private-keys.yaml
$(helmc home)/workspace/charts/workflow-v2.3.0/manifests/deis-builder-secret-ssh-private-keys.yaml
# uninstall workflow
$ helmc uninstall workflow-v2.1.0 -n deis
# install workflow v2.2.0
$ helmc install workflow-v2.2.0
# install workflow v2.3.0
$ helmc install workflow-v2.3.0
```

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

Expand Down
6 changes: 3 additions & 3 deletions src/quickstart/provider/gke/install-gke.md
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-v2.2.0 # fetches the chart into a
$ helmc fetch deis/workflow-v2.3.0 # fetches the chart into a
# local workspace
$ helmc generate -x manifests workflow-v2.2.0 # generates various secrets
$ helmc install workflow-v2.2.0 # injects resources into
$ helmc generate -x manifests workflow-v2.3.0 # generates various secrets
$ helmc install workflow-v2.3.0 # injects resources into
# your cluster
```

Expand Down
6 changes: 3 additions & 3 deletions src/quickstart/provider/vagrant/install-vagrant.md
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-v2.2.0 # fetches the chart into a
$ helmc fetch deis/workflow-v2.3.0 # fetches the chart into a
# local workspace
$ helmc generate -x manifests workflow-v2.2.0 # generates various secrets
$ helmc install workflow-v2.2.0 # injects resources into
$ helmc generate -x manifests workflow-v2.3.0 # generates various secrets
$ helmc install workflow-v2.3.0 # injects resources into
# your cluster
```

Expand Down
6 changes: 3 additions & 3 deletions src/roadmap/releases.md
Expand Up @@ -114,7 +114,7 @@ specific commits from master.
Export two environment variables that will be used in later steps:

```bash
export WORKFLOW_RELEASE=v2.3.0 WORKFLOW_PREV_RELEASE=v2.2.0 # for example
export WORKFLOW_RELEASE=v2.4.0 WORKFLOW_PREV_RELEASE=v2.3.0 # for example
```

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

```
@here Deis Workflow v2.3.0 is now live!
Release notes: https://github.com/deis/charts/releases/tag/v2.3.0
@here Deis Workflow v2.4.0 is now live!
Release notes: https://github.com/deis/charts/releases/tag/v2.4.0
Master CHANGELOG: https://gist.github.com/mboersma/dcb300c1530552dc612b19f418731234
```

Expand Down
2 changes: 1 addition & 1 deletion src/troubleshooting/kubectl.md
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-v2.2.0`
Using `kubectl`, one can inspect the cluster's current state. When `helmc install workflow-v2.3.0`
is invoked, Workflow is installed into the `deis` namespace. To inspect if Workflow is running,
run:

Expand Down

0 comments on commit 540c4ec

Please sign in to comment.