This is an automated email from the ASF dual-hosted git repository.
dgrove pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/openwhisk-deploy-kube.git
The following commit(s) were added to refs/heads/master by this push:
new 5cf0b7c Add backquotes for file names (#679)
5cf0b7c is described below
commit 5cf0b7cfc364cbe52aa7fd5b43e10319310d394d
Author: Keith Null <[email protected]>
AuthorDate: Mon Mar 8 22:09:18 2021 +0800
Add backquotes for file names (#679)
---
README.md | 4 ++--
docs/configurationChoices.md | 7 +++++--
docs/k8s-aws.md | 4 +++-
docs/k8s-docker-for-mac.md | 2 +-
docs/k8s-docker-for-windows.md | 2 +-
docs/k8s-kind.md | 7 +++++--
6 files changed, 17 insertions(+), 9 deletions(-)
diff --git a/README.md b/README.md
index 1fa5d2f..7eb1dab 100644
--- a/README.md
+++ b/README.md
@@ -294,7 +294,7 @@ Configure the OpenWhisk CLI, wsk, by setting the auth and
apihost
properties (if you don't already have the wsk cli, follow the
instructions [here](https://github.com/apache/openwhisk-cli)
to get it). Replace `whisk.ingress.apiHostName` and `whisk.ingress.apiHostPort`
-with the actual values from your mycluster.yaml.
+with the actual values from your `mycluster.yaml`.
```shell
wsk property set --apihost
<whisk.ingress.apiHostName>:<whisk.ingress.apiHostPort>
wsk property set --auth
23bc46b1-71f6-4ed5-8c54-816aa4f8c502:123zO3xZCLrMN6v2BKK1dXYFpXlPkccOFqm12CdAsMgRU4VrNZ9lyGVCGuMDGIwP
@@ -306,7 +306,7 @@ host environment. Instead, exposed NodePorts are forwarded
from localhost
to the appropriate containers. This means that you will use `localhost`
instead of `whisk.ingress.apiHostName` when configuring
the `wsk` cli and replace `whisk.ingress.apiHostPort`
-with the actual values from your mycluster.yaml.
+with the actual values from your `mycluster.yaml`.
```shell
wsk property set --apihost localhost:<whisk.ingress.apiHostPort>
diff --git a/docs/configurationChoices.md b/docs/configurationChoices.md
index 5f7afe1..7a7950e 100644
--- a/docs/configurationChoices.md
+++ b/docs/configurationChoices.md
@@ -157,20 +157,23 @@ approach to provisioning dynamic storage if it's not
already provisioned
on your cluster.
If your cluster is not thus configured and you want to use persistence,
-then you will need to add the following stanza to your mycluster.yaml.
+then you will need to add the following stanza to your `mycluster.yaml`.
+
```yaml
k8s:
persistence:
hasDefaultStorageClass: false
explicitStorageClass: <DESIRED_STORAGE_CLASS_NAME>
```
+
If <DESIRED_STORAGE_CLASS_NAME> has a dynamic provisioner, deploying
the Helm chart will automatically create the required PersistentVolumes.
If <DESIRED_STORAGE_CLASS_NAME> does not have a dynamic provisioner,
then you will need to manually create the required persistent volumes.
Alternatively, you may also entirely disable the usage of persistence
-by adding the following stanza to your mycluster.yaml:
+by adding the following stanza to your `mycluster.yaml`:
+
```yaml
k8s:
persistence:
diff --git a/docs/k8s-aws.md b/docs/k8s-aws.md
index b73e868..4b36a21 100644
--- a/docs/k8s-aws.md
+++ b/docs/k8s-aws.md
@@ -64,8 +64,10 @@ A typical output would be as shown below
]
}
```
-Add the following to your mycluster.yaml, using your certificate's Arn
+
+Add the following to your `mycluster.yaml`, using your certificate's Arn
instead of the example one:
+
```yaml
whisk:
ingress:
diff --git a/docs/k8s-docker-for-mac.md b/docs/k8s-docker-for-mac.md
index b96b57c..9644acf 100644
--- a/docs/k8s-docker-for-mac.md
+++ b/docs/k8s-docker-for-mac.md
@@ -52,7 +52,7 @@ might also have installed on your machine. Finally, pick the
You will be using a NodePort ingress to access OpenWhisk. Assuming
`kubectl describe nodes | grep InternalIP` returns 192.168.65.3 and
port 31001 is available to be used on your host machine, a
-mycluster.yaml for a standard deployment of OpenWhisk would be:
+`mycluster.yaml` for a standard deployment of OpenWhisk would be:
```yaml
whisk:
ingress:
diff --git a/docs/k8s-docker-for-windows.md b/docs/k8s-docker-for-windows.md
index 8296990..aa6f4b5 100644
--- a/docs/k8s-docker-for-windows.md
+++ b/docs/k8s-docker-for-windows.md
@@ -62,7 +62,7 @@ the box to enable Kubernetes.
You will be using a NodePort ingress to access OpenWhisk. Assuming
`kubectl describe nodes | find "InternalIP"` returns 192.168.65.3 and
port 31001 is available to be used on your host machine, a
-mycluster.yaml for a standard deployment of OpenWhisk would be:
+`mycluster.yaml` for a standard deployment of OpenWhisk would be:
```yaml
whisk:
diff --git a/docs/k8s-kind.md b/docs/k8s-kind.md
index f220de9..518ef7a 100644
--- a/docs/k8s-kind.md
+++ b/docs/k8s-kind.md
@@ -75,15 +75,18 @@ kubectl label node kind-worker2 openwhisk-role=invoker
### Configuring OpenWhisk
-To configure OpenWhisk, you first need to define a mycluster.yaml
+To configure OpenWhisk, you first need to define a `mycluster.yaml`
that specifies the "inside the cluster" ingress information and
other system configuration. First, determine the internalIP of
a worker node with the command:
+
```
kubectl describe node kind-worker | grep InternalIP: | awk '{print $2}'
```
-A mycluster.yaml for a standard deployment of OpenWhisk would look
+
+A `mycluster.yaml` for a standard deployment of OpenWhisk would look
like the below, replacing <InternalIP> with its actual value:
+
```yaml
whisk:
ingress:
