Skip to content

Commit 5c78f72

Browse files
author
Matthew Fisher
committed
Merge pull request #208 from bacongobbler/beta3
chore(src): bump documentation to reference v2.0.0-beta3
2 parents e37e5f2 + 42d038c commit 5c78f72

5 files changed

Lines changed: 30 additions & 30 deletions

File tree

src/installing-workflow/configuring-object-storage.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,15 +17,15 @@ The helm chart for Deis Workflow can be easily configured to connect Workflow co
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 chart, do so with `helm fetch deis/workflow-beta2`
21-
* **Step 4:** Open the helm chart with `helm edit workflow-beta2` and look for the template file `tpl/generate_params.toml`
20+
* **Step 3:** If you haven't already fetched the helm chart, do so with `helm fetch deis/workflow-beta3`
21+
* **Step 4:** Open the helm chart with `helm edit workflow-beta3` and look for the template file `tpl/generate_params.toml`
2222
* **Step 5:** Update the `storage` parameter to reference the storage platform you are using: `s3`, `azure`, `gcs`
2323
* **Step 6:** Update the values in the section which corresponds to your storage type, including region, bucket names and access credentials
2424
* Note: you do not need to base64 encode any of these values as Helm will handle encoding automatically
25-
* **Step 7:** Save your changes and re-generate the helm chart by running `helm generate -x manifests workflow-beta2`
25+
* **Step 7:** Save your changes and re-generate the helm chart by running `helm generate -x manifests workflow-beta3`
2626
* **Step 8:** Check the generated file in your manifests directory, you should see `deis-objectstorage-secret.yaml`
2727

28-
You are now ready to `helm install workflow-beta2` using your desired object storage.
28+
You are now ready to `helm install workflow-beta3` using your desired object storage.
2929

3030
## Object Storage Configuration and Credentials
3131

src/installing-workflow/installing-deis-workflow.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -50,10 +50,10 @@ $ helm repo add deis https://github.com/deis/charts
5050
Now that you have Helm installed and have added the Deis Chart Repository, install Workflow by running:
5151

5252
```
53-
$ helm fetch deis/workflow-beta2 # fetches the chart into a
53+
$ helm fetch deis/workflow-beta3 # fetches the chart into a
5454
# local workspace
55-
$ helm generate -x manifests workflow-beta2 # generates various secrets
56-
$ helm install workflow-beta2 # injects resources into
55+
$ helm generate -x manifests workflow-beta3 # generates various secrets
56+
$ helm install workflow-beta3 # injects resources into
5757
# your cluster
5858
```
5959

