Skip to content

Commit ee21e4d

Browse files
committed
Updates to Pro guidelines
Signed-off-by: Alex Ellis (OpenFaaS Ltd) <[email protected]>
1 parent 5643158 commit ee21e4d

File tree

1 file changed

+8
-20
lines changed

1 file changed

+8
-20
lines changed

chart/openfaas/README.md

Lines changed: 8 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -100,15 +100,15 @@ echo "OpenFaaS admin password: $PASSWORD"
100100

101101
#### Deploy OpenFaaS Pro - OpenFaaS Standard / OpenFaaS For Enterprises
102102

103-
It's recommended to run with a ClusterRole so that:
103+
You should have landed here from the following page: [Install OpenFaaS Pro](https://docs.openfaas.com/deployment/pro/), if you did not, please go there now and read the instructions before continuing.
104+
105+
It's recommended to install OpenFaaS Pro with a ClusterRole so that:
104106

105107
* Prometheus can scrape node metrics for CPU-based autoscaling, and report CPU/RAM consumption usage of functions via the API.
106-
* The Operator can manage functions across multiple namespaces
107108
* The Operator can obtain accurate namespace information for the installation
109+
* The Operator can manage functions across multiple namespaces
108110

109-
First:
110-
111-
* Create the required secret with your [OpenFaaS Pro license](https://www.openfaas.com/pricing/):
111+
Create the required secret with your [OpenFaaS Pro license](https://www.openfaas.com/pricing/):
112112

113113
```bash
114114
kubectl create secret generic \
@@ -119,21 +119,9 @@ kubectl create secret generic \
119119

120120
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.
121121

122-
Now deploy OpenFaaS from the helm chart repo:
122+
Review the recommended Pro values in [values-pro.yaml](values-pro.yaml). These are overlaid on top of the default values in [values.yaml](values.yaml), which is used as a base for all installations.
123123

124-
```sh
125-
helm repo update \
126-
&& helm upgrade openfaas \
127-
--install openfaas/openfaas \
128-
--namespace openfaas \
129-
--set openfaasPro=true
130-
```
131-
132-
The main change here is to add: `--set openfaasPro=true`
133-
134-
For production, we recommend creating your own values.yaml file, but make sure you do not copy any more settings into it than strictly necessary. This way the file can be maintained easily over time.
135-
136-
Example installation with a values.yaml file instead of using `--set`:
124+
Now deploy OpenFaaS from the helm chart repo:
137125

138126
```sh
139127
helm repo update \
@@ -144,7 +132,7 @@ helm repo update \
144132
-f values-pro.yaml
145133
```
146134

147-
You can also review recommended Pro values in [values-pro.yaml](values-pro.yaml)
135+
For production, you should take a copy of the `values-pro.yaml` file, and keep any of your own custom settings and overrides there. We do not recommend copying the base `values.yaml` files as it is rather large, and contains settings that are updated by our team on a regular basis such as image versions.
148136

149137
#### OpenFaaS OEM
150138

0 commit comments

Comments
 (0)