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

Commit

Permalink
Merge pull request #501 from mboersma/release-v2.5.0
Browse files Browse the repository at this point in the history
chore(changelogs): add v2.5.0 changelog
  • Loading branch information
mboersma authored Sep 9, 2016
2 parents 2a51743 + b84a2dc commit c73c4fd
Show file tree
Hide file tree
Showing 13 changed files with 354 additions and 35 deletions.
2 changes: 1 addition & 1 deletion _scripts/deploy.sh
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

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

export IMAGE_PREFIX=deisci VERSION=v2.4.2
export IMAGE_PREFIX=deisci VERSION=v2.5.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
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,7 @@ pages:
- v2.4.0: changelogs/v2.4.0.md
- v2.4.1: changelogs/v2.4.1.md
- v2.4.2: changelogs/v2.4.2.md
- v2.5.0: changelogs/v2.5.0.md
theme_dir: themes/deis
docs_dir: src
markdown_extensions:
Expand Down
318 changes: 318 additions & 0 deletions src/changelogs/v2.5.0.md

Large diffs are not rendered by default.

10 changes: 5 additions & 5 deletions src/installing-workflow/configuring-object-storage.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ If you are using AWS S3 and your Kubernetes nodes are configured with appropriat

### Step 3: Fetch Workflow charts

If you haven't already fetched the Helm Classic chart, do so with `helmc fetch deis/workflow-v2.4.2`
If you haven't already fetched the Helm Classic chart, do so with `helmc fetch deis/workflow-v2.5.0`

### Step 4: Configure Workflow charts

Expand All @@ -49,7 +49,7 @@ Operators should configure object storage by either populating a set of environm

**Option 2:** Using template file `tpl/generate_params.toml`

* Edit Helm Classic chart by running `helmc edit workflow-v2.4.2` and look for the template file `tpl/generate_params.toml`
* Edit Helm Classic chart by running `helmc edit workflow-v2.5.0` and look for the template file `tpl/generate_params.toml`
* Update the `storage` parameter to reference the platform you are using, e.g. `s3`, `azure`, `gcs`, or `swift`
* Find the corresponding section for your storage type and provide appropriate values including region, bucket names, and access credentials.
* Save your changes to `tpl/generate_params.toml`.
Expand All @@ -59,15 +59,15 @@ Operators should configure object storage by either populating a set of environm

### Step 5: Generate manifests

Generate the Workflow chart by running `helmc generate -x manifests workflow-v2.4.2`.
Generate the Workflow chart by running `helmc generate -x manifests workflow-v2.5.0`.

### Step 6: Verify credentials

Helm Classic stores the object storage configuration as a Kubernetes secret.

You may check the contents of the generated file named `deis-objectstorage-secret.yaml` in the `helmc` workspace directory:
```
$ cat $(helmc home)/workspace/charts/workflow-v2.4.2/manifests/deis-objectstorage-secret.yaml
$ cat $(helmc home)/workspace/charts/workflow-v2.5.0/manifests/deis-objectstorage-secret.yaml
apiVersion: v1
kind: Secret
metadata:
Expand All @@ -82,7 +82,7 @@ data:
builder-bucket: bXlmYW5jeS1idWlsZGVyLWJ1c2tldAo=
```

You are now ready to `helmc install workflow-v2.4.2` using your desired object storage.
You are now ready to `helmc install workflow-v2.5.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
Original file line number Diff line number Diff line change
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.4.2`
* **Step 1:** If you haven't already fetched the Helm Classic chart, do so with `helmc fetch deis/workflow-v2.5.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.4.2` and look for the template file `tpl/generate_params.toml`
* Open the Helm Classic chart with `helmc edit workflow-v2.5.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.4.2`
* **Step 3:** Re-generate the Helm Classic chart by running `helmc generate -x manifests workflow-v2.5.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.4.2` [as usual][installing].
You are now ready to `helmc install workflow-v2.5.0` [as usual][installing].

[database]: ../understanding-workflow/components.md#database
[object storage]: configuring-object-storage.md
Expand Down
8 changes: 4 additions & 4 deletions src/installing-workflow/configuring-registry.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Deis Workflow currently supports
2. EC2 Container Registry([ecr][ecr]).
3. off-cluster storage providers like dockerhub, quay.io, etc., or self hosted docker registry.

* **Step 1:** If you haven't already fetched the Helm Classic chart, do so with `helmc fetch deis/workflow-v2.4.2`
* **Step 1:** If you haven't already fetched the Helm Classic chart, do so with `helmc fetch deis/workflow-v2.5.0`
* **Step 2:** Update registry location 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 `REGISTRY_LOCATION` to `off-cluster`, `ecr` or `gcr`, then set the following environment variables accordingly.
* For `REGISTRY_LOCATION=gcr`:
Expand Down Expand Up @@ -52,14 +52,14 @@ Deis Workflow currently supports
`REGISTRY_ORGANIZATION` can be left empty if there is no namespacing in the registry. A [namespace][namespace] is a collection of repositories with a common name prefix.

