58.3. Instance Binds #
Before performing instructions from this section, create a storage.
58.3.1. 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 → 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 backup catalog.
Specify 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 is bound to the storage.
Remote mode: Specifies whether to use the remote mode for the storage.
If you enable this toggle, specify the following parameters:
Remote server IP and Port: The IP address and port number of the remote server where the bound instance is installed.
User: The operating system user that owns files and catalogs of the bound instance and on behalf of which the instance service runs. In most cases, it is the
postgresuser.SSH parameters: SSH options.
In pg_probackup, these options are specified using the
--ssh-optionsremote option.To add an option, click Add, and then specify the option and its value.
You can add multiple options.
Storage parameters: Storage parameters of the backup catalog.
Available parameters:
Full backups, pcs.: The maximum number of full backups.
For example, if you enter
3, the catalog can contain a maximum of three full backups.To disable this limitation, enter
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 enter
7, the catalog must always contain backups required for restoring the data for the last seven days, including today.To disable this limitation, enter
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 enter
3, the catalog must always contain at least three backups on each timeline.To disable this limitation, enter
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.
Full backups, pcs, Retention window, days, and WAL depth, pcs are applied only if you enable Merge and/or Delete in Expired copies.
Values of Full backups, pcs. and Retention window, days are considered simultaneously when deleting expired backups from the catalog.
For example, if you enter
3in Full backups, pcs. and7in Retention window, days, a maximum of three full backups are saved, as well as all backups required for restoring the data for the past seven days, including today.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.
58.3.2. Viewing Instance Binds #
In the navigation panel, go to Backup → Storages.
To view instance binds to an S3 storage, select S3 storages.
Click the name of the storage.
The following storage parameters will be displayed at the top of the page:
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 backup catalog.
When viewing instance 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 commands for interactions between the manager and S3 storage are executed.
Port: The port number 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.
Below, the table of instance binds with the following columns will be displayed:
Bind name.
Instance: The instance that is bound to the storage. When an instance is bound to a storage, the backup catalog for this instance is created in the storage.
Full backups, pcs.: The maximum number of full backups.
Retention window, days: The number of days (24 hours) covered by backups.
WAL depth, pcs.: The minimum number of backups on each timeline. 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.
Actions.
For more information about available actions, refer to the corresponding instructions.
58.3.3. 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 → 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.
58.3.4. Deleting an Instance Bind #
Important
Deleted instance binds cannot be restored.
To delete an instance bind:
In the navigation panel, go to 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.