Request a Demo
21.1. Installation in the Minimal Environment
Prev UpChapter 21. Installation ProcedureHome Next

21.1. Installation in the Minimal Environment #

21.1.1. Meeting Prerequisites
21.1.2. Installing the Additional Software
21.1.3. Adding the Package Repository
21.1.4. Installing the Manager
21.1.5. Accessing the PPEM Web Application
21.1.6. Installing the Agent
21.1.7. Verifying the Installation

21.1.1. Meeting Prerequisites #

Ensure that the following prerequisites are met:

Table 21.1. Prerequisites

Prerequisite

Host for manager

Host for agent

Platform

Any platform that is compatible with the x86_64 (AMD64) architecture.

It can be either a physical server, a virtual machine, or a container that can be accessed in privileged mode.

Host resources

2 CPU cores, 4 GB RAM, 40 GB SSD (or higher)

2 CPU cores, 2 GB RAM, 20 GB SSD (or higher)

Operating system

Any of:

  • Alt Linux 10/11/SP 8.2/SP 8.4/SP 10

  • Astra Linux Smolensk 1.7/1.8

  • Red OS 7.3/8.2

  • ROSA 2021.1

  • Debian 11/12

  • Red Hat Enterprise Linux 8/9

  • SUSE Linux Enterprise Server 15

  • Ubuntu 20.04/22.04/24.04

Software

(Optional) Additional software must be installed to enable more PPEM features, such as logging, monitoring, and metrics collection.

Internet access

The host must have Internet access to reach the Postgres Pro package repositories.

Privileged user

  • Ability to connect to the host on behalf of the root user or any other user who can use sudo.

  • Ability to connect to the DBMS on the host on behalf of the superuser (typically the postgres user).


For more information about hardware and software requirements, refer to Chapter 4.

21.1.2. Installing the Additional Software #

Note

This is an optional step.

Skip it if you do not need the PPEM features listed below.

PPEM requires the additional software to be installed on the hosts with DBMS and agents for the following PPEM features to operate:

This software is automatically detected by the agent installed on the host, and the related features are enabled automatically.

21.1.3. Adding the Package Repository #

On both the manager and agent hosts, add the Postgres Pro package repository:

  1. Get the access key for the repository:

    1. Open your personal account in the technical support portal.

    2. Go to Administration → License Set → Repositories.

    3. Locate and copy the access key.

      Access keys are available only to license set administrators.

  2. Download the pgpro-repo-add.sh Bash script: 

    wget --user 'access_key' --password='access_key_value' https://repo.postgrespro.com/ppem/ppem/keys/pgpro-repo-add.sh

    This script adds the Postgres Pro repository so that the package manager of the host operating system can use it.

    Pass the following credentials to wget:

    • --user: access_key

    • --password: the access key from the technical support portal

  3. (Optional) Examine the content of the script, if necessary.

  4. Make the script file executable and run it: 

    
chmod +x pgpro-repo-add.sh && ./pgpro-repo-add.sh

    The script will install the Postgres Pro GPG keys, add the repository, and configure the package manager.

  5. When prompted, enter the same access credentials as above:

    • access_key as the user name

    • The access key from the technical support portal as the password

    Important

    If no credentials are provided or they are invalid, the script offers to add the repository without credentials.

    If you proceed without credentials, you must manually provide the credentials later in order to access the repository.

21.1.4. Installing the Manager #

On the manager host:

  1. Add the Postgres Pro package repository, if not added yet.

  2. Install the ppem and ppem-gui binary packages using the package manager of the operating system.

  3. Create the PPEM repository database:

    1. On behalf of the DBMS superuser (e.g., postgres), create the ppem user who will own the repository database. Use the --pwprompt option only if you want to set a password for this user: 

      sudo -u postgres createuser --pwprompt ppem

      If you used --pwprompt, enter a password for the ppem user when prompted.

    2. On behalf of the DBMS superuser (e.g., postgres), create the repository database with the ppem user as its owner: 

      sudo -u postgres createdb -O ppem ppem

    3. Verify that the database owner can connect to the ppem repository database: 

      sudo -u ppem psql

      The psql prompt must be displayed, indicating the successful connection.

      If the DBMS is installed with non-default settings, you may need to adjust the authentication parameters.

      For more information, refer to the Connections and Authentication and Client Authentication sections of the official Postgres Pro documentation.

  4. Specify the access credentials for the repository database in the manager configuration file: 

    repo:
  url: "postgres:///ppem?user=ppem&password=ppem_user_password"

    Where ppem_user_password is the password set at step 3a.

    Usually the configuration is located in the /etc/ppem-manager.yml file.

    If you cannot locate the configuration file, try to locate or recreate it using the package manager.

  5. Enable and start the manager service: 

    systemctl enable --now ppem

  6. Verify that the services are running correctly: 

    systemctl status ppem

Note

If another initialization system is used, adjust the relevant commands as needed.

21.1.5. Accessing the PPEM Web Application #

The agent requires an API key to interact with the manager.

Access the PPEM web application to obtain the key:

  1. In a web browser, go to the following URL: 

    http://PPEM_manager_host_address:8080/

  2. On the authorization page, enter the default admin username and admin password, then click Log in.

  3. In the navigation panel, go to Summary.

  4. The agent installation instruction will be displayed on the page. Copy the key from the instruction.

  5. If the agent installation instruction was accidentally closed:

    1. In the navigation panel, go to Infrastructure → Agents.

    2. In the Authentication key column next to any agent, click Copy the key to copy the key.

21.1.6. Installing the Agent #

For a DBMS to be managed by PPEM, the agent must be installed on the DBMS host.

For the sake of simplicity, it is assumed in the quick start guide that the agent will operate on behalf of the postgres DBMS superuser, without the need to explicitly grant privileges to a dedicated agent user.

Warning

Use this approach only for evaluating and testing purposes.

In production environments, create a separate agent user and grant a minimal set of privileges to it.

To install the agent on the DBMS host:

  1. Add the Postgres Pro package repository, if not already added.

  2. Install the ppem-agent binary package using the package manager of the operating system.

  3. In the /etc/ppem-agent.yml agent configuration file, specify values for the following parameters:

    • agent.manager.api_key: The previously obtained API key for connecting the agent to the manager.

    • agent.manager.url: The URL for connecting the agent to the manager.

      Example: http://ppem.example.com:8080/v1.

    • agent.instance.connection_defaults: The credentials of the superuser (typically postgres) of the DBMS that PPEM will manage.

      The password parameter is optional. Use it only if you want to set a password for the DBMS connection.

    If necessary, use the sample agent configuration file as a reference.

  4. Enable and start the agent service: 

    systemctl enable --now ppem-agent

  5. Ensure that the service is up and running: 

    systemctl status ppem-agent

Note

If another init system is in use, correct the related commands as necessary.

21.1.7. Verifying the Installation #

After completing the steps described in the previous sections, verify the installation:

  1. Log in to the PPEM web application as described in Section 21.1.5.

  2. In the navigation panel, go to Infrastructure → Instances.

  3. Verify that your Postgres Pro instance appears in the list of managed database instances.

You have successfully installed PPEM in a minimal environment. The database instance can now be managed through the web application.

Prev Up Next
Chapter 21. Installation Procedure Home Part IV. Installation and Setup
epub pdf