Workflows

Backup-Workflow ausführen

Workflow erstellen

Erstelle die Datei workflows/default/backup.yml in deinem Serverhost-Verzeichnis:

workflows/default/backup.yml

name: Backup Workflow

steps:
  - name: copy-running-to-backup
    uses: simplecloud/copy
    with:
      from: "{{ runtime.server-dir }}"
      to: "{{ runtime.templates }}/.backup/{{ runtime.name }}/{{ time.now.date }}/{{ time.now.dateTime }}-{{ runtime.nice-id }}-{{ runtime.process-id }}"
      init-dir-if-missing: true

Workflow laden

Starte den Serverhost neu. SimpleCloud verwendet den Dateipfad als Workflow-ID. Dieser Workflow erhält daher die ID default/backup.

Workflow zuweisen

Öffne im Dashboard eine Servergruppe oder einen persistenten Server und gehe zu Settings > Workflows. Füge unter Manual Workflows den Eintrag default/backup hinzu.

Workflow ausführen

Starte den Server, falls er noch nicht läuft. Öffne anschließend sein Aktionsmenü und führe zum Testen default/backup aus.

Backup prüfen

Öffne auf dem Serverhost dieses Verzeichnis:

templates/.backup/<name>/<date>/<date-time>-<server>-<process-id>/

Prüfe, ob das Zielverzeichnis die erwarteten Dateien enthält. Zeitstempel und Prozess-ID geben jedem Lauf ein eigenes Zielverzeichnis.

Ein Workflow ist nur auf Serverhosts verfügbar, auf denen seine Datei vorhanden ist. Wenn die betroffenen Server auf mehreren Serverhosts ausgeführt werden können, füge jedem von ihnen dieselbe Datei hinzu und starte die Serverhosts neu.

Bei der manuellen Aktion werden die Dateien kopiert, während der Minecraft-Server läuft. Ändern sich dabei Welten oder Plugin-Daten, kann die Kopie inkonsistent sein. Füge für solche Dateien default/backup unter On Stop Workflows hinzu und stoppe den Server normal. Stop-Workflows werden ausgeführt, nachdem der Serverprozess beendet wurde. Platziere default/backup vor internal/cleanup.

internal/cleanup entfernt das laufende Verzeichnis eines Gruppenservers. Jeder Workflow, der dieses Verzeichnis liest, muss vor dem Cleanup ausgeführt werden.

Dieser Workflow erstellt Dateikopien, prüft jedoch nicht, ob sie sich wiederherstellen lassen, und entfernt keine alten Backups. Teste die Wiederherstellung der benötigten Daten und lege eine Aufbewahrungsstrategie für templates/.backup/ fest.

Workflow-Datei verstehen

Der Backup-Workflow hat dieselbe grundlegende Struktur wie jeder andere Workflow:

name identifiziert den Workflow in den Serverhost-Logs.
steps enthält die Operationen in ihrer Ausführungsreihenfolge.
name innerhalb eines Steps identifiziert diesen Step in den Logs.
uses wählt die Aktion aus. Dieser Workflow verwendet simplecloud/copy.
with enthält die von der Aktion benötigten Werte.

In diesem Workflow verweist from auf das laufende Serververzeichnis. to erzeugt für jeden Lauf einen eigenen Backup-Pfad. Fehlt die Quelle, erstellt init-dir-if-missing: true ein leeres Quellverzeichnis, anstatt einen Fehler auszulösen. Prüfe deshalb immer, ob das Backup die erwarteten Dateien enthält.

Vom Workflow verwendete Werte

Werte innerhalb von {{ ... }} werden beim Ausführen des Workflows ersetzt.

Wert	Ergebnis
`{{ runtime.server-dir }}`	Laufendes Serververzeichnis
`{{ runtime.templates }}`	Template-Verzeichnis des Serverhosts
`{{ runtime.name }}`	Name der Servergruppe oder des persistenten Servers
`{{ runtime.nice-id }}`	Name des laufenden Servers, zum Beispiel `lobby-1`
`{{ runtime.process-id }}`	ID des laufenden Prozesses
`{{ time.now.date }}`	Aktuelles Datum
`{{ time.now.dateTime }}`	Aktuelles Datum und aktuelle Uhrzeit

Backup-Workflow anpassen

Verwende den Backup-Workflow als Ausgangspunkt:

Workflow kopieren

Kopiere workflows/default/backup.yml an einen neuen Pfad, zum Beispiel workflows/custom/world-backup.yml.

Workflow ändern

Gib ihm einen neuen name und passe die Kopierpfade und Ausschlüsse an deine Aufgabe an.

Workflows neu laden

Starte jeden Serverhost neu, auf dem die neue Datei vorhanden ist.

