You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/installing-workflow/configuring-object-storage.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,25 +11,25 @@ Every component that relies on object storage uses two inputs for configuration:
11
11
1. Component-specific environment variables (e.g. `BUILDER_STORAGE` and `REGISTRY_STORAGE`)
12
12
2. Access credentials stored as a Kubernetes secret named `objectstorage-keyfile`
13
13
14
-
The helm chart for Deis Workflow can be easily configured to connect Workflow components to off-cluster object storage. Deis Workflow currently supports Google Compute Storage, Amazon S3 and Azure Blob Storage.
14
+
The helm classic chart for Deis Workflow can be easily configured to connect Workflow components to off-cluster object storage. Deis Workflow currently supports Google Compute Storage, Amazon S3 and Azure Blob Storage.
15
15
16
16
***Step 1:** Create storage buckets for each of the Workflow subsystems: builder, registry and database
17
17
* Note: Depending on your chosen object storage you may need to provide globally unique bucket names.
18
18
* Note: If you provide credentials with sufficient access to the underlying storage, Workflow components will create the buckets if they do not exist.
19
19
***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-beta3`
21
-
***Step 4:** Open the helm chart with `helm edit workflow-beta3` and look for the template file `tpl/generate_params.toml`
20
+
***Step 3:** If you haven't already fetched the helm classic chart, do so with `helmc fetch deis/workflow-beta3`
21
+
***Step 4:** Open the helm classic chart with `helmc edit workflow-beta3` and look for the template file `tpl/generate_params.toml`
22
22
***Step 5:** Update the `storage` parameter to reference the storage platform you are using: `s3`, `azure`, `gcs`
23
23
***Step 6:** Update the values in the section which corresponds to your storage type, including region, bucket names and access credentials
24
-
* 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-beta3`
24
+
* Note: you do not need to base64 encode any of these values as Helm Classic will handle encoding automatically
25
+
***Step 7:** Save your changes and re-generate the helm classic chart by running `helmc generate -x manifests workflow-beta3`
26
26
***Step 8:** Check the generated file in your manifests directory, you should see `deis-objectstorage-secret.yaml`
27
27
28
-
You are now ready to `helm install workflow-beta3` using your desired object storage.
28
+
You are now ready to `helmc install workflow-beta3` using your desired object storage.
29
29
30
30
## Object Storage Configuration and Credentials
31
31
32
-
During the `helm generate` step, Helm creates a Kubernetes secret in the Deis namespace named `objectstorage-keyfile`. The exact structure of the file depends on storage backend specified in `tpl/generate_params.toml`.
32
+
During the `helmc generate` step, Helm Classic creates a Kubernetes secret in the Deis namespace named `objectstorage-keyfile`. The exact structure of the file depends on storage backend specified in `tpl/generate_params.toml`.
Copy file name to clipboardExpand all lines: src/installing-workflow/installing-deis-workflow.md
+15-15Lines changed: 15 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,21 +1,21 @@
1
1
# Installing Deis Workflow
2
2
3
-
We will use the Helm package manager for Kubernetes to install Deis Workflow onto a Kubernetes cluster. If you don't have Helm installed, see [Helm's own documentation][helm] for more info.
3
+
We will use the Helm Classic package manager for Kubernetes to install Deis Workflow onto a Kubernetes cluster. If you don't have Helm Classic installed, see [Helm Classic's own documentation][helm] for more info.
4
4
5
5
## Check Your Setup
6
6
7
-
First check that the `helm` command is available and the version is 0.6 or newer.
7
+
First check that the `helmc` command is available and the version is 0.6 or newer.
8
8
9
9
```
10
-
$ helm --version
11
-
helm version 0.6.0+1c8688e
10
+
$ helmc --version
11
+
helmc version 0.6.0+1c8688e
12
12
```
13
13
14
-
Ensure the `kubectl` client is installed and can connect to your Kubernetes cluster. `helm` will
14
+
Ensure the `kubectl` client is installed and can connect to your Kubernetes cluster. `helmc` will
15
15
use it to communicate. You can test that it is working properly by running:
16
16
17
17
```
18
-
$ helm target
18
+
$ helmc target
19
19
Kubernetes master is running at https://10.245.1.2
20
20
Heapster is running at https://10.245.1.2/api/v1/proxy/namespaces/kube-system/services/heapster
21
21
KubeDNS is running at https://10.245.1.2/api/v1/proxy/namespaces/kube-system/services/kube-dns
@@ -24,7 +24,7 @@ Grafana is running at https://10.245.1.2/api/v1/proxy/namespaces/kube-system/ser
24
24
InfluxDB is running at https://10.245.1.2/api/v1/proxy/namespaces/kube-system/services/monitoring-influxdb
25
25
```
26
26
27
-
If you see a list of targets like the one above, `helm` can communicate with the Kubernetes master.
27
+
If you see a list of targets like the one above, `helmc` can communicate with the Kubernetes master.
28
28
29
29
Deis Workflow requires Kubernetes 1.2 or higher. You can test that by running:
30
30
@@ -37,27 +37,27 @@ Server Version: version.Info{Major:"1", Minor:"2", GitVersion:"v1.2.3", GitCommi
37
37
## Add the Deis Chart Repository
38
38
39
39
The [Deis Chart Repository](https://github.com/deis/charts) contains everything you
40
-
need to install Deis onto your Kubernetes cluster, with a single `helm install` command.
40
+
need to install Deis onto your Kubernetes cluster, with a single `helmc install` command.
41
41
42
-
Run the following command to add this repository to Helm:
42
+
Run the following command to add this repository to Helm Classic:
43
43
44
44
```
45
-
$ helm repo add deis https://github.com/deis/charts
45
+
$ helmc repo add deis https://github.com/deis/charts
46
46
```
47
47
48
48
## Install Deis Workflow
49
49
50
-
Now that you have Helm installed and have added the Deis Chart Repository, install Workflow by running:
50
+
Now that you have Helm Classic installed and have added the Deis Chart Repository, install Workflow by running:
51
51
52
52
```
53
-
$ helm fetch deis/workflow-beta3 # fetches the chart into a
53
+
$ helmc fetch deis/workflow-beta3 # fetches the chart into a
54
54
# local workspace
55
-
$ helm generate -x manifests workflow-beta3 # generates various secrets
56
-
$ helm install workflow-beta3 # injects resources into
55
+
$ helmc generate -x manifests workflow-beta3 # generates various secrets
56
+
$ helmc install workflow-beta3 # injects resources into
57
57
# your cluster
58
58
```
59
59
60
-
Helm will install a variety of Kubernetes resources in the `deis` namespace.
60
+
Helm Classic will install a variety of Kubernetes resources in the `deis` namespace.
61
61
You'll need to wait for the pods that it launched to be ready. Monitor their status
2. A new [Helm chart for Deis](https://github.com/deis/charts) that references all of the new
33
+
2. A new [Helm Classic chart for Deis](https://github.com/deis/charts) that references all of the new
34
34
images referenced above. For example, if `$DEIS_RELEASE` is `2.0.0-beta3`, the new chart would
35
35
be in a new directory called `workflow-beta3`.
36
36
@@ -54,9 +54,9 @@ git submodule status
54
54
55
55
Keep the list of commit SHAs handy - you'll need it for later.
56
56
57
-
# Step 2: Create a new Helm chart
57
+
# Step 2: Create a new Helm Classic chart
58
58
59
-
Next, we'll create a new [Helm](https://github.com/helm/helm) chart so that we can "stage" a
59
+
Next, we'll create a new [Helm Classic](https://github.com/helm/helm) chart so that we can "stage" a
60
60
version of our release for testing. The process is fairly simple:
61
61
62
62
1. Create a new branch: `git checkout -b release-$DEIS_RELEASE`
@@ -105,14 +105,14 @@ and run the following two commands to tag and push updated docker images:
105
105
TAG=$DEIS_RELEASE make docker-tag docker-push
106
106
```
107
107
108
-
# Step 5: Update Helm chart
108
+
# Step 5: Update Helm Classic chart
109
109
110
-
Now that new Docker images are on public Docker repositories, it's time to update the Helm chart
110
+
Now that new Docker images are on public Docker repositories, it's time to update the Helm Classic chart
111
111
to reference the official images. To do so, simply modify all `dockerTag` entries in the
112
112
`generate_params.toml` files in the `workflow-$DEIS_RELEASE_SHORT` and
113
113
`workflow-$DEIS_RELEASE_SHORT-e2e` to be `$DEIS_RELEASE` (instead of the ones based on git tags).
114
114
115
-
Also, ensure that the `README.md` and `Chart.yaml` files in the new helm chart have updated references to the chart. For example, references to `helm install workflow-betaX` should become `helm install workflow-$DEIS_RELEASE_SHORT`
115
+
Also, ensure that the `README.md` and `Chart.yaml` files in the new helm classic chart have updated references to the chart. For example, references to `helmc install workflow-betaX` should become `helmc install workflow-$DEIS_RELEASE_SHORT`
116
116
117
117
If you find any references that should be bumped, open a pull-request against the documentation.
118
118
@@ -123,7 +123,7 @@ When you're done, commit and push your changes. You should get your pull request
123
123
# Step 6: Update Changelogs
124
124
125
125
At this point, part of the first part and all of the second part of the release is complete.
126
-
That is, the Helm chart for the new Deis version is done, and new Docker versions for all
126
+
That is, the Helm Classic chart for the new Deis version is done, and new Docker versions for all
127
127
components are done.
128
128
129
129
The remaining work is simply generating changelogs and tagging each component's GitHub repository.
0 commit comments