Postgres Pro Enterprise Manager : Documentation: 2: 5.28. Backup : Postgres Professional

5.28. Backup
Prev	Up	Chapter 5. Using PPEM	Home	Next

5.28. Backup #

5.28.1. Storages
5.28.2. Instance Binds
5.28.3. Backups
5.28.4. Backup Schedules
5.28.5. Configuring Backup Storage Parameters for an Instance

PPEM supports creating backups for instances. You can use a backup to create a new instance if the previous instance fails. To work with backups, you must first install and configure the backup and restore tools.

Before creating backups, create storages where they will be located. You can create local and S3 storages.

Note

Local storages are intended for introductory use with PPEM. For production environments with a large number of instances and created backups, it is recommended to use S3 storages.

When creating a storage, you must bind an instance to it. When an instance is bound to a storage, a catalog for this instance’s backups is created in the storage.

You cannot bind an instance to the same storage twice. If an instance is bound for the second time, it is unbound from the previous storage. You can manage instance binds separately.

Backup schedules can be created for automatically creating instance backups at the specified time interval. Backup schedules also allow for scheduling a single backup at the specified date and time.

5.28.1. Storages #

This section explains how to manage storages. It includes the following instructions:

Creating a Storage

You can create local storages and S3 storages.

Creating a Local Storage

In the navigation panel, go to Backup → Backup storages.
In the top-right corner of the page, click Create backup storage.
Select Local storage, and then click Next.
Enter parameters of the new local storage (parameters marked with an asterisk are required):
- Storage name.
- Catalog of copies: The path to the local storage catalog where backups will be located.
  Specify the path to an empty catalog.
- System user: The OS user who will own the local storage catalog.
  It is recommended to specify the user on behalf of which the instance is installed, because this user must have read and write privileges in the local storage catalog.
- Instance: The instance that will be bound to the local storage. When an instance is bound to a storage, a catalog for this instance’s backups is created in the storage.
  You cannot bind an instance to the same storage twice. If an instance is bound for the second time, it is unbound from the previous storage.
- Storage parameters: The backup storage parameters of the storage catalog created for the instance.
  Available parameters:
  - Retention redundancy, pcs.: The maximum number of full backups.
    For example, if you specify 3, the catalog can contain a maximum of three full backups.
    To disable this limitation, specify 0. In this case, the number of backups in the catalog is not limited.
  - Retention window, days: The number of days (24 hours) covered by backups.
    For example, if you specify 7, the catalog must always contain backups required for restoring the data for the last seven days, including today.
    To disable this limitation, specify 0. In this case, backups can be deleted from the catalog at any moment.
  - WAL depth, pcs.: The minimum number of backups on each timeline. Having backups on all timelines is required for point-in-time recovery (PITR).
    For example, if you specify 3, the catalog must always contain at least three backups on each timeline.
    To disable this limitation, specify 0. In this case, point-in-time recovery is not available.
  - Expired copies: The management policy for expired backups.
    Possible values:
    Merge: Merge expired backups with new ones if possible.
    Delete: Delete expired backups from the catalog.
    You can enable all checkboxes simultaneously.
  Retention redundancy, pcs, Retention window, days, and WAL depth, pcs are applied only if you enable Merge and/or Delete in Expired copies.
  The values of Retention redundancy, pcs. and Retention window, days are considered simultaneously when deleting expired backups from the catalog.
  For example, if you enter 3 in Retention redundancy, pcs. and 7 in Retention window, days, a maximum of three full backups are saved, as well as all backups required for restoring the data for the past 7 days, including today.
  You can also configure storage parameters for an instance, as well as for a backup when creating it.
  The following priority is applied:
  - backup parameters are applied first
  - instance parameters are applied second
  - storage parameters are applied third
  For more information about storage parameters, refer to the official Postgres Pro documentation on pg_probackup.
Click Save.

Creating an S3 Storage

In the navigation panel, go to Backup → Backup storages, and then select S3 storages.
In the top-right corner of the page, click Create backup storage.
Select S3 storage, and then click Next.
Enter parameters of the new S3 storage (parameters marked with an asterisk are required):
- Storage name.
- Type: The provider of the S3 storage.
  Possible values:
  - AWS
  - Minio
  - VK
