doc: consolidate descriptions of SSH connectivity requirements

This commit is contained in:
Ian Barwick
2018-10-31 10:11:13 +09:00
parent fdcc3850c8
commit b74129f363
2 changed files with 37 additions and 33 deletions

View File

@@ -7,6 +7,11 @@
<secondary>prerequisites</secondary> <secondary>prerequisites</secondary>
</indexterm> </indexterm>
<indexterm>
<primary>configuration</primary>
<secondary>ssh</secondary>
</indexterm>
<title>Prerequisites for configuration</title> <title>Prerequisites for configuration</title>
<para> <para>
Following software must be installed on both servers: Following software must be installed on both servers:
@@ -26,15 +31,36 @@
At network level, connections between the PostgreSQL port (default: <literal>5432</literal>) At network level, connections between the PostgreSQL port (default: <literal>5432</literal>)
must be possible between all nodes. must be possible between all nodes.
</para> </para>
<para> <para>
Optionally, if you want <application>repmgr</application> to copy PostgreSQL configuration Passwordless <command>SSH</command> connectivity between all servers in the replication cluster
files which are located outside the data directory (as is the case with e.g. is not required, but is necessary in the following cases:
<link linkend="packages-debian-ubuntu">Debian packages</link>) <itemizedlist>
when <link linkend="repmgr-standby-clone">cloning a standby</link>, or use &repmgr; to perform <listitem>
<link linkend="preparing-for-switchover">switchovers</link>, passwordless SSH connections are required <simpara>if you need &repmgr; to copy configuration files from outside the PostgreSQL
between all nodes. Additionally, for copying files outide the data directory, data directory (as is the case with e.g. <link linkend="packages-debian-ubuntu">Debian packages</link>);
<application>rsync</application> must be installed. in this case <command>rsync</command> must also be installed on all servers.
</simpara>
</listitem>
<listitem>
<simpara>to perform <link linkend="performing-switchover">switchover operations</link></simpara>
</listitem>
<listitem>
<simpara>
when executing <command><link linkend="repmgr-cluster-matrix">repmgr cluster matrix</link></command>
and <command><link linkend="repmgr-cluster-crosscheck">repmgr cluster crosscheck</link></command>
</simpara>
</listitem>
</itemizedlist>
</para> </para>
<tip>
<simpara>
Consider setting <varname>ConnectTimeout</varname> to a low value in your SSH configuration.
This will make it faster to detect any SSH connection errors.
</simpara>
</tip>
</sect1> </sect1>

View File

@@ -13,7 +13,7 @@
</para> </para>
<para> <para>
From version 4.0, repmgr is compatible with all PostgreSQL versions from 9.3, including PostgreSQL 10. From version 4.0, repmgr is compatible with all PostgreSQL versions from 9.3.
Note that some &repmgr; functionality is not available in PostgreSQL 9.3 and PostgreSQL 9.4. Note that some &repmgr; functionality is not available in PostgreSQL 9.3 and PostgreSQL 9.4.
</para> </para>
@@ -31,7 +31,7 @@
<para> <para>
&repmgr; must be installed on each server in the replication cluster. &repmgr; must be installed on each server in the replication cluster.
If installing repmgr from packages, the package version must match the PostgreSQL If installing repmgr from packages, the package version must match the PostgreSQL
version. If installing from source, repmgr must be compiled against the same version. If installing from source, &repmgr; must be compiled against the same
major version. major version.
</para> </para>
@@ -42,32 +42,10 @@
</para> </para>
<para> <para>
Passwordless <command>ssh</command> connectivity between all servers in the replication cluster See also <link linkend="configuration-prerequisites">Prerequisites for configuration</link>
is not required, but is necessary in the following cases: for information on networking requirements.
<itemizedlist>
<listitem>
<simpara>if you need &repmgr; to copy configuration files from outside the PostgreSQL
data directory (in which case <command>rsync</command> is also required)</simpara>
</listitem>
<listitem>
<simpara>to perform <link linkend="performing-switchover">switchover operations</link></simpara>
</listitem>
<listitem>
<simpara>
when executing <command><link linkend="repmgr-cluster-matrix">repmgr cluster matrix</link></command>
and <command><link linkend="repmgr-cluster-crosscheck">repmgr cluster crosscheck</link></command>
</simpara>
</listitem>
</itemizedlist>
</para> </para>
<tip>
<simpara>
Consider setting <varname>ConnectTimeout</varname> to a low value in your SSH configuration.
This will make it faster to detect any SSH connection errors.
</simpara>
</tip>
<tip> <tip>
<simpara> <simpara>
We recommend using a session multiplexer utility such as <command>screen</command> or We recommend using a session multiplexer utility such as <command>screen</command> or