//Cloudogu EcoSystem Docs

Admin-Dogu

Das Admin-Dogu ist ein Tool zur verwaltung und Pflege von Dogus in einem Cloudogu EcoSystem. Die übersichtliche Benutzeroberfläche bietet Zugriff auf Funktionen, die sonst nur über die Konsole erreichbar sind. Mit wenigen Klicks können Administratoren so ihr Cloudogu EcoSystem verwalten.

Über den Eintrag "Administration" im gleichnamigen Abschnitt des Warp-Menüs kann das Dogu aufgerufen werden

Position im Warp Menü

Das Admin-Dogu bietet vier Unterseiten: Logging, Monitoring, Dogu-Management und Wartung.

Navbar des Admin Dogus

Dogu-Teilbereich "Logging"

Für die Benutzung des Bereichs Logging wird eine Rolle mit mindestens lesendem Zugriff benötigt.

Auf der Logging Seite lassen sich die Logs der einzelnen Dogus herunterladen. Mithilfe der Logs lassen sich interne Abläufe nachvollziehen oder etwaige Fehler ergründen.

Logging Bereich

Ein Klick auf die Schaltfläche Logs herunterladen öffnet einen Dialog, in welchem ausgewählt werden kann, ob die gesamte Log-Datei oder eine bestimmte Anzahl von Zeilen des Logs heruntergeladen werden sollen.

Auswählen der Anzahl von Logfilezeilen

Ist das Kontrollkästchen Komplett aktiviert, wird nach Bestätigen der HERUNTERLADEN Schaltfläche die gesamte Log-Datei heruntergeladen.

Manuelles auswählen der Anzahl von Logfilezeilen

Ist das Kontrollkästchen Komplett deaktiviert, kann im Feld Zeilen die Menge an Zeilen eingestellt werden, die heruntergeladen werden soll. Steht Zeilen auf 0, so wird die gesamte Log-Datei heruntergeladen.

Dogu-Teilbereich "Monitoring"

Für die Benutzung des Bereichs Monitoring wird eine Rolle mit mindestens lesendem Zugriff benötigt.

Der Monitoring-Bereich gibt Aufschluss über den Zustand der einzelnen Dogus. Ein grüner Haken bedeutet, dass alles in Ordnung ist.

Wird ein graues Ausrufungszeichen mit dem Schriftzug "unbekannt" angezeigt, heißt dies, dass das entsprechende Dogu diese Funktion aktuell nicht anbietet.

Monitoring Bereich

Dogu-Teilbereich "Dogu-Management"

Für die Benutzung des Bereichs Dogu-Managment wird eine Rolle mit mindestens schreibendem Zugriff benötigt.

Mithilfe des Dogu-Managments lassen sich Dogus starten, stoppen und neu starten.

Management Bereich

Das Stoppen und neu starten von Dogus muss jeweils in dem sich öffnenden Dialog bestätigt werden.

Dialog nach Klick auf "restart"

Dialog nach Klick auf "stop"

Das Starten von Dogus muss nicht bestätigt werden. Ein erfolgreicher Start eines Dogus wird über eine Erfolgsmeldung im unteren Bildbereich angezeigt.

Erfolgreiches Starten eines Dogus

Sollte es beim Starten, Stoppen oder Neustarten eines Dogus zu einem Fehler kommen, wird dies mit einer Fehlermeldung im unteren Bereich angezeigt.

Misserfolg beim Starten eines Dogus

Ist ein Dogu relevant für die Erreichbarkeit der Umgebung, wird die Stop-Aktion aktiv unterbunden. Andernfalls lässt sich das Dogu im Anschluss nicht wieder über die Benutzeroberfläche starten.

Dogu darf nicht gestoppt werden

Dogu-Teilbereich "Wartung"

Für die Benutzung des Bereichs Wartung wird eine Rolle mit schreibendem Zugriff benötigt.

Mithilfe der Seite Wartung lässt sich der Debug-Modus aktivieren und deaktivieren. Außerdem kann dort ein Support-Archiv mit Log-Dateien und relevanten Informationen über das System erstellt und heruntergeladen werden. Das Support-Archiv kann dazu verwendet werden, um den Support der Cloudogu GmbH bei Analyse von Problemen mit der Umgebung zu unterstützen.

