# promete04/homelab architecture

> Architecture diagram of the GitHub repository promete04/homelab, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-03-29). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/promete04/homelab
- Repository: https://github.com/promete04/homelab

## Overview

##### Project Type and Purpose
- This is a homelab repository designed to document and experiment with a personal IT infrastructure setup.
- Its purpose is to track configurations, document the hardware (Dell Optiplex 9020, HP Proliant MicroServer, UPS, etc.), and record the evolution of a networking and server management environment.
- The README details the hardware and software used (Ubuntu Server, Docker, Tailscale, TrueNAS scale) and shares future plans like hardware upgrades and new integrations, which are all key to understanding the scope of the project.

##### File Structure
- The structure suggests this repository acts as a central reference for various aspects of the homelab rather than containing active application logic.

##### Extract Key Architectural Elements from the README
- Major hardware components: Dell Optiplex as Primary Server, HP Proliant MicroServer (NAS), and networking gear.
- The software stack comprises elements like Docker (containerization), Ubuntu Server (hosting OS), Tailscale for networking, and TrueNAS scale for storage.

a. Main Components:
- Physical Hardware Layer: “Primary Server (Dell Optiplex 9020)”, “NAS (HP Proliant MicroServer G7)”, “Networking Gear”, and “UPS”.
- Virtualization & Containerization: Highlight Docker running on Ubuntu Server to manage virtual environments.
- Storage & Media: Represent TrueNAS scale as the solution managing the storage and media services.
- Network Connectivity: Include a representation for Tailscale, indicating the remote access/secure tunneling layer.
- Documentation & Configuration: Although not part of the active runtime, the repository contains configuration files, scripts, and documentation which might be depicted as a “Central Repository of Configurations and Scripts”.

b. Relationships and Interactions:
- Network interconnections where Tailscale facilitates external or remote access.
- Dependencies such as how the NAS might serve as a storage backend for containers or how automation scripts (as referenced in your README) interact with these systems.

c. Architectural Patterns and Technologies:
- A layered architecture: a physical hardware layer, a virtualization/container abstraction layer, and an administration/documentation layer.
- Specific technologies like Docker (containerization) and Tailscale (software-defined networking).

d. Technology, Frameworks, and Tools:
- Use annotations where needed to note that some items (automation, hypervisor details) are “to be added” as per the future ideas, indicating an evolving setup.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Physical Layer
    subgraph "Physical Layer"
        PS["Primary Server (Dell Optiplex 9020)"]:::hardware
        NAS["NAS (HP ProLiant MicroServer)"]:::hardware
        UPS["UPS"]:::hardware
        NWG["Networking Gear"]:::hardware
    end

    %% Virtualization & Containerization Layer
    subgraph "Virtualization & Containerization Layer"
        UDS["Ubuntu Server & Docker"]:::virtualization
    end

    %% Network Connectivity Layer
    subgraph "Network Connectivity"
        TS["Tailscale"]:::network
    end

    %% Documentation & Configurations
    subgraph "Documentation & Configurations"
        VDC["Virtualization & Containerization Documentation"]:::docs
        DIAG["Infrastructure Diagrams & Visual Documentation"]:::docs
        DIAGS["Additional Diagrams"]:::docs
        SETUP["Setup Visuals"]:::docs
    end

    %% Connections between layers
    PS -->|"runs_container_on"| UDS
    UDS -->|"utilizes_storage"| NAS
    PS -->|"backs_up_to"| NAS
    TS -->|"provides_access_to"| UDS

    VDC -->|"documents"| UDS
    DIAG -->|"guides"| VDC
    DIAGS -->|"supplements"| DIAG
    SETUP -->|"supplements"| DIAG

    %% Class Definitions
    classDef hardware fill:#AED6F1,stroke:#1B4F72,stroke-width:2px;
    classDef virtualization fill:#A3E4D7,stroke:#1D8348,stroke-width:2px;
    classDef network fill:#F9E79F,stroke:#B7950B,stroke-width:2px;
    classDef docs fill:#F5CBA7,stroke:#943126,stroke-width:2px;

    %% Click Events
    click PS "https://github.com/promete04/homelab/blob/main/docs/User-maunal/optiplex-9020-desktop_owners-manual_en-us.pdf"
    click NAS "https://github.com/promete04/homelab/blob/main/docs/User-maunal/HP ProLiant MicroServer.pdf"
    click VDC "https://github.com/promete04/homelab/blob/main/README.md"
    click TS "https://github.com/promete04/homelab/blob/main/README.md"
    click DIAG "https://github.com/promete04/homelab/blob/main/docs/Diagrams/homelab.drawio"
    click DIAGS "https://github.com/promete04/homelab/tree/main/pictures/Diagrams"
    click SETUP "https://github.com/promete04/homelab/tree/main/pictures/Setup"
```