- Host: The server where the commands for interactions between the manager and S3 storage will be executed.
- Server name: The network address of the S3 storage server.
- Protocol https: Specifies whether the HTTPS is used for interactions between the manager and S3 storage.
- Port: The number of the port for connecting the manager to the S3 storage.
- Access Key ID and Secret access key: The secure keys for connecting the manager to the S3 storage.
- Bucket: The name of the bucket on the S3 storage server where backups will be located.
- Region: The region where the S3 storage server is located.
- Catalog of copies: The path to the bucket catalog where backups will be located.
- Instance: The instance that will be bound to the S3 storage. When an instance is bound to a storage, a catalog for this instance’s backups is created in the storage.
  You cannot bind an instance to the same storage twice. If an instance is bound for the second time, it is unbound from the previous storage.
- Storage parameters: The backup storage parameters of the storage catalog created for the instance.
  Available parameters:
  - Retention redundancy, pcs.: The maximum number of full backups.
    For example, if you specify 3, the catalog can contain a maximum of three full backups.
    To disable this limitation, specify 0. In this case, the number of backups in the catalog is not limited.
  - Retention window, days: The number of days (24 hours) covered by backups.
    For example, if you specify 7, the catalog must always contain backups required for restoring the data for the last seven days, including today.
    To disable this limitation, specify 0. In this case, backups can be deleted from the catalog at any moment.
  - WAL depth, pcs.: The minimum number of backups on each timeline. Having backups on all timelines is required for point-in-time recovery (PITR).
    For example, if you specify 3, the catalog must always contain at least three backups on each timeline.
    To disable this limitation, specify 0. In this case, point-in-time recovery is not available.
  - Expired copies: The management policy for expired backups.
    Possible values:
    Merge: Merge expired backups with new ones if possible.
    Delete: Delete expired backups from the catalog.
    You can enable all checkboxes simultaneously.
  Retention redundancy, pcs, Retention window, days, and WAL depth, pcs are applied only if you enable Merge and/or Delete in Expired copies.
  The values of Retention redundancy, pcs. and Retention window, days are considered simultaneously when deleting expired backups from the catalog.
  For example, if you enter 3 in Retention redundancy, pcs. and 7 in Retention window, days, a maximum of three full backups are saved, as well as all backups required for restoring the data for the past 7 days, including today.
  You can also configure storage parameters for an instance, as well as for a backup when creating it.
  The following priority is applied:
  - backup parameters are applied first
  - instance parameters are applied second
  - storage parameters are applied third
  For more information about storage parameters, refer to the official Postgres Pro documentation on pg_probackup.
Click Save.

Viewing Storages

To view storages, in the navigation panel, go to Backup → Backup storages.

To view S3 storages, select S3 storages.

The table of storages with the following columns will be displayed:

Name.
Instance: The instance where the catalog of the local storage is located.
This column is only displayed on the Local tab.
Catalog of copies: The path to the catalog where backups are located.
This column is only displayed on the Local tab.
Parameters:
- Type: The provider of the S3 storage.
  Possible values:
  - AWS
  - Minio
  - VK
- Host: The server where the commands for interactions between the manager and S3 storage are executed.
- Port: The number of the port for connecting the manager to the S3 storage.
- Bucket: The name of the bucket on the S3 storage server where backups are located.
- Region: The region where the S3 storage server is located.
This column is only displayed on the S3 storages tab.
Retention redundancy, pcs.: The maximum number of full backups in a storage.
Retention window, days: The number of days (24 hours) covered by backups in the storage.
WAL depth, pcs.: The minimum number of backups on each timeline in a storage. Having backups on all timelines is required for point-in-time recovery (PITR).
Expired copies: The management policy for expired backups.
Possible values:
- Disabled: Do not perform any actions with expired backups.
- Merge: Merge expired backups with new ones if possible.
- Delete: Delete expired backups from the catalog.
All values except Disabled can be displayed simultaneously.

Editing a Storage

In the navigation panel, go to Backup → Backup storages.
To edit an S3 storage, select S3 storages.
Click next to the storage.
Edit storage parameters.
Click Save.

Deleting a Storage

