Backup and Restore

Overview #

There are three different concepts exposed in the user interface when backing up a system:

  1. Full Backup
    A full backup saves all configuration and assets for a system at a specific point in time. Restoring a full backup will return the system to the state it was in when the full backup was created.
  2. Partial Backup
    A partial backup saves only the relevant configuration for a selected page. This allows pieces of a system (content) to be shared between different servers.
  3. Recovery Backup
    A Recovery Backup is a full backup that is automatically created prior to performing any restore operation or installation of a module. It is good practice to periodically create a full backup to prevent the loss of work. Recovery backups are automatically created to ensure changes to a system are not unintentionally lost due to a restore operation.

To open the Backup & Restore user interface, use either: #

  •  – The icon located in the Admin Toolbar, the vertical bar that runs down the left side of an administrator’s screen.
  • System Menu -> Backup & Restore.

When importing partial archives generated from versions prior to edgeSuite v3.4, pages can have some unexpected behavior. This is due to the way pages are identified.  This will likely only be an issue in a deployment with multiple servers, where some servers are still running older versions of edgeCore.  Best practice is to keep all edgeCore server versions synchronized to the latest version.

Purpose of a Backup #

Backups are used in a number of different scenarios:

  • They provide a mechanism to migrate configuration from one environment to another. For example, migration from development, to staging, to production.
  • They are used when upgrading Edge to a newer version.
  • They can provide a stable instance that can be restored in the event that the system gets in a bad state.
  • They provide a way for Edge Support to investigate and troubleshoot support issues. The Edge Support Team may request a backup archive when isolating a problem.

Backup & Restore Interface #

The Backup & Restore interface separates out manually created full and partial backups, from recovery backups that are automatically created. Users can toggle between the two different groups of backups using the toggle control in at the top right (shown below):

Backups Shows all manually created full and partial backups.
Recovery Shows all automatically created backups. Recovery Backups are full backups created prior to a restore operation.

The list of backups appears in a table with the following attributes:

Name #

The name that was given to this backup. Some backup names are automatically generated, which includes the date and time the backup was created, to make it unique. This name is also used for the name of the backup file edgeCore creates on the file system, so it must only contain characters valid for a filename.

Type #

The type of backup file for this backup.

Full All configuration and assets for a system at a specific point in time. On the server file system, full backups are named with a .zip extension
Partial Only the relevant configuration required for selected pages. On the server file system, partial backups are named with a .esb extension.

Description #

This column contains additional descriptive information. It is particularly useful when working with recovery backups, because the system will provide information about why the recovery file was created.

Date Created #

The date and time the backup was created.

Version #

The version of edgeCore used to create the backup archive.

File Location #

Backup files are saved to the edgeCore server’s file system.

  • Backups:
    Manually created full and partial backups are located here: [Install_Home]/exports/
  • Recovery:
    Automatically created recovery files are located here: [Install_Home]/exports/recovery

Create a Backup #

Creating a backup is accomplished by clicking the “Backup” button in the bottom right of the toolbar (shown below).

After clicking the “Backup” button, a “Configure Backup” dialog is displayed.

File Name #

Specify a name for the backup. If you leave the name blank, the system default will include the date and time in the backup name for reference.

Backup Type #

Specify the type of backup you want:

Full Saves everything in the system. Restoring a Full Backup will restore the system to that point in time.
See Full Backup for more information.
Partial Saves all the associated configuration and assets for selected pages. This is a good way to share content across systems.
See Partial Backup for more information.

Include Log Files #

Determines whether log files should be included with the archive. This option is mainly used when working with Edge Support.

Yes Log Files will be included with the archive.
No Log Files will not be included with the archive.

Results #

Once an archive has been created, a dialog will appear showing a summary of its contents.

  • The summary allows an administrator to validate the contents of a backup.
  • Clicking on the pie chart will show a list of the individual files for the selected category.

#

This same preview will appear prior to restoring a backup.

Restoring an Archive #

This option becomes available after selecting an item in the table. The User Interface will vary based on the type of archive being restored. See the following sections for additional information:

  1. Full Backup (.ZIP):
    See Full Backup for more information.
  2. Partial Backup (.ESB):
    See Partial Backup for more information.

Uploading an Archive #

“Upload” allows an administrator to move an archive from their local system up to the edgeCore server. The “Upload Archive” dialog allows uploading a single archive file, or multiple files.

Downloading an Archive #

“Download” allows an administrator to move an archive from the edgeCore server to their local system.