Skip to content

Commit 6da860a

Browse files
committed
Update istio instructions
Signed-off-by: Alex Ellis (OpenFaaS Ltd) <[email protected]>
1 parent 83ccaa5 commit 6da860a

File tree

1 file changed

+26
-32
lines changed

1 file changed

+26
-32
lines changed

chart/openfaas/README.md

Lines changed: 26 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -84,8 +84,9 @@ Deploy CE from the helm chart repo directly:
8484

8585
```sh
8686
helm repo update \
87-
&& helm upgrade openfaas --install openfaas/openfaas \
88-
--namespace openfaas
87+
&& helm upgrade openfaas \
88+
--install openfaas/openfaas \
89+
--namespace openfaas
8990
```
9091

9192
> The above command will also update your helm repo to pull in any new releases.
@@ -103,9 +104,9 @@ echo "OpenFaaS admin password: $PASSWORD"
103104

104105
```bash
105106
kubectl create secret generic \
106-
-n openfaas \
107-
openfaas-license \
108-
--from-file license=$HOME/.openfaas/LICENSE
107+
-n openfaas \
108+
openfaas-license \
109+
--from-file license=$HOME/.openfaas/LICENSE
109110
```
110111

111112
If you wish to use the OpenFaaS Pro dashboard, [you must run the steps to "Create a signing key"](https://docs.openfaas.com/openfaas-pro/dashboard/#installation) before installing the Helm chart.
@@ -114,9 +115,10 @@ Now deploy OpenFaaS from the helm chart repo:
114115

115116
```sh
116117
helm repo update \
117-
&& helm upgrade openfaas --install openfaas/openfaas \
118-
--namespace openfaas \
119-
--set openfaasPro=true
118+
&& helm upgrade openfaas \
119+
--install openfaas/openfaas \
120+
--namespace openfaas \
121+
--set openfaasPro=true
120122
```
121123

122124
The main change here is to add: `--set openfaasPro=true`
@@ -127,10 +129,11 @@ Example installation with a values.yaml file instead of using `--set`:
127129

128130
```sh
129131
helm repo update \
130-
&& helm upgrade openfaas --install openfaas/openfaas \
131-
--namespace openfaas \
132-
-f values.yaml \
133-
-f values-pro.yaml
132+
&& helm upgrade openfaas \
133+
--install openfaas/openfaas \
134+
--namespace openfaas \
135+
-f values.yaml \
136+
-f values-pro.yaml
134137
```
135138

136139
You can also review recommended Pro values in [values-pro.yaml](values-pro.yaml)
@@ -154,10 +157,11 @@ If you are working on a patch for the helm chart, you can deploy it directly fro
154157
You can run the following command from within the `faas-netes` folder, not the chart's folder.
155158

156159
```sh
157-
helm upgrade openfaas --install chart/openfaas \
158-
--namespace openfaas \
159-
-f ./chart/openfaas/values.yaml \
160-
-f ./chart/openfaas/values-pro.yaml
160+
helm upgrade openfaas \
161+
--install chart/openfaas \
162+
--namespace openfaas \
163+
-f ./chart/openfaas/values.yaml \
164+
-f ./chart/openfaas/values-pro.yaml
161165
```
162166

163167
In the example above, I'm overlaying two additional YAML files for settings for the chart.
@@ -216,15 +220,6 @@ In addition:
216220
* Set the `imagePullPolicy` to `IfNotPresent` so that the `kubelet` only pulls images which are not already available
217221
* Explore alternatives such as not scaling to absolute zero, and using async calls which do not show the cold start
218222

219-
#### httpProbe vs. execProbe
220-
221-
A note on health-checking probes for functions:
222-
223-
* httpProbe - (`default`) most efficient. (compatible with Istio >= 1.1.5)
224-
* execProbe - least efficient option, but compatible with Istio < 1.1.5
225-
226-
Use `--set faasnetes.httpProbe=true/false` to toggle between http / exec probes.
227-
228223
### Verify the installation
229224

230225
Once all the services are up and running, log into your gateway using the OpenFaaS CLI. This will cache your credentials into your `~/.openfaas/config.yml` file.
@@ -351,23 +346,22 @@ If you use a service mesh like Linkerd or Istio in your cluster, then you should
351346

352347
### Istio mTLS
353348

354-
To install OpenFaaS with Istio mTLS pass `--set istio.mtls=true` and disable the HTTP probes:
349+
Istio requires OpenFaaS Pro to function correctly.
350+
351+
To install OpenFaaS Pro with Istio mTLS pass `--set istio.mtls=true` and disable the HTTP probes:
355352

356353
```sh
357354
helm upgrade openfaas --install chart/openfaas \
358355
--namespace openfaas \
359-
--set basic_auth=true \
356+
--set openfaasPro=true \
360357
--set exposeServices=false \
361-
--set faasnetes.httpProbe=false \
362-
--set httpProbe=false \
363358
--set gateway.directFunctions=true \
359+
--set gateway.probeFunctions=true \
364360
--set istio.mtls=true
365361
```
366362

367363
The above command will enable mTLS for the openfaas control plane services and functions excluding NATS.
368364

369-
> Note that the above instructions were tested on GKE 1.13 and Istio 1.2
370-
371365
## Zero scale
372366

373367
### Scale-up from zero (on by default)
@@ -479,7 +473,7 @@ yaml) |
479473

480474
| Parameter | Description | Default |
481475
| ----------------------- | ---------------------------------- | ---------------------------------------------------------- |
482-
| `faasnetes.httpProbe` | Use a httpProbe instead of exec | `false` |
476+
| `faasnetes.httpProbe` | Use a httpProbe instead of exec | `true` |
483477
| `faasnetes.image` | Container image used for provider API | See [values.yaml](./values.yaml) |
484478
| `faasnetes.imagePullPolicy` | Image pull policy for deployed functions | `Always` |
485479
| `faasnetes.livenessProbe.initialDelaySeconds` | Number of seconds after the container has started before [probe](https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#container-probes) is initiated | `2` |

0 commit comments

Comments
 (0)