Skip to main content
Version Next

Backup Management Service Installation

PgSmart integrates with pgBackRest, a component from the PostgreSQL ecosystem, to perform backup and restore operations.

Prerequisites

  • PgSmart CLI must be installed after meeting the minimum requirements.

  • Additional package repository to resolve indirect dependencies. According to each organization's security and support policies, Tecnisys does not provide these packages. For Enterprise Linux family distributions, the Extra Packages for Enterprise Linux - EPEL repository generally provides the necessary indirect dependencies.

  • The PgSmart Agent service must be started on all database nodes.

    Terminal input
        systemctl start pgsmart-agent

  • Log in through the local PgSmart user. For example:

    Terminal input
        su - pgsmart

  • PgSmart Agent Registration via the PgSmart-Client.

Command Syntax

To install the Backup service, use one of the following commands:

Terminal input
    pgsmart install -s backup [Flags]
Terminal input
    pgsmart install --service=backup [Flags]

Flags​

  • -M, --pg-version=11–17 => Defines the PostgreSQL major version to install. The latest available release will be used.
  • -a, --agent=<agent> => Defines the alias, hostname, or IP address where a PgSmart Agent is installed.
  • -h, --help => Displays the help.
  • -q, --quiet => Non-interactive execution for service installation. Used together with --service, --pg-version, and --agent.
  • -s, --service=backup => Backup Services of the PostgreSYS Platform.
Non-Interactive Installation

This installation mode is activated by the quiet option (--quiet, -q) and uses default values for parameters not specified. However, this option is disabled during the first installation due to the need to create the PostgreSYS package repository based on interactively requested information.

Terminal input
    pgsmart install -a <agent> -q --service=backup
Figure 1 - Backup Installation - Non-Interactive
Figure 1 - Backup Installation - Non-Interactive
Interactive Installation
Terminal input
  pgsmart install
  1. Select the PgSmart Agent (or Register a new Agent).
  2. Select Gerenciamento de Backups.
  3. Select the PostgreSQL Major Version.
  4. Select the Release of the selected PostgreSQL major version.
note

PostgreSQL binaries will be installed along with the selected components.

  1. Confirm the installation.

  2. Confirm whether to install/update the PostgreSYS Package Repository.

    6.1 If yes, select Provide and enter:

    • Repository URL.

    • Identification code.

    • Repository name.

    • Repository user (optional if different from Tecnisys standard).

    • Repository password (optional if different from Tecnisys standard).

    • Confirm whether to activate GPG key verification.

      • If so, provide the path to the GPG key file.

        note
        • For a local installation, don't forget to download and import the public GPG key of the repositories (RPM-GPG-KEY-PGSYS).

        For example, for RHEL 8 distributions, access:

        File path
        https://repo.tecnisys.com.br/repository/yum/pgsys/repos/4.0.0/rhel-8-x86_64/RPM-GPG-KEY-PGSYS
        • The compressed installation packages (tar.gz) already include the GPG public key.
        Figure 2 - Backup Installation - Interactive
        Figure 2 - Backup Installation - Interactive

Command Variations for Interactive Installation​

Some parameters can be pre-passed in the command line; however, without the quiet option (--quiet, -q), execution remains interactive, and these parameters are used as default values in the prompts.

Terminal input
    pgsmart install --service=backup
Terminal input
    pgsmart install --pg-version=15
Final Notes
note

PgSmart defines environment variables (PGDATA, PGBIN, among others) in the current user's bash_profile, which will be loaded in new sessions. Run the following command to apply them immediately:

Terminal input
    source ~/.bash_profile