Update
This commit is contained in:
@@ -1,6 +1,11 @@
|
||||
# Benutzergruppen & Rechte
|
||||
|
||||
Dieser Bereich verwaltet Rollenmodelle und bestimmt, welche Aktionen Benutzer:innen durchführen dürfen. Du benötigst `user-groups-access` zum Lesen sowie `user-groups-edit`/`user-groups-delete` für Änderungen.
|
||||
Dieser Bereich verwaltet Rollenmodelle und bestimmt, welche Aktionen Benutzer:innen durchführen dürfen.
|
||||
|
||||
**Relevante Rechte**
|
||||
- `Bereich & Navigation (Benutzergruppen)`
|
||||
- `Benutzergruppen bearbeiten`
|
||||
- `Benutzergruppen löschen`
|
||||
|
||||
## Gruppen anlegen
|
||||
1. Button **Gruppe erstellen** wählen.
|
||||
@@ -23,7 +28,7 @@ Der Rechte-Dialog zeigt die gesamte Permissionstruktur in Kategorien (Stacks, Lo
|
||||
- **none** – kein Zugriff
|
||||
- **read** – Zugriff auf Ansicht/Lesen
|
||||
- **full** – volle Bearbeitungsrechte
|
||||
3. Abhängigkeiten werden automatisch hervorgehoben. Beispiel: Um `logs-delete` nutzen zu dürfen, muss `logs-access` mindestens `full` sein.
|
||||
3. Abhängigkeiten werden automatisch hervorgehoben. Beispiel: Um `Logs löschen` nutzen zu dürfen, muss `Bereich & Navigation (Logs)` mindestens `Vollzugriff` sein.
|
||||
4. Speichern bestätigt die Anpassungen. StackPulse aktualisiert sofort die effektiven Rechte aller Benutzer in dieser Gruppe.
|
||||
|
||||
## Benutzer zu Gruppen hinzufügen
|
||||
@@ -36,6 +41,6 @@ Der Rechte-Dialog zeigt die gesamte Permissionstruktur in Kategorien (Stacks, Lo
|
||||
- Löschen entfernt keine Benutzer, aber deren effektive Rechte können sich dadurch verringern.
|
||||
|
||||
## Best Practices
|
||||
- Erstelle zunächst eine Basisgruppe (z. B. „Viewer“) mit `read`-Rechten für Stacks und Logs.
|
||||
- Erstelle zunächst eine Basisgruppe (z. B. „Viewer“) mit Leserechten für Stacks und Logs.
|
||||
- Verwende separate Gruppen für sensible Aktionen wie Wartung oder Superuser-Verwaltung.
|
||||
- Nutze sprechende Beschreibungen, damit Kolleg:innen sofort erkennen, wofür eine Gruppe gedacht ist.
|
||||
|
||||
@@ -1,43 +1,62 @@
|
||||
# Wartungsbereich
|
||||
|
||||
Der Wartungsbereich bündelt alle Funktionen rund um Maintenance-Mode, Serververwaltung, Update-Skripte und SSH-Verbindungen. Sichtbar für Benutzer:innen mit `maintenance-access` (Teilbereiche erfordern zusätzliche Unterrechte).
|
||||
Der Wartungsbereich bündelt Maintenance-Mode, Serververwaltung (inkl. Agent-Integration), Update-Skripte und SSH-Konfiguration. Sichtbar für Benutzer:innen mit `Bereich & Navigation (Wartung)`; Unterbereiche haben eigene Rechte:
|
||||
|
||||
## Portainer-Status
|
||||
- Klick auf **Status prüfen**, um eine Live-Abfrage gegen Portainer durchzuführen. Ergebnis zeigt API-Verfügbarkeit, Endpoint-IDs und Auth-Status.
|
||||
- Häufige Fehler werden direkt erklärt (z. B. fehlender API-Key oder Netzwerkprobleme).
|
||||
**Relevante Rechte**
|
||||
- `Bereich & Navigation (Wartung)`
|
||||
- `Server-Sektion`
|
||||
- `Server bearbeiten` / `Server löschen`
|
||||
- `SSH/Update-Skript`
|
||||
- `Update durchführen`
|
||||
- `Agent`
|
||||
- `Doppelte Stacks`
|
||||
- `mTLS Sektion`
|
||||
- `Superuser löschen`
|
||||
|
||||
- `Server-Sektion` (lesen) zeigt die Serverübersicht.
|
||||
- `Server bearbeiten` (lesen) zeigt Server-Details inkl. Portainer-Status; Felder bleiben schreibgeschützt. Vollzugriff erlaubt Bearbeiten/Speichern.
|
||||
- `Server löschen` löscht Server (nur bei Vollzugriff).
|
||||
- `SSH/Update-Skript` und `Update durchführen` hängen am Unterpunkt Portainer/SSH und erfordern Vollzugriff auf Server-Edit.
|
||||
- `Agent` (lesen/voll) steuert die Agent-Sektion im Server-Detail.
|
||||
|
||||
## Maintenance-Mode
|
||||
1. Schalter **Wartungsmodus aktivieren** toggeln.
|
||||
2. Optionale Nachricht eingeben (z. B. „Upgrade um 22:00 Uhr“); sie erscheint im gesamten UI als Banner.
|
||||
3. Aktivieren/Deaktivieren protokolliert automatisch Events in den Logs.
|
||||
1. Schalter **Wartungsmodus aktivieren** umlegen.
|
||||
2. Jede Aktivierung/Deaktivierung wird in den Logs protokolliert.
|
||||
|
||||
## Server & API-Key verwalten
|
||||
- Register „Server“ listet alle Portainer-Instanzen.
|
||||
- Über **Server hinzufügen** kannst du Name + URL ergänzen und anschließend API-Key speichern.
|
||||
- Buttons in der Tabelle:
|
||||
- **API-Key aktualisieren** – neues Token einsetzen.
|
||||
- **Server löschen** – nur möglich, wenn mindestens ein weiterer Server existiert oder du sofort neue Daten einträgst.
|
||||
## Serververwaltung & API-Key
|
||||
- Liste zeigt alle eingetragenen Portainer-Server.
|
||||
- **Server hinzufügen**/**bearbeiten**/**löschen** nur mit `Server bearbeiten` (Vollzugriff); löschen zusätzlich `Server löschen`.
|
||||
- Im Server-Detail:
|
||||
- **Server-URL/Name** und **Portainer API-Key**: editierbar nur mit `Server bearbeiten` Vollzugriff; bei Leserecht sichtbar, aber gesperrt.
|
||||
- **Self-Stack-ID**: Stack-ID von StackPulse selbst; blockiert Redeploys dieses Stacks.
|
||||
- **Status prüfen**: Live-Check gegen Portainer (Version, Edition, Update vorhanden). Sichtbar ab `Server bearbeiten` (lesen).
|
||||
|
||||
## Self-Stack ID
|
||||
- Feld „Eigener Stack“ akzeptiert die Stack-ID, in der StackPulse selbst läuft.
|
||||
- Nach dem Speichern sind Redeploy-Aktionen für diesen Stack im Dashboard deaktiviert.
|
||||
## Agent-Integration (Portainer CE / Edge)
|
||||
Für die Community Edition von Stackpulse kannst du je Server einen StackPulse Agent hinterlegen. Er liefert Stack- und Portainer-Metadaten, wenn die Business-API fehlt. Hierzu muss auch der Agent auf dem Server der Portainer Instanz laufen. Der Agent wird für die Business Edition nicht benötigt.
|
||||
|
||||
1. Im Server-Detail **Agent konfigurieren** öffnen.
|
||||
2. **Agent URL** eintragen, der **Agent Token** wird automatisch generiert und kann nicht geändert werden (Token = `AGENT_TOKEN` des Agents).
|
||||
StackPulse prüft Erreichbarkeit und zeigt Online-/Fehlerstatus. Sichtbar mit `Agent` lesen, Bearbeitung mit `Agent` voll.
|
||||
3. mTLS-Zertifikate verwalten:
|
||||
- **Bootstrap-Token erzeugen** (Einmal-Token) und im Agent als `AGENT_BOOTSTRAP_TOKEN` setzen.
|
||||
- Agent holt Zertifikate automatisch ab; Status im Zertifikate-Abschnitt.
|
||||
- **Zertifikate anzeigen** (PEM) (nur bei entsprechenden Rechten)
|
||||
4. Portainer-Version kann gelesen werden, wenn der Agent online ist.
|
||||
|
||||
## SSH-Konfiguration
|
||||
Erforderliche Permission: `maintenance-ssh-update`.
|
||||
1. Host, Port, Benutzername eintragen. Optional Passwort und zusätzliche SSH-Argumente (z. B. `-o StrictHostKeyChecking=no`).
|
||||
2. Passwort wird verschlüsselt gespeichert; alternativ kannst du Public-Key-Auth nutzen und das Feld leer lassen.
|
||||
3. **Verbindung testen**: StackPulse baut eine SSH-Verbindung auf und zeigt das Ergebnis in Echtzeit.
|
||||
Erfordert `SSH/Update-Skript` (sichtbar/bearbeitbar nur bei Vollzugriff auf Server-Edit).
|
||||
1. Host, Port, Benutzername und Passwort sowie eventuell notwendige Extra-Argumente eintragen.
|
||||
2. Passwort wird verschlüsselt gespeichert.
|
||||
3. **Verbindung testen** prüft Erreichbarkeit und meldet Ergebnis direkt.
|
||||
|
||||
## Update-Skript
|
||||
- Standard-Skript wird angezeigt und kann als Ausgangspunkt genutzt werden.
|
||||
- Eigenes Skript: Inhalt in das Editorfeld kopieren und speichern. StackPulse prüft auf leere Zeilen und Basisbefehle.
|
||||
- Skript zurücksetzen entfernt die benutzerdefinierte Variante und stellt den Default wieder her.
|
||||
|
||||
## Portainer-Update auslösen
|
||||
1. Stelle sicher, dass Wartungsmodus aktiv ist und SSH-Konfiguration + Skript korrekt sind.
|
||||
2. Klicke auf **Update starten**. Der aktuelle Fortschritt erscheint in einem Logpanel.
|
||||
3. Der Button bleibt deaktiviert, solange ein Update läuft. Über **Status aktualisieren** kannst du den Fortschritt erneut abfragen.
|
||||
## Update-Skript & Portainer-Update
|
||||
- Standard-Skript ist sichtbar und kann überschrieben werden (Recht `SSH/Update-Skript` + Server-Edit Vollzugriff). **Zurücksetzen** stellt den Standard wieder her.
|
||||
- Start eines Updates (`Update durchführen` + Server-Edit Vollzugriff):
|
||||
1) Wartungsmodus wird automatisch aktiviert.
|
||||
2) SSH-Konfiguration und Skript prüfen.
|
||||
3) **Update starten** klicken. Der Fortschritt und die Logausgaben erscheinen im Fenster.
|
||||
4) Während ein Update läuft, sind Änderungen am System gesperrt.
|
||||
|
||||
## Fehlerbehandlung
|
||||
- Bei SSH-Fehlern zeigt StackPulse die genaue Ausgabe an. Passe Host/Port/Benutzer oder Skript an.
|
||||
- Falls das Update-Skript Probleme verursacht, kannst du es jederzeit stoppen, indem du Portainer manuell prüfst und ggf. das Skript anpasst.
|
||||
- SSH-/Update-Fehler werden mit Klartextausgabe angezeigt. Bei Bedarf Host/Port/User, Passwort oder Skript anpassen.
|
||||
- Agent offline: URL/Token prüfen, Bootstrap-Token ggf. neu erzeugen und den Agent neu starten.
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# Setup-Assistent
|
||||
|
||||
Beim ersten Start erscheint automatisch der Setup-Bereich. Du erreichst ihn später jederzeit über `/setup`, solange nicht alle Schritte abgeschlossen sind.
|
||||
Beim ersten Start erscheint automatisch der Setup-Bereich und führt dich durch alle Schritte, bis die Einrichtung abgeschlossen ist.
|
||||
|
||||
## Voraussetzungen
|
||||
- Portainer Business Edition mit gültigem API-Key
|
||||
@@ -31,5 +31,5 @@ Beim ersten Start erscheint automatisch der Setup-Bereich. Du erreichst ihn spä
|
||||
|
||||
## Setup wiederholen oder ändern
|
||||
- Über das Dashboard → **Wartung** → Abschnitt *Serververwaltung* kannst du zusätzliche Portainer-Server hinzufügen oder entfernen.
|
||||
- Superuser lässt sich im Bereich **Benutzer** löschen, sofern du `maintenance-superuser-delete` besitzt.
|
||||
- Superuser lässt sich im Bereich **Benutzer** löschen, sofern du das Recht `Superuser löschen` besitzt.
|
||||
- Der Self-Stack (StackPulse-eigener Stack) kann in der Wartung gepflegt werden, damit er nicht versehentlich redeployed wird.
|
||||
|
||||
@@ -2,6 +2,11 @@
|
||||
|
||||
Die Stacks-Ansicht ist der Startpunkt nach dem Login und liefert einen Überblick über alle Stacks der angebundenen Portainer-Instanz.
|
||||
|
||||
**Relevante Rechte**
|
||||
- `Redeploy einzeln`
|
||||
- `Redeploy Auswahl`
|
||||
- `Redeploy Alle`
|
||||
|
||||
## Aufbau
|
||||
- **Header** mit Suchfeld, Filterchips für Status sowie Buttons für Redeploy-Aktionen.
|
||||
- **Tabelle** mit Name, Endpoint, Status, letzte Aktion, Redeploy-Status und verfügbaren Buttons.
|
||||
@@ -15,9 +20,9 @@ Die Stacks-Ansicht ist der Startpunkt nach dem Login und liefert einen Überblic
|
||||
## Redeploy-Aktionen
|
||||
| Aktion | Voraussetzung | Vorgehen |
|
||||
|--------|---------------|----------|
|
||||
| **Einzelner Stack** | Permission `stacks-redeploy-single` | Button **Redeploy** in der jeweiligen Zeile klicken und bestätigen. |
|
||||
| **Mehrere Stacks** | `stacks-redeploy-selection` | Checkboxen der gewünschten Stacks aktivieren, anschließend **Redeploy Auswahl**. |
|
||||
| **Alle Stacks** | `stacks-redeploy-all` | Button **Redeploy alle** auslösen. Nutze vorher Filter, um sicherzugehen, dass alle Stacks korrekt angezeigt werden. |
|
||||
| **Einzelner Stack** | Recht `Redeploy einzeln` | Button **Redeploy** in der jeweiligen Zeile klicken und bestätigen. |
|
||||
| **Mehrere Stacks** | Recht `Redeploy Auswahl` | Checkboxen der gewünschten Stacks aktivieren, anschließend **Redeploy Auswahl**. |
|
||||
| **Alle Stacks** | Recht `Redeploy Alle` | Button **Redeploy alle** auslösen. Nutze vorher Filter, um sicherzugehen, dass alle Stacks korrekt angezeigt werden. |
|
||||
|
||||
Während eines Redeploys erscheint pro Stack ein Fortschrittsbadge. Du kannst das Panel schließen; beim nächsten Besuch wird der aktuelle Status aus dem Backend gelesen.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user