diff --git a/README.md b/README.md index cbed6b84..72973554 100644 --- a/README.md +++ b/README.md @@ -29,14 +29,33 @@ Before we get started everything below must be taken into consideration, you mus - [ ] bring a **positive attitude** and be ready to learn and fail a lot. _The more you fail, the more you can learn from._ - [ ] run the cluster on bare metal machines or VMs within your home network — **this is NOT designed for cloud environments**. - [ ] have Debian 12 freshly installed on 1 or more AMD64/ARM64 bare metal machines or VMs. Each machine will be either a **control node** or a **worker node** in your cluster. -- [ ] give your nodes unrestricted internet access — _air-gapped environments won't work_. +- [ ] give your nodes unrestricted internet access — **air-gapped environments won't work**. - [ ] have a domain you can manage on Cloudflare. - [ ] be willing to commit encrypted secrets to a public GitHub repository. - [ ] have a DNS server that supports split DNS (e.g. Pi-Hole) deployed somewhere outside your cluster **ON** your home network. -## 💻 System Preparation +## 💻 Machine Preparation -This projects supported Linux distro for running Kubernetes is Debian, Ubuntu _might_ work but it is not currently supported due to [these](https://github.com/onedr0p/flux-cluster-template/pull/830) reasons. +### System requirements + +📍 _k3s default behaviour is that all nodes are able to run workloads, including contol nodes. Worker nodes are therefore optional._ + +📍 _If you have 3 or more nodes it is strongly recommended to make 3 of them control nodes for a highly available control plane._ + +📍 _Ideally you will run the cluster on bare metal machines. If you intend to run your cluster on Proxmox VE, my thoughts and recommendations about that are documented [here](https://onedr0p.github.io/home-ops/notes/proxmox-considerations.html)._ + +#### Minimum + +| Role | Memory | Cores | Disk | +|-----------|-----------|---------|-------------| +| Control | 8GB | 4 | 100GB SSD | +| Worker | 4GB | 2 | 100GB SSD | + +#### Recommended + +| Role | Memory | Cores | System Disk | Data Disk | CPU | +|-----------|-----------|---------|--------------|---------------|----------| +| Any | 32GB | 8 | 100GB SSD | 1TB NVMe | AMD64 | #### Debian for AMD64