# mrodozov/homelabboardworks architecture

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

- Interactive diagram: https://gitdiagram.com/mrodozov/homelabboardworks
- Repository: https://github.com/mrodozov/homelabboardworks

## Overview

##### Project type and purpose
- This is a documentation-and-configuration repository for “homelabboardworks,” a personal home-lab setup guide for multiple single-board computers (SBCs).
- It contains per-board, per-OS how-tos, scripts, and Docker-compose setups rather than a traditional multi-tier application.

##### File structure
- Top level directories correspond to hardware targets:
- arndale_EX5420
- odroid_M1S
- odroid_U
- odroid_XU
- x64
- Each hardware folder subdivides into OS or service configurations (e.g., ubuntu_20, gentoo, owncloud).
- Configuration files appear: post_install.sh, .env, docker-compose.yml, plus READMEs with step-by-step instructions.

##### README
- Confirms purpose: “Settings and howtos/whattos for my single board computers.”

a. Components
- Hardware nodes: each SBC model (Arndale EX5420, Odroid M1S/U/XU, x64 host)
- OS deployment layers: Ubuntu variants, Gentoo, Archlinux, Funtoo, etc.
- Service layers: Docker (OwnCloud), Kasm Workspaces
- Configuration artifacts: shell scripts, Docker-compose, environment files, README guides
- User/Administrator terminal (SSH, serial console)
b. Relationships and interactions
- Administrator connects (SSH/console) to each hardware node
- Executes configuration scripts (post_install.sh, shell instructions in READMEs)
- For Docker-based services, the host OS runs Docker Engine → Docker-compose → OwnCloud container
- On x64 host, Kasm-setup scripts launch containerized workspaces
c. Architectural patterns and principles
- “Infrastructure as Code” via shell scripts and docker-compose
- Clear separation of hardware targets each with its own configuration subtree
- Reusable service deployments (OwnCloud, Kasm) decoupled from OS specifics
d. Key technologies
- Linux distributions (Ubuntu, Arch, Gentoo, Funtoo)
- Docker + docker-compose
- Shell scripting (post_install.sh, setup scripts)
- Environment-based configuration (.env files)

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Global Entities
    Admin["Administrator Terminal<br/>(SSH/Serial)"]:::admin
    Repo["homelabboardworks Repository"]:::repo

    %% Hardware Modules
    subgraph "Arndale EX5420"
        direction TB
        AEX["Arndale EX5420"]:::hardware
        AEX_Lin["Linaro Ubuntu 14.02"]:::os
    end

    subgraph "Odroid M1S"
        direction TB
        OMS["Odroid M1S"]:::hardware
        OMS_Gentoo["Gentoo"]:::os
        OMS_Kodi["Kodi 21 on Ubuntu 22"]:::service
        OMS_MUbuntu["MUbuntu 22"]:::os
        OMS_Ub20["Ubuntu 20.04"]:::os
        OMS_Ub22["Ubuntu 22.04"]:::os
    end

    subgraph "Odroid U"
        direction TB
        OU["Odroid U"]:::hardware
        OU_Arch["Arch Linux"]:::os
        OU_OCIS["OCIS"]:::service
        OU_OwnCloud["OwnCloud Docker Service"]:::service
        OU_Ub16["Ubuntu 16.04"]:::os
        OU_Ub20["Ubuntu 20.04"]:::os
        OU_Post["post_install.sh"]:::script
        OU_Snapd["snapd_issue Notes"]:::script
    end

    subgraph "Odroid XU"
        direction TB
        OXU["Odroid XU"]:::hardware
        OXU_Arch["Arch Linux"]:::os
        OXU_Funtoo["Funtoo"]:::os
    end

    subgraph "x64 Host"
        direction TB
        X64["x64 Host"]:::hardware
        X64_Kasm["Kasm Workspaces Setup"]:::service
    end

    %% Connections
    Admin -->|connects to| AEX
    Admin -->|connects to| OMS
    Admin -->|connects to| OU
    Admin -->|connects to| OXU
    Admin -->|connects to| X64

    Repo --> AEX
    Repo --> OMS
    Repo --> OU
    Repo --> OXU
    Repo --> X64

    %% Hardware to OS/Services
    AEX -->|has OS| AEX_Lin

    OMS -->|has OS| OMS_Gentoo
    OMS -->|has Service| OMS_Kodi
    OMS -->|has OS| OMS_MUbuntu
    OMS -->|has OS| OMS_Ub20
    OMS -->|has OS| OMS_Ub22

    OU -->|has OS| OU_Arch
    OU -->|has Service| OU_OCIS
    OU -->|has Service| OU_OwnCloud
    OU -->|has OS| OU_Ub16
    OU -->|has OS| OU_Ub20
    OU_Ub20 -->|contains| OU_Post
    OU_Ub20 -->|contains| OU_Snapd

    OXU -->|has OS| OXU_Arch
    OXU -->|has OS| OXU_Funtoo

    X64 -->|runs Service| X64_Kasm

    %% Click Events
    click AEX "https://github.com/mrodozov/homelabboardworks/tree/main/arndale_EX5420/"
    click AEX_Lin "https://github.com/mrodozov/homelabboardworks/tree/main/arndale_EX5420/linaro_ubuntu1402/"
    click OMS "https://github.com/mrodozov/homelabboardworks/tree/main/odroid_M1S/"
    click OMS_Gentoo "https://github.com/mrodozov/homelabboardworks/tree/main/odroid_M1S/gentoo/"
    click OMS_Kodi "https://github.com/mrodozov/homelabboardworks/tree/main/odroid_M1S/kodi_21_overubuntu_22/"
    click OMS_MUbuntu "https://github.com/mrodozov/homelabboardworks/tree/main/odroid_M1S/mubuntu_22/"
    click OMS_Ub20 "https://github.com/mrodozov/homelabboardworks/tree/main/odroid_M1S/ubuntu_20/"
    click OMS_Ub22 "https://github.com/mrodozov/homelabboardworks/tree/main/odroid_M1S/ubuntu_22/"
    click OU "https://github.com/mrodozov/homelabboardworks/tree/main/odroid_U/"
    click OU_Arch "https://github.com/mrodozov/homelabboardworks/tree/main/odroid_U/archlinux/"
    click OU_OCIS "https://github.com/mrodozov/homelabboardworks/tree/main/odroid_U/ocis/"
    click OU_OwnCloud "https://github.com/mrodozov/homelabboardworks/tree/main/odroid_U/owncloud/"
    click OU_Ub16 "https://github.com/mrodozov/homelabboardworks/tree/main/odroid_U/ubuntu_16/"
    click OU_Ub20 "https://github.com/mrodozov/homelabboardworks/tree/main/odroid_U/ubuntu_20/"
    click OU_Post "https://github.com/mrodozov/homelabboardworks/blob/main/odroid_U/ubuntu_20/post_install.sh"
    click OU_Snapd "https://github.com/mrodozov/homelabboardworks/tree/main/odroid_U/ubuntu_20/snapd_issue/"
    click OXU "https://github.com/mrodozov/homelabboardworks/tree/main/odroid_XU/"
    click OXU_Arch "https://github.com/mrodozov/homelabboardworks/tree/main/odroid_XU/archlinux/"
    click OXU_Funtoo "https://github.com/mrodozov/homelabboardworks/tree/main/odroid_XU/funtoo/"
    click X64 "https://github.com/mrodozov/homelabboardworks/tree/main/x64/"
    click X64_Kasm "https://github.com/mrodozov/homelabboardworks/tree/main/x64/kasm_setup/"

    %% Styles
    classDef admin fill:#f9f,stroke:#333,stroke-width:1px;
    classDef repo fill:#cfc,stroke:#333,stroke-width:1px;
    classDef hardware fill:#ddd,stroke:#333,stroke-width:1px;
    classDef os fill:#bbf,stroke:#333,stroke-width:1px;
    classDef service fill:#fb3,stroke:#333,stroke-width:1px;
    classDef script fill:#bfb,stroke:#333,stroke-width:1px;
```