In the navigation panel, go to Backup → Backup storages.
To delete an S3 storage, select S3 storages.
Click next to the storage.
Select one of the following values:
- Remove from repository only: Delete the storage from the repository and web application.
  When the agent is restarted on the server, the storage is automatically recreated in the web application.
- Recursive removing of all backups and storage: Delete the storage and its catalog from the repository, web application, and server.
  Important
  If you select this value, the deleted storage cannot be restored.
Confirm the operation and click Delete.

5.28.2. Instance Binds #

This section explains how to manage instance binds. It includes the following instructions:

Before performing these instructions, create a storage.

Binding an Instance to a Storage

You cannot bind an instance to the same storage twice. If an instance is bound for the second time, it is unbound from the previous storage.

To bind an instance to a storage:

In the navigation panel, go to Backup → Backup storages.
To view instance binds to an S3 storage, select S3 storages.
Click the name of the storage.
In the top-right corner of the page, click Bind instance.
The following storage parameters will be displayed:
- Local storage or S3 storage: The unique name of the storage.
- Catalog: The path to the storage catalog where backups are placed.
- System user: The operating system user that owns the storage catalog.
Enter parameters of the new instance bind (parameters marked with an asterisk are required):
- Identifier: The unique name of the instance bind.
- Instance: The instance that will be bound to the storage.
- Storage parameters: The backup storage parameters of the storage catalog created for the instance.
  Available parameters:
  - Retention redundancy, pcs.: The maximum number of full backups.
    For example, if you specify 3, the catalog can contain a maximum of three full backups.
    To disable this limitation, specify 0. In this case, the number of backups in the catalog is not limited.
  - Retention window, days: The number of days (24 hours) covered by backups.
    For example, if you specify 7, the catalog must always contain backups required for restoring the data for the last seven days, including today.
    To disable this limitation, specify 0. In this case, backups can be deleted from the catalog at any moment.
  - WAL depth, pcs.: The minimum number of backups on each timeline. Having backups on all timelines is required for point-in-time recovery (PITR).
    For example, if you specify 3, the catalog must always contain at least three backups on each timeline.
    To disable this limitation, specify 0. In this case, point-in-time recovery is not available.
  - Expired copies: The management policy for expired backups.
    Possible values:
    Merge: Merge expired backups with new ones if possible.
    Delete: Delete expired backups from the catalog.
    You can enable all checkboxes simultaneously.
  Retention redundancy, pcs, Retention window, days, and WAL depth, pcs are applied only if you enable Merge and/or Delete in Expired copies.
  The values of Retention redundancy, pcs. and Retention window, days are considered simultaneously when deleting expired backups from the catalog.
  For example, if you enter 3 in Retention redundancy, pcs. and 7 in Retention window, days, a maximum of three full backups are saved, as well as all backups required for restoring the data for the past 7 days, including today.
  You can also configure storage parameters for a backup when creating it, as well as for a storage when creating or editing it.
  The following priority is applied:
  - backup parameters are applied first
  - instance parameters are applied second
  - storage parameters are applied third
  For more information about storage parameters, refer to the official Postgres Pro documentation on pg_probackup.
Click Save.

Viewing Instance Binds

In the navigation panel, go to Backup → Backup storages.
To view instance binds to an S3 storage, select S3 storages.
Click the name of the storage.

The table of instance binds with the following columns will be displayed:

Binding name.
Instance: The bound instance.
Retention redundancy, pcs.: The maximum number of full backups in a storage.
Retention window, days: The number of days (24 hours) covered by backups in the storage.
WAL depth, pcs.: The minimum number of backups on each timeline in a storage. Having backups on all timelines is required for point-in-time recovery (PITR).
Actions.
For more information about available actions, refer to other instructions in this section.

The following storage parameters are displayed at the top of the table of instance binds:

When viewing instance binds to a local storage:
- Catalog: The path to the local storage catalog where backups are located.
- System user: The operating system user that owns the local storage catalog.
When viewing binds to an S3 storage:
- Provider: The provider of the S3 storage.
- Region: The region where the S3 storage server is located.
- Protocol: The protocol used for interactions between the manager and S3 storage.
- Host: The server where the commands for interactions between the manager and S3 storage are executed.
- Port: The number of the port for connecting the manager to the S3 storage.
- Catalog: The path to the bucket catalog where backups are located.
- Bucket: The name of the bucket on the S3 storage server where backups are located.

