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.
- This project is free to use for any purpose, but it comes with no warranty
- You must use the same GPLv3 license in
- You must keep the copy right notice and/or include an acknowledgement
- Your project must remain open-source
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).
x86_64 computer(s) should work, you can use old PCs, laptops or servers.
This is the requirements for each node
|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 (checkout the single node cluster adjustments tutorial)||3 or more for high availability|
- Ability to boot from the network (PXE boot)
- Wake-on-LAN capability, used to wake the machines up automatically without physically touching the power button
- 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)
Buying a domain is highly recommended, but if you don't have one, see alternate DNS setup.
You need to do it once per machine if the default config is not sufficent, usually for consumer hardware this can not be automated (it requires something like IPMI to automate).
- Enable Wake-on-LAN (WoL) and network boot
- Use UEFI mode and disable CSM (legacy) mode
- Disable secure boot
Boot order options (select one, each has their pros and cons):
- Only boot from the network if no operating system found: works on most hardware but you need to manually wipe your hard drive or delete the existing boot record for the current OS
- Prefer booting from the network if turned on via WoL: more convenience but your BIOS must support it, and you must test it throughly to ensure you don't accidentally wipe your servers
Below is my BIOS setup for reference. Your motherboard may have a different name for the options, so you'll need to adapt it to your hardware.
Devices: NetworkSetup: PXEIPv4: true PXEIPv6: false Advanced: CPUSetup: VT-d: true Power: AutomaticPowerOn: WoL: Automatic # Use network boot if Wake-on-LAN Security: SecureBoot: false Startup: CSM: false
- MAC address for each machine
- OS disk name (for example
- Network interface name (for example
- Choose a static IP address for each machine (just the desired address, we don't set anything up yet)