kube-homelab

A Kubernetes based setup to run a home server.

Getting started

Architecture

The architecture is evolving as this is an active project I'm working on, but her's the basic idea.

The approach is layered and layers depend on one or more installed components from the layer below.

Learn more

I had also created a video where I show how I set the homelab up for my use.

Requirements

• Linux nodes (a VM, Raspberry PI, Tower PC)
• Docker installed on the node
• systemd configured on the nodes (this is because k3s runs as a systemd service)
• ssh configured with a keypair - password based authentication is not supported

Terminology

• Any reusable part of this project will be an atom.
• Various parts of the setup are put into different terraform modules to be used as a workspace, each. This is also called a molecule.

Software to run the terraform molecules

• terraform installed on the agent which will execute terraform (can be the node itself as well) - currently required_version = ">=1.3.0"
• terraform-backend-git if you want to use a git repository to store terraform state.

Order of molecules

1. k3s
2. cluster-resources

Running the molecules

Only if you are using a remote backend

• Fill .envrc with all the required values. Place one .envrc in each molecule, this will help segregate their values and also because each molecule should have its own state file, so export TF_BACKEND_GIT_GIT_STATE= will change. I use state-<MOLECULE_NAME>.json as the pattern
• Import all environment variables by running . .envrc in the directory of the molecule
• Run the terraform init as follows - terraform init -backend-config="address=${BACKEND}" -backend-config="lock_address=${BACKEND}" -backend-config="unlock_address=${BACKEND}" the BACKEND env var is setup based on the other env vars in .envrc

If you use local backend

• Remove the backend "http" {} from all molecules and init the molecules terraform init
• Now run terraform apply -var-file=inputs.tfvars (modify the inputs.tfvars as per your liking)

Read any specific requirements per molecule in their readme.

Test bed

I'm using Raspberry Pi 4 and Raspberry Pi 5 as the nodes on my Kubernetes cluster and all testing is done on this setup.

• Raspberry Pi 4 + Raspberry Pi 5
• Ubuntu Server 22.04
• docker 20.10.12