Skip to content
This repository was archived by the owner on Feb 2, 2021. It is now read-only.

Commit 6381b37

Browse files
committed
Update ARM note
Signed-off-by: Alex Ellis (OpenFaaS Ltd) <alexellis2@gmail.com>
1 parent 795de64 commit 6381b37

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

USER_GUIDE.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,15 @@ This tool automates the installation of OpenFaaS Cloud on Kubernetes. Before sta
88

99
For your cluster the following specifications are recommended:
1010

11-
* 2-3 nodes with 1-2 vCPU and 2-4GB RAM each
11+
* 3-4 nodes with 2 vCPU each and 4GB RAM
1212

13-
These are guidelines and not a hard requirement, you may well be able to run with fewer resources.
13+
These are guidelines and not a hard requirement, you may well be able to run with fewer resources, but please do not ask for support if you use less and run into problems.
14+
15+
> Note: You must use Intel hardware, ARM such as arm64 and armhf (Raspberry Pi) is not supported and not on the roadmap either. This could change if a company was willing to sponsor and pay for the features and ongoing maintenance.
1416
1517
### Note for k3s users
1618

17-
If using k3s. ofc-bootstrap uses Nginx for its IngressController, but k3s ships with Traefik and this will configuration is incompatible. When you set up k3s, make sure you pass the `--no-deploy traefik` flag.
19+
If you are using k3s, then you will need to disable Traefik. ofc-bootstrap uses nginx-ingress for its IngressController, but k3s ships with Traefik and this will configuration is incompatible. When you set up k3s, make sure you pass the `--no-deploy traefik` flag.
1820

1921
Example with [k3sup](https://k3sup.dev):
2022

@@ -28,7 +30,7 @@ Example with [k3d](https://github.com/rancher/k3d):
2830
k3d create --server-arg "--no-deploy=traefik"
2931
```
3032

31-
> From Alex: If you're planning on using k3s with DigitalOcean, please stop and think why you are doing this instead of using the managed service called DOKS. DOKS is a free, managed control-plane and much less work for you, k3s on Droplets will be more expensive given that you have to run your own "master".
33+
> A note on DigitalOcean: if you're planning on using k3s with DigitalOcean, please stop and think why you are doing this instead of using the managed service called DOKS. DOKS is a free, managed control-plane and much less work for you, k3s on Droplets will be more expensive given that you have to run your own "master".
3234
3335
### Credentials and dependent systems
3436

@@ -572,3 +574,4 @@ kubectl apply -f ./tmp/generated-ingress-ingress.yaml
572574
kubectl apply -f ./tmp/generated-tls-auth-domain-cert.yml
573575
kubectl apply -f ./tmp/generated-tls-wildcard-domain-cert.yml
574576
```
577+

0 commit comments

Comments
 (0)