This is a mono repository for my home infrastructure and Kubernetes cluster. I try to adhere to Infrastructure as Code (IaC) and GitOps practices using the tools like Ansible, Terraform, Kubernetes, Flux, Renovate and GitHub Actions.
There's an excellent template over at k8s-at-home/template-cluster-k3 if you wanted to try and follow along with some of the practices I use here.
My cluster is k3s provisioned overtop bare-metal Ubuntu 20.04 using the Ansible galaxy role ansible-role-k3s. This is a semi hyper-converged cluster, workloads and block storage are sharing the same available resources on my nodes while I have a separate server for (NFS) file storage.
🔸 Click here to see my Ansible playbooks and roles.
- projectcalico/calico: Internal Kubernetes networking plugin.
- rook/rook: Distributed block storage for peristent storage.
- mozilla/sops: Manages secrets for Kubernetes, Ansible and Terraform.
- kubernetes-sigs/external-dns: Automatically manages DNS records from my cluster in a cloud DNS provider.
- jetstack/cert-manager: Creates SSL certificates for services in my Kubernetes cluster.
- kubernetes/ingress-nginx: Ingress controller to expose HTTP traffic to pods over DNS.
Flux watches my cluster folder (see Directories below) and makes the changes to my cluster based on the YAML manifests.
Renovate watches my entire repository looking for dependency updates, when they are found a PR is automatically created. When some PRs are merged Flux applies the changes to my cluster.
This Git repository contains the following directories (kustomizatons) under cluster.
📁 cluster # k8s cluster defined as code
├─📁 flux # flux, gitops operator, loaded before everything
├─📁 crds # custom resources, loaded before 📁 core and 📁 apps
├─📁 charts # helm repos, loaded before 📁 core and 📁 apps
├─📁 config # cluster config, loaded before 📁 core and 📁 apps
├─📁 core # crucial apps, namespaced dir tree, loaded before 📁 apps
└─📁 apps # regular apps, namespaced dir tree, loaded last| Name | CIDR |
|---|---|
| Kubernetes Nodes | 192.168.42.0/24 |
| Kubernetes external services (Calico w/ BGP) | 192.168.69.0/24 |
| Kubernetes pods | 10.42.0.0/16 |
| Kubernetes services | 10.43.0.0/16 |
- HAProxy configured on Opnsense for the Kubernetes Control Plane Load Balancer.
- Calico configured with
externalIPsto expose Kubernetes services with their own IP over BGP which is configured on my router.
Due to issues, retrictions or nuances with Velero, Benji, Gemini, Kasten K10 by Veeam, Stash by AppsCode and others I am currently using a DIY (or more specifically a "Poor Man's Backup") solution that is leveraging Kyverno, Kopia and native Kubernetes CronJob and Job resources.
At a high level the way this operates is that:
- Kyverno creates a
CronJobfor eachPersistentVolumeClaimresource that contain a label ofpolicy.home.arpa/snapshot: "true" - Everyday the
CronJobcreates aJoband uses Kopia to connect to a Kopia repository on my NAS over NFS and then snapshots the contents of the app data mount into the Kopia repository
Some important notes on the implementation of this method:
- The snapshots made by Kopia are incremental which makes the
Jobrun very quick. - The app data mount is frozen during backup to prevent writes and unfrozen when the snapshot is complete.
- The
PersistentVolumeClaimresources must contain the labelsapp.kubernetes.io/name,app.kubernetes.io/instance, andpolicy.home.arpa/snapshot - Kopia has a Web UI which you can deploy into your cluster to have access to the repository via the UI or by executing into the
Podand using the Kopia CLI. This deployment is required if using the Taskfilesnapshot:createandsnapshot:restoretasks I created. - Recovery is done manually by using a different
Jobwhich utilizes a task with Taskfile I wrote a task that creates a restoreJobthat shutdowns the app and restores a snapshot from the Kopia repository into the apps' dataPersistentVolumeClaimand then puts the app back into a running state - There is another
CronJobthat syncs the Kopia repository to Backblaze B2 everyday.
Over WAN, I have port forwarded ports 80 and 443 to the load balancer IP of my ingress controller that's running in my Kubernetes cluster.
Cloudflare works as a proxy to hide my homes WAN IP and also as a firewall. When not on my home network, all the traffic coming into my ingress controller on port 80 and 443 comes from Cloudflare. In Opnsense I block all IPs not originating from the Cloudflares list of IP ranges.
🔸 Cloudflare is also configured to GeoIP block all countries except a few I have whitelisted
k8s_gateway is deployed on Opnsense. With this setup, k8s_gateway has direct access to my clusters ingress records and serves DNS for them in my internal network. k8s_gateway is only listening on 127.0.0.1 on port 53.
For adblocking, I have AdGuard Home also deployed on Opnsense which has a upstream server pointing the k8s_gateway I mentioned above. Adguard Home listens on my MANAGEMENT, SERVER, IOT and GUEST networks on port 53. In my firewall rules I have NAT port redirection forcing all the networks to use the Adguard Home DNS server.
Without much engineering of DNS @home, these options have made my Opnsense router a single point of failure for DNS. I believe this is ok though because my router should have the most uptime of all my systems.
external-dns is deployed in my cluster and configure to sync DNS records to Cloudflare. The only ingresses external-dns looks at to gather DNS records to put in Cloudflare are ones that I explicitly set an annotation of external-dns/is-public: "true"
🔸 Click here to see how else I manage Cloudflare with Terraform.
My home IP can change at any given time and in order to keep my WAN IP address up to date on Cloudflare. I have deployed a CronJob in my cluster, this periodically checks and updates the A record ipv4.domain.tld.
Click to see da rack!
| Device | Count | OS Disk Size | Data Disk Size | Ram | Operating System | Purpose |
|---|---|---|---|---|---|---|
| Protectli FW6D | 1 | 500GB mSATA | N/A | 16GB | Opnsense 22 | Router |
| Intel NUC8i3BEK | 3 | 256GB NVMe | N/A | 32GB | Ubuntu 22.04 | Kubernetes (k3s) Masters |
| Intel NUC8i5BEH | 3 | 240GB SSD | 1TB NVMe (rook-ceph) | 64GB | Ubuntu 22.04 | Kubernetes (k3s) Workers |
| PowerEdge T340 | 1 | 2TB SSD | 8x12TB ZFS RAIDz2 | 64GB | Ubuntu 22.04 | Apps (Minio, Nexus, etc) & NFS |
| Lenovo SA120 | 1 | N/A | 8x12TB | N/A | N/A | DAS |
| Raspberry Pi | 1 | 32GB SD Card | N/A | 4GB | PiKVM | Network KVM |
| TESmart 8 Port KVM Switch | 1 | N/A | N/A | N/A | N/A | Network KVM switch for PiKVM |
| APC SMT1500RM2U w/ NIC | 1 | N/A | N/A | N/A | N/A | UPS |
| CyberPower PDU41001 | 2 | N/A | N/A | N/A | N/A | PDU |
Thanks to all the people who donate their time to the Kubernetes @Home community. A lot of inspiration for my cluster came from the people that have shared their clusters over at awesome-home-kubernetes.
See commit history
See LICENSE