Image backup and recovery allows you to save the current state of your Utility and Sandbox instances and any associated application properties. Backups can be performed manually on demand. Currently the system supports up to 100 retained backups per system type (Utility Server or Sandbox), after which you will need to delete previous backups if you wish to create a new one.
Sandbox and Utility Servers¶
Navigate to your Dashboard to implement manual backups for your account.
- Go to the “Sandbox” or “Utility Servers” page and navigate to the “Backups” table listed under the desired system.
- Click “Create backup” and assign it a name. Click “Create” and accept the prompt to power off your Sandbox when you’re ready.
- Once the backup has started, the instance will go into maintenance mode and you will not be able to access it until the task is complete.
The time to create a backup varies based on image size and operating state. Backing up a standard 45 GB image in a powered off state typically takes 5-10 minutes. If the instance is running or if the underlying cloud services are under heavy load, you will likely see longer wait times.
- Once your backup is completed, it will appear in the “Backups” list. At a glance, you can see the name of the backup, when it was created, and the type of backup (manual, scheduled, or publish).
If you would like to adjust the number of retained manual backups for your system, please continue to the “Scheduled Backups” section below.
Administrators can enable scheduled backups for a Sandbox or Utility Server from the same area of Dashboard.
Navigate to the desired system page and find the “Backups” table. Click on the kebab menu icon in the upper right corner of the table and select “Settings.”
A new window will appear. Enable the “Schedule daily backups” toggle to reveal two new fields. Click “Confirm” in the bottom right corner of the window once you have specified your desired settings.
- Backup time: Select the desired time of day you would like your automatic backup to be performed and which time zone this applies to. Backups will occur daily (including weekends) at the designated time.
We do not advise scheduling backups during operational hours for Utility Servers since they will be made briefly unavailable during the backup process. Scheduling backups for Sandbox instances does not affect production users and therefore can be scheduled at any time.
- Number of scheduled backups retained: This value specifies the number of scheduled backups you would like to store.
- Number of manual backups retained: This value specifies the number of manual backups you would like to store.
Please note that the maximum number of retained manual or scheduled backups is 100. Backups are stored as a standard machine image and will incur storage costs from your cloud provider.
Restore from a Backup¶
Restoring an image from a previous backup is simple. Restoring from a previous backup will replace your current Sandbox or Utility Server image with the backup image you select. Any changes made since the selected backup was created will be erased.
- Click on the ellipsis located to the right of the backup you wish to restore and choose “Restore.”
- A prompt will appear to confirm before the process starts. Click “Restore” to continue.
After the backup has been restored, the instance will be returned to its previous operational state.
Delete a Backup¶
To delete a backup, simply click on the ellipsis to the right of the backup you wish you delete and select “Delete.”
Administrators can create a backup of Personal Drives and Enterprise Profile volumes by navigating to the “Volumes” page from their Dashboard and clicking on the “Backups” tab. From there, click “Create Backup.”
A new menu will appear prompting you to select the volume and designate a name for your backup.
Click “Create” when you’re ready. A progress indicator will appear above the “Backups” section.
Alternatively, administrators can create a backup of a volume by navigating back to the “Volumes” tab, clicking on the ellipsis next to the desired volume, and selecting “Backup.”
Administrators can specify the number of retained manual backups by clicking on the kebab menu in the upper corner of the “Backups” section and selecting “Settings.” Click “Confirm” once the desired settings have been updated.
Please note that the maximum number of retained manual or scheduled backups is 100. Backups are stored as standard machine images and will incur storage costs from your cloud provider.
To set up automatic backups, navigate to the “Volumes” page from the Dashboard of your account and click on the “Backups” tab. Click on the kebab menu listed under the “Backups” section and select “Settings.” A new window will appear, enable the “Schedule daily backups” toggle.
Specify the time of day you would like your backups to occur. Note that daily backups occur every day of the week, including weekends. You can also adjust how many automatic backups you would like Frame to store at a time by adjusting “Number of scheduled backups retained.” Click “Confirm” when you’re done.
Restore from a Backup¶
To restore from a backup, simply click on the ellipsis next to the desired backup and select “Restore.”
Restoring from a previous backup will flash the volume with the backup image you select. Any changes made since the selected backup was created will be erased.
Delete a backup¶
To delete a backup from the “Backups” tab on the “Settings” page of your Dashboard, simply click on the ellipsis to the right of the backup you wish you delete and select “Delete.”
Backup Management through User Profile¶
Since Personal Drives are tied to an authenticated user, all users have the ability to manage their own volume backups easily from their profile page. Users simply click on their name in the upper right corner of the page and select “Edit.”
From the profile page, the user can click on the “Personal drive backups” tab listed on the left.
Users can initiate manual backups of their Personal Drive at any time. End user instructions for accessing and managing Personal Drives can be found in this end user guide.
Enterprise Profile disk backups can only be managed by an administrator and are not accessible to the end user.