github/repmgr
1
0
Fork 0
mirror of https://github.com/EnterpriseDB/repmgr.git synced 2026-03-26 00:26:30 +00:00
Code Issues Packages Projects Releases 1 Wiki Activity

doc: update repmgr.conf sample

Browse Source 
Convert recovery.conf references to generic configuration descriptions,
and fix spacing.
This commit is contained in:
Ian Barwick
2019-11-08 11:48:44 +09:00
parent c3aba173ea
commit ce85ba6df5
1 changed files with 29 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

57
repmgr.conf.sample
View File

@@ -21,7 +21,7 @@
# repmgr and repmgrd require the following items to be explicitly configured. # repmgr and repmgrd require the following items to be explicitly configured.
#node_id= # A unique integer greater than zero #node_id= # A unique integer greater than zero
#node_name='' # An arbitrary (but unique) string; we recommend #node_name='' # An arbitrary (but unique) string; we recommend
# using the server's hostname or another identifier # using the server's hostname or another identifier
# unambiguously associated with the server to avoid # unambiguously associated with the server to avoid
@@ -29,8 +29,8 @@
# node's current role, e.g. 'primary' or 'standby1', # node's current role, e.g. 'primary' or 'standby1',
# as roles can change and it will be confusing if # as roles can change and it will be confusing if
# the current primary is called 'standby1'. # the current primary is called 'standby1'.
# The string's maximum length is 63 characters and it should # The string's maximum length is 63 characters and it should
# contain only printable ASCII characters. # contain only printable ASCII characters.
#conninfo='' # Database connection information as a conninfo string. #conninfo='' # Database connection information as a conninfo string.
# All servers in the cluster must be able to connect to # All servers in the cluster must be able to connect to
@@ -77,7 +77,7 @@
#location='default' # An arbitrary string defining the location of the node; this #location='default' # An arbitrary string defining the location of the node; this
# is used during failover to check visibility of the # is used during failover to check visibility of the
# current primary node. For further details see: # current primary node. For further details see:
# https://repmgr.org/docs/current/repmgrd-network-split.html # https://repmgr.org/docs/current/repmgrd-network-split.html
#use_replication_slots=no # whether to use physical replication slots #use_replication_slots=no # whether to use physical replication slots
# NOTE: when using replication slots, # NOTE: when using replication slots,
@@ -160,12 +160,13 @@
#repmgr_bindir='' # Path to repmgr binary directory (location of the repmgr #repmgr_bindir='' # Path to repmgr binary directory (location of the repmgr
# binary. Only needed if the repmgr executable is not in # binary. Only needed if the repmgr executable is not in
# the system $PATH or the path defined in "pg_bindir". # the system $PATH or the path defined in "pg_bindir".
#use_primary_conninfo_password=false # explicitly set "password" in recovery.conf's #use_primary_conninfo_password=false # explicitly set "password" in "primary_conninfo"
# "primary_conninfo" parameter using the value contained # using the value contained in the environment variable
# in the environment variable PGPASSWORD # PGPASSWORD
#passfile='' # path to .pgpass file to include in "primary_conninfo" #passfile='' # path to .pgpass file to include in "primary_conninfo"
#------------------------------------------------------------------------------ #------------------------------------------------------------------------------
# external command options # external command options
#------------------------------------------------------------------------------ #------------------------------------------------------------------------------
@@ -179,7 +180,7 @@
# rsync_options=--archive --checksum --compress --progress --rsh="ssh -o \"StrictHostKeyChecking no\"" # rsync_options=--archive --checksum --compress --progress --rsh="ssh -o \"StrictHostKeyChecking no\""
# ssh_options=-o "StrictHostKeyChecking no" # ssh_options=-o "StrictHostKeyChecking no"
#pg_ctl_options='' # Options to append to "pg_ctl" #pg_ctl_options='' # Options to append to "pg_ctl"
#pg_basebackup_options='' # Options to append to "pg_basebackup" #pg_basebackup_options='' # Options to append to "pg_basebackup"
#rsync_options='' # Options to append to "rsync" #rsync_options='' # Options to append to "rsync"
ssh_options='-q -o ConnectTimeout=10' # Options to append to "ssh" ssh_options='-q -o ConnectTimeout=10' # Options to append to "ssh"
@@ -197,19 +198,19 @@ ssh_options='-q -o ConnectTimeout=10' # Options to append to "ssh"
# tablespace_mapping=/path/to/original/tablespace=/path/to/new/tablespace # tablespace_mapping=/path/to/original/tablespace=/path/to/new/tablespace
# restore_command = 'cp /path/to/archived/wals/%f %p' # restore_command = 'cp /path/to/archived/wals/%f %p'
#tablespace_mapping='' # Tablespaces can be remapped from one #tablespace_mapping='' # Tablespaces can be remapped from one
# file system location to another. This # file system location to another. This
# parameter can be provided multiple times. # parameter can be provided multiple times.
#restore_command='' # This will be placed in the recovery.conf file generated #restore_command='' # This will be included in the recovery configuration
# by repmgr. # generated by repmgr.
#archive_cleanup_command='' # This will be placed in the recovery.conf file generated #archive_cleanup_command='' # This will be included in the recovery configuration
# by repmgr. Note we recommend using Barman for managing # generated by repmgr. Note we recommend using Barman for
# WAL archives (see: https://www.pgbarman.org ) # managing WAL archives (see: https://www.pgbarman.org )
#recovery_min_apply_delay= # If provided, "recovery_min_apply_delay" in recovery.conf #recovery_min_apply_delay= # If provided, "recovery_min_apply_delay" will be set to
# will be set to this value (PostgreSQL 9.4 and later). # this value (PostgreSQL 9.4 and later).
#------------------------------------------------------------------------------ #------------------------------------------------------------------------------
@@ -296,8 +297,8 @@ ssh_options='-q -o ConnectTimeout=10' # Options to append to "ssh"
# (default: 100) # (default: 100)
#connection_check_type=ping # How to check availability of the upstream node; valid options: #connection_check_type=ping # How to check availability of the upstream node; valid options:
# 'ping': use PQping() to check if the node is accepting connections # 'ping': use PQping() to check if the node is accepting connections
# 'connection': execute a throwaway query on the current connection # 'connection': execute a throwaway query on the current connection
#reconnect_attempts=6 # Number of attempts which will be made to reconnect to an unreachable #reconnect_attempts=6 # Number of attempts which will be made to reconnect to an unreachable
# primary (or other upstream node) # primary (or other upstream node)
#reconnect_interval=10 # Interval between attempts to reconnect to an unreachable #reconnect_interval=10 # Interval between attempts to reconnect to an unreachable
@@ -318,8 +319,8 @@ ssh_options='-q -o ConnectTimeout=10' # Options to append to "ssh"
# for the the local node to restart and become ready to accept connections after # for the the local node to restart and become ready to accept connections after
# executing "follow_command" (defaults to the value set in "standby_reconnect_timeout") # executing "follow_command" (defaults to the value set in "standby_reconnect_timeout")
#monitoring_history=no # Whether to write monitoring data to the "montoring_history" table #monitoring_history=no # Whether to write monitoring data to the "montoring_history" table
#monitor_interval_secs=2 # Interval (in seconds) at which to write monitoring data #monitor_interval_secs=2 # Interval (in seconds) at which to write monitoring data
#degraded_monitoring_timeout=-1 # Interval (in seconds) after which repmgrd will terminate if the #degraded_monitoring_timeout=-1 # Interval (in seconds) after which repmgrd will terminate if the
# server(s) being monitored are no longer available. -1 (default) # server(s) being monitored are no longer available. -1 (default)
# disables the timeout completely. # disables the timeout completely.
@@ -348,7 +349,7 @@ ssh_options='-q -o ConnectTimeout=10' # Options to append to "ssh"
# an error, pause the specified amount of seconds before rerunning the election. # an error, pause the specified amount of seconds before rerunning the election.
# #
# The following items are relevant for repmgrd running on the primary, # The following items are relevant for repmgrd running on the primary,
# and will be ignored on non-primary nodes # and will be ignored on non-primary nodes
#child_nodes_check_interval=5 # Interval (in seconds) to check for attached child nodes (standbys) #child_nodes_check_interval=5 # Interval (in seconds) to check for attached child nodes (standbys)
#child_nodes_connected_min_count=-1 # Minimum number of child nodes which must remain connected, otherwise #child_nodes_connected_min_count=-1 # Minimum number of child nodes which must remain connected, otherwise
# disconnection command will be triggered # disconnection command will be triggered
@@ -373,7 +374,7 @@ ssh_options='-q -o ConnectTimeout=10' # Options to append to "ssh"
# NOTE: These commands must be runnable on remote nodes as well for switchover # NOTE: These commands must be runnable on remote nodes as well for switchover
# to function correctly. # to function correctly.
# #
# If you use sudo, the user repmgr runs as (usually 'postgres') must have # If you use sudo, the user repmgr runs as (usually 'postgres') must have
# passwordless sudo access to execute the command. # passwordless sudo access to execute the command.
# #
# For example, to use systemd, you can set # For example, to use systemd, you can set
@@ -386,8 +387,8 @@ ssh_options='-q -o ConnectTimeout=10' # Options to append to "ssh"
# # this is required when running sudo over ssh without -t: # # this is required when running sudo over ssh without -t:
# Defaults:postgres !requiretty # Defaults:postgres !requiretty
# postgres ALL = NOPASSWD: /usr/bin/systemctl stop postgresql-9.6, \ # postgres ALL = NOPASSWD: /usr/bin/systemctl stop postgresql-9.6, \
# /usr/bin/systemctl start postgresql-9.6, \ # /usr/bin/systemctl start postgresql-9.6, \
# /usr/bin/systemctl restart postgresql-9.6 # /usr/bin/systemctl restart postgresql-9.6
# #
# Debian/Ubuntu users: use "sudo pg_ctlcluster" to execute service control commands. # Debian/Ubuntu users: use "sudo pg_ctlcluster" to execute service control commands.
# #
@@ -414,7 +415,7 @@ ssh_options='-q -o ConnectTimeout=10' # Options to append to "ssh"
# Various warning/critical thresholds used by "repmgr node check". # Various warning/critical thresholds used by "repmgr node check".
#archive_ready_warning=16 # repmgr node check --archive-ready #archive_ready_warning=16 # repmgr node check --archive-ready
#archive_ready_critical=128 # #archive_ready_critical=128 #
# Numbers of files pending archiving via PostgreSQL's # Numbers of files pending archiving via PostgreSQL's
# "archive_command" configuration parameter. If # "archive_command" configuration parameter. If
@@ -439,8 +440,8 @@ ssh_options='-q -o ConnectTimeout=10' # Options to append to "ssh"
# BDR monitoring options # BDR monitoring options
#------------------------------------------------------------------------------ #------------------------------------------------------------------------------
#bdr_local_monitoring_only=false # Only monitor the local node; no checks will be #bdr_local_monitoring_only=false # Only monitor the local node; no checks will be
# performed on the other node # performed on the other node
#bdr_recovery_timeout # If a BDR node was offline and has become available #bdr_recovery_timeout # If a BDR node was offline and has become available
# maximum length of time in seconds to wait for the # maximum length of time in seconds to wait for the
# node to reconnect to the cluster # node to reconnect to the cluster