Manage Application Server Backups

It is strongly recommended that you take backups while an application server is not running. Make sure that your application server is stopped before taking any backups.


Backups are used for copying and archiving target data (target is either a disk or an application server as a single whole of all disks used).

  • Images menu lists normal backups of an application server 
  • Files menu list application server's incremental backups    
  • Schedules menu allows you to schedule automatic backups for an application server. See Schedules Settings section of this guide for details.

OnApp supports two backup types: normal and incremental: 

  • Normal - simple method of taking backups by making a full copy of target data and storing it in an archive.  

    Ensure that you do not use XFS or other filesystems not supported by OnApp for Linux backups as OnApp will address them as ext3/4 filesystems.

  • Incremental - advanced method of taking backups. During the incremental backup, only the changes made after the last backup are archived instead of backing up the whole target. You must have dedicated backup servers configured in your cloud to be able to utilize the incremental backups functionality. Incremental backups are enabled via AdminSettings > Configuration > Backups/Templates menu.

    It is not possible to take incremental backups if you are using location group functionality without a backup server added to the group - the following error message will appear:

    "Backup cannot be made at this time: This disk cannot be backed up, check Location Group settings."

    This issue will be fixed in next releases. As a workaround, add an empty backup server zone to your location group.

Each backup type can be taken in two ways:

  • Manually - the user logs into OnApp CP and clicks the “Take backup” button.

  • Automatically - the user enables backup schedule (daily, weekly, monthly, yearly). To enable auto-backups for application servers that support incremental backups which used auto-backups option before the upgrade, re-enable automatic backups by switching them off and on again.

  • If you are using incremental backups option, you should either enable dedicated backup servers in your cloud or share the backups and templates folders (paths) between your compute resources. SSH file transfer option will be skipped for application servers using incremental backups. Existing full backups will be still accessible via Backups > Images menu.
  • If required, you can change the block size which is used during backup creation at Control Panel > Admin > Settings > Configuration by editing the Block Size (MB) parameter.

How Do Incremental Backups Work?



For example, we have a disk with three files:

  • File1 - 4Gb

  • File2 - 2Gb

  • File3 - 3Gb

The first incremental backup will be 9 GB (sum of all files). If you decide to take another incremental backup soon thereafter, the backup size will be equal to 0, as the files have not been changed since the first backup (if your backup has complicated directory structure, it could be more than 0, as file system could store some system data).

Then:

  • If the user decides to delete File2, the target size will now be 7Gb. The subsequent incremental backup size will be 0, as new data has not been added. 

  • If the user adds File4 of 4 GB size, the subsequent incremental backup will equal 4 GB (the size of new data added). 

  • If the user increases File3 disk size to 6 GB, the subsequent incremental backup size will equal 6 GB, although the target is increased by 3 GB. This happens because the incremental system takes the update of the existing file as the deletion of the existing file and adding the new file with the same name (the first version of File3 has been deleted and the new one with 6GB size has been added).

Backups can be saved either to a compute resource or to a dedicated backup server. When saving a backup, the system calculates if user has enough physical/ bucket resources to save a backup in the selected destination.

When saving a backup to a compute resource, the system does not check if compute resource has enough disk space to save a backup and only checks if a user has enough bucket limits.

When saving a backup to a dedicated backup server, the system checks both disk space and bucket limits.

Free disk size on a target must be at least equal to the disk’s size for which the backup is taken (or to a size of all application server disk for incremental backup).
In some cases (for example, if a user has scheduled several disk backups simultaneously but there are only free space/billing limits for the first one) the system may allow taking all the backups but will not be able to save them. This will result in a system error and over-billing.


View Application Server Backups



To view the list of application server's backups:

  1. Go to your Control Panel > CloudApplication Servers menu.
  2. Click the label of the required application server.
  3. Click the Backups tab, then select the appropriate backup type:
    • Images - full backups
    • Files - incremental backups
  4. On the screen that appears, you'll see a list of application server backups sorted by category.
  5. Click the label of the required application server backup to see the following tools - restore backup, delete backup and add/edit note.


Take Application Server Backup



To take an incremental backup:

  1. Go to your Control Panel > Cloud > Application Servers menu.
  2. Click the label of the server you want to back up.
  3. Click the Backups tab, then select Files. 
  4. To take a backup, click the Take a Backup button at the end of the list.

Backups in the OnApp Control Panel are associated with a particular user instead of being associated with an application server. To view the list of user backups, refer to View User Backups section.

Template extraction is performed during server provisioning or taking a backup when using a particular template. To prevent the template from being used in other transactions during extraction, the template is locked during the extraction and unlocked on accomplishment. If other transaction tries to use the locked template, it will fail after 5 minutes of standby. The transaction which locked template and failed means that extracted template is broken.

Storing scheme:

  • template /onapp/templates/your_template.tgz
  • extracted template /onapp/backups/templates/your_template
  • locked template /onapp/backups/templates/your_template.lock

Take Application Server Disk Backup



To back up an application server:

  1. Go to your Control Panel > Cloud > Application Servers menu.
  2. Click the label of the server you want to back up.
  3. Click the Storage tab > Disks. You'll see a list of the disks allocated to that application server.
  4. Click the Actions icon next to a disk you want to take a backup of, then click Backup. You'll see a list of all the backups taken and pending for that disk, along with the tools to restore backups, delete them, and convert them to templates.
    • To make a backup, click the Take a Backup button at the end of the list. You may add a note and also Force Windows Backup.

      This option for Windows application servers is designed as a last resort,when the backup cannot be taken due to NTFS file system problems.
      Switching this option will bring up a dialog box with the following message: "If you enable this option there is no guarantee that backup will be consistent."

      Select "Yes" to proceed

    • To restore a backup, click the Restore link next to the backup you want to revert to.

Backups in the OnApp Control Panel are associated with a particular user instead of being associated with an application server. To view the list of user backups, refer to View User Backups section.

Restore Application Server Backup



To restore a backup:

  1. Go to your Control Panel > Cloud > Application Servers menu.
  2. Click the label of the required application server.
  3. Click the Backups tab, then select the appropriate backup type:
    • Images - full backups
    • Files - incremental backups
  4. On the screen that appears, click the Actions icon next to the backup you want to revert to and choose Restore.


Add Application Server Backup Note



To edit application server backup's note:

  1. Go to your Control Panel > Cloud > Application Servers menu.
  2. Click the label of the required application server.
  3. Click the Backups tab, then select the appropriate backup type:
    • Images - full backups
    • Files - incremental backups
  4. On the screen that appears, click the Actions icon next to the required backup and choose Add Note. Make necessary changes and click Submit.


Delete Application Server Backup



To delete a backup:

  1. Go to your Control Panel > Cloud > Application Servers menu.
  2. Click the label of the required Application server.
  3. Click the Backups tab, then select the appropriate backup type:
    • Images - full backups
    • Files - incremental backups
  4. On the screen that appears, click the Actions icon next to the backup you want to remove and choose Delete.