Referenz des Installers
Übersicht
Diese Übersicht fasst zusammen, was wsp kennt: Kommandos, globale Schalter, Dateien und Verzeichnisse, Ports, ausgehende Ziele, Dienste im Stack und die Rückgabewerte. Hilfe zu einem einzelnen Kommando gibt wsp <kommando> --help.
Voraussetzungen
- Alle Kommandos verlangen Root-Rechte
- Globale Schalter stehen vor dem Kommando, zum Beispiel
sudo wsp --headless --yes update
Kommandos
| Kommando | Zweck | Verändert |
|---|
wsp install | Erstinstallation | ja |
wsp update | Neuere Version | ja |
wsp status | Zustand anzeigen | nein |
wsp doctor | Prüfen | nein |
wsp backup | Sicherung anlegen | ja |
wsp restore <id> | Sicherung zurückspielen | ja |
wsp rollback | Vorherigen Stand | ja |
wsp rotate [name] | Geheimnis erneuern | ja |
wsp adopt | Stack übernehmen | ja |
wsp import | Alt-Daten aus 1.x | ja |
wsp tenants | Mandanten | beim Löschen |
wsp uninstall | Instanz entfernen | ja |
Globale Schalter
| Schalter | Bedeutung |
|---|
--headless | Ohne Oberfläche, ohne Rückfragen |
--yes | Rückfragen bejahen |
--no-color | Farbausgabe abschalten |
--debug | Ausführliche Ausgabe |
--accessible | Eingaben zeilenweise |
--version | Version anzeigen |
--helpdesk <url> | Abweichender Supportdienst |
NO_COLOR=1 wirkt wie --no-color, WSP_ACCESSIBLE=1 wie --accessible.
Dateien und Verzeichnisse
| Ort | Inhalt |
|---|
/etc/wsp/env | Ihre Konfiguration |
/etc/wsp/secrets/ | Je Geheimnis eine Datei |
/etc/wsp/instance-id | Kennung der Instanz |
/etc/wsp/registry.json | Kurzlebige Registry-Zugänge |
/etc/wsp/tls/ | Selbst erzeugtes Zertifikat |
/etc/nginx/conf.d/workspace.conf | nginx-Seite |
/var/lib/wsp/state.json | Zustand der Installation |
/var/lib/wsp/stack.yml | Beschreibung der Dienste |
/var/lib/wsp/backups/ | Sicherungen |
/var/lib/wsp/import/ | Arbeitsverzeichnis des Imports |
/var/lib/wsp/wsp.lock | Laufsperre |
/var/log/wsp/ | Ein Protokoll je Lauf |
Ports
| Port | Wer | Sichtbarkeit |
|---|
| 80 | nginx | öffentlich |
| 443 | nginx | öffentlich |
| 3000 | Oberfläche | nur lokal |
| 3001 | Anwendungslogik | nur lokal |
Ausgehende Ziele
| Ziel | Wofür |
|---|
support.projektmanagement.cloud | Releases, Changelog, Registry-Zugang |
registry.workspace.pm | Abbilder von WORKSPACE.PM |
registry-1.docker.io | PostgreSQL und Redis |
acme-v02.api.letsencrypt.org | Zertifikate |
download.docker.com | Pakete |
Es gibt keine eingehende Verbindung von uns zu Ihnen.
Dienste im Stack
| Dienst | Aufgabe |
|---|
wsp_workspacepm | Programmoberfläche |
wsp_workspaceapi | Anwendungslogik |
wsp_mpxj-converter | Projektplan-Import und -Export |
wsp_postgres-workspace | Datenbank |
wsp_redis | Zwischenspeicher und Warteschlangen |
Rückgabewerte
| Wert | Bedeutung |
|---|
| 0 | Erfolgreich |
| 1 | Allgemeiner Fehler |
| 2 | Vorbedingung verletzt |
| 3 | Konfiguration unvollständig |
| 4 | Registry oder Lizenz |
| 5 | Sicherung fehlgeschlagen |
| 6 | Migration fehlgeschlagen |
| 7 | Abnahme rot, zurückgerollt |
| 8 | Anderer Lauf aktiv |
| 9 | Abgebrochen |
Bei Wert 2 wurde nichts verändert, bei Wert 5 hat das Update nicht begonnen.
Tastenbelegung und Bestätigungswörter
| Taste | Wirkung |
|---|
↑ ↓ | Auswahl bewegen |
↵ | Bestätigen, weiter |
⇧⇥ | Eine Seite zurück |
Esc | Eine Ebene zurück |
l | Protokoll ein- und ausblenden |
? | Hilfe zum Bildschirm |
q | Beenden |
Bei zerstörenden Vorgängen tippen Sie ein Wort: wiederherstellen, zurückrollen, entfernen oder den Namen des Mandanten.
Häufige Fehler und Tipps
- Hinweis: Globale Schalter gehören vor das Kommando.
sudo wsp --headless update, nicht sudo wsp update --headless.
- Tipp:
wsp status --json für Überwachung nutzen.
- Ohne Installation liefert es
{"installed": false}.
- Hinweis: Ein Rückgabewert ändert nie seine Bedeutung.
- Damit lassen sich Skripte dauerhaft darauf stützen.