src/managing-workflow/platform-logging.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ The logging platform is made up of 2 components - [Fluentd](https://github.com/d
1010
Logger acts like a syslog server and receives all log messages that are occurring on the cluster. It then filters this data to only Deis deploy applications and stores those log messages in a ring buffer where they can be fetched via the Deis CLI.
1111

1212
## Installation
13-
With the release of workflow-beta2 chart the logging system is part of the main installation of Workflow. You will then need to watch the components come up and verify they are in a running state by executing the following command:
13+
With the release of workflow-beta3 chart the logging system is part of the main installation of Workflow. You will then need to watch the components come up and verify they are in a running state by executing the following command:
1414

1515
```
1616
$ kubectl get pods --namespace=deis
@@ -52,22 +52,22 @@ Error: There are currently no log messages. Please check the following things:
5252

5353
## Architecture Diagram
5454
```
55-
┌──────────────┐
56-
│ │
57-
│ Host ├─────┐
58-
│ Fluentd│ │
59-
└──────────────┘ UDP
60-
55+
┌──────────────┐
56+
│ │
57+
│ Host ├─────┐
58+
│ Fluentd│ │
59+
└──────────────┘ UDP
60+
6161
┌──────────────┐ │ ┌──────────────┐
6262
│ │ │ │ Logger │
6363
│ Host │─UDP─┼─────▶│ Host │
6464
│ Fluentd│ │ │ Fluentd │
6565
└──────────────┘ │ └──────────────┘
66-
┌──────────────┐ │
67-
│ │ UDP
68-
│ Host │─────┘
69-
│ Fluentd│
70-
└──────────────┘
66+
┌──────────────┐ │
67+
│ │ UDP
68+
│ Host │─────┘
69+
│ Fluentd│
70+
└──────────────┘
7171
```
7272

7373
## Default Configuration

src/managing-workflow/upgrading-workflow.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
To upgrade to a newer version of Workflow, run the following:
44

55
```
6-
$ helm uninstall workflow-beta1 -n deis
6+
$ helm uninstall workflow-beta2 -n deis
77
$ helm update
8-
$ helm fetch deis/workflow-beta2
9-
$ helm generate -x manifests workflow-beta2
10-
$ helm install workflow-beta2
8+
$ helm fetch deis/workflow-beta3
9+
$ helm generate -x manifests workflow-beta3
10+
$ helm install workflow-beta3
1111
```

src/roadmap/release-checklist.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ The below sections present a step by step guide to releasing a new Deis Workflow
77
examples, we'll be assuming that the below two environment variables are present in wherever
88
you're working. Make sure to set them (e.g. by `export`ing them) before you get started.
99

10-
- `$DEIS_RELEASE` - the full name of this version. For example, `v2.0.0-beta2`
11-
- `$DEIS_RELEASE_SHORT` - The short name of this version. For example, `beta2`
10+
- `$DEIS_RELEASE` - the full name of this version. For example, `v2.0.0-beta3`
11+
- `$DEIS_RELEASE_SHORT` - The short name of this version. For example, `beta3`
1212

1313
# What's a release?
1414

@@ -31,8 +31,8 @@ A release consists of the following artifacts:
3131
- [workflow-manager](https://github.com/deis/workflow-manager)
3232
- [workflow-cli](https://github.com/deis/workflow-cli)
3333
2. A new [Helm chart for Deis](https://github.com/deis/charts) that references all of the new
34-
images referenced above. For example, if `$DEIS_RELEASE` is `2.0.0-beta2`, the new chart would
35-
be in a new directory called `workflow-beta2`.
34+
images referenced above. For example, if `$DEIS_RELEASE` is `2.0.0-beta3`, the new chart would
35+
be in a new directory called `workflow-beta3`.
3636

3737
# Step 1: Get the status of all components
3838

@@ -60,21 +60,21 @@ Next, we'll create a new [Helm](https://github.com/helm/helm) chart so that we c
6060
version of our release for testing. The process is fairly simple:
6161

6262
1. Create a new branch: `git checkout -b release-$DEIS_RELEASE`
63-
2. Copy an existing chart: `cp -r workflow-beta2 workflow-$DEIS_RELEASE_SHORT`
63+
2. Copy an existing chart: `cp -r workflow-beta3 workflow-$DEIS_RELEASE_SHORT`
6464
3. Modify the `workflow-$DEIS_RELEASE_SHORT/tpl/generate_params.toml` file to ensure that all
6565
`dockerTag` values look like `git-$COMPONENT_SHA_SHORT`, where `$COMPONENT_SHA_SHORT` is the first
6666
7 characters of the applicable SHA that you got in the previous step.
6767
4. Ensure that all `DEBUG` variables in manifests are `false`.
6868
5. Commit your changes: `git commit -a -m "chore(workflow-$DEIS_RELEASE_SHORT): releasing workflow-$DEIS_RELEASE_SHORT"`
6969
6. Push your changes to your fork: `git push -u $YOUR_FORK_REMOTE release-$DEIS_RELEASE`. Note that
7070
`$YOUR_FORK_REMOTE` is the git URI to the remote of your `deis/charts` fork. Mine is `git@github.com:arschles/deis-charts.git`, for example.
71-
7. Do steps 2-5 with the `workflow-beta2-e2e` directory
71+
7. Do steps 2-5 with the `workflow-beta3-e2e` directory
7272
8. Open a pull request from your branch to merge into `master` on https://github.com/deis/charts
7373

7474
# Step 3: Manual Testing
7575

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

0 commit comments

Comments
 (0)