Getting Started with PostgreSYS

This section will guide you quickly and objectively through the first steps of the PostgreSYS Platform deployment process in your database environment.

At the end, you will be able to access PgSmart Web, or PgSmart CLI, to install and configure the desired components.

We recommend reading the Overview section for a better understanding of the Platform Architecture.

PgSmart Agent Installation

The first step is to install the PgSmart Agent on all machines/servers you want to manage.

1. Download the installation package

   Terminal input

   wget --user=USUARIO --password=SENHA https://repo.tecnisys.com.br/yum/pgsys/pgsmart/4.0.0/rhel-8-x86_64/pgsmart-agent-4.0.0-1.el8.x86_64.rpm

2. Install the installation package

   Terminal input

   rpm -ivh pgsmart-agent-4.0.0-1.el8.x86_64.rpm

3. Start the service

   Terminal input

   systemctl enable --now pgsmart-agent

4. Get the connection key

   Terminal input

   cat /opt/pgsmart-agent/pgsmart.yml | grep connectionKey

note

For more details about the installation process, refer to PgSmart Agent Installation.

PgSmart CLI Installation

The next step is to install the PgSmart CLI on a client or utility machine to interact with the installed PgSmart Agent(s).

1. Download the installation package

   Terminal input

   wget --user=USUARIO --password=SENHA https://repo.tecnisys.com.br/yum/pgsys/pgsmart/4.0.0/rhel-8-x86_64/pgsmart-client-4.0.0-1.el8.x86_64.rpm

2. Install the installation package

   Terminal input

   rpm -ivh pgsmart-client-4.0.0-1.el8.x86_64.rpm

3. Register a PgSmart Agent

   Terminal input

   pgsmart config agent

   3.1. Select Agent Registration.

   3.2. Select Register and enter the PgSmart Agent data.

   3.3. Press <enter> to use the default hostname or IP of the machine where the PgSmart Agent is installed.

   3.4. Press <enter> to use the default port used by the PgSmart Agent or enter the desired port.

   3.5. Press <enter> to use the default alias (nickname) of the PgSmart Agent or enter the desired alias.

   3.6. Enter the connection key of the PgSmart Agent.

   3.7. Press <enter> to confirm the Agent Registration.

PgSmart Web Installation

PgSmart Web is the web interface for managing PostgreSYS Database Environments.

Some Platform features are only available through this interface. Its use is highly recommended.

1. Install PgSmart Web via PgSmart CLI

   Terminal input

   pgsmart install

   1.1. Press <enter> to select PostgreSYS Environment Administration and Operation.

   1.2. Using <space> and <enter>, select Metadata Database along with PgSmart Client (already selected by default).

   1.3. Press <enter> to proceed with the selection of PgSmart Web.

   1.4. Press <enter> to register the Tecnisys Repository (the Yes option is already selected).

   1.5. Enter the package repository address (<enter> to select the official Tecnisys repository).

   1.6. Enter your Username for accessing the package repository.

   1.7. Enter your Password for accessing the package repository.

   1.8. Press <enter> to confirm GPG key verification (the Yes option is already selected).

2. Access PgSmart Web through the browser

  https://<hostname-pgsmart-web>:4435

Docker Image

A quick and simple way to run the PgSmart client interfaces is through its Docker image.

With it, you will have PgSmart CLI and PgSmart Web available in a single container.

Follow the steps to import and run the container:

1. Log in to the official Tecnisys repository

   Terminal input

   docker login -u <seu email> repo.tecnisys.com.br

2. Download the Docker image of PgSmart clients

   Terminal input

   docker pull repo.tecnisys.com.br/pgsys/pgsmart-client:4.0.0

3. Run a container (mapping the access port to PgSmart Web)

   Terminal input

   docker run -p 4435:4435 -d pgsmart-client

4. Optionally, access the pgsmart CLI in the running container

   Terminal input

   docker exec -it <container-id> bash

5. Access PgSmart Web through the browser

  https://localhost:4435