Run actions of Backup manager

Eugenia Kuzina

After you define a configuration and specify a schedule for backups, they will be created automatically according to your settings. However, you can manage backups manually via the Backup manager actions described below.

To run the actions, click Actions at the top of the Backup manager page and select the required action. The action will be executed for the cluster selected from the Cluster combo box next to Actions.

Select an action
Select an action

The following actions are available:

Backup

The Backup action allows you to create a backup. Backups are produced on the leader. To run the action, click Backup in the action list on the Backup manager page.

The window that opens contains the following fields:

  • Type — a backup type. Possible values are: Full — full, Incr — incremental, Diff — differential.

  • Date created — a current timestamp. Non-editable field.

  • Configuration — the current configuration version that will be used. You can click the version name to open the Configuration tab, where you can check or edit the configuration parameters. Non-editable field.

Set field values according to your requirements and click Run.

Backup action window
Backup action window

While the backup is being created, a progress bar of the backup creation is displayed on the Topology page.

Backup progress bar
Backup progress bar

The created backups are listed on the Backups tab of the Backup manager page.

The Backups tab
The "Backups" tab

Restore

The Restore action allows you to restore databases on all cluster nodes. Click Restore in the action list on the Backup manager page to run the action. The action window will be opened.

The Restore window
The "Restore" window

The Restore window contains the following fields:

  • Restore target — determines how the recovery should be performed. Currently, only the restore from a backup is supported. It corresponds to the Backup name value. Below this field, a combo box with available backups is displayed. It allows you to select the backup from which you want to restore. Click info r dark info r light to show detailed information on the selected backup:

    • Date created — a creation timestamp.

    • Backup type — a backup type. Possible values are: Full — full, Incr — incremental, Diff — differential.

    • Configuration — the configuration version that was used. You can click the version name to open the Configuration tab with specified parameters.

  • Dates — a time period for which the list of backups will be available in the combo box. You can select this period as a range (by default) or use a calendar to specify it.

    Select a range
    Select a range

    To select a period in the from <date> to <date> format, click Calendar.

    Select a period in the calendar
    Select a period in the calendar

  • Databases to restore — the databases to restore from the selected backup.

  • Process — the maximum number of concurrent pgbackrest processes decompressing and moving files that are used during a restore operation.

  • Delta — a flag that indicates whether to restore only the files that have changes from the existing files in the PostgreSQL data directory. This option can significantly speed up the restore process. If Delta is not set, all files in the data directory will be removed before the restore operation.

  • Use checksums — a flag that indicates whether to utilize checksums instead of timestamps to determine if a file should be replaced with its updated version from a backup. Using checksums is safer, but may slow down the recovery operation for large files. The Use checksums flag is available if Delta is checked.

After you set the field values, click Run to execute the Restore action.

The performed restores are displayed on the Restores tab of the Backup manager page.

The Restores tab
The "Restores" tab

Cleanup

The Cleanup action removes expired backups and related data. A backup is considered expired according to the backup settings.

To start the action, select Cleanup in the action list and click Run in the window that opens.

The Cleanup action’s window
The "Cleanup" action’s window

You can find the action result on the Actions page.

NOTE
Backups with the FAILED status are not removed directly by the Cleanup action. They may be removed only if they match retention rules specified by backup settings or are included in the dependency interval of another backup (for example, with the INVALID status).

Verify

The Verify action checks if backup metadata used by ADP Control corresponds to the backups in the specified repository.

To start the action, select Verify in the action list and click Run in the window that opens.

The Verify action’s window
The "Verify" action’s window

You can find the action result on the Actions page.

The Actions page
The "Actions" page

Click the Verify action to view details.

Details of the Verify action
Details of the "Verify" action

Apply backup config

The Apply backup config action opens the Configuration sub-tab of the Backup manager → Settings tab. On this tab, the applied backup configuration is marked as current.

The Configuration tab
The "Configuration" tab

You can create a new configuration on this tab. ADP Control automatically applies this new configuration after you save it.

Found a mistake? Seleсt text and press Ctrl+Enter to report it