Wartungsbereich

Abschnitt: Support-Paket

Das Support-Paket kann durch einen Klick auf die Schaltfläche Support-Paket zusammenstellen und herunterladen erzeugt werden. Der Download des Archives startet im Anschluss automatisch. Das zuletzt erzeugte Support-Paket wird in einem Verzeichnis auf dem Host-System gespeichert und kann erneut heruntergeladen werden, ohne es neu zusammenstellen zu müssen. Mit einem Klick auf die Schaltfläche Letztes Archiv löschen wird das erstellte Support-Archiv entfernt.

maintenance_archive

Die folgenden Daten sind in dem Support-Archiv enthalten:

Konfiguration

Dateien etcd/etcd.tree und etcd/etcd.json

Enthalten sind:

  • Sämtliche Schlüssel, die im etcd gespeichert sind, werden als Baumstruktur aufgelistet (nur die Schlüssel, keine Werte)
  • Abgesehen von sensiblen Schlüsseln sind alle Schlüssel sowie deren Werte in einer json-Datei enthalten

Es kann konfiguriert werden, dass bestimmte Verzeichnisse oder Schlüssel komplett aus der json-Datei ausgeschlossen werden. Dafür müssen ein bzw. mehrere Werte im etcd, ähnlich wie in dem folgenden Beispiel, gesetzt werden:

config/_global/debug/excluded_etcd_keys/<frei-wählbarer-name-1> => config config/_global/debug/excluded_etcd_keys/<frei-wählbarer-name-2> => dogu_v2

In der etcd.json-Datei sind anschließend diese Schlüssel zensiert dargestellt:

{ 
   "config" : "***",
   "dogu_v2" : "***"
}
Logs

Dateien logs/[servicename].log

Die Logdateien aller installierten Dogus sowie den folgenden Services sind ebenfalls enthalten:

  • syslog
  • cesappd
  • cesapp
  • ces-setup
  • backup-watcher
Dogu-Informationen

Datei dogu-information

Informationen über alle installierten Dogus, deren Status (gestartet, gestoppt etc.) sowie die Größe ihrer Volumes sind enthalten.

Umgebungsvariablen

Datei env

Alle im System gesetzten Umgebungsvariablen sind enthalten.

Prozess-Informationen

Datei process-information

Informationen zu allen laufenden Prozessen und Services, wie zum Beispiel 'cesappd' und dem 'backup-watcher'.

System-Informationen

Datei system-information

Informationen zu dem System (Verbaute Hardware, Betriebssystem, Partitionen, Auslastung, Speicherverbrauch, installierte Pakete) sind enthalten.

Volume-Informationen

Datei volume-information

Eine Liste mit allen Dateinamen aller Volumes sämtlicher Dogus ist enthalten.

Abschnitt: Debug-Modus

In diesem Abschnitt kann der Debug-Modus aktiviert und deaktiviert werden. Durch den Debug-Modus werden alle Dogus auf das höchste Log-Level gesetzt und geben damit die maximale Menge an Logs aus. Der Debug-Modus sollte nicht dauerhaft aktiv sein, da die Dogus durch das hohe Log-Aufkommen langsamer sind und in kurzer Zeit relativ große Datenmengen entstehen. Der Debug-Modus ist dafür gedacht, einen Fehler zu reproduzieren und anschließend das Support-Paket mit den erweiterten Log-Informationen zu erzeugen.

maintenance_debug

Ein Klick auf die Schaltfläche Debug-Modus starten öffnet einen Dialog, um den Vorgang zu bestätigen. Über die Schaltfläche Abbrechen kann der Dialog geschlossen werden, ohne den Debug-Modus zu starten. Nach der Aktivierung des Debug-Modus ist das gesamte System für mehrere Minuten nicht mehr über die Benutzeroberfläche erreichbar. Das gilt auch für das Admin-Dogu.

maintenance_modal_start

Nachdem über den Dialog das Starten des Debug-Modus bestätigt wurde, wird eine Warnung angezeigt:

