Ein Community-Check-Repository anbinden

Binde ein externes Community-Check-Repository an, damit dessen Monitoring-Checks in deiner Check-Bibliothek erscheinen und wie Built-in-Checks Geräten zugewiesen werden können.

Geschrieben von Stefan Steuer

Zuletzt aktualisiert Vor 8 Tagen

Ein Community-Check-Repository anbinden

Deine Check-Bibliothek listet jeden Monitoring-Check auf, den octoja auf einem Gerät ausführen kann. Sie wird aus Check-Repositories befüllt: dem eingebauten offiziellen Repository, deinen eigenen Checks und allen Community-Check-Repositories, die du anbindest. Ein Community-Check-Repository ist ein externer Ort, der fertige Checks veröffentlicht — binde eines an, und seine Checks erscheinen in deiner Check-Bibliothek und lassen sich wie jeder Built-in-Check zuweisen.

Bevor du beginnst

Du brauchst die Berechtigung Check-Repository-Verwaltung (check-repositories.manage), um die Repositories-Seite zu öffnen und ein Repository hinzuzufügen. Berechtigungen werden über Gruppen unter Administration → Gruppen vergeben.
Um die Check-Bibliothek zu durchsuchen und die entstehenden Checks zuzuweisen, brauchst du zusätzlich die Monitoring-Check-Verwaltung (monitoring-checks.manage).
Die Basis-URL des Repositories — die Adresse, unter der seine registry.json veröffentlicht ist, zum Beispiel https://checks.example.com/.
Bei einem privaten Repository: den HTTP-Basic-Auth-Benutzernamen und das Passwort dafür.

Schritte

Gehe zu Konfiguration → Check-Bibliothek.
Klicke oben rechts auf Repositories verwalten, um die Seite Repositories zu öffnen.
Klicke auf Community-Repository hinzufügen.
Fülle den Dialog aus:

Feld	Was du einträgst
Name	Ein Anzeigename für das Repository. Er erscheint neben den Checks des Repositories in der Check-Bibliothek.
URL	Die absolute URL, unter der die `registry.json` des Repositories veröffentlicht ist (zum Beispiel `https://checks.example.com/`). Sie muss mit `http://` oder `https://` beginnen.
Benutzername / Passwort	Optional. Nur nötig, wenn das Repository HTTP-Basic-Authentifizierung verlangt. Ein Passwort setzt einen Benutzernamen voraus. Die Zugangsdaten werden bei jeder Synchronisation und jedem Check-Download an das Repository gesendet.

Klicke auf Verbindung prüfen. octoja prüft die URL und etwaige Zugangsdaten und meldet, wie viele Checks gefunden wurden. Schlägt es fehl, siehe Fehlerbehebung unten.
Klicke auf Repository hinzufügen.

Was danach passiert

octoja liest die Registry des Repositories, lädt jede Check-Definition herunter und fügt die Checks deiner Check-Bibliothek mit einem Community-Badge und dem Repository-Namen hinzu. Von dort weist du sie genau wie Built-in-Checks zu — öffne den Checks-Tab eines Geräts oder ein Konfigurationspaket und füge den Check hinzu. Siehe Checks mit Konfigurationspaketen zuweisen.

octoja synchronisiert jedes angebundene Repository automatisch einmal pro Stunde und übernimmt neue oder geänderte Checks. Du kannst auch bei Bedarf synchronisieren — siehe unten.

Ein Repository synchronisieren

Auf der Seite Repositories zeigt jedes offizielle und jedes Community-Repository eine Zeit Zuletzt synchronisiert und eine Aktion Jetzt synchronisieren. Die automatische stündliche Synchronisation lädt nur, wenn das Repository etwas Neueres als deine letzte Synchronisation veröffentlicht hat; Jetzt synchronisieren erzwingt immer eine vollständige Aktualisierung. Deine eigenen Checks erscheinen als Benutzerdefiniert-Repository und lassen sich nicht synchronisieren — sie liegen bereits in octoja.

Ein Repository bearbeiten

Über die Aktion Bearbeiten an einem Community-Repository änderst du dessen Namen, URL oder Basic-Auth-Zugangsdaten. Lass das Passwortfeld leer, um das aktuelle Passwort beizubehalten. Offizielle und benutzerdefinierte Repositories werden von octoja verwaltet und können nicht bearbeitet werden.

Ein Repository entfernen

Die Aktion Löschen entfernt ein Community-Repository. Bestehende Check-Zuweisungen, die auf die Checks des Repositories verweisen, funktionieren nicht mehr, bis du sie neu zuweist — verschiebe oder entferne diese Checks also zuerst. Offizielle und benutzerdefinierte Repositories können nicht gelöscht werden.

Repository-Typen

Typ	Was es ist
Offiziell	octojas eigenes Repository gepflegter Checks. Immer vorhanden und von octoja aktuell gehalten; schreibgeschützt.
Community	Ein Repository, das du anbindest. Bearbeitbar, synchronisierbar und entfernbar.
Benutzerdefiniert	Deine eigenen Checks, in octoja erstellt. Von octoja verwaltet und nicht von einer URL synchronisiert.

Die genaue Struktur, die ein Repository veröffentlichen muss, damit octoja es lesen kann — registry.json, die Manifeste je Check und wie die Synchronisation entscheidet, was geladen wird — findest du in der Check-Repository-Referenz.

Fehlerbehebung

Der Verbindungstest meldet, dass das Repository nicht erreichbar ist. octoja konnte die URL nicht erreichen. Prüfe, ob die URL korrekt und aus dem Internet erreichbar ist, das Schema http:// oder https:// enthält und — bei einem privaten Repository — der Basic-Auth-Benutzername und das Passwort stimmen.

Der Verbindungstest meldet, dass die Registry ungültig ist. Die URL hat geantwortet, aber octoja konnte unter dieser Adresse keine gültige registry.json lesen. Stelle sicher, dass die registry.json direkt unter der Basis-URL liegt und wohlgeformt ist. Die Check-Repository-Referenz beschreibt das erforderliche Format.

Die Checks erscheinen nicht in der Check-Bibliothek. Vergewissere dich, dass der Verbindungstest bestanden und das Repository hinzugefügt wurde, und warte dann auf die nächste stündliche Synchronisation oder klicke auf Jetzt synchronisieren. Außerdem brauchst du die Berechtigung Monitoring-Check-Verwaltung, um die Check-Bibliothek zu sehen.