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

Commit

Permalink
docs(*): update versions to v2.9.1 and add changelog
Browse files Browse the repository at this point in the history
A couple of fixes were also applied to the release document to reflect some small nuances in the
release cycle.
  • Loading branch information
Matthew Fisher committed Dec 15, 2016
1 parent 3866bd4 commit c5d4d46
Show file tree
Hide file tree
Showing 12 changed files with 53 additions and 36 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.9.0
export IMAGE_PREFIX=deisci VERSION=v2.9.1
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 @@ -98,6 +98,7 @@ pages:
- v2.7.0: changelogs/v2.7.0.md
- v2.8.0: changelogs/v2.8.0.md
- v2.9.0: changelogs/v2.9.0.md
- v2.9.1: changelogs/v2.9.1.md
theme_dir: themes/deis
docs_dir: src
markdown_extensions:
Expand Down
20 changes: 20 additions & 0 deletions src/changelogs/v2.9.1.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
## Workflow v2.9.0 -> v2.9.1

#### Releases

- controller v2.9.0 -> v2.9.1
- slugbuilder v2.4.7 -> v2.4.8

#### Fixes

- [`d723de6`](https://github.com/deis/controller/commit/d723de618d0a420cfba3c5be7e3d53c17aa9a404) (controller) - api: account for NoneType when resource is gone (#1178)
- [`ebeb922`](https://github.com/deis/slugbuilder/commit/ebeb9223919a9725f570cc26534e525c6e2d0e13) (slugbuilder) - env_dir: Remove directories from the env dir passed to the compile
- [`e058fa2`](https://github.com/deis/slugbuilder/commit/e058fa27b3f8c2e3bf9e20c06374ef4450f0a186) (slugbuilder) - ssh: read the ssh key from dir instead of environment

#### Maintenance

- [`673ce82`](https://github.com/deis/slugbuilder/commit/673ce822af983855a3a1565095838bfe0d5b4a08) (slugbuilder) - buildpacks: update heroku-buildpack-php to v115
- [`998b7ce`](https://github.com/deis/slugbuilder/commit/998b7ce2b043c8dfd8787027a33b2e336d37d050) (slugbuilder) - buildpacks: update heroku-buildpack-ruby to v149
- [`195c4f2`](https://github.com/deis/slugbuilder/commit/195c4f28c821048779e471a202f8d9d80d753ce7) (slugbuilder) - buildpacks: update heroku-buildpack-gradle to v19
- [`03ab39a`](https://github.com/deis/slugbuilder/commit/03ab39af4f7e7da944cd46ae2c8da35c28954ae5) (slugbuilder) - buildpacks: update heroku-buildpack-php to v116
- [`51514b1`](https://github.com/deis/slugbuilder/commit/51514b14259bfab0329b372213835bb8d6873451) (slugbuilder) - buildpacks: update heroku-buildpack-go to v54
10 changes: 5 additions & 5 deletions src/installing-workflow/chart-provenance.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
As of Workflow [v2.8.0](../changelogs/v2.8.0.md), Deis has released [Kubernetes Helm][helm] charts for Workflow
and for each of its [components](../understanding-workflow/components.md).

Helm provides tools for establishing and verifying chart integrity. (For an overview, see the [Provenance](https://github.com/kubernetes/helm/blob/master/docs/provenance.md) doc.) All release charts from the Deis Workflow team are now signed using this mechanism.
Helm provides tools for establishing and verifying chart integrity. (For an overview, see the [Provenance](https://github.com/kubernetes/helm/blob/master/docs/provenance.md) doc.) All release charts from the Deis Workflow team are now signed using this mechanism.

The full `Deis, Inc. (Helm chart signing key) <[email protected]>` public key can be found [here](../security/1d6a97d0.txt), as well as the [pgp.mit.edu](http://pgp.mit.edu/pks/lookup?op=vindex&fingerprint=on&search=0x17E526B51D6A97D0) keyserver and the official Deis Keybase [account][deis-keybase]. The key's fingerprint can be cross-checked against all of these sources.

Expand Down Expand Up @@ -35,22 +35,22 @@ $ helm repo add deis https://charts.deis.com/workflow
"deis" has been added to your repositories
$ helm fetch --verify deis/workflow && echo
Verification: &{0xc420338460 sha256:5e33bff6f4e8191b5887a139cd42c6afb6eb0cef5d066130a87c6a3a3f588edd workflow-v2.9.0.tgz}
Verification: &{0xc420338460 sha256:5e33bff6f4e8191b5887a139cd42c6afb6eb0cef5d066130a87c6a3a3f588edd workflow-v2.9.1.tgz}
```

One can then inspect the fetched `workflow-v2.9.0.tgz.prov` provenance file.
One can then inspect the fetched `workflow-v2.9.1.tgz.prov` provenance file.

If the chart was not signed, the command above would result in:

```
Error: Failed to fetch provenance "https://charts.deis.com/workflow/workflow-v2.9.0.tgz.prov"
Error: Failed to fetch provenance "https://charts.deis.com/workflow/workflow-v2.9.1.tgz.prov"
```

Alternatively, the chart can also be verified at install time:

```
$ helm install --verify deis/workflow --namespace deis
Fetched deis/workflow to workflow-v2.9.0.tgz
Fetched deis/workflow to workflow-v2.9.1.tgz
NAME: olfactory-star
LAST DEPLOYED: Thu Nov 10 11:45:44 2016
NAMESPACE: deis
Expand Down
8 changes: 4 additions & 4 deletions src/installing-workflow/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,12 @@ Deis Workflow, follow the [quickstart guide](../quickstart/index.md) for assista

## Check Your Setup

Check that the `helm` command is available and the version is 2.0.0 or newer.
Check that the `helm` command is available and the version is 2.1.0 or newer.

```
$ helm version
Client: &version.Version{SemVer:"v2.0.0", GitCommit:"51bdad42756dfaf3234f53ef3d3cb6bcd94144c2", GitTreeState:"clean"}
Server: &version.Version{SemVer:"v2.0.0", GitCommit:"51bdad42756dfaf3234f53ef3d3cb6bcd94144c2", GitTreeState:"clean"}
Client: &version.Version{SemVer:"v2.1.0", GitCommit:"b7b648456ba15d3d190bb84b36a4bc9c41067cf3", GitTreeState:"clean"}
Server: &version.Version{SemVer:"v2.1.0", GitCommit:"b7b648456ba15d3d190bb84b36a4bc9c41067cf3", GitTreeState:"clean"}
```

## Choose Your Deployment Strategy
Expand Down Expand Up @@ -91,4 +91,4 @@ After installing Workflow, [register a user and deploy an application](../quicks

[Kubernetes v1.3.4+]: system-requirements.md#kubernetes-versions
[helm]: https://github.com/kubernetes/helm/blob/master/docs/install.md
[valuesfile]: https://charts.deis.com/workflow/values-v2.9.0.yaml
[valuesfile]: https://charts.deis.com/workflow/values-v2.9.1.yaml
6 changes: 2 additions & 4 deletions src/installing-workflow/system-requirements.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,10 @@ To run Deis Workflow on a Kubernetes cluster, there are a few requirements to ke
## Kubernetes Versions


Deis Workflow requires the latest patch release of Kubernetes v1.3 or v1.4. Workflow is not
Deis Workflow requires the latest patch release of Kubernetes v1.3 or higher. Workflow is not
compatible with Kubernetes v1.2, and Kubernetes v1.3.0 through v1.3.3 have
[a bug when mounting secrets](https://github.com/deis/workflow/issues/372) which prevents Deis
Workflow from starting. Kubernetes v1.4 is highly recommended but is not required.

At this time, Kubernetes v1.5 is not compatible with Workflow v2.9.0.
Workflow from starting. Kubernetes v1.5 is highly recommended but is not required.

## Storage Requirements

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 @@ -86,7 +86,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.9.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.9.1/tpl/deis-logger-fluentd-daemon.yaml) -

```
env:
Expand Down
2 changes: 1 addition & 1 deletion src/managing-workflow/upgrading-workflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Deis Workflow releases may be upgraded in-place with minimal downtime. This upgrade process requires:

* Helm version [2.0.0 or newer](https://github.com/kubernetes/helm/releases/tag/v2.0.0)
* Helm version [2.1.0 or newer](https://github.com/kubernetes/helm/releases/tag/v2.1.0)
* Configured Off-Cluster Storage
* A Kubernetes cluster with more than one node is required for the rolling upgrade of the deis-router (as it is a rolling upgrade with host ports)

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 @@ -2,12 +2,12 @@

## Check Your Setup

First check that the `helm` command is available and the version is v2.0.0 or newer.
First check that the `helm` command is available and the version is v2.1.0 or newer.

```
$ helm version
Client: &version.Version{SemVer:"v2.0.0", GitCommit:"51bdad42756dfaf3234f53ef3d3cb6bcd94144c2", GitTreeState:"clean"}
Server: &version.Version{SemVer:"v2.0.0", GitCommit:"51bdad42756dfaf3234f53ef3d3cb6bcd94144c2", GitTreeState:"clean"}
Client: &version.Version{SemVer:"v2.1.0", GitCommit:"b7b648456ba15d3d190bb84b36a4bc9c41067cf3", GitTreeState:"clean"}
Server: &version.Version{SemVer:"v2.1.0", GitCommit:"b7b648456ba15d3d190bb84b36a4bc9c41067cf3", GitTreeState:"clean"}
```

Ensure the `kubectl` client is installed and can connect to your Kubernetes 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 @@ -2,12 +2,12 @@

## Check Your Setup

First check that the `helm` command is available and the version is v2.0.0 or newer.
First check that the `helm` command is available and the version is v2.1.0 or newer.

```
$ helm version
Client: &version.Version{SemVer:"v2.0.0", GitCommit:"51bdad42756dfaf3234f53ef3d3cb6bcd94144c2", GitTreeState:"clean"}
Server: &version.Version{SemVer:"v2.0.0", GitCommit:"51bdad42756dfaf3234f53ef3d3cb6bcd94144c2", GitTreeState:"clean"}
Client: &version.Version{SemVer:"v2.1.0", GitCommit:"b7b648456ba15d3d190bb84b36a4bc9c41067cf3", GitTreeState:"clean"}
Server: &version.Version{SemVer:"v2.1.0", GitCommit:"b7b648456ba15d3d190bb84b36a4bc9c41067cf3", GitTreeState:"clean"}
```

Ensure the `kubectl` client is installed and can connect to your Kubernetes 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 @@ -2,12 +2,12 @@

## Check Your Setup

First check that the `helm` command is available and the version is v2.0.0 or newer.
First check that the `helm` command is available and the version is v2.1.0 or newer.

```
$ helm version
Client: &version.Version{SemVer:"v2.0.0", GitCommit:"51bdad42756dfaf3234f53ef3d3cb6bcd94144c2", GitTreeState:"clean"}
Server: &version.Version{SemVer:"v2.0.0", GitCommit:"51bdad42756dfaf3234f53ef3d3cb6bcd94144c2", GitTreeState:"clean"}
Client: &version.Version{SemVer:"v2.1.0", GitCommit:"b7b648456ba15d3d190bb84b36a4bc9c41067cf3", GitTreeState:"clean"}
Server: &version.Version{SemVer:"v2.1.0", GitCommit:"b7b648456ba15d3d190bb84b36a4bc9c41067cf3", GitTreeState:"clean"}
```

Ensure the `kubectl` client is installed and can connect to your Kubernetes cluster.
Expand Down
20 changes: 9 additions & 11 deletions src/roadmap/releases.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,8 +128,8 @@ verify it can be fetched (and verified):
```
$ helm repo add controller https://charts.deis.com/controller
"controller" has been added to your repositories
$ helm fetch --verify controller/controller --version v2.9.0 && echo
Verification: &{0xc42028d3b0 sha256:17b94dd854e090c6627728bdcb5e2ea588f3cb4fecc1082a5a03c909c0ed0ecd controller-v2.9.0.tgz}
$ helm fetch --verify controller/controller --version v2.9.1 && echo
Verification: &{0xc42028d3b0 sha256:17b94dd854e090c6627728bdcb5e2ea588f3cb4fecc1082a5a03c909c0ed0ecd controller-v2.9.1.tgz}
```

## How to Release Workflow
Expand All @@ -142,7 +142,7 @@ deliverable. This section leads a maintainer through creating a Workflow release
Export two environment variables that will be used in later steps:

```bash
export WORKFLOW_RELEASE=v2.9.0 WORKFLOW_PREV_RELEASE=v2.8.0 # for example
export WORKFLOW_RELEASE=v2.9.1 WORKFLOW_PREV_RELEASE=v2.9.0 # for example
```

### Step 2: Tag Supporting Repositories
Expand Down Expand Up @@ -204,7 +204,7 @@ the chart versions existing in the `WORKFLOW_PREV_RELEASE` chart and the _most r
```bash
helm repo add deis https://charts.deis.com/workflow
helm fetch --untar deis/workflow --version $WORKFLOW_PREV_RELEASE
deisrel changelog global workflow/requirements.lock mapping.json > $WORKFLOW_RELEASE
deisrel changelog global workflow/requirements.lock mapping.json > changelog-$WORKFLOW_RELEASE.md
```

To get non-component repo changelogs (presumably tagged in Step 3 above), one can issue a command like the following
Expand All @@ -226,15 +226,13 @@ update PR created in the next step.

Create a new pull request at [deis/workflow][] that updates version references to the new release.
Use `git grep $WORKFLOW_PREV_RELEASE` to find any references, but be careful not to change
`CHANGELOG.md`. This PR should also change `upgrading-workflow-md` by updating references to
older releases to `$WORKFLOW_PREV_RELEASE`, so the documentation always describes upgrading
between recent versions.
`CHANGELOG.md`.

Place the `$WORKFLOW_RELEASE` master changelog generated in Step 7 in the `changelogs` directory.
Make sure to add a header to the page to make it clear that this is for a Workflow release, e.g.:

```
## Workflow v2.8.0 -> v2.9.0
## Workflow v2.9.0 -> v2.9.1
```

### Step 8: Close GitHub Milestones
Expand Down Expand Up @@ -267,9 +265,9 @@ Post a message to the #company channel on Slack. Include a link to the released
master CHANGELOG:

```
@here Deis Workflow v2.9.0 is now live!
Release notes: https://github.com/deis/charts/releases/tag/v2.9.0
Master CHANGELOG: https://deis.com/docs/workflow/changelogs/v2.9.0/
@here Deis Workflow v2.9.1 is now live!
Release notes: https://github.com/deis/charts/releases/tag/v2.9.1
Master CHANGELOG: https://deis.com/docs/workflow/changelogs/v2.9.1/
```

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

0 comments on commit c5d4d46

Please sign in to comment.