Skip to content

Commit c597a2e

Browse files
author
Keerthan Mala
committed
ref(helm): update the docs to refer helm classic instead of helm
1 parent 54a251f commit c597a2e

7 files changed

Lines changed: 37 additions & 37 deletions

File tree

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Our official support channels are:
2222
- controller: https://github.com/deis/controller/issues
2323
- database: https://github.com/deis/postgres/issues
2424
- documentation: https://github.com/deis/workflow/issues
25-
- helm: https://github.com/helm/helm/issues
25+
- helm classic: https://github.com/helm/helm/issues
2626
- minio: https://github.com/deis/minio/issues
2727
- registry: https://github.com/deis/registry/issues
2828
- router: https://github.com/deis/router/issues

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

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,25 +11,25 @@ Every component that relies on object storage uses two inputs for configuration:
1111
1. Component-specific environment variables (e.g. `BUILDER_STORAGE` and `REGISTRY_STORAGE`)
1212
2. Access credentials stored as a Kubernetes secret named `objectstorage-keyfile`
1313

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.
1515

1616
* **Step 1:** Create storage buckets for each of the Workflow subsystems: builder, registry and database
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-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`
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
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`
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-beta3` using your desired object storage.
28+
You are now ready to `helmc install workflow-beta3` using your desired object storage.
2929

3030
## Object Storage Configuration and Credentials
3131

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`.
3333

3434
```
3535
# Set the storage backend

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

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
11
# Installing Deis Workflow
22

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.
44

55
## Check Your Setup
66

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.
88

99
```
10-
$ helm --version
11-
helm version 0.6.0+1c8688e
10+
$ helmc --version
11+
helmc version 0.6.0+1c8688e
1212
```
1313

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
1515
use it to communicate. You can test that it is working properly by running:
1616

1717
```
18-
$ helm target
18+
$ helmc target
1919
Kubernetes master is running at https://10.245.1.2
2020
Heapster is running at https://10.245.1.2/api/v1/proxy/namespaces/kube-system/services/heapster
2121
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
2424
InfluxDB is running at https://10.245.1.2/api/v1/proxy/namespaces/kube-system/services/monitoring-influxdb
2525
```
2626

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.
2828

2929
Deis Workflow requires Kubernetes 1.2 or higher. You can test that by running:
3030

@@ -37,27 +37,27 @@ Server Version: version.Info{Major:"1", Minor:"2", GitVersion:"v1.2.3", GitCommi
3737
## Add the Deis Chart Repository
3838

3939
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.
4141

42-
Run the following command to add this repository to Helm:
42+
Run the following command to add this repository to Helm Classic:
4343

4444
```
45-
$ helm repo add deis https://github.com/deis/charts
45+
$ helmc repo add deis https://github.com/deis/charts
4646
```
4747

4848
## Install Deis Workflow
4949

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:
5151

5252
```
53-
$ helm fetch deis/workflow-beta3 # fetches the chart into a
53+
$ helmc fetch deis/workflow-beta3 # fetches the chart into a
5454
# 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
5757
# your cluster
5858
```
5959

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.
6161
You'll need to wait for the pods that it launched to be ready. Monitor their status
6262
by running:
6363

src/managing-workflow/upgrading-workflow.md

Lines changed: 5 additions & 5 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-beta2 -n deis
7-
$ helm update
8-
$ helm fetch deis/workflow-beta3
9-
$ helm generate -x manifests workflow-beta3
10-
$ helm install workflow-beta3
6+
$ helmc uninstall workflow-beta2 -n deis
7+
$ helmc update
8+
$ helmc fetch deis/workflow-beta3
9+
$ helmc generate -x manifests workflow-beta3
10+
$ helmc install workflow-beta3
1111
```

src/roadmap/release-checklist.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ A release consists of the following artifacts:
3030
- [workflow-e2e](https://github.com/deis/workflow-e2e)
3131
- [workflow-manager](https://github.com/deis/workflow-manager)
3232
- [workflow-cli](https://github.com/deis/workflow-cli)
33-
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
3434
images referenced above. For example, if `$DEIS_RELEASE` is `2.0.0-beta3`, the new chart would
3535
be in a new directory called `workflow-beta3`.
3636

@@ -54,9 +54,9 @@ git submodule status
5454

5555
Keep the list of commit SHAs handy - you'll need it for later.
5656

57-
# Step 2: Create a new Helm chart
57+
# Step 2: Create a new Helm Classic chart
5858

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
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`
@@ -105,14 +105,14 @@ and run the following two commands to tag and push updated docker images:
105105
TAG=$DEIS_RELEASE make docker-tag docker-push
106106
```
107107

108-
# Step 5: Update Helm chart
108+
# Step 5: Update Helm Classic chart
109109

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
111111
to reference the official images. To do so, simply modify all `dockerTag` entries in the
112112
`generate_params.toml` files in the `workflow-$DEIS_RELEASE_SHORT` and
113113
`workflow-$DEIS_RELEASE_SHORT-e2e` to be `$DEIS_RELEASE` (instead of the ones based on git tags).
114114

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`
116116

117117
If you find any references that should be bumped, open a pull-request against the documentation.
118118

@@ -123,7 +123,7 @@ When you're done, commit and push your changes. You should get your pull request
123123
# Step 6: Update Changelogs
124124

125125
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
127127
components are done.
128128

129129
The remaining work is simply generating changelogs and tagging each component's GitHub repository.

src/understanding-workflow/architecture.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ compliant Kubernetes cluster.
88

99
![System Overview](../diagrams/Ecosystem_Basic.png)
1010

11-
Operators use [Helm][] to configure and install the Workflow components which
11+
Operators use [Helm Classic][helm] to configure and install the Workflow components which
1212
interface directly with the underlying Kubernetes cluster. Service discovery,
1313
container availability and networking are all delegated to Kubernetes, while
1414
Workflow provides a clean and simple developer experience.

src/understanding-workflow/concepts.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ directly from application source code, aggregating logs, and managing deployment
2828
configurations and app releases are just some of the features Workflow adds.
2929

3030
Deis Workflow is a set of Kubernetes-native components, installable via
31-
[Helm][helm]. Systems engineers who are familiar with Kubernetes will feel right
31+
[Helm Classic][helm]. Systems engineers who are familiar with Kubernetes will feel right
3232
at home running Workflow.
3333

3434
See the [components][components] overview for more detail.

0 commit comments

Comments
 (0)