git.rot13.org Git - pgpool-online-recovery/blob - README.md

   1 pgpool-online-recovery
   2 ======================
   3
   4 This simple project aims to automate and make easy the online recovery process of a failed pgpool's backend node in master/slave mode.
   5
   6 This version is work-in-progress using Centos7 and upstream packages. It doesn't require psmisc package, making Centos7 minimal installation sufficient for scripts to run, since it uses systemd to manage postgresql-9.6 installed in /var/lib/pgsql/9.6/data/
   7
   8 Hardware configuration is 3 nodes:
   9
  10 10.200.1.60 edozvola-pgpool
  11 10.200.1.61 edozvola-db-01
  12 10.200.1.62 edozvola-db-02
  13
  14 If installing on existing streaming replication you will need to tell pgpool where current master is with:
  15
  16 echo 0 > /tmp/postgres_master
  17
  18 You can also force re-check of nodes by removing status file and restarting pgool:
  19
  20 rm /var/log/pgpool_status
  21 systemctl restart pgpool
  22
  23 Deployment script ./t/0-init-cluster.sh assumes that machine from which it's run is 10.200.1.1 which is added
  24 in pg_hba.conf as authorized to be able to deploy cluster. You can run it with:
  25
  26 make init
  27
  28 This will destroy all databases on all nodes, archive logs, etc, so don't do this if you need your old data later.
  29
  30 Requirements
  31 ============
  32
  33 There are two requirements to these scripts to work.
  34
  35 * The first one is [pgpool-II](http://www.pgpool.net) (v3.6.5) available for [Centos7 from upstream](http://www.pgpool.net/yum/rpms/3.6/redhat/rhel-7-x86_64/pgpool-II-pg96-3.6.5-1pgdg.rhel7.x86_64.rpm).
  36 * The second one is obviously Postgres server (v9.6) also for [Centos7 from upstream](https://yum.postgresql.org/9.6/redhat/rhel-7-x86_64/pgdg-redhat96-9.6-3.noarch.rpm)
  37
  38 There are several tutorials about setting up pgpool2 and postgres servers with [Streaming Replication](http://wiki.postgresql.org/wiki/Streaming_Replication) and this readme is far to be a howto for configuring both of them.
  39
  40 Installation and configuration
  41 ==============================
  42 What about the given scripts and config files ?
  43
  44 **pgpool.conf** : This is a sample config file for pgpool that activates master/slave mode, loadbalancing, backends health check, failover, ...
  45
  46 **postgresql.conf.master** : A config file for postgres master node.
  47
  48 **postgresql.conf.slave** : A config file for postgres slave node.
  49
  50 **recovery.conf** : A config file used by postgres slave for streaming replication process.
  51
  52 **failover.sh** : This script will be executed automatically when a pgpool's backend node (postgres node) fails down. It'll switch the standby node (slave) to master (new master).
  53
  54 **online-recovery.sh** : This is the bash script which you'll execute manually in order to :
  55 * Reboot, sync and reattach slave node to pgpool if it fails.
  56 * Setup new master and new slave, sync and reattach them to pgpool if current master fails.
  57 This script will invoque remotely the script streaming-replication.sh (in the new slave node) to start the [online recovery process](http://www.postgresql.org/docs/8.1/static/backup-online.html) within the standby node.
  58 PS : When a node (master or slave) fails, pgpool still running and DBs remain available. Otherwise, pgpool will detach this node for data consistancy reasons.
  59
  60 **streaming-replication.sh** : This script can be executed manually to synchronize a slave node with a given master node (master name/ip must be passed as argument to streaming-replication.sh). Otherwise, this same script is triggred be online-recovery.sh via ssh during failback process.
  61
  62 Installation
  63 ------------
  64
  65 The installation steps are simple. You just need to copy provided bash scripts and config files as follow.
  66
  67 **In pgpool node** :
  68 * Copy pgpool.conf to /etc/pgpool-II/. This is an optional operation and in this case you have to edit the default pgpool.conf file in order to looks like the config file we provided.
  69 * Copy failover.sh into /etc/pgpool-II/ and online-recovery.sh to same directory or another directory that will be easily accessible.
  70
  71 **In the master and slave postgres nodes** :
  72 * Copy streaming-replication.sh script into /var/lib/pgsql/ (postgres homedir).
  73 * Copy postgresql.conf.master and postgresql.conf.slave files to /var/lib/pgsql/9.6/data/.
  74 * Finally copy recovery.conf into /var/lib/postgresql/9.1/main/.
  75
  76 PS : All similar old files must be backed up to be able to rollback in case of risk (e.g: cp -p /etc/pgpool-II/pgpool.conf /etc/pgpool-II/pgpool.conf.backup).
  77 Make sure that :
  78 - All scripts are executable and owned by the proper users.
  79 - /var/lib/pgsql/9.6/archive directory is created (used to archive WAL files). This folder must be owned by postgres user !
  80 - Do not forge to edit pg_hba.conf in each postgres server to allow access to cluster's nodes.
  81
  82 Not enough ! It remains only the configuration steps and we'll be done :)
  83
  84 Configuration
  85 -------------
  86
  87 To do, just follow these steps :
  88
  89 1- First of all make sure you have created a postgres user in pgpool node with SSH access to all Postgres nodes. All cluster's nodes have to be able to ssh each other. You can put "config" file with "StrictHostKeyChecking=no" option under .ssh/ directory of postgres user. This is a best practice (essencially when automating a bunch of operations) that allows postgres to ssh remote machine for the first time without prompting and validating Yes/No authorization question.
  90
  91 2- In Pgpool node set up pgpool.conf file for instance the parameters :
  92
  93         # Controls various backend behavior for instance master and slave(s).
  94         backend_hostname0='master.foo.bar'
  95         backend_port0 = 5432
  96         backend_weight0 = 1
  97         backend_data_directory0 = '/var/lib/postgres/9.1/main/'
  98         backend_flag0 = 'ALLOW_TO_FAILOVER'
  99         backend_hostname1='slave.foo.bar'
 100         backend_port1 = 5432
 101         backend_weight1 = 1
 102         backend_data_directory1 = '/var/lib/postgres/9.1/main/'
 103         backend_flag1 = 'ALLOW_TO_FAILOVER'
 104         # Pool size
 105         num_init_children = 32
 106         max_pool = 4
 107         # Master/Slave and load balancing (replication mode must be off)
 108         load_balance_mode = on
 109         master_slave_mode = on
 110         master_slave_sub_mode = 'stream'
 111         #Health check (must be set up to detecte postgres server status up/down)
 112         health_check_period = 30
 113         health_check_user = 'postgres'
 114         health_check_password = 'postgrespass'
 115         # - Special commands -
 116         follow_master_command = 'echo %M > /tmp/postgres_master'
 117         # Failover command
 118         failover_command = '/path/to/failover.sh %d %H %P /tmp/trigger_file'
 119
 120 3- In failover.sh script, specify the proper ssh private key to postgres user to access new master  node via SSH.
 121
 122         ssh -i /var/lib/postgresql/.ssh/id_rsa postgres@$new_master "touch $trigger_file"
 123
 124 4- Idem for online-recovery.sh you have juste to change if needed the postgres's private key, the rest of params is set automatically when the script runs. Magic hein ! :)
 125
 126 5- Change the primary_conninfo access parameters (to master) in recovery.conf file in slave side :
 127
 128         primary_conninfo = 'host=master-or-slave.foo.bar port=5432 user=postgres password=nopass'
 129
 130 6- Rename recovery.conf to recovery.done in master side.
 131
 132 7- Setup postgres master node (after backup of postgresql.conf) :
 133
 134         cp -p postgresql.conf.master postgresql.conf
 135         /etc/init.d/postgresql restart
 136
 137 8- Setup postgres slave node (after backup of postgresql.conf) :
 138
 139         cp -p postgresql.conf.slave postgresql.conf
 140
 141 9- Start first slave synchronisation with master by executing streaming-replication.sh as postgres user :
 142
 143         su postgres
 144         cd ~
 145         ./streaming-replication.sh master.foo.bar
 146
 147 10- Restart pgpool :
 148
 149         /etc/init.d/pgpool2 restart
 150
 151 At his stage slave node is connected to master and both of them are connected to pgpool. If the master fails down, pgpool detach it from the pool and perform failover process (slave become master) automatically.
 152
 153 Tests
 154 =====
 155
 156 Test PCP interface (as root) :
 157
 158         #retrieves the node information
 159         pcp_node_info 10 localhost 9898 postgres "postgres-pass" "postgres-id"
 160         #detaches a node from pgpool
 161         pcp_detach_node 10 localhost 9898 postgres "postgres-pass" "postgres-id"
 162         #attaches a node to pgpool
 163         pcp_attach_node 10 localhost 9898 postgres "postgres-pass" "postgres-id"
 164
 165 After starting pgpool, try to test this two scenarios :
 166
 167 **1. When a slave fails down** :
 168
 169 Open pgpool log file 'journalctl -u pgpool -f'
 170
 171 Stop slave node 'sudo systemctl stop postgresql-9.6'
 172
 173 After exceeding health_check_period, you should see this log message :
 174
 175         [INFO] Slave node is down. Failover not triggred !
 176
 177 Now, start slave failback process (as root) :
 178
 179         # ./online-recovery.sh
 180
 181 **2. When a master fails down** :
 182
 183 Idem, open pgpool log file.
 184
 185 Stop master node '/etc/init.d/postgres stop'.
 186
 187 After exceeding health_check_period, you should see this log message :
 188
 189         [INFO] Master node is down. Performing failover...
 190
 191 Start failback process (as root) to switch master(new slave) and slave(new master) roles :
 192
 193         # ./online-recovery.sh