mirror of
https://github.com/EnterpriseDB/repmgr.git
synced 2026-03-25 16:16:29 +00:00
Add default makefile target. Document building
with PGXS. Convert README to be a .rst file, and make it and INSTALL valid ReST markup in advance of merging the two.
This commit is contained in:
Greg Smith
153
INSTALL
153
INSTALL
@@ -1,72 +1,128 @@
|
||||
======
|
||||
repmgr
|
||||
======
|
||||
|
||||
To install repmgr and repmgrd follow this steps:
|
||||
Installation Steps
|
||||
==================
|
||||
|
||||
1) Extract the distribution tar file into the contrib directory of the
|
||||
PostgreSQL distribution sources
|
||||
2) Check your primary server is correctly configured
|
||||
3) Write a suitable repmgr.conf for the node
|
||||
4) Build repmgr programs
|
||||
5) Set up trusted copy between postgres accounts (this is only useful for the
|
||||
STANDBY CLONE case)
|
||||
6) repmgrd additional steps
|
||||
To install repmgr and repmgrd follow these steps:
|
||||
|
||||
1. Build repmgr programs
|
||||
|
||||
Extract the distribution tar file
|
||||
=================================
|
||||
cp repmgr.tar.gz ${postgresql_sources}/contrib/.
|
||||
cd ${postgresql_sources}/contrib
|
||||
tar xvzf repmgr-1.0.tar.gz
|
||||
2. Check your primary server is correctly configured
|
||||
|
||||
3. Write a suitable repmgr.conf for the node
|
||||
|
||||
4. Set up trusted copy between postgres accounts (this is only useful for
|
||||
the ``STANDBY CLONE`` case)
|
||||
|
||||
5. repmgrd additional steps
|
||||
|
||||
Build repmgr programs
|
||||
---------------------
|
||||
|
||||
Both methods of installation will place the binaries at the same location as your
|
||||
postgres binaries, such as ``psql``. There are two ways to build it. The second
|
||||
requires a full PostgreSQL source code tree to install the program directly into.
|
||||
The first instead uses the PostgreSQL Extension System (PGXS) to install. For
|
||||
this method to work, you will need the pg_config program available in your PATH.
|
||||
In some distributions of PostgreSQL, this requires installing a separate
|
||||
development package in addition to the basic server software. For example,
|
||||
the RPM packages of PostgreSQL put ``pg_config`` into the ``postgresql-devel``
|
||||
package, not the main server one.
|
||||
|
||||
Build repmgr programs - PGXS
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
If you are using a packaged PostgreSQL build and have ``pg_config``
|
||||
available, the package can be built and installed using PGXS instead::
|
||||
|
||||
tar xvzf repmgr-1.0.tar.gz
|
||||
cd repmgr
|
||||
make USE_PGXS=1
|
||||
make USE_PGXS=1 install
|
||||
|
||||
This is preferred to building from the ``contrib`` subdirectory of the main
|
||||
source code tree.
|
||||
|
||||
If you need to remove the source code temporary files from this directory,
|
||||
that can be done like this::
|
||||
|
||||
make USE_PGXS=1 clean
|
||||
|
||||
Using a full source code tree
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
In this method, the repmgr distribution is copied into the PostgreSQL source
|
||||
code tree, assumed to be at the ${postgresql_sources} for this example.
|
||||
The resulting subdirectory must be named ``contrib/repmgr``, without any
|
||||
version number::
|
||||
|
||||
cp repmgr.tar.gz ${postgresql_sources}/contrib
|
||||
cd ${postgresql_sources}/contrib
|
||||
tar xvzf repmgr-1.0.tar.gz
|
||||
cd repmgr
|
||||
make
|
||||
make install
|
||||
|
||||
If you need to remove the source code temporary files from this directory,
|
||||
that can be done like this::
|
||||
|
||||
make clean
|
||||
|
||||
Confirm software was built correctly
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
You should now find the repmgr programs available in the subdirectory where
|
||||
the rest of your PostgreSQL installation is at. You can confirm the software
|
||||
is available by checking its version::
|
||||
|
||||
repmgr --version
|
||||
repmgrd --version
|
||||
|
||||
Note that if you have a RPM install of PostgreSQL 9.0, the entire PostgreSQL
|
||||
binary directory will not be in your PATH by default. You may need to include
|
||||
the full path of the binary instead, such as::
|
||||
|
||||
/usr/pgsql-9.0/bin/repmgr --version
|
||||
/usr/pgsql-9.0/bin/repmgr --version
|
||||
|
||||
Check your primary server configuration
|
||||
=======================================
|
||||
---------------------------------------
|
||||
|
||||
PostgreSQL should have been previously built and installed on the system
|
||||
PostgreSQL should have been previously built and installed on the system. Here
|
||||
is a sample of changes to the postgresql.conf file::
|
||||
|
||||
postgresql.conf
|
||||
---------------
|
||||
listen_addresses='*'
|
||||
wal_level = 'hot_standby'
|
||||
archive_mode = on
|
||||
archive_command = 'cd .' # we can also use exit 0, anything that just do
|
||||
listen_addresses='*'
|
||||
wal_level = 'hot_standby'
|
||||
archive_mode = on
|
||||
archive_command = 'cd .' # we can also use exit 0, anything that just do
|
||||
# nothing
|
||||
max_wal_senders = 10
|
||||
wal_keep_segments = 5000 # 80 GB required on pg_xlog
|
||||
hot_standby = on
|
||||
max_wal_senders = 10
|
||||
wal_keep_segments = 5000 # 80 GB required on pg_xlog
|
||||
hot_standby = on
|
||||
|
||||
Also you need to add the machines that will participate in the cluster in
|
||||
pg_hba.conf.
|
||||
NOTE: Is preferred that you have a repmgr user and database and just give
|
||||
access to that user, also if you put a password to the user you need to create
|
||||
a .pgpass file
|
||||
ie:
|
||||
pg_hba.conf file. One possibility is to trust all connections from the
|
||||
replication users from all addresses, such as::
|
||||
|
||||
host repmgr repmgr 10.8.0.0/24 trust
|
||||
host replication all 10.8.0.0/24 trust
|
||||
host repmgr repmgr 10.8.0.0/24 trust
|
||||
host replication all 10.8.0.0/24 trust
|
||||
|
||||
It is preferred that you have a repmgr user and database and just give
|
||||
access to that user. If you give a password to the user, you need to create
|
||||
a .pgpass file for them as well to allow automatic login.
|
||||
|
||||
Write a suitable repmgr.conf
|
||||
============================
|
||||
----------------------------
|
||||
|
||||
It should have these three parameters:
|
||||
|
||||
1) cluster: A string (single quoted) that identify the cluster we are on
|
||||
2) node: An integer that identify our node in the cluster
|
||||
3) conninfo: A string (single quoted) that teach repmgr how to connect to this
|
||||
node
|
||||
1. cluster: A string (single quoted) that identify the cluster we are on
|
||||
|
||||
2. node: An integer that identify our node in the cluster
|
||||
|
||||
Build repmgr programs
|
||||
=====================
|
||||
|
||||
make repmgr
|
||||
make repmgrd
|
||||
|
||||
make install (this will put the binaries on the same location as your postgres
|
||||
binaries)
|
||||
|
||||
3. conninfo: A string (single quoted) that teach repmgr how to connect to this node
|
||||
|
||||
Set up trusted copy between postgres accounts
|
||||
---------------------------------------------
|
||||
@@ -76,7 +132,7 @@ to work, the postgres accounts on each system need to be able to access files
|
||||
on their partner node without a password.
|
||||
|
||||
First generate a ssh key, using an empty passphrase, and copy the resulting
|
||||
keys and a maching authorization file to a privledged user on the other system:
|
||||
keys and a maching authorization file to a privledged user on the other system::
|
||||
|
||||
[postgres@db1]$ ssh-keygen -t rsa
|
||||
Generating public/private rsa key pair.
|
||||
@@ -104,12 +160,11 @@ user's account::
|
||||
Now test that ssh in both directions works (you may have to accept some new
|
||||
known hosts in the process)
|
||||
|
||||
|
||||
repmgrd additional steps
|
||||
========================
|
||||
|
||||
To use the repmgrd (repmgr daemon) to monitor standby so we know how is going
|
||||
the replication and how far they are from primary, you need to execute the
|
||||
repmgr.sql script in the postgres database.
|
||||
``repmgr.sql`` script in the postgres database.
|
||||
|
||||
You also need to add a row for every node in the repl_node table
|
||||
|
||||
Reference in New Issue
Block a user