Editing an Instance Bind

You cannot bind an instance to the same storage twice. If an instance is bound for the second time, it is unbound from the previous storage.

To edit an instance bind:

In the navigation panel, go to Backup → Backup storages.
To view instance binds to an S3 storage, select S3 storages.
Click the name of the storage.
Click next to the instance bind.
Edit instance bind parameters.
Click Save.

Deleting an Instance Bind

Important

Deleted instance binds cannot be restored.

To delete an instance bind:

In the navigation panel, go to Backup → Backup storages.
To view instance binds to an S3 storage, select S3 storages.
Click the name of the storage.
Click next to the instance bind.
Confirm the operation and click Delete.

5.28.3. Backups #

This section explains how to manage backups. It includes the following instructions:

Creating a Backup

Go to backups in one of the following ways:
- Using the backup section:
  In the navigation panel, go to Backup.
- Using the configuration section of the specified instance:
  1. In the navigation panel, go to Infrastructure → Instances.
  2. Click the name of the instance.
  3. In the navigation panel, go to Backup.
In the top-right corner of the page, click Create backup.
Enter parameters of the new backup (parameters marked with an asterisk are required):
- Instance: The instance for which the backup will be created.
  The value is entered automatically when creating a backup using the table of backups of the specified instance.
- Copy storage: The storage where the backup will be located.
  You can select a local or S3 storage. The local storage must be located on the same server as the instance for which you are creating the backup.
- User and Password: The name and password of the DBMS user under which the backup will be performed.
- Database: The database for connecting to the instance.
- Backup mode: The backup creation mode.
  Possible values:
  - full
  - page
  - ptrack
  - delta
  For more information about backup modes, refer to the official Postgres Pro documentation on pg_probackup.
- Threads count: The number of parallel threads that will be started at backup creation.
- Waiting time (sec): The waiting timeout in seconds for WAL segment archiving and streaming.
- Create a stand-alone backup: Specifies whether to create a streaming backup that includes the WAL records required for restoring the instance later.
- Replication slot: The replication slot that will be used for transferring WAL records.
- Create temporary replication slot: Specifies whether to create a temporary replication slot for transferring WAL records of the instance for which you are creating the backup.
  If you enable this checkbox, WAL segments are available even when they are switched at backup creation.
Click Next, and then specify additional parameters if required:
- External catalogs: The path to the instance catalog that will also be included in the backup.
- include log catalog: Specifies whether the backup includes the catalog with the instance activity logs.
- Don’t check copy: Specifies whether to skip the automatic verification of the created backup.
  If you enable this checkbox, the backup is created faster.
- Smooth execution of the checkpoint: Specifies whether backup creation starts only after the scheduled checkpoint.
- Disable block-level verification: Specifies whether to disable the block-level checksum verification for faster consistency checking at backup creation.
- Compression level: The file compression level at backup creation.
  You can enter a value from 0 to 9, where 0 disables file compression, and 9 enables the highest file compression level.
- Compression algorithm: The algorithm used for compressing files.
  Possible values:
  - zlib
  - lz4
  - zstd
  - pglz
  This parameter is available only if you enter a value greater than 0 in Compression level.
- Pinning: The pinning parameters of the backup.
  Possible values:
  - Do not pin: Do not pin the backup.
    If you select this value, the parameters specified in Parameters of storing are used.
  - ttl: After the backup is created, it cannot be deleted from a storage during the specified number of days.
    For this value, in Retention period, days, enter the number of days.
  - expire-time: The backup cannot be deleted from a storage until the specified date and time.
    For this value, in Retention period until, specify the date and time.
