My deployment manifests for the homelab
Find a file
Repository files (latest commit first)
Filename Latest commit message Latest commit date
2026-09-02 20:06:24 -05:00
.gitignore Remove migrated Kubernetes configuration from public documentation repository 2026-09-02 19:56:22 -05:00
README.md Remove migrated Kubernetes configuration from public documentation repository 2026-09-02 19:56:22 -05:00

Homelab documentation

This public repository is the documentation home for the homelab. Start with the wiki, which records architecture, runbooks, and migration decisions.

Operational Kubernetes configuration has moved to Homelab/platform. The former k8s directory is removed from the current tree; its tracked history remains available. See the preservation record for the complete mapping. Operational repository links require appropriate access.

Repository ownership

Repository Responsibility
This repository and its wiki Public architecture, runbooks, diagrams, and documentation issues
Homelab/platform Shared RKE2/UDS infrastructure, networking, storage, secrets integration, and platform bundles
Homelab/workflows Reusable CI/CD workflows, scanning, and runners
Homelab/bundles Cross-application package composition and coordinated migration procedures
Homelab application repositories Application source, deployment definitions, packages, and implementation issues

Track operational work on the Homelab Roadmap. Keep one operational source for each resource; do not reintroduce live configuration under this repository.

Target architecture

System Role Relevant hardware / workload
NucBox G5 RKE2 server, control plane, and etcd Intel N97, 4 cores, ~12 GB RAM; tainted to prevent normal application scheduling
Sager laptop RKE2 worker i7-7700K, 32 GB RAM, GTX 1070; possible future Jellyfin host
OptiPlex 5070 RKE2 worker i7-9700, 32 GB RAM; game-server workloads and ~4 TB of existing local data
Media server RKE2 GPU worker i5-6600K, 32 GB RAM, RTX 3080 Ti; ComfyUI, current Jellyfin host, and ~786 GB of local ComfyUI assets
TrueNAS SCALE Persistent and shared storage Existing ZFS datasets, application data under /mnt/homelab/apps/, and shared media under /mnt/homelab/media

Deployment and migration

RKE2, UDS Core, MetalLB, TrueNAS CSI, and the legacy Istio passthrough baseline are established. Remaining routing, secrets, deployment-pipeline, and application migration work is tracked in the owning Homelab repositories. The wiki and current issues distinguish installed services from planned changes.

UDS bundle deployment is the target. Preserved raw manifests in platform are transitional comparison/testing material. Manual infrastructure deployment is supported; validate the application deployment pipeline before migrating applications. Each production cutover needs validation and a rollback plan, and existing datasets retain their documented owners.

Wiki checkout and backup

The wiki is a separate Git repository at https://git.gitchegumi.com/gitchegumi/homelab.wiki.git. Clone and back it up separately from this repository. Keep this parent repository as its Forgejo home.

Secret handling

This repository is public. Never commit API keys, passwords, RKE2 join tokens, kubeconfigs, private keys, populated runtime configs, or Kubernetes Secret values. Base64 is not encryption. Runtime secrets belong in the approved secrets backend; bootstrap artifacts remain outside Git. Sanitized documentation examples may be added when useful, but operational definitions belong in their owning repository.