Neue ID zuweisen

Füge unter Settings > Workflows den Eintrag custom/world-backup hinzu. Die Workflow-ID entspricht immer dem Pfad unterhalb von workflows/, jedoch ohne .yml.

Kopierumfang ändern

Die Aktion simplecloud/copy unterstützt unter with diese Einstellungen:

Einstellung	Zweck
`from`	Zu kopierende Datei oder zu kopierendes Verzeichnis
`to`	Ziel des Kopiervorgangs
`replace`	Gibt an, ob vorhandene Dateien überschrieben werden; Standardwert ist `true`
`exclude`	Pfad oder Liste von Pfaden, die ausgelassen werden
`init-dir-if-missing`	Gibt an, ob das Quellverzeichnis erstellt wird, wenn es nicht existiert; Standardwert ist `false`

Füge beispielsweise eine exclude-Liste hinzu, um Logs und Caches auszulassen, während der Rest des Backups unverändert bleibt:

with:
  from: "{{ runtime.server-dir }}"
  to: "{{ runtime.templates }}/.backup/{{ runtime.name }}/{{ time.now.date }}/{{ time.now.dateTime }}-{{ runtime.nice-id }}-{{ runtime.process-id }}"
  init-dir-if-missing: true
  exclude:
    - "logs/**"
    - "cache/**"

Muster unter exclude sind relativ zu from.

Verfügbare Aktionen

Dateien kopieren

simplecloud/copy kopiert eine Datei oder ein Verzeichnis von from nach to. Mit replace legst du fest, ob vorhandene Dateien überschrieben werden. Mit exclude lässt du passende Pfade aus.

Archive erstellen oder entpacken

simplecloud/compress erstellt ein Archiv und simplecloud/decompress entpackt eines. Beide Aktionen benötigen from und to; replace ist optional. Der Dateiname des Archivs bestimmt sein Format.

Datei hochladen

simplecloud/upload sendet die Datei unter from an die URL unter to. Die Aktion lädt Dateien hoch, keine Verzeichnisse. Du kannst außerdem die HTTP-method und einen Wert für authorization-bearer festlegen.Speichere langlebige Zugriffstokens unter Settings > Secrets und setze authorization-bearer auf eine Secret-Referenz, zum Beispiel "{{ secrets.BACKUP_TOKEN }}".

Dateien löschen

simplecloud/delete entfernt den unter path angegebenen Inhalt. Verwende min-age, zum Beispiel 7d, um neuere Dateien zu behalten.

Löschpfade sind nicht auf das Serververzeichnis beschränkt. Prüfe den endgültigen Pfad, bevor du den Workflow ausführst.

Steps wiederholen

simplecloud/foreach führt verschachtelte Steps für jeden Eintrag unter items aus. Lege mit as den Variablennamen fest, den die verschachtelten steps verwenden.

Eingebaute Workflows

Workflow	Zweck
`internal/setup`	Bereitet das Serververzeichnis vor dem Start vor
`internal/cleanup`	Bereinigt Dateien, nachdem der Server gestoppt wurde

Lass internal/setup und internal/cleanup zugewiesen, sofern du ihr Verhalten nicht bewusst ersetzt.

Fehlerbehebung

Der Workflow wird nicht aufgelistet

Workflow-IDs werden manuell im Dashboard eingetragen. Prüfe, ob die Datei auf dem Serverhost vorhanden ist, starte den Serverhost neu und füge die ID erneut hinzu.

Der Workflow wird nicht gefunden

Prüfe, ob die ID dem Dateipfad entspricht. custom/world-backup muss beispielsweise auf workflows/custom/world-backup.yml verweisen.

Ein Backup fehlt

Suche in den Serverhost-Logs nach Backup Workflow und copy-running-to-backup. Prüfe bei einem automatischen Backup außerdem, ob default/backup vor internal/cleanup steht.

Introduction

Setup

Configuration

Plugins

Backup-Workflow ausführen

Workflow-Datei verstehen

Vom Workflow verwendete Werte

Backup-Workflow anpassen

Kopierumfang ändern

Verfügbare Aktionen

Eingebaute Workflows

Fehlerbehebung

​Backup-Workflow ausführen

​Workflow-Datei verstehen

​Vom Workflow verwendete Werte

​Backup-Workflow anpassen

​Kopierumfang ändern

​Verfügbare Aktionen

​Eingebaute Workflows

​Fehlerbehebung

Backup-Workflow ausführen

Workflow-Datei verstehen

Vom Workflow verwendete Werte

Backup-Workflow anpassen

Kopierumfang ändern

Verfügbare Aktionen

Eingebaute Workflows

Fehlerbehebung