Mein docker-homelab Repository auf GitHub hat schon lange kein wirkliches Update mehr erhalten. Zusätzlich Anwendungen sind in den letzten Monaten kaum hinzugekommen. Entsprechend wurde es Zeit, dieses einmal auf den neusten Stand zu bringen. Inspiriert durch die k8s-at-home Community habe ich noch ein paar weitere Dinge hinzugefügt die die zukünftige Erweiterung vereinfachen werden. Was hat sich also alles geändert?
Struktur wurde massiv überarbeitet
Zum ersten und wohl wichtigsten Punkt ist, dass die Struktur, heißt die Ordner massiv überarbeitet worden sind. Angefangen habe ich das Repository mit Anwendungen die ich selbst verwende und das passte ohne Probleme auf die Startseite. Als später durch die Community immer mehr Anwendungen dazu kamen habe ich diese in Kategorien unterteilt. Allerdings musste hier auch die Liste der Anwendungen manuell gepflegt werden. Unschöne Arbeit, gerade wenn durch pull requests Anwendungen hinzu kamen.
Jetzt liegen sie wieder alle zusammen in einem Ordner unter „compose-files/applications„. Das hat zur Folge, dass für ein git pull auf eurem Server die Struktur sich massiv ändert. Beachtet dies bitte, wenn ihr die Struktur 1:1 übernommen habt.
Der Vorteil ist, dass nun die Liste der Anwendungen automatisch generiert wird. Das k8s-at-home Projekt macht dies auch mit seinen Helm files so. Ich finde die Idee sehr gut und habe sie daher frecherweise übernommen. Die Informationen werden aus jeweiligen compose-info.yaml Dateien ausgelesen und in einer Tabelle dargestellt. Zukünftig möchte ich diese Datei noch mit anderen Informationen erweitern. Zum Beispiel wenn zu den Anwendungen ein Blog-Artikel oder YouTube Video erschienen ist. Zudem soll sich die jeweilige README.md Datei der einzelnen Anwendungen auch daraus generieren lassen. So muss nur jeweils eine Datei gepflegt werden und die Möglichkeit viele weitere Anwendungen hinzuzufügen wird einfacher.
GitHub Actions für yamllint
YAML ist ziemlich pingelig was die Struktur der Daten angeht, entsprechend habe ich das linting für die yaml-Dateien im compose-files Ordner wieder sauber erstellt. Nun können falsch Einrücken besser identifiziert werden und Fehler beim Starten der Anwendungen auf dem heimischen Servern können so minimiert werden.
Templates für Bugs und Vorschläge
Viele andere Projekte nutzen ja bereits auch schon die ISSUE_TEMPLATES von GitHub. Ich habe das nun auch endlich eingeführt. So können entsprechend Bugs und Feature Requests einfacher adressiert werden.
