Skip to content

Commit 6ed2e1d

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

File tree

2 files changed

+18
-23
lines changed

2 files changed

+18
-23
lines changed

README.md

Lines changed: 6 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -57,16 +57,11 @@ Find out more: [OpenFaaS Standard and For Enterprises](https://www.openfaas.com/
5757

5858
## Get started
5959

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)
6162
* [Read news and tutorials on the openfaas.com blog](https://www.openfaas.com/blog/)
6263
* [Meet the community at the weekly Office Hours](https://docs.openfaas.com/community)
6364

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.
67-
68-
Read more: [Introducing PLONK](https://www.openfaas.com/blog/plonk-stack/).
69-
7065
## Technical and operational information
7166

7267
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
106101

107102
By default all OpenFaaS functions and services are deployed to the `openfaas` and `openfaas-fn` namespaces. To alter the namespace use the `helm` chart.
108103

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
114105

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/)
116108

117109
### Image pull policy
118110

@@ -125,7 +117,7 @@ Note: When set to `Never`, **only** local (or pulled) images will work. When se
125117

126118
## Kubernetes Versions
127119

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.
129121

130122
## Contributing
131123

chart/openfaas/README.md

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -343,16 +343,18 @@ Some configurations in combination with client-side KeepAlive settings may becau
343343
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.
344344

345345

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.
347349

348350
You temporarily access the Prometheus metrics by using `port-forward`
349351

350352
```sh
351-
kubectl --namespace openfaas port-forward deployment/prometheus 31119:9090
353+
kubectl -n openfaas \
354+
port-forward deployment/prometheus 9090:9090
352355
```
353356

354-
Then open `http://localhost:31119` to directly query the OpenFaaS metrics scraped by Prometheus.
355-
357+
Then open `http://127.0.0.1:9090` to directly query the OpenFaaS metrics scraped by Prometheus.
356358

357359
### Service meshes
358360

@@ -362,7 +364,7 @@ If you use a service mesh like Linkerd or Istio in your cluster, then you should
362364
--set gateway.directFunctions=true
363365
```
364366

365-
### Istio mTLS
367+
#### Istio mTLS
366368

367369
Istio requires OpenFaaS Pro to function correctly.
368370

@@ -375,7 +377,8 @@ helm upgrade openfaas --install chart/openfaas \
375377
--set exposeServices=false \
376378
--set gateway.directFunctions=true \
377379
--set gateway.probeFunctions=true \
378-
--set istio.mtls=true
380+
--set istio.mtls=true \
381+
-f values-pro.yaml
379382
```
380383

381384
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
384387

385388
### Scale-up from zero (on by default)
386389

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.
388391

389392
```sh
390393
--set gateway.scaleFromZero=true/false
@@ -447,7 +450,7 @@ If you have created additional namespaces for functions, delete those too, with
447450

448451
## Kubernetes versioning
449452

450-
This Helm chart currently supports version 1.16+
453+
This Helm chart currently supports version 1.19+
451454

452455
Note that OpenFaaS itself may support a wider range of versions, [see here](../../README.md#kubernetes-versions)
453456

@@ -487,7 +490,7 @@ yaml) |
487490
| `ingress.enabled` | Create ingress resources | `false` |
488491
| `istio.mtls` | Create Istio policies and destination rules to enforce mTLS for OpenFaaS components and functions | `false` |
489492
| `kubernetesDNSDomain` | Domain name of the Kubernetes cluster | `cluster.local` |
490-
| `k8sVersionOverride` | Override kubeVersion for the ingress creation | `""` |
493+
| `k8sVersionOverride` | Override kubeVersion for the ingress creation, this should be left blank. | `""` |
491494
| `nodeSelector` | Global [NodeSelector](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/) | `{}` |
492495
| `openfaasImagePullPolicy` | Image pull policy for openfaas components, can change to `IfNotPresent` in offline env | `Always` |
493496
| `openfaasPro` | Deploy OpenFaaS Pro | `false` |

0 commit comments

Comments
 (0)