- Storage parameters: The backup storage parameters of the storage catalog created for the instance.
  Available parameters:
  - Retention redundancy: The maximum number of full backups.
    For example, if you specify 3, the catalog can contain a maximum of three full backups.
    To disable this limitation, specify 0. In this case, the number of backups in the catalog is not limited.
  - Retention window: The number of days (24 hours) covered by backups.
    For example, if you specify 7, the catalog must always contain backups required for restoring the data for the last seven days, including today.
    To disable this limitation, specify 0. In this case, backups can be deleted from the catalog at any moment.
  - WAL depth: The minimum number of backups on each timeline. Having backups on all timelines is required for point-in-time recovery (PITR).
    For example, if you specify 3, the catalog must always contain at least three backups on each timeline.
    To disable this limitation, specify 0. In this case, point-in-time recovery is not available.
  - Expired copies: The management policy for expired backups.
    Possible values:
    Merge: Merge expired backups with new ones if possible.
    Delete: Delete expired backups from the catalog.
    Remove expired WAL: Delete WAL of expired backups from the catalog.
    You can enable all checkboxes simultaneously.
  Retention redundancy, Retention window, and WAL depth are applied only if you enable Merge and/or Delete in Expired copies.
  The values of Retention redundancy and Retention window are considered simultaneously when deleting expired backups from the catalog.
  For example, if you enter 3 in Retention redundancy and 7 in Retention window, a maximum of three full backups are saved, as well as all backups required for restoring the data for the past 7 days, including today.
  You can also configure storage parameters for an instance, as well as for a storage when creating or editing it.
  The following priority is applied:
  - backup parameters are applied first
  - instance parameters are applied second
  - storage parameters are applied third
  For more information about storage parameters, refer to the official Postgres Pro documentation on pg_probackup.
Click Execute backup.

Viewing Backups

Go to backups in one of the following ways:

Using the backup section:
In the navigation panel, go to Backup.
Using the configuration section of the specified instance:
1. In the navigation panel, go to Infrastructure → Instances.
2. Click the name of the instance.
3. In the navigation panel, go to Backup.

The table of backups with the following columns will be displayed:

Size.
This column includes additional information:
ID: The ID of the backup in pg_probackup.
Mode: The backup creation mode.
Possible values:
- FULL
- DELTA
- PAGE
- PTRACK
For more information about backup modes, refer to the official Postgres Pro documentation on pg_probackup.
Storage: The storage where the backup is located.
Instance: The instance for which the backup is created.
Status.
Possible values:
- REQUESTED: Backup creation was requested.
- SCHEDULED: The backup creation was scheduled.
- RUNNING: The backup is being created.
- DONE: The backup was created successfully.
- DELETING_CANCEL: Backup deletion was canceled.
- DELETING: The backup is being deleted.
- VALIDATING: The backup consistency check is being performed.
- VALIDATED: The consistency check demonstrated that the backup was not damaged during storage.
- MERGING: An expired backup is being merged with a new one.
- MERGED: An expired backup was successfully merged with a new one.
- ERROR: An error occurred during backup.
  This status is also displayed if the consistency check showed that the backup was damaged during storage.
Started at and Finished at: The start and end date of backup creation.
User: The user that created the backup.
Validation status: The status of the backup consistency check.
Possible values:
- validated: The consistency check of the backup was performed successfully.
- validating: The backup consistency check is being performed.
Start of validation and End of validation: The start and end date and time of the backup consistency check.
Actions.
For more information about available actions, refer to other instructions in this section.

Checking the Consistency of a Backup

The consistency check ensures that a backup was not damaged during storage.

To check the consistency of a backup:

Go to backups in one of the following ways:
- Using the backup section:
  In the navigation panel, go to Backup.
- Using the configuration section of the specified instance:
  1. In the navigation panel, go to Infrastructure → Instances.
  2. Click the name of the instance.
  3. In the navigation panel, go to Backup.
Click next to the backup.

You can view the result of the consistency check in the Status column of the table of backups:

If the backup was damaged during storage, the ERROR value will be displayed.
If the backup was not damaged during storage, the VALIDATED value will be displayed.

Viewing the Log of a Backup

The backup log provides information about the backup creation progress.

To view the log of a backup:

Go to backups in one of the following ways:
- Using the backup section:
  In the navigation panel, go to Backup.
- Using the configuration section of the specified instance:
  1. In the navigation panel, go to Infrastructure → Instances.
  2. Click the name of the instance.
  3. In the navigation panel, go to Backup.
Click next to the backup.

Editing Pinning Parameters of a Backup

Go to backups in one of the following ways:
- Using the backup section:
  In the navigation panel, go to Backup.
