Skip to content
Snippets Groups Projects
Commit b343273d authored by Alex Ellis (OpenFaaS Ltd)'s avatar Alex Ellis (OpenFaaS Ltd)
Browse files

Remove functionNamespace from README examples


This has a default value so makes the command longer than
necessary.

Signed-off-by: default avatarAlex Ellis (OpenFaaS Ltd) <alexellis2@gmail.com>
parent 099b2198
No related branches found
No related tags found
No related merge requests found
......@@ -85,8 +85,7 @@ Deploy CE from the helm chart repo directly:
```sh
helm repo update \
&& helm upgrade openfaas --install openfaas/openfaas \
--namespace openfaas \
--set functionNamespace=openfaas-fn
--namespace openfaas
```
> 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:
helm repo update \
&& helm upgrade openfaas --install openfaas/openfaas \
--namespace openfaas \
--set functionNamespace=openfaas-fn \
--set openfaasPro=true \
--set autoscaler.enabled=true
--set openfaasPro=true
```
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`:
helm repo update \
&& helm upgrade openfaas --install openfaas/openfaas \
--namespace openfaas \
--set functionNamespace=openfaas-fn \
-f values.yaml \
-f values-pro.yaml
```
......@@ -160,7 +156,6 @@ You can run the following command from within the `faas-netes` folder, not the c
```sh
helm upgrade openfaas --install chart/openfaas \
--namespace openfaas \
--set functionNamespace=openfaas-fn \
-f ./chart/openfaas/values.yaml \
-f ./chart/openfaas/values-pro.yaml
```
......@@ -169,15 +164,16 @@ In the example above, I'm overlaying two additional YAML files for settings for
You can override specific images by adding `--set gateway.image=` for instance.
#### Generate basic-auth credentials
#### Pre-create basic-auth credentials for OpenFaaS Pro/CE
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.
The chart has a pre-install hook which can generate basic-auth credentials, enable it with `--set generateBasicAuth=true`.
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`.
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`.
Example command to generate a random password:
```sh
# generate a random password
PASSWORD=$(head -c 12 /dev/urandom | shasum| cut -d' ' -f1)
kubectl -n openfaas create secret generic basic-auth \
--from-literal=basic-auth-user=admin \
--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
### Istio mTLS
To install OpenFaaS with Istio mTLS pass `--set istio.mtls=true` and disable the HTTP probes:
To install OpenFaaS with Istio mTLS pass `--set istio.mtls=true` and disable the HTTP probes:
```sh
helm upgrade openfaas --install chart/openfaas \
--namespace openfaas \
--set basic_auth=true \
--set functionNamespace=openfaas-fn \
--set exposeServices=false \
--set faasnetes.httpProbe=false \
--set httpProbe=false \
......
......@@ -9,7 +9,7 @@ createCRDs: true # Set to false if applying CRDs in another way
basic_auth: true # Authentication for core components, no good reason to disable this
rbac: true # Kubernetes RBAC, no good reason to disable this
generateBasicAuth: true # Set to false if applying credentials separately from the chart, otherwise set to true
generateBasicAuth: true # Set to false if applying credentials separately from the chart, otherwise set to true
securityContext: true
exposeServices: true
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment