Skip to content

Commit

Permalink
feat(docs): add README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
willianpaixao committed Nov 8, 2024
1 parent ebe037c commit 0690fe9
Show file tree
Hide file tree
Showing 5 changed files with 38 additions and 30 deletions.
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Willian's homelab

This is a repository to document my homelab setup. Currently running two Kubernetes clusters, one with Raspberry Pis 4
and another with Turing Pi Cluster Board and RK1.

## Getting Started

The documentation is published on GitHub Pages. You can access it [here](https://willianpaixao.github.io/homelab/).

### Prerequisites

You'll need to install the following tools to run the project:

- [Flux](https://fluxcd.io/)
- [Helm](https://helm.sh/)
- [Kubectl](https://kubernetes.io/docs/tasks/tools/)
- [SOPS](https://getsops.io/)

## License

This project is licensed under the GPLv3 License - see the [LICENSE](LICENSE) file for details.

## Acknowledgments

This project was bootstrapped with [cluster-template](https://github.com/onedr0p/cluster-template). Huge thanks
to [onedr0p](https://github.com/onedr0p) for the amazing work.
18 changes: 11 additions & 7 deletions docs/content/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,19 +11,23 @@ title = 'Homelab'
For more information about Turing Pi Cluster Board, please visit the [main](turingpi) article.

## Network

For detailed information about the network topology, please visit the [network](network) article.

## Software

### Services

| Service | Description |
|-----------------------------------------|--------------------------|
| [Kubernetes](https://kubernetes.io/) | Container Orchestration |
| [Prometheus](https://prometheus.io/) | Monitoring |
| [Grafana](https://grafana.com/grafana/) | Visualization |
| [Pi-hole](https://pi-hole.net/) | Network-wide Ad Blocking |
| [WireGuard](https://www.wireguard.com/) | VPN |
| Service | Description |
|-----------------------------------------|----------------------------|
| [Grafana](https://grafana.com/grafana/) | Visualization |
| [Immich](https://immich.app/) | Photo and video management |
| [Kubernetes](https://kubernetes.io/) | Container Orchestration |
| [Pi-hole](https://pi-hole.net/) | Network-wide Ad Blocking |
| [Prometheus](https://prometheus.io/) | Monitoring |
| [Sonarr](https://sonarr.tv/) | TV Shows |
| [Radarr](https://radarr.video/) | Movies |
| [WireGuard](https://www.wireguard.com/) | VPN |

## Features

Expand Down
22 changes: 0 additions & 22 deletions docs/content/network.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,28 +7,6 @@ tags = ['network']

# Network topology

{{<mermaid>}}
architecture-beta
service vigilant(server)[vigilant]

group proxmox(cloud)[zion]
service dozer(server)[dozer] in proxmox
service tank(server)[tank] in proxmox

group main(cloud)[main]
service logos(server)[logos] in main
service mjolnir(server)[mjolnir] in main
service mnemosyne(server)[mnemosyne] in main
service vishnu(server)[vishnu] in main

group turing(cloud)[turing]
service cotijuba(server)[cotijuba] in turing
service marajo(server)[marajo] in turing
service outeiro(server)[outeiro] in turing
service tapajos(server)[tapajos] in turing
{{</mermaid>}}


### Gateways and switches

| Host | IP address | MAC address |
Expand Down
1 change: 1 addition & 0 deletions docs/content/turingpi.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
date = '2024-11-08T11:55:00+01:00'
draft = true
title = 'Turing Pi Cluster Board'
tags = ['cluster', 'turingpi']
+++
# Turing Pi Cluster Board
![Turing Pi 2](../images/turingpi-1.jpg)
1 change: 0 additions & 1 deletion kubernetes/raspberry/network/cloudflared/app/config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ metadata:
namespace: network
data:
config.yaml: |
---
originRequest:
originServerName: "external.${SECRET_DOMAIN}"
ingress:
Expand Down

0 comments on commit 0690fe9

Please sign in to comment.