- Using the configuration section of the specified instance:
  1. In the navigation panel, go to Infrastructure → Instances.
  2. Click the name of the instance.
  3. In the navigation panel, go to Backup.
Click → Edit pinning next to the backup.
Select one of the following values:
- Do not pin: Apply backup storage parameters.
- ttl: After the backup storage parameters are edited, the backup cannot be deleted during the specified number of days.
  For this value, in Retention period, days, enter the number of days.
- expire-time: The backup cannot be deleted until the specified date and time.
  For this value, in Retention period until, specify the date and time.
Click Save.

Creating an Instance from a Backup

Before performing this instruction, create a backup.

To create an instance from a backup:

Go to backups in one of the following ways:
- Using the backup section:
  In the navigation panel, go to Backup.
- Using the configuration section of the specified instance:
  1. In the navigation panel, go to Infrastructure → Instances.
  2. Click the name of the instance.
  3. In the navigation panel, go to Backup.
Click → Restore next to the backup.
Enter parameters of the new instance (parameters marked with an asterisk are required):
- Name.
- Server: The server where the instance is installed.
- System user: The OS user who will own the instance files and catalogs and on behalf of which the instance service will run. In most cases, it is the postgres user.
  It is recommended to ensure that the specified user exists in the OS.
- Main data directory: The path to the server catalog where the main instance catalogs and files will be located.
- Connection address and Connection port: The network address and port number that the instance will use for receiving client connections.
- Tags: The tags that will be assigned to the instance.
- Backup: The backup from which the instance will be created.
  The value is entered automatically.
- Backup size: The size of the backup from which the instance will be created.
  The value is entered automatically.
- Restore point: The state to which the instance must be restored.
  Possible values:
  - —: Restore the instance to the last state covered by the backup.
  - Time: Restore the instance state to the specified date and time covered by the backup.
    For this value, in Time, specify the date and time.
  - LSN: Restore the instance to the state corresponding to the specified WAL LSN.
    For this value, in LSN, enter the WAL LSN.
  - Transaction: Restore the instance state to the specified transaction number.
    For this value, in Transaction, enter the transaction number.
  For Time, LSN, and Transaction, specify the following parameters:
  - Restore including the specified value: Specifies whether the instance state is restored including the specified value.
    For example, if you enter 123456 in Transaction and enable Restore including the specified value, the instance state is restored to the transaction 123456. If you do not enable Restore including the specified value, the instance state is restored to the 123455 transaction.
  - Action after restore: The action to perform on the server after restoring the instance to the state.
    Possible values:
    Pause after restore: Pause the creation of the instance from the backup.
    It allows ensuring that the correct state was restored for the instance before creating it.
    Promote after restore: Create the instance from the backup and start receiving client connections.
    Shutdown instance after restore: Create the instance from the backup, and then stop the server.
- Partial recovery: Specifies the instance databases that will be restored or excluded from the restoration process.
  Possible values:
  - Do not use: Restore all instance databases.
  - Exclude some databases: Exclude the specified databases from restoration.
  - Restore some databases: Restore the specified instance databases.
  For Exclude some databases and Restore some database, specify the unique name of the database using Databases, and then click Add database.
- Checking available space: Allows checking whether there is enough disk space on the server for creating the instance from the backup.
  To start the check, click Check.
Click Execute.

Deleting a Backup

Important

Deleted backups cannot be restored.

To delete a backup:

Go to backups in one of the following ways:
- Using the backup section:
  In the navigation panel, go to Backup.
- Using the configuration section of the specified instance:
  1. In the navigation panel, go to Infrastructure → Instances.
  2. Click the name of the instance.
  3. In the navigation panel, go to Backup.
Click → Delete next to the backup.
Click Delete.

5.28.4. Backup Schedules #

This section explains how to manage backup schedules. It includes the following instructions:

Creating a Backup Schedule

In the navigation panel, go to Backup → Schedule.
In the top-right corner of the page, click Create task.
Enter parameters of the new backup schedule (parameters marked with an asterisk are required):
- Name.
- Set cron-string execution: Allows specifying the time interval for creating backups in the crontab format.
  If you turn on this toggle, in Execution, enter the string.
