Homelab

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 about homelab in general, see the r/homelab introduction.

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

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

Monitoring dashboard powered by Grafana

Git server powered by Gitea

Matrix chat server

Continuous integration with Tekton

Continuous deployment with ArgoCD

Cluster management using Lens

Secret management with Vault

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
	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	Operational dashboards
	Helm	The package manager for Kubernetes
	K3s	Lightweight distribution of Kubernetes
	Kubernetes	Container-orchestration system, the backbone of this project
	Loki	Log aggregation system
	Longhorn	Cloud native distributed block storage for Kubernetes
	MetalLB	Bare metal load-balancer for Kubernetes
	NGINX	Kubernetes Ingress Controller
	Prometheus	Systems monitoring and alerting toolkit
	Renovate	Automatically update dependencies
	Tekton	Cloud native solution for building CI/CD systems
	Vault	Secrets and encryption management system
	ZeroTier	VPN without port forwarding

Get Started

Try it out locally without any hardware (just 4 commands!)
Deploy on real hardware for production workload

Roadmap

See roadmap and open issues for a list of proposed features and known issues.

Contributing

Any contributions you make are greatly appreciated.

Please see contributing guide for more information.

License

Distributed under the GPLv3 License. See license page or LICENSE.md file for more information.

Acknowledgements

References:

Here is a list of the contributors who have helped to improve this project. Big shout-out to them!

If you feel you're missing from this list, feel free to add yourself in a PR.

Project Name	Stars	Packages Using This	Most Recent Commit	Total Releases	Latest Release	Open Issues	License	Language
Netdata	63,210		a day ago			319	gpl-3.0	C
Real-time performance monitoring, done right! https://www.netdata.cloud
Devops Exercises	43,402		4 days ago			21	other	Python
Linux, Jenkins, AWS, SRE, Prometheus, Docker, Python, Ansible, Git, Kubernetes, Terraform, OpenStack, SQL, NoSQL, Azure, GCP, DNS, Elastic, Network, Virtualization. DevOps Interview Questions
Traefik	43,197	18	2 days ago	160	September 16, 2022	619	mit	Go
The Cloud Native Application Proxy
Kong	34,911		a day ago			229	apache-2.0	Lua
🦍 The Cloud-Native API Gateway
Awesome Cheatsheets	33,309		a month ago			85	mit	JavaScript
👩‍💻👨‍💻 Awesome cheatsheets for popular programming languages, frameworks and development tools. They include everything you should know in one single file.
Portainer	25,610	1	2 days ago	78	April 21, 2021	1,141	zlib	Go
Making Docker and Kubernetes management easy.
Dokku	24,634	2	20 hours ago	77	April 22, 2021	45	mit	Shell
A docker-powered PaaS that helps you build and manage the lifecycle of applications
Faas	23,093	9	5 days ago	31	April 12, 2021	31	mit	Go
OpenFaaS - Serverless Functions Made Simple
Docker_practice	22,409		4 days ago	9	December 01, 2021	7		Go
Learn and understand Docker&Container technologies, with real DevOps practice!
Rancher	21,076	20	a day ago	207	April 25, 2021	2,479	apache-2.0	Go
Complete container management platform