* **2.** Using template file `tpl/generate_params.toml`:
* Open the helm classic chart with `helmc edit workflow-v2.4.2` and look for the template file `tpl/generate_params.toml`
* Open the helm classic chart with `helmc edit workflow-v2.5.0` and look for the template file `tpl/generate_params.toml`
* Update the `registry_location` parameter to reference the registry location you are using: `off-cluster`, `ecr`, `gcr`
* Update the values in the section which corresponds to your registry location type.
* Note: you do not need to base64 encode any of these values as Helm Classic will handle encoding automatically
* **Step 3:** Save your changes and re-generate the helm classic chart by running `helmc generate -x manifests workflow-v2.4.2`
* **Step 3:** Save your changes and re-generate the helm classic chart by running `helmc generate -x manifests workflow-v2.5.0`
* **Step 4:** Check the generated file in your manifests directory, you should see `deis-registry-secret.yaml`

You are now ready to `helmc install workflow-v2.4.2` using your desired registry.
You are now ready to `helmc install workflow-v2.5.0` using your desired registry.

[registry]: ../understanding-workflow/components.md#registry
[storage]: configuring-object-storage
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 @@ -68,10 +68,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.4.2 # fetches the chart into a
$ helmc fetch deis/workflow-v2.5.0 # fetches the chart into a
# local workspace
$ helmc generate -x manifests workflow-v2.4.2 # generates various secrets
$ helmc install workflow-v2.4.2 # injects resources into
$ helmc generate -x manifests workflow-v2.5.0 # generates various secrets
$ helmc install workflow-v2.5.0 # injects resources into
# your cluster
```

Expand Down
2 changes: 1 addition & 1 deletion src/managing-workflow/platform-logging.md
Original file line number Diff line number Diff line change
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.4.2/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.5.0/tpl/deis-logger-fluentd-daemon.yaml) -

```
env:
Expand Down
4 changes: 2 additions & 2 deletions src/managing-workflow/upgrading-workflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,8 +52,8 @@ namespace "deis" annotated
Exporting environment variables for the previous and latest versions will help reduce confusion later on:

```
$ export PREVIOUS_WORKFLOW_RELEASE=v2.3.0
$ export DESIRED_WORKFLOW_RELEASE=v2.4.2
$ export PREVIOUS_WORKFLOW_RELEASE=v2.4.2
$ export DESIRED_WORKFLOW_RELEASE=v2.5.0
```

### Step 2: Fetch new charts
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-v2.4.2 # fetches the chart into a
$ helmc fetch deis/workflow-v2.5.0 # fetches the chart into a
# local workspace
$ helmc generate -x manifests workflow-v2.4.2 # generates various secrets
$ helmc install workflow-v2.4.2 # injects resources into
$ helmc generate -x manifests workflow-v2.5.0 # generates various secrets
$ helmc install workflow-v2.5.0 # 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-v2.4.2 # fetches the chart into a
$ helmc fetch deis/workflow-v2.5.0 # fetches the chart into a
# local workspace
$ helmc generate -x manifests workflow-v2.4.2 # generates various secrets
$ helmc install workflow-v2.4.2 # injects resources into
$ helmc generate -x manifests workflow-v2.5.0 # generates various secrets
$ helmc install workflow-v2.5.0 # injects resources into
# your cluster
```

Expand Down
8 changes: 4 additions & 4 deletions src/quickstart/provider/vagrant/install-vagrant.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ First check that the `helm` command is available and the version is 0.8 or newer

```
$ helmc --version
helmc version 0.8.0+f3cafbc
helmc version 0.8.1
```

Ensure the `kubectl` client is installed and can connect to your Kubernetes cluster. `helm` will
Expand Down 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.4.2 # fetches the chart into a
$ helmc fetch deis/workflow-v2.5.0 # fetches the chart into a
# local workspace
$ helmc generate -x manifests workflow-v2.4.2 # generates various secrets
$ helmc install workflow-v2.4.2 # injects resources into
$ helmc generate -x manifests workflow-v2.5.0 # generates various secrets
$ helmc install workflow-v2.5.0 # injects resources into
# your cluster
```

Expand Down
10 changes: 5 additions & 5 deletions src/roadmap/releases.md
Original file line number Diff line number Diff line change
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.4.2 WORKFLOW_PREV_RELEASE=v2.3.0 # for example
export WORKFLOW_RELEASE=v2.5.0 WORKFLOW_PREV_RELEASE=v2.4.2 # for example
```

### Step 2: Update Jenkins Jobs
Expand Down Expand Up @@ -239,7 +239,7 @@ git push upstream $WORKFLOW_RELEASE

Paste the same CHANGELOG from the previous step into the body of release notes for [deis/charts][]
in GitHub. In the "Release Title" field, use the project & component with its release, such as
"Deis Workflow v2.4.2":
"Deis Workflow v2.5.0":

```bash
deisrel changelog individual workflow $WORKFLOW_PREV_RELEASE HEAD $WORKFLOW_RELEASE | pbcopy
Expand Down Expand Up @@ -301,9 +301,9 @@ Post a message to the #company channel on Slack. Include a link to the released
master CHANGELOG:

```
@here Deis Workflow v2.4.2 is now live!
Release notes: https://github.com/deis/charts/releases/tag/v2.4.2
Master CHANGELOG: https://gist.github.com/mboersma/dcb300c1530552dc612b19f418731234
@here Deis Workflow v2.5.0 is now live!
Release notes: https://github.com/deis/charts/releases/tag/v2.5.0
Master CHANGELOG: https://deis.com/docs/workflow/changelogs/v2.5.0/
```

You're done with the release. Nice job!
Expand Down

0 comments on commit c73c4fd

Please sign in to comment.