- Task planning: The type of the backup schedule.
  Possible values:
  - Time-delayed: One backup will be created at the specified date and time.
  - On schedule: Backups will be created at the specified time interval.
    For this value, specify the following parameters:
    Interval: The unit of measurement of the time interval.
    Possible values:
    Minutes
    Hours
    Days
    Repeat every: The time interval for creating backups by minutes or hours.
    This parameter is available only if you select Minutes or Hours from Interval.
    Execution days: The days when backups will be created.
    Cron total line: The string in the crontab format that specifies the time interval for creating backups.
    The value is entered automatically.
  This parameter is available only if you turn off Set cron-string execution.
- Time: The date and/or time when the backup will be created.
  This parameter is available only if you select Time-delayed from Task planning or Days from Interval.
- Start and Repeat until: The start and end date and time for creating backups on schedule.
  These parameters are available only if you turn on Set cron-string execution or select On schedule from Task planning.
- Instance: The instance for which the backup will be created.
- Copy storage: The storage where the backup will be located.
  You can select a local or S3 storage. The local storage must be located on the same server as the instance for which you are creating the backup.
- User and Password: The name and password of the DBMS user under which the backup will be performed.
- Database: The database for connecting to the instance.
- Backup mode: The backup creation mode.
  Possible values:
  - full
  - page
  - ptrack
  - delta
  For more information about backup modes, refer to the official Postgres Pro documentation on pg_probackup.
- Threads count: The number of parallel threads that will be started at backup creation.
- Waiting time (sec): The waiting timeout in seconds for WAL segment archiving and streaming.
- Create a stand-alone backup: Specifies whether to create a streaming backup that includes the WAL records required for restoring the instance later.
- Replication slot: The replication slot that will be used for transferring WAL records.
- Create temporary replication slot: Specifies whether to create a temporary replication slot for transferring WAL records of the instance for which you are creating the backup.
  If you enable this checkbox, WAL segments are available even when they are switched at backup creation.
Click Next, and then specify additional parameters if required:
- External catalogs: The path to the instance catalog that will also be included in the backup.
- include log catalog: Specifies whether the backup includes the catalog with the instance activity logs.
- Don’t check copy: Specifies whether to skip the automatic verification of the created backup.
  If you enable this checkbox, the backup is created faster.
- Smooth execution of the checkpoint: Specifies whether backup creation starts only after the scheduled checkpoint.
- Disable block-level verification: Specifies whether to disable the block-level checksum verification for faster consistency checking at backup creation.
- Compression level: The file compression level at backup creation.
  You can enter a value from 0 to 9, where 0 disables file compression, and 9 enables the highest file compression level.
- Compression algorithm: The algorithm used for compressing files.
  Possible values:
  - zlib
  - lz4
  - zstd
  - pglz
  This parameter is available only if you enter a value greater than 0 in Compression level.
- Pinning: The pinning parameters of the backup.
  Possible values:
  - Do not pin: Do not pin the backup.
    If you select this value, the parameters specified in Parameters of storing are used.
  - ttl: After the backup is created, it cannot be deleted from a storage during the specified number of days.
    For this value, in Retention period, days, enter the number of days.
  - expire-time: The backup cannot be deleted from a storage until the specified date and time.
    For this value, in Retention period until, specify the date and time.
- Storage parameters: The backup storage parameters of the storage catalog created for the instance.
  Available parameters:
  - Retention redundancy: The maximum number of full backups.
    For example, if you specify 3, the catalog can contain a maximum of three full backups.
    To disable this limitation, specify 0. In this case, the number of backups in the catalog is not limited.
  - Retention window: The number of days (24 hours) covered by backups.
    For example, if you specify 7, the catalog must always contain backups required for restoring the data for the last seven days, including today.
    To disable this limitation, specify 0. In this case, backups can be deleted from the catalog at any moment.
  - WAL depth: The minimum number of backups on each timeline. Having backups on all timelines is required for point-in-time recovery (PITR).
    For example, if you specify 3, the catalog must always contain at least three backups on each timeline.
    To disable this limitation, specify 0. In this case, point-in-time recovery is not available.
  - Expired copies: The management policy for expired backups.
    Possible values:
    Merge: Merge expired backups with new ones if possible.
    Delete: Delete expired backups from the catalog.
    Remove expired WAL: Delete WAL of expired backups from the catalog.
    You can enable all checkboxes simultaneously.
  Retention redundancy, Retention window, and WAL depth are applied only if you enable Merge and/or Delete in Expired copies.
  The values of Retention redundancy and Retention window are considered simultaneously when deleting expired backups from the catalog.
  For example, if you enter 3 in Retention redundancy and 7 in Retention window, a maximum of three full backups are saved, as well as all backups required for restoring the data for the past 7 days, including today.
  You can also configure storage parameters for an instance, as well as for a storage when creating or editing it.
  The following priority is applied:
  - backup parameters are applied first
  - instance parameters are applied second
  - storage parameters are applied third
  For more information about storage parameters, refer to the official Postgres Pro documentation on pg_probackup.
