Command: ubos-admin backup

/docs/developers/details/understanding/backup/

Running

To see the supported options, invoke ubos-admin backup --help.

This command must be run as root (sudo ubos-admin backup).

Understanding

There are many variations of this command. Regardless of which variation of the command is used, UBOS generally performs the following actions:

  • It suspends the Site or Sites affected by the backup, and temporarily replaces them with a placeholder page.

  • For each of the Apps and Accessories affected by the backup, UBOS will examine the corresponding UBOS Manifest and look for AppConfigItems that have the following fields:

    "retentionpolicy" : "keep",
    "retentionbucket" : "name"
    

    Each of the AppConfigItems with these two fields will be backed up. All other AppConfigItems will be ignored for the purposes of backup.

  • The actual backup performed depends on the type of AppConfigItem. For example, a MySQL database will be dumped, and the resulting dump file will be added to the backup.

  • The individually exported items, and certain meta-data are assembled in a UBOS backup file.

  • UBOS resumes the Site or Sites affacted by the backup, and removes the placeholder page.

  • If the user requested encryption of the backup, the entire backup file will be encrypted with GPG.

  • Depending on the data transfer protocol specified, the resulting file will either be moved into the desired location on the local device, or transferred over the network to a remote host with the specified host and parameters.

See also: