You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+6-14Lines changed: 6 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -57,16 +57,11 @@ Find out more: [OpenFaaS Standard and For Enterprises](https://www.openfaas.com/
57
57
58
58
## Get started
59
59
60
-
* Tutorial: [Deploy OpenFaaS to Kubernetes with its helm chart](https://docs.openfaas.com/deployment)
60
+
*[Deploy OpenFaaS Pro to Kubernetes with its helm chart](https://docs.openfaas.com/deployment/pro/)
61
+
*[Deploy OpenFaaS CE to Kubernetes with its helm chart](https://docs.openfaas.com/deployment)
61
62
*[Read news and tutorials on the openfaas.com blog](https://www.openfaas.com/blog/)
62
63
*[Meet the community at the weekly Office Hours](https://docs.openfaas.com/community)
63
64
64
-
### The PLONK Stack
65
-
66
-
OpenFaaS can be used as complete stack for Cloud Native application development called PLONK. The PLONK Stack includes: Prometheus, Linux/Linkerd, OpenFaaS, NATS/Nginx and Kubernetes.
The rest of this document is dedicated to technical and operational information for the controller.
@@ -106,13 +101,10 @@ The readiness checking for functions assumes you are using our function watchdog
106
101
107
102
By default all OpenFaaS functions and services are deployed to the `openfaas` and `openfaas-fn` namespaces. To alter the namespace use the `helm` chart.
108
103
109
-
### Ingress
110
-
111
-
To configure ingress see the `helm` chart. By default NodePorts are used. These are listed in the [deployment guide](https://docs.openfaas.com/deployment).
112
-
113
-
By default functions are exposed at `http://gateway:8080/function/NAME`.
104
+
### Ingress & TLS
114
105
115
-
You can also use the [IngressOperator to set up custom domains and HTTP paths](https://github.com/openfaas/ingress-operator)
106
+
*[Configure TLS for the gateway and dashboard](https://docs.openfaas.com/reference/tls-openfaas/)
107
+
*[Configure TLS for functions](https://docs.openfaas.com/reference/tls-functions/)
116
108
117
109
### Image pull policy
118
110
@@ -125,7 +117,7 @@ Note: When set to `Never`, **only** local (or pulled) images will work. When se
125
117
126
118
## Kubernetes Versions
127
119
128
-
faas-netes maintainers strive to support as many Kubernetes versions as possible and it is currently compatible with Kubernetes 1.11 and higher. Instructions for OpenShift are also available in the documentation.
120
+
faas-netes maintainers strive to support as many Kubernetes versions as possible and it is currently compatible with Kubernetes 1.19 and higher. Instructions for OpenShift are also available in the documentation.
Copy file name to clipboardExpand all lines: chart/openfaas/README.md
+12-9Lines changed: 12 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -343,16 +343,18 @@ Some configurations in combination with client-side KeepAlive settings may becau
343
343
In this mode, all invocations will pass through the gateway to faas-netes, which will look up endpoint IPs directly from Kubernetes, the additional hop may add some latency, but will do fair load-balancing, even with KeepAlive.
344
344
345
345
346
-
### Metrics
346
+
### Viewing the Prometheus metrics
347
+
348
+
It's better to view the metrics from OpenFaaS via [the official Grafana dashboards](https://docs.openfaas.com/openfaas-pro/grafana-dashboards/), than by running direct queries, however, it can be useful to view the metrics directly for exploration and debugging.
347
349
348
350
You temporarily access the Prometheus metrics by using `port-forward`
The above command will enable mTLS for the openfaas control plane services and functions excluding NATS.
@@ -384,7 +387,7 @@ The above command will enable mTLS for the openfaas control plane services and f
384
387
385
388
### Scale-up from zero (on by default)
386
389
387
-
Scaling up from zero replicas is enabled by default, to turn it off set `scaleFromZero` to `false` in the helm chart options for the `gateway` component.
390
+
Scaling up from zero replicas is enabled by default, to turn it off set `scaleFromZero` to `false` in the helm chart options for the `gateway` component. There is very little reason to turn this setting off.
388
391
389
392
```sh
390
393
--set gateway.scaleFromZero=true/false
@@ -447,7 +450,7 @@ If you have created additional namespaces for functions, delete those too, with
447
450
448
451
## Kubernetes versioning
449
452
450
-
This Helm chart currently supports version 1.16+
453
+
This Helm chart currently supports version 1.19+
451
454
452
455
Note that OpenFaaS itself may support a wider range of versions, [see here](../../README.md#kubernetes-versions)
0 commit comments