Seminar Zoraxy Plugins: Betrieb, Architektur, Entwicklung

Inhaltsverzeichnis

• Abstract
• Zielgruppe und Voraussetzungen
• Lernziele
• Agenda
• Praxisübungen
• Ergebnisartefakte und Übergabe

Abstract

Dieses Seminar vermittelt den sicheren Betrieb und die Entwicklung von Zoraxy-Plugins. Teil 1 behandelt Plugin-Lifecycle, Installation, Enablement, Logging sowie Stabilitätsprinzipien (Plugin als separater Prozess). Teil 2 führt durch eine minimalistische Plugin-Entwicklung mit Web-UI, Build und Integration in Zoraxy, inklusive einer „Hello World“-Implementierung als Referenzmuster. Erforderliche Skills (HTML/JS/CSS, Go bevorzugt) und Lizenz-/Veröffentlichungsaspekte werden als Rahmenbedingungen eingeordnet.

Zielgruppe und Voraussetzungen

• Zielgruppe: Plattformengineering, Tooling-Teams, DevOps-Entwicklung
• Voraussetzungen:
  • Go-Grundlagen oder Bereitschaft für Guided Coding
  • Web-Grundlagen (HTML/JS/CSS)
  • Laufende Zoraxy-Instanz oder Build-Umgebung

Lernziele

• Plugins sicher installieren und aktivieren (manueller Pfad, Namenskonvention)
• Plugin-Isolation und Crash-Verhalten verstehen (separater Prozess, Disable bei Crash)
• Minimalplugin erstellen: Struktur, Introspect, UI Serving, Build/Test
• Plugin-Übergabe standardisieren (Build-Artefakte, Versionierung, Dokumentation)

Agenda

Tag 1: Plugin-Betrieb und Architektur

• Plugin-Überblick, Anwendungsfälle, Grenzen
• Installation und Enablement: Verzeichnisstruktur, Binary-Name, Restart
• Stabilität: getrennte Prozesse, Verhalten bei Crash
• Betriebsstandards: Logging, Versionierung, Rollback
• Vorbereitung Entwicklungsumgebung (Go + Editor + Source)

Tag 2: Plugin-Entwicklung (Minimalpfad)

• Dev Setup: Zoraxy Source, Go Compiler, Projektstruktur
• Hello World: Ordner, Go-Modul, Plugin-Lib, Web-Assets
• Introspect/Handshake und UI Router (Konzept + Umsetzung)
• Build/Test/Enable in Zoraxy, Debugging und Auto-Reload-Hinweis
• Packaging, Dokumentation, Übergabe

Praxisübungen

• Plugin manuell installieren
  • Plugin-Name festlegen (ohne Sonderzeichen/Spaces im Folder/Binary)
  • Ordnerstruktur erstellen: plugins/<pluginname>/
  • Binary ablegen, Name exakt wie Pluginname
  • Linux: Ausführungsrechte setzen
  • Zoraxy neu starten, Plugin in UI aktivieren
  • Ergebnis: Plugin läuft, UI erreichbar
• Entwicklungsumgebung vorbereiten
  • Zoraxy Source bereitstellen
  • Go Compiler installieren
  • Zoraxy einmal starten, damit Ordnerstruktur erzeugt wird
  • Editorprojekt öffnen
• Hello-World Plugin entwickeln (Minimal)
  • Plugin-Ordner erstellen, Go-Projekt initialisieren (main.go + go.mod)
  • Plugin-Library aus Zoraxy Source kopieren (mod/plugins/zoraxy_plugin)
  • Web-Ordner anlegen, index.html erstellen (UI minimal)
  • Introspect definieren (Plugin-ID, Name, Version, UIPath)
  • Embedded UI Router erstellen und servern
  • Build ausführen, Plugin aktivieren, Funktion prüfen
  • Ergebnis: reproduzierbares Minimalplugin

Ergebnisartefakte und Übergabe

• Plugin-Lifecycle Runbook (Install/Enable/Disable/Rollback)
• Minimalplugin als Template (intern)
• Build- und Release-Checkliste (Version, Kompatibilität, Test)