Skip to content

Commit cc792bb

Browse files
Improvement in the documentation (#637)
Co-authored-by: Yadwinder <[email protected]>
1 parent f917982 commit cc792bb

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

README.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -243,11 +243,15 @@ 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.
247+
246248
Deployment can be done by using the following single command:
247249
```shell
248250
helm install owdev ./helm/openwhisk -n openwhisk --create-namespace -f mycluster.yaml
249251
```
250252

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`.
254+
251255
Deploying to OKD/OpenShift uses the command sequence:
252256
```shell
253257
helm template owdev ./helm/openwhisk -n openwhisk -f mycluster.yaml > owdev.yaml
@@ -260,9 +264,11 @@ by simply doing `oc delete -f owdev.yaml`
260264

261265
You can use the command `helm status owdev -n openwhisk` to get a summary
262266
of the various Kubernetes artifacts that make up your OpenWhisk
263-
deployment. Once the `install-packages` Pod is in the `Completed` state,
267+
deployment. Once the pod name containing the word `install-packages` is in the `Completed` state,
264268
your OpenWhisk deployment is ready to be used.
265269

270+
**NOTE:** You can check the status of the pod by running the following command `kubectl get pods -n openwhisk --watch`.
271+
266272
## Configure the wsk CLI
267273

268274
Configure the OpenWhisk CLI, wsk, by setting the auth and apihost
@@ -366,6 +372,8 @@ launch the tests:
366372
-Dwhisk.auth=$WHISK_AUTH -Dwhisk.server=https://$WHISK_SERVER -Dopenwhisk.home=`pwd`
367373
```
368374

375+
**NOTE:** You need to install JDK 8 in order to run these tests.
376+
369377
### Deploying a locally built docker image.
370378

371379
If you are using Kubernetes in Docker, it is
@@ -435,4 +443,3 @@ If your OpenWhisk deployment is not working, check our
435443
Report bugs, ask questions and request features [here on GitHub](../../issues).
436444

437445
You can also join our slack channel and chat with developers. To get access to our slack channel, request an invite [here](http://slack.openwhisk.org).
438-

0 commit comments

Comments
 (0)