Configure External Database to Connect OpenG2P Environment

This document provides instructions to setup and install external database for OpenG2P environments.

Prerequisites

• Make sure you have the hardware required for the external database setup.

Installation and configuration

1. Log in to the external database node.

2. Install PostgreSQL using below commands.

   sudo apt update
   sudo apt install postgresql

3. After the installation of postgreSQL, use the below command to check the status.

   service postgresql status

4. Use the command below to log into the default postgres database using the default user, postgres, following a successful installation.

   sudo -u postgres psql

5. After you logged in, use the command below to confirm the database connection and details on the list of databases, users, and tables.

Command	Description

1. You should use the command below to set one for yourself, as the default postgres user does not have a password. \password postgres - to set the password, the password must have the combination of lowercase, uppercase, number. For example, xwfJhfI9tK Note : The password must not have the special characters @, #, or -.

2. After setting up the postgres password, the user must exit from the database and run the command below to perform some server-level configurations.

   1. Access the postgresql.conf file, locate the parameter below, uncomment it, set it to listen on all IP addresses, and configure it to increase the number of connections.

      vim /etc/postgresql/14/main/postgresql.conf
      listen_addresses = '*'
      max_connections = 500
      wal_level = logical
   2. Acess pg_hba.conf file and allow TCP/IP connections (host) to all databases (all) for all users (all) with any IPv4 address (0.0.0.0/0) using an scram-sha-256 encrypted password for authentication and save the file.

      vim /etc/postgresql/14/main/pg_hba.conf

      
   3. Restart PostgreSQL service to load configuration changes.

      sudo systemctl restart postgresql
   4. Make sure your system is listening to the 5432 port that is reserved for PostgreSQL.

      ss -nlt | grep 5432
3. Use the command below to log back into postgresdb now. Provide the postgres database, the password that you have configured.

   psql -U postgres -h localhost
4. Use the command below to create the socialregistry and ODK databases, use a random password in each command.

   CREATE ROLE socialregistryuser WITH LOGIN NOSUPERUSER CREATEDB CREATEROLE INHERIT REPLICATION CONNECTION LIMIT -1 PASSWORD '<**provide password**>';
   CREATE DATABASE socialregistrydb WITH OWNER = socialregistryuser TEMPLATE = template0 ENCODING = 'UTF8' TABLESPACE = pg_default CONNECTION LIMIT = -1;
   
   CREATE ROLE odkuser WITH LOGIN NOSUPERUSER CREATEDB CREATEROLE INHERIT REPLICATION CONNECTION LIMIT -1 PASSWORD '<**provide password**>';
   CREATE DATABASE odkdb WITH OWNER = odkuser TEMPLATE = template0 ENCODING = 'UTF8' TABLESPACE = pg_default CONNECTION LIMIT = -1;
5. Try onnecting to both the databases and verify.

   psql -U socialregistryuser -h localhost -d socialregistrydb
   psql -U odkuser -h localhost -d odkdb

Configure external databases while doing deployment from the Rancher UI.

1. Access the rancher-ui to start installing the SocialRegistry/PBMS and update the below parametes as shown below in the Edit YAML and install the services.

   1. Make the default postgresql enabled equals to false.

   2. Add the below parameters in the last section of postgresql.

      #Make the default postgresql enabled equals to false.
      postgresql:
        auth:
          database: socialregistrydb/pbmsdb
          username: socialregistryuser/pbmsuser
        enabled: false
      #Add the below parameters in the last section of default postgresql.
      externalDatabase:
        create: false
        database: socialregistrydb/pbmsdb
        host: <IP address of External DB>
        password: <password for DB>
        port: 5432
        user: socialregistryuser/pbmsuser
   3. Add the below parameters in the last section of ODK.

      odk-central:
        backend:
          envVars:
            DB_HOST: <IP address of External DB>
            DB_NAME: odkdb
            DB_USER: odkuser
            envVarsFrom:
              DB_PASSWORD: <password for ODK DB>
        postgresql:
          enabled: false
   4. Add the below parameters in the last section of reportingInit.

      envVars:
        DB_NAME: socialregistrydb/pbmsdb
        DB_HOSTNAME: `<IP address of External DB>`
        DB_USER: socialregistryuser/pbmsuser
      envVarsFrom:
        DB_PASS: `<password for SR DB>`
2. Make sure the SR and ODK connected to the external databases and verify the tables by logging into the external database.

3. And for more information on high availability PostgreSQL clusters setup, refer here.