Skip to content

Commit cb895ca

Browse files
authored
document installing release using Helm repository (#671)
1 parent 0b5cea1 commit cb895ca

File tree

2 files changed

+24
-9
lines changed

2 files changed

+24
-9
lines changed

README.md

Lines changed: 23 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -243,16 +243,33 @@ For simplicity, in this README, we have used `owdev` as the release name and
243243
You can use a different name and/or namespace simply by changing the commands
244244
used below.
245245

246-
**NOTE:** Clone the repository https://github.com/apache/openwhisk-deploy-kube.git and use to Helm chart available under the `helm/openwhisk` folder.
246+
**NOTE:** The commands below assume Helm v3.2.0 or higher. Verfiy your local Helm version with the command `helm version`.
247+
248+
### Deploying Released Charts from Helm Repository
249+
250+
The OpenWhisk project maintains a Helm repository at `https://openwhisk.apache.org/charts`.
251+
You may install officially released versions of OpenWhisk from this repository:
252+
253+
```
254+
helm repo add openwhisk https://openwhisk.apache.org/charts
255+
helm repo update
256+
helm install owdev openwhisk/openwhisk -n openwhisk --create-namespace -f mycluster.yaml
257+
```
258+
259+
### Deploying from Git
260+
261+
To deploy directly from sources, either download the
262+
[latest source release](https://github.com/apache/openwhisk-deploy-kube/releases) or
263+
`git clone https://github.com/apache/openwhisk-deploy-kube.git` and use the Helm chart
264+
from the `helm/openwhisk` folder of the sourc tree.
247265

248-
Deployment can be done by using the following single command:
249266
```shell
250267
helm install owdev ./helm/openwhisk -n openwhisk --create-namespace -f mycluster.yaml
251268
```
252269

253-
**NOTE:** The above command will only work for Helm v3.2.0 or higher versions. Verfiy your local Helm version with the command `helm version`.
270+
### Deploying to OKD/OpenShift
254271

255-
Deploying to OKD/OpenShift uses the command sequence:
272+
Deploying to OKD/OpenShift currently requires a two command sequence:
256273
```shell
257274
helm template owdev ./helm/openwhisk -n openwhisk -f mycluster.yaml > owdev.yaml
258275
oc create -f owdev.yaml
@@ -262,6 +279,8 @@ used to create the `Route` resource specified in the generated `owdev.yaml`.
262279
We recommend generating to a file to make it easier to undeploy OpenWhisk later
263280
by simply doing `oc delete -f owdev.yaml`
264281

282+
### Checking status
283+
265284
You can use the command `helm status owdev -n openwhisk` to get a summary
266285
of the various Kubernetes artifacts that make up your OpenWhisk
267286
deployment. Once the pod name containing the word `install-packages` is in the `Completed` state,

docs/k8s-docker-for-windows.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -77,10 +77,6 @@ nginx:
7777
7878
### Using helm to install OpenWhisk
7979
80-
Installation expects `openwhisk` namespace to be created. To create, run
81-
82-
`kubectl create namespace openwhisk`
83-
8480
Indicate the Kubernetes worker nodes that should be used to execute user
8581
containers by OpenWhisk's invokers. For a single node development cluster,
8682
simply run:
@@ -92,7 +88,7 @@ Make sure you created your
9288

9389
```cmd
9490
cd openwhisk-deploy-kube
95-
helm install owdev ./helm/openwhisk -n openwhisk -f mycluster.yaml
91+
helm install owdev ./helm/openwhisk -n openwhisk --create-namespace -f mycluster.yaml
9692
```
9793

9894
You can use the command `helm status owdev -n openwhisk` to get a summary of the various

0 commit comments

Comments
 (0)