Skip to content

Commit

Permalink
Updates to README files
Browse files Browse the repository at this point in the history
Signed-off-by: Alex Ellis (OpenFaaS Ltd) <[email protected]>
  • Loading branch information
alexellis committed Nov 23, 2024
1 parent ee21e4d commit 6ed2e1d
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 23 deletions.
20 changes: 6 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,16 +57,11 @@ Find out more: [OpenFaaS Standard and For Enterprises](https://www.openfaas.com/

## Get started

* Tutorial: [Deploy OpenFaaS to Kubernetes with its helm chart](https://docs.openfaas.com/deployment)
* [Deploy OpenFaaS Pro to Kubernetes with its helm chart](https://docs.openfaas.com/deployment/pro/)
* [Deploy OpenFaaS CE to Kubernetes with its helm chart](https://docs.openfaas.com/deployment)
* [Read news and tutorials on the openfaas.com blog](https://www.openfaas.com/blog/)
* [Meet the community at the weekly Office Hours](https://docs.openfaas.com/community)

### The PLONK Stack

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.

Read more: [Introducing PLONK](https://www.openfaas.com/blog/plonk-stack/).

## Technical and operational information

The rest of this document is dedicated to technical and operational information for the controller.
Expand Down Expand Up @@ -106,13 +101,10 @@ The readiness checking for functions assumes you are using our function watchdog

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

### Ingress

To configure ingress see the `helm` chart. By default NodePorts are used. These are listed in the [deployment guide](https://docs.openfaas.com/deployment).

By default functions are exposed at `http://gateway:8080/function/NAME`.
### Ingress & TLS

You can also use the [IngressOperator to set up custom domains and HTTP paths](https://github.com/openfaas/ingress-operator)
* [Configure TLS for the gateway and dashboard](https://docs.openfaas.com/reference/tls-openfaas/)
* [Configure TLS for functions](https://docs.openfaas.com/reference/tls-functions/)

### Image pull policy

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

## Kubernetes Versions

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

## Contributing

Expand Down
21 changes: 12 additions & 9 deletions chart/openfaas/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -343,16 +343,18 @@ Some configurations in combination with client-side KeepAlive settings may becau
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.


### Metrics
### Viewing the Prometheus metrics

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.

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

```sh
kubectl --namespace openfaas port-forward deployment/prometheus 31119:9090
kubectl -n openfaas \
port-forward deployment/prometheus 9090:9090
```

Then open `http://localhost:31119` to directly query the OpenFaaS metrics scraped by Prometheus.

Then open `http://127.0.0.1:9090` to directly query the OpenFaaS metrics scraped by Prometheus.

### Service meshes

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

### Istio mTLS
#### Istio mTLS

Istio requires OpenFaaS Pro to function correctly.

Expand All @@ -375,7 +377,8 @@ helm upgrade openfaas --install chart/openfaas \
--set exposeServices=false \
--set gateway.directFunctions=true \
--set gateway.probeFunctions=true \
--set istio.mtls=true
--set istio.mtls=true \
-f values-pro.yaml
```

The above command will enable mTLS for the openfaas control plane services and functions excluding NATS.
Expand All @@ -384,7 +387,7 @@ The above command will enable mTLS for the openfaas control plane services and f

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

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

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

## Kubernetes versioning

This Helm chart currently supports version 1.16+
This Helm chart currently supports version 1.19+

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

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

0 comments on commit 6ed2e1d

Please sign in to comment.