maintenance_modal_warn_activate

Anschließend wird das System für einige Minuten in den Wartungsmodus versetzt und die Log-Level werden konfiguriert. Der Wartungsmodus ist daran erkennbar, dass folgende Seite angezeigt wird, wenn man die Umgebung über die Benutzeroberfläche erreichen möchte.

maintenance_mode

Die Wartungsseite wird nicht automatisch neu geladen, wenn der Wartungsmodus beendet wurde. Es reicht aus, die Browser-Seite einmal neu zuladen.

Anschließend ist links von der Aktivierungsschaltfläche zu erkennen, dass der Support-Modus aktiviert ist:

maintenance_debug_activated

Außerdem wird unterhalb der Navigationsleiste ein Hinweis ausgegeben, der in allen Bereichen des Admin-Dogus sichtbar ist.

debug_mode_active_label

Nachdem der Fehler reproduziert und das Archiv erstellt wurde, sollte der Debug-Modus wieder deaktiviert werden. Durch einen Klick auf Debug-Modus stoppen erscheint erneut ein Dialog:

maintenance_modal_stop

Mit der Bestätigung des Dialogs erscheint wieder ein Hinweis:

maintenance_modal_warn_deactivate

Das System ist erneut für mehrere Minuten nicht erreichbar und befindet sich im Wartungsmodus. Anschließend kann es wieder wie gewohnt genutzt werden.

Rollen und Berechtigungen

Aktuell existieren im Admin-Dogu Rollen für den lesenden, schreibenden und administrierenden Zugriff auf die Anwendungsfunktionalitäten. Benutzer ohne mindestens eine dieser Rollen haben keinerlei Zugriff auf das Admin-Dogu.

Konfiguration der Rollen

Über die Konfiguration des Admin-Dogus lassen sich Gruppen einstellen, die dem Benutzer die entsprechenden Rollen gewähren.

lesender Zugriff
config/admin/groups/reader

Benutzer mit dieser Rolle haben Zugriff auf das Admin-Dogu und können hauptsächlich Informationen einsehen, aber keine Einstellungen am System vornehmen.

schreibender Zugriff
config/admin/groups/writer

Benutzer mit dieser Rolle haben Zugriff auf das Admin-Dogu und können zusätzlich Daten über die Oberfläche verändern.

administrierender Zugriff
config/admin/groups/admin

Benutzer mit dieser Rolle haben Zugriff auf das Admin-Dogu und können alle verfügbaren Funktionen über die Benutzeroberfläche verwenden. Neben der über config/admin/groups/admin konfigurierten Gruppe, erhalten auch alle Benutzter administrative Berechtigungen, wenn ihnen über das User Management die allgemeine Admin-Gruppe des Cloudogu EcoSystem zugewiesen wurde.

Anzeige in der Benutzeroberfläche

Die zugeordnete Rolle kann in der Benutzeroberfläche in der Navigationsleiste an dem Benutzerbild links vom eigenen Benutzernamen erkannt werden.

Rolle mit lesendem Zugriff

reader_role_icon

Rolle mit schreibendem Zugriff

writer_role_icon

Rolle mit administrativem Zugriff

admin_role_icon

Troubleshooting

Zeigt das Admin Dogu in den Tabellen statt der installierten Dogus Fehlermeldung an, ist eine mögliche Ursache, dass die Version des cesappd-Services zu alt ist. Das Admin Dogu benötigt für die korrekte Funktionsweise mindestens Version 3.0.2 von cesappd.

Eine aktuelle Version von cesappd kann über apt per:

apt update && apt install cesappd

installiert werden.

Sollte das nicht ausreichen, um den Fehler zu beheben, kann über den Befehl

# aktuell installiertes Dogu entfernen
cesapp purge admin && \
# Dogu neu aus dem Premium-Namespace installieren
cesapp install premium/admin && \
# Dogu starten
cesapp start admin

das Admin-Dogu erneut installiert werden. Das Admin-Dogu hält keine Daten in einer Datenbank, die verloren gehen könnten.

Admin-Dogu im Fehlerhaften zustand