Click Save.

Viewing Backup Schedules

In the navigation panel, go to Backup → Schedule.

The table of backup schedules with the following columns will be displayed:

Task: The unique name of the backup schedule.
Agent: The agent that creates backups.
This column includes additional information:
Instance: The instance for which backups will be created.
Storage: The storage where backups are located.
Compression: The file compression level at backup creation.
You can enter a value from 0 to 9, where 0 disables file compression, and 9 enables the highest file compression level.
Last execution: The date and time of the last backup creation.
Schedule: The string in the crontab format that specifies the time interval for creating backups.
User: The user that created the backup schedule.

Executing a Backup Schedule

You can manually execute a backup schedule to instantly start the backup creation.

To execute a backup schedule:

In the navigation panel, go to Backup → Schedule.
Click → Run next to the backup schedule.

Deactivating and Activating a Backup Schedule

You can deactivate a backup schedule to temporarily stop backup creation. Backup schedules are activated by default.

To deactivate or activate a backup schedule:

In the navigation panel, go to Backup → Schedule.
Click → Deactivate or Activate next to the backup schedule.

Deleting a Backup Schedule

Important

Deleted backup schedules cannot be restored.

When you delete a backup schedule, the associated backups are not deleted.

To delete a backup schedule:

In the navigation panel, go to Backup → Schedule.
Click → Delete next to the backup schedule.
Click Delete.

5.28.5. Configuring Backup Storage Parameters for an Instance #

In the navigation panel, go to Infrastructure → Instances.
Click the name of the instance.
In the navigation panel, go to Backup → Retention policy.
Click next to the storage.
Specify the backup storage parameters of the storage catalog created for the instance:
- Retention redundancy, pcs.: The maximum number of full backups.
  For example, if you specify 3, the catalog can contain a maximum of three full backups.
  To disable this limitation, specify 0. In this case, the number of backups in the catalog is not limited.
- Retention window, days: The number of days (24 hours) covered by backups.
  For example, if you specify 7, the catalog must always contain backups required for restoring the data for the last seven days, including today.
  To disable this limitation, specify 0. In this case, backups can be deleted from the catalog at any moment.
- WAL depth: The minimum number of backups on each timeline. Having backups on all timelines is required for point-in-time recovery (PITR).
  For example, if you specify 3, the catalog must always contain at least three backups on each timeline.
  To disable this limitation, specify 0. In this case, point-in-time recovery is not available.
- Expired copies: The management policy for expired backups.
  Possible values:
  - Merge: Merge expired backups with new ones if possible.
  - Delete: Delete expired backups from the catalog.
  You can enable all checkboxes simultaneously.
Retention redundancy, pcs, Retention window, days, and WAL depth, pcs are applied only if you enable Merge and/or Delete in Expired copies.
The values of Retention redundancy, pcs. and Retention window, days are considered simultaneously when deleting expired backups from the catalog.
For example, if you enter 3 for Retention redundancy, pcs. and 7 for Retention window, days, a maximum of three full backups are saved, as well as all backups required for restoring the data for the past 7 days, including today.
You can also configure storage parameters for a backup when creating it, as well as for a storage when creating or editing it.
The following priority is applied:
- backup parameters are applied first
- instance parameters are applied second
- storage parameters are applied third
For more information about storage parameters, refer to the official Postgres Pro documentation on pg_probackup.
Click Save.

Prev	Up	Next
5.27. Task Console	Home	5.29. Query Plan Visualization

epub pdf