For the complete documentation index, see llms.txt. This page is also available as Markdown.

PostgreSQL

To create a new application for PostgreSQL database backup, go to the tab: Applications -> Instances

Then select the Create button. The Creating an Application Definition section will be displayed, which needs to be completed.

This is a description of how your script is going to be invoked - you need to specify:

  • Name - unique name of the application in the Storware Backup & Recovery system.

  • Choose Node Config - select which node should perform the task.

  • Backup policy - specify which backup policy should be used for this application.

  • Command execution configuration - select a prepared template for PostgreSQL backup or create a new one yourself.

In the SSH access subtab, complete the following fields:

  • Host - set the address of the host where the PostgreSQL instance exists.

  • Port - set the host port.

Next, select OS Credentials or create a new one and provide the following information:

  • Name - unique name of the OS Credentials.

  • User - indicate a user for SSH connection.

  • Password - enter the connection password.

  • SSH key path - alternatively, you can specify the SSH key path for authorization.

After saving the application configuration, define the following environment variables:

Environment Variables

Variable
Value
Description

VP_SQL_USER

string

PostgreSQL login username.

VP_SQL_COMPRESS

yes / no

Compresses the backup on the PostgreSQL server.

VP_SQL_PASSWORD

string

Password for the PostgreSQL database user.

VP_SQL_LOGFILE

string

Path on the PostgreSQL server for the backup job log file.

VP_SQL_DBLIST

string

Database names to back up. Separate multiple names with commas.

VP_SQL_STOREPATH

string

Path on the PostgreSQL server for the temporary backup file. Use this directory only for Storware Backup & Recovery, as it is cleaned after each backup.

VP_SQL_SCRIPTPATH

string

Path to the backup script on the PostgreSQL host. Copy the appropriate script from /opt/vprotect/server/scripts/application to the database host. Then specify its destination path here.

Note: After the new application is fully configured, save the changes and go to the Backup SLAs configuration.

Last updated