mirror of https://github.com/khuedoan/homelab.git synced 2024-12-22 15:44:34 +07:00

Modern self-hosting framework, fully automated from empty disk to operating services with a single command.

ansible argocd devops docker fedora gitops helm homelab k3s k8s-at-home kubernetes netboot pxe self-hosting terraform

Go to file

Khue Doan bad289d7da test: add CIS benchmark		2024-03-26 23:36:13 +07:00
.woodpecker	ci: add Helm diff step	2024-01-09 23:50:33 +07:00
apps	feat: install PairDrop	2024-03-13 19:22:23 +07:00
bootstrap	chore(argocd): upgrade Helm chart to v6	2024-03-12 07:55:24 +07:00
docs	feat(external): allow adding extra third party secrets	2024-03-14 20:11:58 +07:00
external	feat(external): allow adding extra third party secrets	2024-03-14 20:11:58 +07:00
metal	perf(metal): increase root partition size	2024-03-26 23:34:54 +07:00
platform	refactor!: replace docker registry with Zot	2024-03-26 23:26:28 +07:00
scripts	fix(hacks): don't use string interpolation for Gitea auth	2024-03-02 23:34:46 +07:00
system	fix(rook-ceph): auto remove OSD if safe to remove	2024-03-13 12:16:38 +07:00
test	test: add CIS benchmark	2024-03-26 23:36:13 +07:00
.envrc	build!: switch to Nix flake	2023-10-27 16:37:53 +07:00
.gitattributes	style: do not detect YAML files	2021-12-25 19:54:26 +07:00
.gitignore	refactor!: switch dev environment from Vagrant to k3d	2022-04-04 03:21:42 +07:00
.pre-commit-config.yaml	ci: remove sops-pre-commit	2024-01-19 22:26:37 +07:00
.yamllint.yaml	refactor(docs): apply the Diátaxis framework	2022-09-19 02:40:07 +07:00
flake.lock	chore: update dependencies	2024-01-06 01:56:35 +07:00
flake.nix	ci: add Helm diff step	2024-01-09 23:50:33 +07:00
LICENSE.md	style: convert LICENSE to Markdown	2021-11-18 00:35:38 +07:00
Makefile	chore(metal): update OS image to Fedora 39	2023-11-19 11:00:58 +07:00
mkdocs.yml	docs: replace Longhorn with Rook Ceph	2024-03-13 10:11:25 +07:00
README.md	docs: replace Longhorn with Rook Ceph	2024-03-13 10:11:25 +07:00
renovate.json5	build!: switch to Nix flake	2023-10-27 16:37:53 +07:00

README.md

Khue's Homelab

Features • Get Started • Documentation

This project utilizes Infrastructure as Code and GitOps to automate provisioning, operating, and updating self-hosted services in my homelab. It can be used as a highly customizable framework to build your own homelab.

What is a homelab?

Homelab is a laboratory at home where you can self-host, experiment with new technologies, practice for certifications, and so on. For more information, please see the r/homelab introduction and the Home Operations Discord community (formerly known as k8s-at-home).

Overview

Project status: ALPHA

This project is still in the experimental stage, and I don't use anything critical on it. Expect breaking changes that may require a complete redeployment. A proper upgrade path is planned for the stable release. More information can be found in the roadmap below.

Hardware

4 × NEC SFF PC-MK26ECZDR (Japanese version of the ThinkCentre M700):
- CPU: Intel Core i5-6600T @ 2.70GHz
- RAM: 16GB
- SSD: 128GB
TP-Link TL-SG108 switch:
- Ports: 8
- Speed: 1000Mbps

Features

Common applications: Gitea, Jellyfin, Paperless...
Automated bare metal provisioning with PXE boot
Automated Kubernetes installation and management
Installing and managing applications using GitOps
Automatic rolling upgrade for OS and Kubernetes
Automatically update apps (with approval)
Modular architecture, easy to add or remove features/components
Automated certificate management
Automatically update DNS records for exposed services
VPN without port forwarding
Expose services to the internet securely with Cloudflare Tunnel
CI/CD platform
Private container registry
Distributed storage
Support multiple environments (dev, prod)
Monitoring and alerting
Automated offsite backups 🚧
Single sign-on
Infrastructure testing

Some demo videos and screenshots are shown here. They can't capture all the project's features, but they are sufficient to get a concept of it.

Demo

Deploy with a single command (after updating the configuration files)

PXE boot

Homepage powered by... Homepage

Monitoring dashboard powered by Grafana

Git server powered by Gitea

Matrix chat server

Continuous integration with Woodpecker CI

Continuous deployment with ArgoCD

Cluster management using Lens

Tech stack

Logo	Name	Description
	Ansible	Automate bare metal provisioning and configuration
	ArgoCD	GitOps tool built to deploy applications to Kubernetes
	cert-manager	Cloud native certificate management
	Cilium	eBPF-based Networking, Observability and Security (CNI, LB, Network Policy, etc.)
	Cloudflare	DNS and Tunnel
	Docker	Ephemeral PXE server and convenient tools container
	Docker Registry	Private container registry
	ExternalDNS	Synchronizes exposed Kubernetes Services and Ingresses with DNS providers
	Fedora Server	Base OS for Kubernetes nodes
	Gitea	Self-hosted Git service
	Grafana	Observability platform
	Helm	The package manager for Kubernetes
	K3s	Lightweight distribution of Kubernetes
	Kanidm	Modern and simple identity management platform
	Kubernetes	Container-orchestration system, the backbone of this project
	Loki	Log aggregation system
	NGINX	Kubernetes Ingress Controller
	ntfy	Notification service to send notifications to your phone or desktop
	Prometheus	Systems monitoring and alerting toolkit
	Renovate	Automatically update dependencies
	Rook Ceph	Cloud-Native Storage for Kubernetes
	Woodpecker CI	Simple yet powerful CI/CD engine with great extensibility
	ZeroTier	VPN without port forwarding