FAQ:NewInstancePostgreSQL

Generalties

In this chapter, we will consider that SQWareCentral has been installed on dbsqware@sqwarebox.

Limits of this section

This chapter only deals with adding a new instance to a base that is already configured and functional.
Use the portions that apply to your environment, and choose either the automatic or manual method as desired

General operating procedure for integrating a new PostgreSQL instance

There will potentially be one or two connection cases to handle.

• "local" for Unix machines (or those with Cygwin) where you'll be running PostgreSQL on the machine hosting the instance (SSH connection from dbsqware@sqwarebox).
• "remote" for cases where you don't have SSH access to the machine (Windows, RDS, etc.).

Classic steps:

• Setting up the environment

• Checking system prerequisites for the "local" part (bash + rsync)

• Manual tests

• Deployment of the instance

You will see that these steps can be handled one by one or in batches!

Integration of an PostgreSQL instance

Setting up the environment

General

Explanation of "DbAlias" (the unique dbSQWare key)

The dbSQWare key must be unique and consistent with what has been configured for the gvsqw_DbAlias variable in sqwpg_GlobalVar.cfg!
We'll use a variable, PG_SID, which has no value for PostgreSQL but will identify the instance in dbSQWare.
By convention, we often use MYS "_" APPLI "_" ENV.
Example: PG_THISAPPS_PRD or PG_THISOTHERAPPS_DEV ...
But nothing is imposed; you choose what "suits you"! You just need to set the PG_SID variable in the MySQL account profile with the desired value.

Explanation of statuses

• An "open" instance will be handled in "local" mode, meaning we will connect with psql locally on the machine hosting the instance (ssh access from dbsqware@sqwarebox), status "ON".
  
• An instance where we don’t have local unix access will be managed in "remote" mode (like Windows, RDS, ...), status "DIST".
  
• The "OFF" status makes the instance "disappear" from the web view.
  
• The "NEW" status is used as an intermediate status between the beginning and the end of setting up a new instance.
  
• All other statuses allow the instance to be displayed in the repository (especially "KEEP") but will not be taken into account by the automatic processes.
  

Resume of statuses :

Status	Description
ON	locale under Unix (the most common)
DIST	remote-only management
KEEP	temporary status, during maintenance for example or before complete deletion
NEW	temporary status, during configuration
OFF	visual removal of the instance (without deleting its configuration)
XXX	not supported...

Instance declaration in SQWareRepository with SQWareWeb

We will declare the new instance from the SQWareWeb administration interface.

Declare the new instance with the status "NEW" (Add or Duplicate).

Explanation of the fields :

Fields	Description
Db Alias	Unique key that identifies the instance in dbSQWare (no value for PostgreSQL ).
Dbms Name	Type of SGBD
Virtual Host	Virtual Host (same as Host if not clustered) .
Host Name	Hostname of the instance
User Name	User associated with the instance
Port	Listening port of the instance.
Comments	A brief description of what the instance hosts
Status	Instance status (see above for explanations).
Contact	A contact if needed
Environnement	Instance environment (PRD, PPR, REC, DEV, TST, ...)
Client	Used only for filtering (enter a client name and/or department and/or service...)
GlobalHost	Free field in which the hypervisor host is often entered, for example.
Custom1	Free field 1
Custom2	Free field 2

Regenerate the reference files of SQWareCentral.

Type the following command which will generate the reference files:

1 # From : dbsqware@sqwarebox
2 gen_all

Specific procedure for the "local" part (status ON)

/!\ Only instances that will be in the "ON" status !

Verification of system prerequisites for the "local" part (bash + rsync)

Since SQWareProduction is mainly written in bash shell and synchronized from SQWareCentral using rsync, we therefore need "bash" and "rsync" to be installed !

Verification

Adapt to your username and machine name.

bash:

1 # From : postgres@my_postgres_host
2 type bash
3 #or
4 which bash

rsync:

