DE 

//Cloudogu EcoSystem Docs

  1. docs.cloudogu.com
  2. Entwicklerdokumentation
  3. Systemkomponenten
  4. Cesapp
  5. Funktionen
  6. Befehl: cesapp backup
Getting Started
Benutzerhandbuch
Entwicklerdokumentation

Befehl: cesapp backup

Der Befehl cesapp backup --all erstellt ein Backup der Systemdateien und aller Dogus des Cloudogu EcoSystem.

Backup einzelner Komponenten

Einzelne Dogus

Backups einzelner Dogus können mit dem Befehl cesapp backup <dogu-name> erstellt werden.
Diese Funktion wird leider noch nicht unterstützt.

Systemdateien

Backups der Systemdateien lassen sich mit dem Befehl cesapp backup --system erstellen.
Diese Funktion wird leider noch nicht unterstützt.

Dry-run

Der --dry-run Flag listet die einzelnen Schritte des Befehls auf, ohne dass dieser ausgeführt wird.

Liste der Backups ausgeben

Die Liste aller Backups kann mit dem Befehl cesapp backup list ausgegeben werden.
Mit dem Flag --update-in-registry wird die Backup-Liste in der Registry aktualisiert.

Health-Checks

Vor dem Backup werden normalerweise Health-Checks ausgeführt. Falls einer der Health-Checks fehlschlägt, wird das Backup abgebrochen.
Um die Health-Checks zu überspringen, kann der Flag --skip-health-checks verwendet werden.

Konfiguration

Alle hier hinterlegten Keys sind /config/backup untergeordnet.

  • active - Bestimmt, ob automatische Backups aktiv sind; erlaubte Werte: true oder false
  • time - Uhrzeiten automatischer Backups; Format: {\"Times\":[\"12:30:00\"]}
  • ignore_dogu_health - Bestimmt, ob das Backup bei fehlgeschlagenen Health-Checks trotzdem ausgeführt werden soll; erlaubte Werte: true oder false
  • encryption_key - Schlüssel zum Verschlüsseln des Backups
  • backup_type - Typ des Backups; mögliche Werte: local, SFTP, S3
  • local_config/path - Pfad zum lokalen Verzeichnis, in dem das Backup Repository gespeichert werden soll.
  • sftp_config/address - Adresse des SFTP Servers, auf dem ein Backup abgelegt werden soll
  • s3_bucket_config/address - Adresse des S3 Buckets, auf dem ein Backup abgelegt werden soll
  • s3_bucket_config/access_key_id - Access Key ID für den Zugriff auf den S3 Bucket
  • s3_bucket_config/secret_access_key - Secret Access Key für den Zugriff auf den S3 Bucket
  • retention_enabled - Bestimmt, ob Backups zurückgehalten werden sollen; erlaubte Werte: true oder false
  • retention_strategy - Bestimmt die Strategie, mit der Backups zurückgehalten werden. Erlaubte Werte können unter retention_policies abgerufen werden.
  • deny_cross_blueprint_restores - Wenn der Wert auf true gesetzt ist, sind die Backups an eine blueprintId gebunden. Nach einem Blueprint-Upgrade können sie nicht wiederhergestellt werden. Wenn der Wert auf false oder gar nicht gesetzt ist, können alle Backups wiederhergestellt werden.
  • pre_backup_script - Hier kann der Pfad zu einem Bash-Script hinterlegt werden. Der Pfad darf nicht leer sein. Es muss ein absoluter Pfad sein. Das Script muss existieren und ausführbar sein. Das so hinterlegte Script wird vor jedem Backup ausgeführt.
  • post_backup_script - Hier kann der Pfad zu einem Bash-Script hinterlegt werden. Der Pfad darf nicht leer sein. Es muss ein absoluter Pfad sein. Das Script muss existieren und ausführbar sein. Das so hinterlegte Script wird nach jedem erfolgreichen Backup ausgeführt.

Manpage

NAME:
   cesapp backup - backup parts of CES

USAGE:
   cesapp backup command [command options] [arguments...]

DESCRIPTION:
   Creates backups of the Cloudogu EcoSystem. Currently, only --all is supported. Single dogu backups and --system are not.

COMMANDS:
   list     lists all available backups
   help, h  Shows a list of commands or help for one command

OPTIONS:
   --all          back up system and all dogus (default: false)
   --system       back up system files (default: false)
   --dry-run      only prints out the description of the backup steps without backing up anything (default: false)
   --help, -h     show help (default: false)
   --version, -v  print the version (default: false)