Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Single Node

The whole platform on one machine: a mini PC, an old laptop, a Raspberry Pi 4/5 with 4 GB or more. Set it in vars.nix:

profile = "single";

nodes.home = {
  hostname = "home";
  master = true;
  disk = "/dev/nvme0n1";
  address = "192.168.1.20";   # required: every service is reached here
};

It turns off, by default, the parts that only make sense across several machines:

On a clusterOn one machine
StorageLonghorn, 3 copies of every volume on different nodesk3s’ local storage, on the node’s disk
Service addressesMetalLB: the gateway, Pi-hole and the VPN each get a LAN address (nginxIp, piholeIp, wireguardIp)k3s’ built-in load balancer: all on the node’s address
Deploying the appsArgo CD syncs from your repok3s applies the manifests itself; the nightly upgrade (or colmena apply) updates them
k3s’ stateetcdSQLite

Everything else is the same: the gateway with HTTPS, Pi-hole, the VPN and single sign-on, Nextcloud, monitoring, backups, the NAS, the UPS.

What it needs

nixlab’s single-node VM test measures it on every change: k3s, the gateway, cert-manager, Pi-hole, the VPN and a small app, with the OS, use about 1.3 GB of RAM (the platform’s pods ~0.3 GB of that; the rest is k3s and the OS). Leave room for your apps: 4 GB is comfortable, 8 GB is plenty. On a cluster, Longhorn (~0.5 GB per node), MetalLB and Argo CD (~0.7 GB) add up; here they aren’t there.

Things to know

  • Your router’s DNS: point it (or your devices) at the node’s address to use Pi-hole, as on a cluster with piholeIp.
  • Pi-hole’s admin page is at https://pihole.<domain> through the gateway. On a cluster it also has its own address; here port 80 belongs to the gateway.
  • The edge proxy (edge.enable) needs an address of its own, so it isn’t available here.
  • Backups: Longhorn’s backups need Longhorn. Back up your apps with per-app backups instead.
  • Argo CD back on: gitops.enable = true, if you prefer deploying from git with its dashboard (about 0.7 GB more).
  • Growing into a cluster later: a different setup (Longhorn, MetalLB, etcd). Plan a reinstall, with a backup of your apps’ data first.