1 # From : postgres@my_postgres_host
2 type rsync
3 #or
4 which rsync

Installation

Adapt to your machine type (use sudo if you are not root).

RedHat / CentOS / ... :

1 # From : root@my_postgres_host
2 yum install -y bash rsync
3 #or
4 dnf install -y bash rsync

Ubuntu / Debian / ... :

1 # From : root@my_postgres_host
2 apt install -y bash rsync

Unix user modification

Adapt to your machine type (sudo if you're not root). Modify the homedir (not mandatory, but avoids ending up in /var/lib/postgresql):

1 # From : root@my_postgres_host
2 mkdir -p /home/postgres
3 chown postgres:postgres /home/postgres
4 chmod 750 /home/postgres

1. Or directly vi /etc/passwd !

example : postgres:x:1004:989::/home/postgres:/bin/bash </syntaxhighlight>

Assign a passwd to the postgres user (otherwise the key exchange connection will not work!):

1 # From : root@my_postgres_host
2 passwd postgres

Deployment of SSH key(s) from SQWareCentral to the target machine(s)

There are two ways to proceed:

• An automatic one (from dbsqware@sqwarebox, but it requires you to know the password of the postgres Unix account)
• A manual one that you apply on each postgres Unix account

/!\ The password of your postgres Unix account must have been initialized, otherwise key-based authentication will not work!

Deployment of SSH key(s): batch method

1 # From : dbsqware@sqwarebox
2 menu_pg GenDeplSshKeys_SQWareCentral GenLstInstanceNew

Verify that this is indeed the list you want to deploy, then choose option 1 ...
=> Enter the Unix password when prompted !

Deployment of SSH key(s): manual method

1 # From : postgres@my_postgres_host
2 if [ ! -r $HOME/.ssh/id_rsa ]
3 then
4 ssh-keygen -t rsa -N ''''''' -f $HOME/.ssh/id_rsa
5 fi
6 chmod go-w $HOME
7 echo "ssh-rsa AAAAB......XSPpdV11 dbsqware@sqwarebox" >>$HOME/.ssh/authorized_keys
8 chmod 700 $HOME/.ssh
9 chmod 600 $HOME/.ssh/authorized_keys

=> Put the correct key in the "echo" (the one from dbsqware@sqwarebox)

SSH connection test from SQWareCentral

1 # From : dbsqware@sqwarebox
2 menu_pg TestSshConnection GenLstInstanceNew

Test of prerequisites on the target host (bash+rsync) via SSH from SQWareCentral

1 # From : dbsqware@sqwarebox
2 menu_pg TestSysPrerequisites GenLstInstanceNew

Deployment of SQWareProduction

1 # From : dbsqware@sqwarebox
2 
3 #If deployment on "unique" user
4 menu_pg DeplScripts GenLstUniqueNew
5 
6 #If deployment on "instance" user, the one specified in SQWareRepository
7 menu_pg DeplScripts GenLstInstanceNew

For "unique" user, it is the "standard" user. By default, we set it to "postgres", and it can be modified in SQWareCentral.

Adding the dbSQWare environment to ~/.profile or ~/.bash_profile

Once again, there are two ways to proceed:

• An automatic one (from dbsqware@sqwarebox)
• A manual one that you apply on each postgres Unix account

Adding the dbSQWare environment: batch method

1 # From : dbsqware@sqwarebox
2 menu_pg AdddbSQWareProfile GenLstInstanceNew

Check that this is indeed the list you want to deploy, then choose 1 ...
=> In ~/.profile or ~/.bash_profile, change the following variable with the appropriate value: gvsqw_Env='XXX'

Adding the dbSQWare environment: manual method

Add the following lines to ~/.profile or ~/.bash_profile

 1 # From : postgres@my_postgres_host
 2 
 3 #dbSQWare
 4 export gvsqw_MysBin=$HOME/SQWareProduction/postgres/bin
 5 export gvsqw_Env='PRD'
 6 lvsqw_IsTerminal=$(tty 2>&1 >/dev/null;echo $?)
 7 if [ "$lvsqw_IsTerminal" = "0" ] && [ -r $gvsqw_MysBin/../etc/.profile_confort ]
 8 then
 9 . $gvsqw_MysBin/../etc/.profile_confort
10 fi

Adding the variable PG_SID

Add the PG_SID variable in the ~/.profile or ~/.bash_profile

1 # From : postgres@my_postgres_host
2 export PG_SID=PG_INST_PRD
3 export PGDATA=/pgdata/$PG_SID/data

Test sendmail (Non mandatory)

1 # From : dbsqware@sqwarebox
2 menu_pg TestSendmail GenLstInstanceNew

"Manual" connection test to the PostgreSQL instance ("local" connection)

/!\ Only instances that will be in "ON" status!

1 # From : dbsqware@sqwarebox
2 menu_pg TestInstConnectionOnNoMail GenLstInstanceNew

Specific Procedure for the "Remote" Port (DIST Status)

Creating a Specific PostgreSQL Account (dbSQWare) (For Remote Connections)

Adapt to your needs depending on what you want to do...

Example with superuser role psql

1 create user dbsdba password 'DoNotSetThisPassword!';
2 alter user dbsdba with superuser;

Example with just "read"

1. >= Version 10, 11, ...

psql

1 create user dbsdba password 'DoNotSetThisPassword!';
2 grant pg_monitor, pg_read_all_settings, pg_read_all_stats to dbsdba;

Example for an “RDS” env

1 create user dbsdba password 'Don'tPutThisPassword!';
2 grant rds_superuser to dbsdba;

Added the line to enable remote connection (PostgreSQL ACL, enter the created user and the IP address of the central point "sqwarebox")

1 postgres@srvdbpg01:/pgdata/PG_120/data (PG_120) $ vi pg_hba.conf
2 host all dbsdba 192.168.230.20/24 md5

Reloading the conf after modifying pg_hba.conf

1 #Reloading the pg_ctl conf (if $PGDATA is set)
2 pg_ctl reload
3 or
4 pg_ctl reload -D $PGDATA
5 
6 ##Reloading the conf with a psql connection
7 psql
8 select pg_reload_conf();

You can enter any username and password you like!
This account must be registered under the Unix account postgres@sqwarebox ...

1 postgres@sqwarebox:/home/postgres () $ cat .passwd_postgres
2 DbAlias;UserName;Passwd;HostName;Port
3 PG_120;dbsdba;myPassword;srvdbpg01;5432

Starting the Instance

Generating the Default SQWareProduction Configuration

/!\ Only instances that will be in "ON" status!

1 # From : dbsqware@sqwarebox
2 menu_pg GenDefConf_SQWareProduction GenLstInstanceNew

Update SQWare Repository

In the dbSQWare repository via the administration console, update the status of the new PostgreSQL instance (currently NEW) to the desired value (ON, DIST).

Testing the "Recovery" of Indicators

At this point, you can test the recovery of missing indicators (in principle, only the instances you have just integrated!).

1 # From : dbsqware@sqwarebox
2 ## for those with status "ON"
3 repind_mys
4 ## for those with status "DIST"
5 repind_mys_dist

Operation (stats, backups, etc.) for "ON" instances

Generating SQWareProduction configs

If you followed the instance insertion procedure, this part is already done by step "menu_pg GenDefConf_SQWareProduction GenLstInstanceNew".
You can check with the next chapter.

Connect to the machine that has the “PostgreSQL ” instance and type the following commands:

1 # From dbsqware@vmyswarebox
2 c PG_INST_PRD

1 #Source de l'env si multi-instance (from postgres@my_postgres_host)
2 e PG_INST_PRD

1 too
2 ./sqwpg_GenerateCreateInstance.ksh -dbsOnly

Vérifier que ce qui est proposé est bon et tapez « y » si c’est le cas.
A ce moment, vous avez généré les fichiers de configuration par défaut de SQWareProduction.

Explanations

The previous steps created some default files. ($HOME/PG_INST_PRD/sqwConfig)

1 #Enter the instance name
2 e PG_INST_PRD
3 cfg
4 cat sqwpg_Jobs.cfg

 1 #############################################
 2 #IndicDba: Gather DBAs indicators
 3 IndicDba:$gvsqw_MysBin/sqwpg_GatherIndicators.ksh -I PG_INST_PRD
 4 
 5 #Dump: backup all databases with postgresDump
 6 Dump:$gvsqw_MysBin/sqwpg_DumpAllDatabases.ksh -I PG_INST_PRD -Exec
 7 
 8 #Optimize : optimize tables for all databases
 9 Optimize:$gvsqw_MysBin/sqwpg_OptimizeAllDatabases.ksh -I PG_INST_PRD -Exec
10 
11 #Analyse : analyze tables for all databases
12 Analyze:$gvsqw_MysBin/sqwpg_AnalyzeAllDatabases.ksh -I PG_INST_PRD -Exec
13 
14 #XtraFull: Backup full with XtraBackup
15 XtraFull:$gvsqw_MysBin/sqwpg_XtraBackup.ksh -I PG_INST_PRD -Type full -Exec
16 
17 #XtraInc: Backup incremental with XtraBackup
18 XtraInc:$gvsqw_MysBin/sqwpg_XtraBackup.ksh -I PG_INST_PRD -Type inc -Exec
19 
20 #MariaFull: Backup full with MariaBackup
21 MariaFull:$gvsqw_MysBin/sqwpg_MariaBackup.ksh -I PG_INST_PRD -Type full -Exec
22 
23 #MariaInc: Backup incremental with MariaBackup
24 MariaInc:$gvsqw_MysBin/sqwpg_MariaBackup.ksh -I PG_INST_PRD -Type inc -Exec
25 
26 #PurgeAlert: Rotate error log
27 PurgeAlert:$gvsqw_MysBin/sqwpg_PurgeAlert.ksh -I PG_INST_PRD

This is a configuration file used by the sqwpg_RunJob.ksh script to execute actions.

File for a default cron job $HOME/CrontabRef_PG_INST_PRD:

 1 ## mm(0-59) hh(0-23) dd(1-31) MM(0-12) DAY(0-sunday, 1-monday, ...) command
 2 ## PG_INST_PRD
 3 #Purge alert
 4 00 08 * * 0 bash -c '. $HOME/.profile PG_INST_PRD;$gvsqw_MysBin/sqwpg_RunJob.ksh -I PG_INST_PRD -A PurgeAlert > $HOME/tmp/PurgeAlert_PG_INST_PRD.log 2>&1'
 5 # Dump
 6 00 20 * * * bash -c '. $HOME/.profile PG_INST_PRD;$gvsqw_MysBin/sqwpg_RunJob.ksh -I PG_INST_PRD -A Dump > $HOME/tmp/Dump_PG_INST_PRD.log 2>&1'
 7 # Optimize
 8 00 04 * * 6 bash -c '. $HOME/.profile PG_INST_PRD;$gvsqw_MysBin/sqwpg_RunJob.ksh -I PG_INST_PRD -A Optimize > $HOME/tmp/Optimize_PG_INST_PRD.log 2>&1'
 9 # Analyze
10 00 05 * * 6 bash -c '. $HOME/.profile PG_INST_PRD;$gvsqw_MysBin/sqwpg_RunJob.ksh -I PG_INST_PRD -A Analyze > $HOME/tmp/Analyze_PG_INST_PRD.log 2>&1'
11 # XtraBackup
12 #00 21 * * 6   bash -c '. $HOME/.profile PG_INST_PRD;$gvsqw_MysBin/sqwpg_RunJob.ksh -I PG_INST_PRD -A XtraFull > $HOME/tmp/XtraFull_PG_INST_PRD.log 2>&1'
13 #00 21 * * 1-5 bash -c '. $HOME/.profile PG_INST_PRD;$gvsqw_MysBin/sqwpg_RunJob.ksh -I PG_INST_PRD -A XtraInc > $HOME/tmp/XtraInc_PG_INST_PRD.log 2>&1'
14 # MariaBackup
15 #00 21 * * 6   bash -c '. $HOME/.profile PG_INST_PRD;$gvsqw_MysBin/sqwpg_RunJob.ksh -I PG_INST_PRD -A MariaFull > $HOME/tmp/MariaFull_PG_INST_PRD.log 2>&1'
16 #00 21 * * 1-5 bash -c '. $HOME/.profile PG_INST_PRD;$gvsqw_MysBin/sqwpg_RunJob.ksh -I PG_INST_PRD -A MariaInc > $HOME/tmp/MariaInc_PG_INST_PRD.log 2>&1'

Startup

Setting up cron:

1 mv $HOME/CrontabRef_PG_INST_PRD $HOME/CrontabRef
2 vi $HOME/CrontabRef
3 crontab $HOME/CrontabRef
4 crontab -l

Update the file CrontabRef  :

1 crontab -l > $HOME/CrontabRef
2 cat $HOME/CrontabRef

Useful commands

alias : e DBALIAS => source env for the instance bin, etc, too ... => to go to the standard SQWareProduction tree cbin, cetc, ctoo ... => to go to the custom SQWareProduction tree log => SQWareProduction logs dmp => go to the backup paths

Some script options: -h => online help -s => online examples -Exec => when present; if not set, only outputs commands without executing them.

Examples :

postgres@my_postgres_host:$HOME/admin/PG_INST_PRD/logs/DumpAllDatabases (MYS_DBA_PRD) $ bin
total 100
drwxr-x---  2 dbsqware dba 4096 Sep  6 14:09 .
drwxr-x--- 15 dbsqware dba  187 Aug 16 15:50 ..
-rwxr-x---  1 dbsqware dba 2957 Aug 16 15:50 sqwpg_AnalyzeAllDatabases.ksh
-rwxr-x---  1 dbsqware dba 2514 Aug 16 15:50 sqwpg_AnalyzeDatabase.ksh
-rwxr-x---  1 dbsqware dba 2608 Aug 16 15:50 sqwpg_CheckAllDatabases.ksh
-rwxr-x---  1 dbsqware dba 2257 Aug 16 15:50 sqwpg_CheckDatabase.ksh
-rwxr-x---  1 dbsqware dba 5418 Aug 16 15:50 sqwpg_CopyDumpAllDatabases.ksh
-rwxr-x---  1 dbsqware dba 5324 Aug 16 15:50 sqwpg_CopyDumpDatabase.ksh
-rwxr-x---  1 dbsqware dba 5610 Sep  6 10:45 sqwpg_CopyMariaBackup.ksh
-rwxr-x---  1 dbsqware dba 5594 Sep  6 14:08 sqwpg_CopyXtraBackup.ksh
-rwxr-x---  1 dbsqware dba 3248 Aug 16 15:50 sqwpg_DumpAllDatabases.ksh
-rwxr-x---  1 dbsqware dba 3541 Aug 16 15:50 sqwpg_DumpDatabase.ksh
lrwxrwxrwx  1 dbsqware dba   36 Jan  2  2022 sqwpg_ExecSQL.ksh -> ../../generic/bin/sqwgen_ExecSQL.ksh
-rwxr-x---  1 dbsqware dba 2455 Aug 16 15:50 sqwpg_GatherIndicators.ksh
-rwxr-x---  1 dbsqware dba 2454 Aug 16 15:50 sqwpg_GatherStructure.ksh
-rwxr-x---  1 dbsqware dba 3043 Aug 16 15:50 sqwpg_MariaBackup.ksh
lrwxrwxrwx  1 dbsqware dba   38 Jan  2  2022 sqwpg_NetBackup.ksh -> ../../generic/bin/sqwgen_NetBackup.ksh
-rwxr-x---  1 dbsqware dba 2959 Aug 16 15:50 sqwpg_OptimizeAllDatabases.ksh
-rwxr-x---  1 dbsqware dba 2522 Aug 16 15:50 sqwpg_OptimizeDatabase.ksh
lrwxrwxrwx  1 dbsqware dba   40 Jan  2  2022 sqwpg_ParallelRun.ksh -> ../../generic/bin/sqwgen_ParallelRun.ksh
-rwxr-x---  1 dbsqware dba 2252 Aug 16 15:50 sqwpg_PurgeAlert.ksh
-rwxr-x---  1 dbsqware dba 3855 Aug 16 15:50 sqwpg_RestoreAllDatabases.ksh
-rwxr-x---  1 dbsqware dba 3463 Aug 16 15:50 sqwpg_RestoreDatabase.ksh
-rwxr-x---  1 dbsqware dba 3825 Aug 16 15:50 sqwpg_RotateLogSlowQuery.ksh
lrwxrwxrwx  1 dbsqware dba   40 Jan  2  2022 sqwpg_RsyncBackup.ksh -> ../../generic/bin/sqwgen_RsyncBackup.ksh
lrwxrwxrwx  1 dbsqware dba   35 Jan  2  2022 sqwpg_RunJob.ksh -> ../../generic/bin/sqwgen_RunJob.ksh
-rwxr-x---  1 dbsqware dba 3025 Aug 16 15:50 sqwpg_XtraBackup.ksh

postgres@my_postgres_host:$HOME/SQWareProduction/postgres/bin (PG_INST_PRD) $ 
./sqwpg_DumpAllDatabases.ksh -h

Sourcing sqwpg_Global.lib v2023.06 SQWareProduction for MySQL (dbSQWare) ...

Usage: sqwpg_DumpAllDatabases.ksh [-h] -I instance [+ options]

DESCRIPTION
   sqwpg_DumpAllDatabases.ksh dump databases in parallel
SUPPORT
   MySql   supported versions: 5.0 <= v <= 8
   MariaDB supported versions: 5.5 <= v <= 11.6

PARAMETERS
     -I  instance       : Target instance to postgresdump.
OPTIONS
     -h  help           : Display the full usage.
     -s                 : Display samples of usage.
     -P  Nb threads     : Number of threads in parallel (by default 2).
     -RD directory      : Directory to write dump file (default /backups/postgres/$PG_SID).
     -ID listdb         : List of databases to be dumped (by default all).
     -ED listdb         : List of databases to exclude from dump.
     -IL likeclause     : Like clause to generate databases list (example: 'db%').
     -EL likeclause     : Like clause to exclude databases (example: 'nodb%').
     -HI Nb_Generations : Number of generations to keep (by default 2).
     -WCD  whereclause  : Where clause to generate databases list.
     -AGR  Nb sec       : Nb of seconds between two runs (by default 1s).
     -AGE  Nb sec       : Nb of seconds between two checks of end (by default 10s).
     -FRT  return_code  : Force return code value on error.
     -Opt  option       : Additional options for postgresdump.
     -Dist              : For distant connection to database (change $gvsqw_ConnectString to $gvsqw_DistConnectString ).
     -AddMail email     : Email address to add at 'xxx'.
     -SendReport        : Send execution log report.
     -NoMail            : Deactivate sendmail on error xxx (by default, send on error).
     -Locale   locale   : Force Locale for help display (fr,en).
     -Consistent        : Lock for consistent mode (by default, no lock).
     -Exec              : Execute commands (default, display generated commands)

Enjoy !