Doc: enhance explanation about fail_over command and follow_master command.
authorTatsuo Ishii <ishii@sraoss.co.jp>
Sun, 24 Feb 2019 07:46:38 +0000 (16:46 +0900)
committerTatsuo Ishii <ishii@sraoss.co.jp>
Sun, 24 Feb 2019 07:46:38 +0000 (16:46 +0900)
Mention that there's complete examples of fail_over_command and
follow_master_command.

doc.ja/src/sgml/failover.sgml
doc/src/sgml/failover.sgml

index 6d13053a81162b1405e3e8241f503ea79ac31718..e1f3817fa5df81d09dc4994524748f4e8d7098e2 100644 (file)
          </para>
        </note>
 
+        <para>
+<!--
+         A complete failover_command example can be found
+         in <xref linkend="example-cluster">.
+-->
+failover_commandの完全な例が<xref linkend="example-cluster">にあります。
+        </para>
+
         <para>
 <!--
           This parameter can be changed by reloading the <productname>Pgpool-II</> configurations.
         </para>
         </note>
         <para>
-<!--
-          Typically <varname>follow_master_command</varname>> command is used to recover
-          the slave from the new primary by calling the pcp_recovery_node command.
+<!-- Typically <varname>follow_master_command</varname> command is
+          used to recover the slave from the new primary by calling
+          the pcp_recovery_node command.  In
+          the <varname>follow_master_command</varname>, it is
+          recommended to check whether
+          target <productname>PostgreSQL</productname> node is running
+          or not using pg_ctl since already stopped node usually has a
+          reason to be stopped: for example, it's broken by hardware
+          problems or administrator is maintaining the node.  If the
+          node is stopped, skip the node. If the node is running, stop
+          the node first and recovery it.  A
+          complete <varname>follow_master_command</varname> example
+          can be found in <xref linkend="example-cluster">.
 -->
 通常は、<varname>follow_master_command</varname>コマンドは<xref linkend="PCP-RECOVERY-NODE">コマンドを呼んで新しいプライマリからスレーブをリカバリするために使用します。
+<varname>follow_master_command</varname>中では、pg_ctlを使ってターゲットの<productname>PostgreSQL</productname>ノードが動いているかどうかを確認することをお勧めします。
+たとえば、そのノードはハードウェア障害で停止しているかも知れませんし、管理者が保守のために停止しているのかも知れません。
+ノードが停止している場合は、そのノードをスキップしてください。
+ノードが動いている場合は、まずそのノードを停止してからリカバリしてください。
+<varname>follow_master_command</varname>の完全な例は、<xref linkend="example-cluster">にあります。
         </para>
         <para>
 <!--
index 204abe5a7085f0522345cb5c13803a8fb4b4ef68..01cc0f56402ff48bbecca3f4ea7258a43210b669 100644 (file)
          </para>
        </note>
 
+        <para>
+         A complete failover_command example can be found
+         in <xref linkend="example-cluster">.
+        </para>
+
         <para>
           This parameter can be changed by reloading the <productname>Pgpool-II</> configurations.
         </para>
         <para>
           If <varname>follow_master_command</varname> is not empty, then after failover
           on the primary node gets completed in Master Slave mode with streaming replication,
-          <productname>Pgpool-II</productname> degenerates all nodes excepted the new primary
+          <productname>Pgpool-II</productname> degenerates all nodes except the new primary
           and starts new child processes to be ready again to accept connections from the clients.
           After this, <productname>Pgpool-II</productname> executes the command configured
           in the <varname>follow_master_command</varname> for each degenerated backend nodes.
         </para>
         </note>
         <para>
-          Typically <varname>follow_master_command</varname> command is used to recover
-          the slave from the new primary by calling the pcp_recovery_node command.
+          Typically <varname>follow_master_command</varname> command
+          is used to recover the slave from the new primary by calling
+          the pcp_recovery_node command.  In
+          the <varname>follow_master_command</varname>, it is
+          recommended to check whether
+          target <productname>PostgreSQL</productname> node is running
+          or not using pg_ctl since already stopped node usually has a
+          reason to be stopped: for example, it's broken by hardware
+          problems or administrator is maintaining the node.  If the
+          node is stopped, skip the node. If the node is running, stop
+          the node first and recovery it.  A
+          complete <varname>follow_master_command</varname> example
+          can be found in <xref linkend="example-cluster">.
         </para>
         <para>
           This parameter can be changed by reloading the <productname>Pgpool-II</> configurations.