Skip to content

Commit b343273

Browse files
committed
Remove functionNamespace from README examples
This has a default value so makes the command longer than necessary. Signed-off-by: Alex Ellis (OpenFaaS Ltd) <[email protected]>
1 parent 099b219 commit b343273

File tree

2 files changed

+9
-14
lines changed

2 files changed

+9
-14
lines changed

chart/openfaas/README.md

Lines changed: 8 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -85,8 +85,7 @@ Deploy CE from the helm chart repo directly:
8585
```sh
8686
helm repo update \
8787
&& helm upgrade openfaas --install openfaas/openfaas \
88-
--namespace openfaas \
89-
--set functionNamespace=openfaas-fn
88+
--namespace openfaas
9089
```
9190

9291
> The above command will also update your helm repo to pull in any new releases.
@@ -117,9 +116,7 @@ Now deploy OpenFaaS from the helm chart repo:
117116
helm repo update \
118117
&& helm upgrade openfaas --install openfaas/openfaas \
119118
--namespace openfaas \
120-
--set functionNamespace=openfaas-fn \
121-
--set openfaasPro=true \
122-
--set autoscaler.enabled=true
119+
--set openfaasPro=true
123120
```
124121

125122
The main change here is to add: `--set openfaasPro=true`
@@ -132,7 +129,6 @@ Example installation with a values.yaml file instead of using `--set`:
132129
helm repo update \
133130
&& helm upgrade openfaas --install openfaas/openfaas \
134131
--namespace openfaas \
135-
--set functionNamespace=openfaas-fn \
136132
-f values.yaml \
137133
-f values-pro.yaml
138134
```
@@ -160,7 +156,6 @@ You can run the following command from within the `faas-netes` folder, not the c
160156
```sh
161157
helm upgrade openfaas --install chart/openfaas \
162158
--namespace openfaas \
163-
--set functionNamespace=openfaas-fn \
164159
-f ./chart/openfaas/values.yaml \
165160
-f ./chart/openfaas/values-pro.yaml
166161
```
@@ -169,15 +164,16 @@ In the example above, I'm overlaying two additional YAML files for settings for
169164

170165
You can override specific images by adding `--set gateway.image=` for instance.
171166

172-
#### Generate basic-auth credentials
167+
#### Pre-create basic-auth credentials for OpenFaaS Pro/CE
168+
169+
If you're using a GitOps tool like ArgoCD or Flux to install OpenFaaS, then you will need to pre-create the basic-auth credentials, so that they remain stable.
173170

174-
The chart has a pre-install hook which can generate basic-auth credentials, enable it with `--set generateBasicAuth=true`.
171+
Why? The chart has a pre-install hook which can generate basic-auth credentials. It is enabled by default and can be turned off with `--set generateBasicAuth=false`.
175172

176-
Alternatively, you can set `generateBasicAuth` to `false` and generate or supply the basic-auth credentials yourself. This is the option you may want if you are using `helm template`.
173+
Example command to generate a random password:
177174

178175
```sh
179176
# generate a random password
180-
PASSWORD=$(head -c 12 /dev/urandom | shasum| cut -d' ' -f1)
181177
kubectl -n openfaas create secret generic basic-auth \
182178
--from-literal=basic-auth-user=admin \
183179
--from-literal=basic-auth-password="$PASSWORD"
@@ -355,13 +351,12 @@ If you use a service mesh like Linkerd or Istio in your cluster, then you should
355351

356352
### Istio mTLS
357353

358-
To install OpenFaaS with Istio mTLS pass `--set istio.mtls=true` and disable the HTTP probes:
354+
To install OpenFaaS with Istio mTLS pass `--set istio.mtls=true` and disable the HTTP probes:
359355

360356
```sh
361357
helm upgrade openfaas --install chart/openfaas \
362358
--namespace openfaas \
363359
--set basic_auth=true \
364-
--set functionNamespace=openfaas-fn \
365360
--set exposeServices=false \
366361
--set faasnetes.httpProbe=false \
367362
--set httpProbe=false \

chart/openfaas/values.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ createCRDs: true # Set to false if applying CRDs in another way
99

1010
basic_auth: true # Authentication for core components, no good reason to disable this
1111
rbac: true # Kubernetes RBAC, no good reason to disable this
12-
generateBasicAuth: true # Set to false if applying credentials separately from the chart, otherwise set to true
12+
generateBasicAuth: true # Set to false if applying credentials separately from the chart, otherwise set to true
1313
securityContext: true
1414

1515
exposeServices: true

0 commit comments

Comments
 (0)