1. Haiilo Support Center
  2. Administration
  3. OnPremise

On-Prem: Management-Endpunkte

Haiilo stellt einige Management-Endpunkte zur Verfügung, mit denen ihr Operationen wie Elasticsearch-Indexaktualisierungen und Wartungsmeldungen durchführen könnt.

Alle Endpunkte sind mit den grundlegenden Authentifizierungsdaten der entsprechenden Plattform geschützt. Die Zugangsdaten findet ihr in eurer .env Konfiguration: COYO_MANAGEMENT_USER and COYO_MANAGEMENT_PASSWORD

Wir empfehlen dringend ein GUI-Tool wie Postman zu nutzen, um eure REST-API-Aufrufe zu verwalten.
 
Hinweis:
Seit Version 32 ändern sich alle /manage/* Endpunkte zu /manage/backend/* 

cURL Beispiele

Um euch einige praktische Kenntnisse zu vermitteln, zeigen wir euch, wie ihr eine Wartungsmeldung setzen und den Wartungsmodus aktivieren könnt. 

Wartungsmeldung

Neben dem Wartungsmodus könnt ihr ein orangefarbenes Banner mit Wartungsinformationen am unteren Rand der Haiilo-Seite mit dem Management-Endpunkt "Wartung" aktivieren. Um das Banner zu entfernen, müssen die Benutzer auf das X klicken oder die eingestellte Dauer muss ablaufen. Auch ist es möglich, ein "DELETE" oder "POST" für eine neue Nachricht zu senden.
 
Wartungsmeldung-DE.png
 
Die Meldung wird so angezeigt, wie ihr es vielleicht erwartet. Wenn die Dauer (in Sekunden) abgelaufen ist, verschwindet die Meldung von selbst. OnlyAdmins setzt die Sichtbarkeit auf alle, wenn es auf false gesetzt ist.
curl -X POST \
  https://<COYO_BACKEND_URL>/manage/maintenance/message/all \
  -u '<COYO_MANAGEMENT_USER>':'<COYO_MANAGEMENT_PASSWORD>' \
  -H 'Content-Type: application/json' \
  -d '{
  "message" : "Planned COYO update at 20:00 pm. We expect a downtime of about 30 minutes.",
  "duration" : 5400,
  "onlyAdmins" : false
}'

Wartungsmodus

Um den gesamten Zugriff auf ein laufendes Haiilo zu beschränken, könnt ihr den Wartungsmodus mit dem Management-Endpunkt "Wartung" einstellen. Wenn ihr den Zugriff nur für "normale" Benutzer einschränken wollt, könnt ihr in die Haiilo-Administration gehen und den Wartungsmodus in den allgemeinen Einstellungen aktivieren. Dann können sich nur Benutzer mit der Berechtigung "Wartungsmodus verwalten" anmelden.

  
Aktiviert den Wartungsmodus mit headline und message:
curl -X POST \
  https://<COYO_BACKEND_URL>/manage/maintenance \
  -u '<COYO_MANAGEMENT_USER>':'<COYO_MANAGEMENT_PASSWORD>' \
  -H 'Content-Type: application/json' \
  -d '{
    "headline": "Upgrading to a new RELEASE",
    "message": "Don'\''t panic!"
  
}'
 
Deaktiviert den Wartungsmodus so:
curl -X DELETE \
  https://<COYO_BACKEND_URL>/manage/maintenance \
  -u '<COYO_MANAGEMENT_USER>':'<COYO_MANAGEMENT_PASSWORD>'

War dieser Beitrag hilfreich?