Prerequisites
Fork this repository
Because this project applies GitOps practices, it's the source of truth for my homelab, so you'll need to fork it to make it yours:
By using this project you agree to the license.
License TL;DR
- This project is free to use for any purpose, but it comes with no warranty
- You must use the same GPLv3 license in
LICENSE - You must keep the copy right notice and/or include an acknowledgement
- Your project must remain open-source
Hardware requirements
Initial controller
Info
The initial controller is the machine used to bootstrap the cluster, we only need it once, you can use your laptop or desktop
- A Linux machine that can run Docker (because the
hostnetworking driver used for PXE boot only supports Linux, you can use a Linux virtual machine with bridged networking if you're on macOS or Windows).
Servers
Any modern x86_64 computer(s) should work, you can use old PCs, laptops or servers.
Info
This is the requirements for each node
| Component | Minimum | Recommended |
|---|---|---|
| CPU | 2 cores | 4 cores |
| RAM | 8 GB | 16 GB |
| Hard drive | 128 GB | 512 GB (depending on your storage usage, the base installation will not use more than 128GB) |
| Node count | 1 | 3 or more for high availability |
Network setup
- All servers must be connected to the same wired network with the initial controller
- You have the access to change DNS config (on your router or at your domain registrar)
Domain
Buying a domain is highly recommended.