Skip to content

Commit 571aa7d

Browse files
committedFeb 22, 2025
update README
1 parent 930b470 commit 571aa7d

File tree

1 file changed

+14
-6
lines changed

1 file changed

+14
-6
lines changed
 

β€ŽREADME.md

+14-6
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ This is my homelab infrastructure, defined in code.
2323

2424
</div>
2525

26-
## πŸ“– Overview
26+
## πŸ“– **Overview**
2727
This repository contains the IaC ([Infrastructure as Code](https://en.wikipedia.org/wiki/Infrastructure_as_code)) configuration for my homelab.
2828

2929
Most of my homelab runs on **Proxmox**, with VMs managed and maintained using [OpenTofu](https://opentofu.org/). All VMs are cloned from templates I created with [Packer](https://www.packer.io/).
@@ -38,17 +38,25 @@ To automate infrastructure updates, I use **Forgejo Actions**, which trigger wor
3838
- **[Yamllint](https://github.com/adrienverge/yamllint)** ensures configuration files are properly structured.
3939
- **[Ansible](https://github.com/ansible/ansible)** is used to execute playbooks on all of my VMs, automating management and configurations
4040

41-
### Security & Networking
41+
### πŸ”’ **Security & Networking**
4242
For Secret management I use [Bitwarden Secrets](https://bitwarden.com/products/secrets-manager/) and their various [integrations](https://bitwarden.com/help/ansible-integration/) into the tools used.
4343
> Kubernetes is using SOPS with Age encryption until migration over to Bitwarden Secrets.
4444
4545
I use **Oracle Cloud** for their [Always-Free](https://www.oracle.com/cloud/free/) VM's and deploy Docker services that require uptime here (Uptime Kuma, this website). [Twingate](https://www.twingate.com/) is used to connect my home network to the various VPS's securely using [Zero Trust architecture](https://en.wikipedia.org/wiki/Zero_trust_architecture).
4646

47-
I use **Cloudflare** for my DNS provider with **Cloudflare Tunnels** to expose some of the services to the world. **Cloudflare Access** is used to restrict the access to some of the services, this is paired with **Fail2Ban** looking through all my reverse proxy logs for malicious actors who made it through Access and banning them via **Cloudflare WAF**.
47+
I use **Cloudflare** for my DNS provider with **Cloudflare Tunnels** to expose some of the services to the world. **Cloudflare Access** is used to restrict the access to some of the services, this is paired with **Fail2Ban** looking through all my reverse proxy logs for malicious actors who made it through **Access** and banning them via **Cloudflare WAF**.
4848

4949
For my home network I use **PfSense** with VLAN segmentation and strict firewall rules to isolate public-facing machines, ensuring they can only communicate with the necessary services and nothing else.
5050

51-
## πŸ§‘β€πŸ’» Getting Started
51+
### **πŸ“Š Monitoring & Observability**
52+
I use a combination of **Grafana, Loki, and Prometheus** with various exporters to collect and visualize system metrics, logs, and alerts. This helps maintain visibility into my infrastructure and detect issues proactively.
53+
54+
- **Prometheus** – Metrics collection and alerting
55+
- **Loki** – Centralized logging for containers and VMs
56+
- **Grafana** – Dashboarding and visualization
57+
- **Exporters** – Node Exporter, cAdvisor, Blackbox Exporter, etc.
58+
59+
## πŸ§‘β€πŸ’» **Getting Started**
5260
This repo is not structured like a project you can easily replicate. Although if you are new to any of the tools used I encourage you to read through the directories that make up each tool to see how I am using them.
5361

5462
Over time I will try to add more detailed instructions in each directories README.
@@ -62,7 +70,7 @@ Some good references for how I learned this stuff (other than RTM)
6270
- [Docker](https://www.youtube.com/watch?v=eGz9DS-aIeY)
6371
- [Ansible](https://www.youtube.com/watch?v=goclfp6a2IQ)
6472

65-
## πŸ–₯️ Hardware
73+
## πŸ–₯️ **Hardware**
6674

6775
| Name | Device | CPU | RAM | Storage | Purpose |
6876
|------------|--------------|----------------|-------------|--------------------------------|--------------------------------|
@@ -71,6 +79,6 @@ Some good references for how I learned this stuff (other than RTM)
7179
| PVE Node 2 | Custom | Intel i7-8700K | 64 GB DDR4 | 1x2TB NVMe | More VMs |
7280

7381

74-
## To-Do
82+
## πŸ“Œ **To-Do**
7583
See [Project Board](https://git.mafyuh.dev/mafyuh/iac/projects/2)
7684

0 commit comments

Comments
 (0)
Please sign in to comment.