Homelab Quick start
Get your Kubernetes homelab up and running fast. This guide covers the minimum steps to launch a cluster and deploy apps with GitOps.
For a deeper technical guide or troubleshooting steps, see Getting Started.
Prerequisites
- Proxmox access with your SSH key added to the hypervisor.
- Tools installed:
opentofu
,talosctl
,kubectl
, andargocd
. - This repository cloned locally.
Overview of steps
- Configure cluster variables.
- Launch the cluster with OpenTofu.
- Retrieve access configs.
Quick Start Steps
-
Clone the repository and move into it:
git clone https://github.com/theepicsaxguy/homelab.git
cd homelab -
Create your configuration files:
First, create your sensitive credentials file from the example.
cp tofu/terraform.tfvars.example tofu/terraform.tfvars
Now, edit
tofu/terraform.tfvars
with your Proxmox API details.Next, edit
tofu/config.auto.tfvars
to match your network settings (like IP addresses and domain names). The defaults are a good starting point. -
Initialize SSH agent and OpenTofu:
eval $(ssh-agent)
ssh-add ~/.ssh/id_rsa
tofu init -
Provision the cluster (this may take a few minutes):
tofu apply
-
Fetch your access configs:
tofu output -raw talos_config > ~/.talos/config
tofu output -raw kube_config > ~/.kube/config
chmod 600 ~/.talos/config ~/.kube/configFor more details see troubleshooting in the full guide.
That's it! Your cluster and GitOps stack are live.