|
1 | 1 | # Deployment guide for Kubernetes |
2 | 2 |
|
3 | | -## Build a cluster |
| 3 | +Before deploying OpenFaaS, you should provision a Kubernetes cluster. |
4 | 4 |
|
5 | | -Before deploying OpenFaaS, you should provision a Kubernetes cluster. There are many options for deploying a local or remote cluster. You can read about the [various Kubernetes distributions here](https://kubernetes.io/docs/setup/). |
| 5 | +## Installing OpenFaaS (an overview) |
| 6 | + |
| 7 | +There are many options for deploying a local or remote cluster. You can read about the [various Kubernetes distributions here](https://kubernetes.io/docs/setup/). |
6 | 8 |
|
7 | 9 | Once you have a cluster, you can follow the detailed instructions on this page. |
8 | 10 |
|
9 | 11 | * Install OpenFaaS CLI |
10 | 12 | * Deploy OpenFaaS using via helm or arkade |
11 | 13 | * Find your OpenFaaS gateway address |
| 14 | +* Retrieve your gateway credentials |
12 | 15 | * Log in, deploy a function, and try out the UI. |
13 | 16 |
|
| 17 | +From there, you should consider: adding a TLS certificate with Ingress, switching to the OIDC/OAuth2 plugin for authentication, and tuning-up for production use. |
| 18 | + |
| 19 | +## Build your cluster |
| 20 | + |
14 | 21 | ### Local clusters |
15 | 22 |
|
16 | 23 | Below are the most popular ways to run a local Kubernetes cluster, but OpenFaaS should run on any. |
@@ -81,13 +88,6 @@ There are three recommended ways to install OpenFaaS and you can pick whatever m |
81 | 88 | 2) `helm` client - sane defaults and easy to configure through YAML or CLI flags. Secure options such as `helm template` or `helm 3` also exist for those working within restrictive environments. |
82 | 89 | 3) With GitOps tooling. You can install OpenFaaS and keep it up to date with [Flux](https://github.com/fluxcd/flux) or [ArgoCD](https://argoproj.github.io/argo-cd/). |
83 | 90 |
|
84 | | -#### Getting help, expert installations and proof-of-concepts |
85 | | - |
86 | | -* You can get help by connecting with the community on the [Community Page](/community/). |
87 | | -* OpenFaaS Ltd offers expert installation, proof-of-concepts, and architecture reviews. Get in touch at: [sales@openfaas.com](mailto:sales@openfaas.com) to find out more. |
88 | | -* The [OpenFaaS Premium Subscription](https://openfaas.com/support/) offers enterprise-grade authentication with SSO and OpenID Connect (OIDC). |
89 | | -* Guidelines are also provided for [preparing for production](/architecture/production/) and for [performance testing](/architecture/performance). |
90 | | - |
91 | 91 | #### 1) Deploy the Chart with `arkade` (fastest option) |
92 | 92 |
|
93 | 93 | The `arkade install` command installs OpenFaaS using its official helm chart, but without using `tiller`, a [component which is insecure by default](https://engineering.bitnami.com/articles/running-helm-in-production.html). arkade can also install other important software for OpenFaaS users such as `cert-manager` and `nginx-ingress`. It's the easiest and quickest way to get up and running. |
@@ -160,25 +160,14 @@ faas-cli store list --platform armhf |
160 | 160 | faas-cli store deploy NAME |
161 | 161 | ``` |
162 | 162 |
|
163 | | -#### 64-bit ARM and AWS Graviton |
164 | | - |
165 | | -For 64-bit ARM servers and devices such as ODroid-C2, Rock64, AWS Graviton and the servers provided by [Equinix Metal (aka Packet)]https://metal.equinix.com). |
166 | | - |
167 | | -Use `arkade` to install OpenFaaS, it will determine the correct files to use to install OpenFaaS. |
168 | | - |
169 | | -When creating new functions you will need to run the build on an ARM64 node. |
| 163 | +Instructions are almost identical for ARM64 users, but use `--platform arm64` instead. |
170 | 164 |
|
171 | | -> Note: expert users can create or use [multi-arch templates](https://github.com/alexellis/multiarch-templates) which can build on a PC and deploy to an ARM64 node. |
| 165 | +### Getting help, expert installations and proof-of-concepts |
172 | 166 |
|
173 | | -* You can run `faas-cli deploy` from any computer using `--gateway` or `OPENFAAS_GATEWAY` |
174 | | -* But you must build Docker images on a Raspberry Pi, not on your PC or laptop. |
175 | | - |
176 | | -For the Function Store, use the following: |
177 | | - |
178 | | -```bash |
179 | | -faas-cli store list --platform arm64 |
180 | | -faas-cli store deploy NAME |
181 | | -``` |
| 167 | +* You can get help by connecting with the community on the [Community Page](/community/). |
| 168 | +* OpenFaaS Ltd offers expert installation, proof-of-concepts, and architecture reviews. Get in touch at: [sales@openfaas.com](mailto:sales@openfaas.com) to find out more. |
| 169 | +* The [OpenFaaS Premium Subscription](https://openfaas.com/support/) offers enterprise-grade authentication with SSO and OpenID Connect (OIDC). |
| 170 | +* Guidelines are also provided for [preparing for production](/architecture/production/) and for [performance testing](/architecture/performance). |
182 | 171 |
|
183 | 172 | #### Learn the OpenFaaS fundamentals |
184 | 173 |
|
|
0 commit comments