Storm Package: synapse-backup
The following Commands are available from this package. This documentation is generated for version 2.3.1 of the package.
This package implements the following Storm Commands.
Delete a backup by name. Examples: # Delete a local backup. backup.del fooservice-celliden-1614611119058 # Delete a backup saved to S3. backup.del --s3 fooservice-celliden-1614611119058 Usage: backup.del [options] <name> Options: --help : Display the command usage. --s3 : Delete a backup from S3. --gcs : Delete a backup from GCS. Arguments: <name> : Name of the backup to delete.
Retrieve a list of backups. Examples: # List backups saved as local files. backup.list # List backups saved to S3. backup.list --s3 Usage: backup.list [options] Options: --help : Display the command usage. --s3 : Retrieve list of backups from S3. --gcs : Retrieve list of backups from GCS.
Take a backup snapshot of the given service name. Run a backup of a service by name or Telepath URL and archive it in the backup service or a supported external storage API. Examples: # Run a backup of a service by name and upload to S3. backup.service --s3 maxmind # Run a backup of a service by telepath URL. backup.service ssl://root:[email protected]:3399/ # Run a backup of a service with an AHA url. backup.service aha://[email protected] Usage: backup.service [options] <url> Options: --help : Display the command usage. --s3 : Save the backup archive to S3. --gcs : Save the backup archive to GCS. --keep-on-fail : Keep the service's local backup on failure instead of deleting it. --wait : Wait for the backup to complete before returning. --debug : Show verbose debug output. Arguments: <url> : Service name or Telepath URL.