Manage configurations in ADBM

Daria Barysheva

Overview

In ADBM, a configuration means a set of options that are used to manage binary database backups. These options include schedules for different backup types, paths for saving backups, log levels, timeouts, compression settings, etc. ADBM supports several configuration versions. But there can be only one active version, which is marked as current in the user interface.

Possible operations with configurations are described below. All operations are performed on the Configuration tab. To open this tab, follow the steps:

  1. Open the Backup Manager page via the ADBCC web interface.

  2. In the table that is located in the Clusters section of the opened page, click the ADB cluster name.

    adbm cluster open
    Select the ADB cluster

  3. Select the Configuration tab.

    adbm config open
    The Configuration tab

Initially, there are no configurations. To start work with backups in ADBM, add the first configuration.

Add a new configuration

  1. Open the Configuration tab as described above.

  2. Fill in the parameters that are located in the General configuration, Timeout, Repository, and Compression sections. Mandatory parameters are highlighted in red. When filling the fields, pay attention to the following icons:

    • info error dark mode — indicates the fields with invalid data. To see the details, hover the mouse over the icon.

      adbm config error1
      Fields with invalid data

    • cron dark cron light — indicates the ability to edit the field value in the separate form that you can open by clicking the icon. Currently, this icon is shown in the fields that define the backup and cleanup schedules. Click the icon to open the Cron expression generator window where you can set a schedule by selecting seconds, minutes, hours, days, months, and years. The selected values are automatically transformed into the cron expression that will be used as the field value. You can see it in the top part of the window along with its description. To save the current expression and return to the main form, click Save.

      adbm config cron
      Cron expression generator
      General configuration
      Parameter Description Default value

      Number of full backups

      A maximum number of full backups. After this limit is reached, the oldest extra full backups will be removed during the next automatic or manual Cleanup action. For more details, see Cleanup

      3

      Number of differential backups

      A maximum number of differential backups. After this limit is reached, the oldest extra differential backups will be removed during the next automatic or manual Cleanup action. For more details, see Cleanup

      6

      Full Backup schedule

      A schedule for automatic creation of full backups. For more details, see Backup

      0 30 0 ? * SAT *

      Differential backup schedule

      A schedule for automatic creation of differential backups. For more details, see Backup

      0 30 0 ? * SUN,MON,TUE,WED,THU,FRI *

      Incremental backup schedule

      A schedule for automatic creation of incremental backups. For more details, see Backup

      0 30 12 * * ?

      Restore point creation schedule

      A schedule for automatic creation of restore points. For more details, see Create restore point

      0 0/15 * * * ?

      Cleanup schedule

      A schedule for deleting extra backups (see Number of full backups and Number of differential backups above) and backups with the failed and invalid statuses. For more details, see Cleanup

      0 0 20 * * ?

      File Log level

      A level for file logging.

      Possible values:

      • off — no logs;

      • error;

      • warn;

      • info;

      • detail;

      • debug;

      • trace.

      info

      Log path

      A path where log files are to be stored

      /home/gpadmin/gpAdminLogs

      Bundle size

      A target size for file bundles. A bundle means grouping single files into one file before the backup launch. It is not recommended to set the option too high because backup retries will need to redo the entire bundle.

      Possible units:

      • MB — megabytes;

      • GB — gigabytes.

      100 MB

      Bundle limit

      A limit for the files that are included in bundles (see Bundle size above). The files larger than this size are stored separately. Bundled files cannot be reused when a backup is resumed, so this option, in fact, controls the files that can be resumed.

      Possible units:

      • KB — kilobytes;

      • MB — megabytes;

      • GB — gigabytes.

      2 MB
      adbm config general
      The "General configuration" section
      Timeout
      Parameter Description Default value

      Database query timeout

      Sets the timeout for queries against the database including the backup start/stop functions which can take a significant amount of time. The timeout should be kept high unless you know that these functions will return quickly. The Database query timeout value should be less than the Protocol timeout value.

      Possible units:

      • ms

      • sec

      • min

      • hour

      • day

      30 min

      Protocol timeout

      Sets the timeout that the local or the remote process can wait for a new message to be received on the protocol layer. The timeout prevents processes from the indefinite waiting. The Protocol timeout value should be greater than the Database query timeout value.

      Possible units:

      • ms

      • sec

      • min

      • hour

      • day

      1830 sec

      I/O timeout

      A timeout that is used for connections and read/write operations. The entire read/write operation does not need to complete within this timeout but some progress should be made, even if it is only a single byte.

      Possible units:

      • ms

      • sec

      • min

      • hour

      1 min

      Job wait timeout

      A timeout for a lock capture at the cluster level before the job starts.

      Possible units:

      • sec

      • min

      15 min
      adbm config timeout
      The Timeout section
      Repository
      Parameter Description Default value

      Archive command

      The command that is to be executed when WAL (Write Ahead Log) files are transferred to the archive director. If you change the Archive command field value, then the ADB cluster is automatically restarted when the configuration is applied (to change the value of the archive_command GUC).

       
      The stanza configuration name prefix for segments that is used in the Archive command should be equal to the Stanza template value (see below): --stanza=<Stanza template>%c

      		 
      PGOPTIONS=\"-c gp_session_role=utility\" /usr/lib/gpdb/bin/pgbackrest --stanza=seg%c archive-push %p

      Archive timeout

      Sets maximum time to wait for each WAL segment (required for backup consistency) to reach the archive repository

      1

      Units

      A measurement unit for the Archive timeout parameter.

      Possible values:

      • ms

      • sec

      • min

      • hour

      • day

      min

      Stanza template

      A stanza configuration name prefix for segments. Should be equal to the prefix that is used in the Archive command value (see above): --stanza=<Stanza template>%c

      seg

      Repository type

      A repository type.

      Possible values:

      • posix

      • s3

      posix

      Exclude path

      Defines the paths and files that should be excluded from backups

      • pg_log/gp_era

      • backups

      • gpperfmon/data/

      • gpbackup_history.yaml

      Repository path

      The repository where backups and archived WAL segments are to be stored. The repository directory should be pre-created and available from Master and Segment hosts. You can use the NFS shared directory, which is connected to all cluster segments. Do not use local directories on segments if the mirroring is switched on — in that case the hosts with mirror segments won’t have the required stanzas

       — 
      adbm config repository
      The Repository section
      Compression
      Parameter Description Default value

      Compression type

      A compression type.

      Possible values:

      • none — no compression;

      • bz2;

      • gz;

      • lz4;

      • zst.

      gz

      Compression level

      A compression level. Possible values: 0 — 9

      0

      Max processes to use for compress/transfer

      The maximum number of processes to be used on every segment for compression/transferring

      1

      Buffer size

      A buffer size for I/O operations in the following format: <value><unit> (e.g. 1mb). Do not use a blank between the value and its unit.

      Possible units:

      • b — bytes;

      • kb — kilobytes;

      • mb — megabytes;

      • gb — gigabytes.

      1mb
      adbm config compression
      The Compression section

  3. Click Save. You can find this button both before and after the sections listed above.

    adbm config save
    Save the configuration

  4. As a result, the Apply backup config. Start action runs. This action, in turn, generates several child actions. You can see all of them on the Actions tab (for more details, see View actions in ADBM).

    Until all necessary actions are completed successfully, the configuration will have the Creating status.

    adbm config save1
    The configuration has the Creating status

  5. As a successful result of all actions, the configuration acquires the Current status. Along with status, the following information about the configuration is available:

    • The version number (starting with 1).

    • The user who created a configuration version.

    • The creation date in the DD/MM/YYYY format.

      adbm config save2
      The successful result

Edit a configuration

After you created the configuration, you cannot edit it. But it is possible to add a new configuration version based on one of the previously created. To do this, perform the following steps:

  1. Open the Configuration tab as described above.

  2. In the list of available configuration versions, click the version on base of which you want to create a new one. All parameters of the selected version are displayed under the list with available versions (in the read-only mode).

    NOTE

    You can create a configuration based on any previous version, not just the latest.
    adbm config edit
    Select a version

  3. Click Create new.

  4. Apply necessary changes to the parameters that are located in the General configuration, Timeout, Repository, and Compression sections. The parameters are the same as described above.

  5. Click Save to add a new configuration version. You can find this button both before and after the sections with parameters.

    adbm config edit2
    Save a new configuration version

  6. As a result, the Apply backup config. Start action runs. This action, in turn, generates several child actions. You can see all of them on the Actions tab (for more details, see View actions in ADBM).

  7. After all necessary actions are completed successfully, the new configuration version becomes available on the Configuration tab and has the Current status.

    NOTE

    • ADBM uses the latest configuration version you added.

    • Inactive configuration versions that have no related backups will be removed during the next automatic or manual Cleanup action.
    adbm config edit3
    The new configuration version
Found a mistake? Seleсt text and press Ctrl+Enter to report it