The backup front-end feature enables our customers to integrate their external backup systems with Abiquo. User backup requirements will be stored as key-values in the virtual machine metadata. Abiquo customers can create a connector that receives information about required backups and sends it to their data center’s backup system. Connectors can subscribe to backup-related events through the outbound API and retrieve backup information stored in a VM using an API call. This feature will enable customers to fully delegate backup decisions to users, who will order backups through the UI. These backups will then be performed outside of Abiquo.
Using the default privileges:
Cloud administrators configure the backup methods to offer at datacenter level
Cloud users configure their VM backup requirements in the Abiquo UI
Beyond version V2.6, Abiquo will offer specific backup connectors to leading backup technologies.
External backup systems may have any of the following options. Cloud administrators can select those that will be available to users based on their external backup systems and resources. If a Cloud Admin changes the available configuration, this only changes NEW VMs. Old VMs can still have the old configuration.
Complete - Complete copy of the VM
Filesystem - Specific backup of a directory (or directories) on the VM
Snapshot - Differential backup of the state and data of a VM at a specific point in time
To enable users to configure VM backups for a datacenter. Go to the Infrastructure tab and open the datacenter. Mark the checkbox to Enable Backup for this Datacenter.
Select the Backups that you will make available to your users and click Save.
By default the privileges that allow users to configure backups of their virtual machines are only assigned to the Cloud Administrator. You can assign these privileges to your cloud administrators, enterprise administrators or users as required.
|Manage datacenter backup configuration||This privilege allows the user to manage backup configuration at datacenter level|
|Manage virtual machine backup configuration|
This privilege allows a user to manage backup configuration at virtual machine level
|Manage virtual machine backup schedule|
This privilege allows a user to specify an additional option for backup configuration by setting backup dates and times
If backups are configured in your datacenter, when you configure your virtual machine, you will see the Backup Configuration tab.
If you have the privilege to Manage virtual machine backup configuration, you can set the basic backup configuration for your virtual machines. This means you can choose the basic backup type and the disk.
Click on the Backup Configuration tab, then click on the Backups page.
Click the checkbox to enable backup
Select backup options from those available in your datacenter
For a filesystem backup, enter the folder or directory path to back up. Click Add to add the path to the list.
To remove a path, click the x beside it in the Path list.
Click Close to continue
If you have the additional privilege to Manage virtual machine backup schedule you can further configure your virtual machine backups. This means you can configure the exact date and time of a backup.
Be careful when configuring the backup time.
Abiquo uses ISO 8601 and users should be informed of the time standard used in the datacenter
Time zones in ISO 8601 are represented as local time (with the location unspecified), as UTC, or as an offset from UTC
Click on the Latest Backups page to view the results of your latest backups. The results shown may vary depending on your datacenter's backup system.
When you change the virtual machine's backup configuration, the backup feature will produce the events described in the following table.
Backup Configuration for virtual machine 'entity.name' has been modified.
When you change the datacenter's backup configuration, the backup feature will produce the events described in the following table.
Backup Configuration 'template.name' has been created for datacenter 'datacenter.name'.
Backup Configuration for datacenter 'DC_NAME' has been modified.
Deleted Backup Configuration 'BU_NAME' for datacenter 'DC_NAME'.
The backup front-end feature is implemented as a free text field called “metadata” in the virtual machine, with a key-value format for backup configuration. The field is stored as JSON in the database but sent as XML in response to API requests. The example below shows different backup options.
A backup is configured under the backupSchedule tag. The backup results are stored under the backupResults tag.
The backup data will be validated and only keywords will be processed. For example, if you added ‘ "<foo> </foo>” instead of “<disk> </disk>” to the example in the “disks” section, it would be ignored.
The following virtual machine backup configurations are valid:
The following values are valid for these backup results elements:
After a Backup Connector receives notification of a backup event from the outbound API, you can retrieve the backup information using the Abiquo API. Also through the Abiquo API, you can retrieve virtual machines with metadata and filter on the metadata keys. So for example, you could retrieve all of the virtual machines requiring complete backups for your datacenter.
The virtualmachine media type contains the metadata element with the backup information. The virtualmachinewithnode and virtualmachinewithnodeextended media types do not. You can get just the metadata for a virtual machine using the metadata media type and using a get over the metadata link.
The following section shows basic examples of API requests that could be used in backup integration.
More examples available in DatacenterResource
Retrieve the metadata of a virtual machine.
Example API Response
To add the results of this backup to the virtual machine metadata, copy the retrieved data, add the new data and perform a put request to virtual machine metadata.
More examples available in VirtualMachineResource
The put request will return the metadata as confirmation of the successful request.
In the Abiquo GUI on the Latest Backups tab:
Just like all the other labels in the Abiquo GUI, backup descriptions for the datacenter can be easily customized. The datacenter backup descriptions are in the Infrastructure.properties GUI labels file. The virtual machine backup descriptions are in the VirtualAppliance.properties file. See Abiquo GUI Localization
Customers must create their own connectors to read the backup requests from Abiquo and send them to their own backup system. The option for users to create an instant backup is not offered. However, if users have access to a defined hour backup, then they can set one to be performed as soon as possible.