2022-01-11 15:04:27 +07:00
# Khue's Homelab
2021-07-18 12:49:42 +07:00
2021-12-05 10:13:15 +07:00
<!-- ANCHOR: introduction -->
2022-01-11 15:04:27 +07:00
[](https://matrix.to/#/#homelab:matrix.khuedoan.com)
[](https://github.com/khuedoan/homelab/tags)
[](https://homelab.khuedoan.com)
[](https://www.gnu.org/licenses/gpl-3.0.html)
[](https://github.com/khuedoan/homelab)
2021-12-05 10:13:15 +07:00
2022-01-22 10:12:15 +07:00
Current status: **ALPHA**
2022-02-13 09:14:18 +07:00
This project utilizes [Infrastructure as Code ](https://en.wikipedia.org/wiki/Infrastructure_as_code ) and [GitOps ](https://www.weave.works/technologies/gitops ) to automate provisioning, operating, and updating self-hosted services in my homelab.
2022-01-11 15:04:27 +07:00
It can be used as a highly customizable framework to build your own homelab.
2022-01-22 13:30:29 +07:00
<!-- TODO -->
<!-- Feel free to join me on my Matrix chat server at [chat.khuedoan.com ](https://chat.khuedoan.com/#/room/#homelab/general:matrix.khuedoan.com ), -->
<!-- or [`#homelab:matrix.khuedoan.com` ](https://matrix.to/#/#homelab:matrix.khuedoan.com ) if you already have a Matrix client. -->
<!-- Please note that the chat server is self - hosted on my homelab and still at the experimental stage. -->
2021-12-05 10:13:15 +07:00
2022-01-11 15:04:27 +07:00
<!-- ANCHOR_END: introduction -->
2021-07-18 12:49:42 +07:00
2021-09-29 01:44:32 +07:00
## Overview
2022-01-11 15:04:27 +07:00
This section provides a high level overview of the project.
For further information, please see the [documentation ](https://homelab.khuedoan.com ).
2021-09-29 01:44:32 +07:00
### Hardware
2021-07-18 12:49:42 +07:00
2022-01-11 15:04:27 +07:00
- 4 × `PC-MK26ECZDR` (Japanese version of the ThinkCentre M700):
2021-07-18 12:49:42 +07:00
- CPU: `Intel Core i5-6600T @ 2.70GHz`
- RAM: `16GB`
- SSD: `128GB`
- TP-Link `TL-SG108` switch:
- Ports: `8`
- Speed: `1000Mbps`
2021-12-14 09:31:34 +07:00
### Features
2022-01-14 09:30:39 +07:00
Project status: **Alpha** (see [roadmap ](#roadmap ) below)
2021-12-14 09:31:34 +07:00
- [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] Modular architecture, easy to add or remove features/components
- [x] Automated certificate management
2021-12-25 01:07:53 +07:00
- [x] Automatically update DNS records for exposed services
2021-12-14 09:31:34 +07:00
- [x] Expose services to the internet securely with [Cloudflare Tunnel ](https://www.cloudflare.com/products/tunnel/ )
- [x] CI/CD platform
2021-12-25 15:23:03 +07:00
- [x] Private container registry
2021-12-14 09:31:34 +07:00
- [x] Distributed storage
2022-02-11 21:33:21 +07:00
- [x] Support multiple environments (dev, stag, prod)
2021-12-25 01:07:53 +07:00
- [ ] Monitoring and alerting 🚧
- [ ] Automated offsite backups 🚧
- [ ] Single sign-on 🚧
2021-12-14 09:31:34 +07:00
2022-01-14 09:30:39 +07:00
Screenshots of some user-facing applications are shown here, I will update them before each release.
2022-01-14 21:14:05 +07:00
They can't capture all of the project's features, but they are sufficient to get a concept of it.
|  |
| :--: |
| Homepage with Ingress discovery powered by [Hajimari ](https://github.com/toboshii/hajimari ) |
|  |
| :--: |
| Git server powered by [Gitea ](https://gitea.io/en-us/ ) |
|  |
| :--: |
| Continuous integration with [Tekton ](https://tekton.dev/ ) |
|  |
| :--: |
| Continuous deployment with [ArgoCD ](https://argoproj.github.io/cd/ ) |
|  |
| :--: |
| Monitoring dashboard powered by [Grafana ](https://grafana.com/ ) |
2022-01-14 09:30:39 +07:00
|  |
2022-01-14 21:14:05 +07:00
| :--: |
2022-01-14 09:30:39 +07:00
| [Matrix ](https://matrix.org/ ) chat server powered by [Element ](https://matrix.org/docs/projects/client/element ) and [Dendrite ](https://matrix.org/docs/projects/server/dendrite ) |
2022-01-14 21:14:05 +07:00
|  |
| :--: |
| Cluster management using [Lens ](https://k8slens.dev/ ) (or you can just use `kubectl` ) |
|  |
| :--: |
| Secret management with [Vault ](https://www.vaultproject.io/ ) |
2021-12-14 09:31:34 +07:00
### Tech stack
2021-09-29 01:44:32 +07:00
2022-01-23 10:33:29 +07:00
< table >
< tr >
< th > Logo< / th >
< th > Name< / th >
< th > Description< / th >
< / tr >
< tr >
< td > < img width = "32" src = "https://simpleicons.org/icons/ansible.svg" > < / td >
< td > < a href = "https://www.ansible.com" > Ansible< / a > < / td >
< td > Automate bare metal provisioning and configuration< / td >
< / tr >
< tr >
< td > < img width = "32" src = "https://cncf-branding.netlify.app/img/projects/argo/icon/color/argo-icon-color.svg" > < / td >
< td > < a href = "https://argoproj.github.io/cd" > ArgoCD< / a > < / td >
< td > GitOps tool built to deploy applications to Kubernetes< / td >
< / tr >
< tr >
< td > < img width = "32" src = "https://github.com/jetstack/cert-manager/raw/master/logo/logo.png" > < / td >
< td > < a href = "https://cert-manager.io" > cert-manager< / a > < / td >
< td > Cloud native certificate management< / td >
< / tr >
< tr >
< td > < img width = "32" src = "https://avatars.githubusercontent.com/u/314135?s=200&v=4" > < / td >
< td > < a href = "https://www.cloudflare.com" > Cloudflare< / a > < / td >
< td > DNS and Tunnel< / td >
< / tr >
< tr >
< td > < img width = "32" src = "https://www.docker.com/sites/default/files/d8/2019-07/Moby-logo.png" > < / td >
< td > < a href = "https://www.docker.com" > Docker< / a > < / td >
< td > Ephermeral PXE server and convenient tools container< / td >
< / tr >
< tr >
< td > < img width = "32" src = "https://upload.wikimedia.org/wikipedia/commons/b/bb/Gitea_Logo.svg" > < / td >
< td > < a href = "https://gitea.com" > Gitea< / a > < / td >
< td > Self-hosted Git service< / td >
< / tr >
< tr >
< td > < img width = "32" src = "https://grafana.com/static/img/menu/grafana2.svg" > < / td >
< td > < a href = "https://grafana.com" > Grafana< / a > < / td >
< td > Operational dashboards< / td >
< / tr >
< tr >
< td > < img width = "32" src = "https://cncf-branding.netlify.app/img/projects/helm/icon/color/helm-icon-color.svg" > < / td >
< td > < a href = "https://helm.sh" > Helm< / a > < / td >
< td > The package manager for Kubernetes< / td >
< / tr >
< tr >
< td > < img width = "32" src = "https://cncf-branding.netlify.app/img/projects/k3s/icon/color/k3s-icon-color.svg" > < / td >
< td > < a href = "https://k3s.io" > K3s< / a > < / td >
< td > Lightweight distribution of Kubernetes< / td >
< / tr >
< tr >
< td > < img width = "32" src = "https://cncf-branding.netlify.app/img/projects/kubernetes/icon/color/kubernetes-icon-color.svg" > < / td >
< td > < a href = "https://kubernetes.io" > Kubernetes< / a > < / td >
< td > Container-orchestration system, the backbone of this project< / td >
< / tr >
< tr >
< td > < img width = "32" src = "https://github.com/grafana/loki/blob/main/docs/sources/logo.png?raw=true" > < / td >
< td > < a href = "https://grafana.com/oss/loki" > Loki< / a > < / td >
< td > Log aggregation system< / td >
< / tr >
< tr >
< td > < img width = "32" src = "https://cncf-branding.netlify.app/img/projects/longhorn/icon/color/longhorn-icon-color.svg" > < / td >
< td > < a href = "https://longhorn.io" > Longhorn< / a > < / td >
< td > Cloud native distributed block storage for Kubernetes< / td >
< / tr >
< tr >
< td > < img width = "32" src = "https://avatars.githubusercontent.com/u/60239468?s=200&v=4" > < / td >
< td > < a href = "https://metallb.org" > MetalLB< / a > < / td >
< td > Bare metal load-balancer for Kubernetes< / td >
< / tr >
< tr >
< td > < img width = "32" src = "https://avatars.githubusercontent.com/u/1412239?s=200&v=4" > < / td >
< td > < a href = "https://www.nginx.com" > NGINX< / a > < / td >
< td > Kubernetes Ingress Controller< / td >
< / tr >
< tr >
< td > < img width = "32" src = "https://cncf-branding.netlify.app/img/projects/prometheus/icon/color/prometheus-icon-color.svg" > < / td >
< td > < a href = "https://prometheus.io" > Prometheus< / a > < / td >
< td > Systems monitoring and alerting toolkit< / td >
< / tr >
< tr >
< td > < img width = "32" src = "https://avatars.githubusercontent.com/u/75713131?s=200&v=4" > < / td >
< td > < a href = "https://rockylinux.org" > Rocky Linux< / a > < / td >
< td > Base OS for Kubernetes nodes< / td >
< / tr >
< tr >
< td > < img width = "32" src = "https://avatars.githubusercontent.com/u/47602533?s=200&v=4" > < / td >
< td > < a href = "https://tekton.dev" > Tekton< / a > < / td >
< td > Cloud native solution for building CI/CD systems< / td >
< / tr >
< tr >
< td > < img width = "32" src = "https://trow.io/trow.png" > < / td >
< td > < a href = "https://trow.io" > Trow< / a > < / td >
< td > Private container registry< / td >
< / tr >
< tr >
< td > < img width = "32" src = "https://simpleicons.org/icons/vault.svg" > < / td >
< td > < a href = "https://www.vaultproject.io" > Vault< / a > < / td >
< td > Secrets and encryption management system< / td >
< / tr >
< / table >
2021-09-29 01:44:32 +07:00
2021-07-18 12:49:42 +07:00
## Get Started
2022-02-02 09:16:35 +07:00
- [Try it out on a VM ](https://homelab.khuedoan.com/try_on_a_vm.html ) without any hardware
2021-11-28 14:00:44 +07:00
- [Deploy on real hardware ](https://homelab.khuedoan.com/deployment ) for real workload
2021-08-04 00:13:48 +07:00
2021-07-18 12:49:42 +07:00
## Roadmap
2022-02-02 09:16:35 +07:00
See [roadmap ](https://homelab.khuedoan.com/roadmap.html ) and [open issues ](https://github.com/khuedoan/homelab/issues ) for a list of proposed features and known issues.
2021-07-18 12:49:42 +07:00
## Contributing
2021-12-14 09:31:34 +07:00
Any contributions you make, either big or small, are greatly appreciated.
2021-07-18 12:49:42 +07:00
## License
2022-01-14 09:26:08 +07:00
> Copyright (c) 2020, 2021, 2022 Khue Doan
2021-12-31 17:05:27 +07:00
2022-01-14 09:29:34 +07:00
< details >
< summary > Distributed under the GPLv3 License.< / summary >
2021-12-31 17:05:27 +07:00
This project is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This project is distributed in the hope that it will be useful, but **WITHOUT ANY WARRANTY** ; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this project (`LICENSE.md`).
If not, see < https: / / www . gnu . org / licenses > .
2021-07-18 12:49:42 +07:00
2022-01-14 09:29:34 +07:00
< / details >
2021-07-18 12:49:42 +07:00
## Acknowledgements
2021-12-25 00:39:40 +07:00
- [ArgoCD usage in my coworker's homelab ](https://github.com/locmai/humble )
2021-07-18 12:49:42 +07:00
- [README template ](https://github.com/othneildrew/Best-README-Template )
- [Run the same Cloudflare Tunnel across many `cloudflared` processes ](https://developers.cloudflare.com/cloudflare-one/tutorials/many-cfd-one-tunnel )
- [MAC address environment variable in GRUB config ](https://askubuntu.com/questions/1272400/how-do-i-automate-network-installation-of-many-ubuntu-18-04-systems-with-efi-and )
2021-09-01 05:39:04 +07:00
- [Official k3s systemd service file ](https://github.com/k3s-io/k3s/blob/master/k3s.service )
2021-12-20 21:44:46 +07:00
- [Official Cloudflare Tunnel examples ](https://github.com/cloudflare/argo-tunnel-examples )
2021-12-25 00:39:40 +07:00
- [Initialize GitOps repository on Gitea and integrate with Tekton by RedHat ](https://github.com/redhat-scholars/tekton-tutorial/tree/master/triggers )
2021-11-30 12:24:25 +07:00
2022-01-19 01:04:25 +07:00
## Stargazers over time
2021-11-30 12:24:25 +07:00
[](https://starchart.cc/khuedoan/homelab)
