Doc: enhance "3.7. Temporarily Shutting Down PostgreSQL".
authorTatsuo Ishii <ishii@sraoss.co.jp>
Sat, 6 Feb 2021 11:42:35 +0000 (20:42 +0900)
committerTatsuo Ishii <ishii@sraoss.co.jp>
Sat, 6 Feb 2021 11:42:35 +0000 (20:42 +0900)
Explain that pcp_detach_node can immediate failover regardless
watchdog and health check settings. Also to enhance readability split
the chapter into two sections.

doc.ja/src/sgml/runtime.sgml
doc/src/sgml/runtime.sgml

index 866ad752b73d7188be1b46d4b79ed69c50c5cc4b..ea5bef36d2ae5c7808fe68cffa07ccf6dc536da7 100644 (file)
@@ -766,65 +766,77 @@ $ <userinput>pgpool -f /usr/local/etc/pgpool.conf -F /usr/local/etc/pcp.conf -m
 この節では最小限の停止時間でこの仕事を実行する方法を説明します。
   </para>
 
-  <para>
-<!--
-   Stopping or restarting <productname>PostgreSQL</productname>
-   causes failover. If the running mode is not streaming replication
-   mode, or the server is a standby server in streaming replication
-   mode, probably that's not a big deal because clients can always
-   use other servers in the cluster. However if the server is primary
-   server, it will cause change of primary server by promoting one of
-   the standby servers. Moreover if there's only one server remains
-   in the cluster, there are no alternative server or standby server
-   which can be promoted.
--->
-<productname>PostgreSQL</productname>を停止、再起動するとフェイルオーバが発生します。
-ストリーミングレプリケーションモードでない場合、あるいはストリーミングレプリケーションモードであってもサーバがスタンバイサーバであればあまり大きな問題にはなりませ
-ん。
-しかし、サーバがクラスタのプライマリサーバなら、スタンバイサーバの一つが昇格してしまいます。
-更には、クラスタに1台のサーバしか残っていなければ、昇格できるスタンバイサーバがないことになります。
-  </para>
-
-  <para>
-<!--
-   In this case you can use <xref linkend="guc-backend-flag"> to avoid
-   failover.  By setting below in pgpool.conf will avoid failover of
-   backend0.
--->
-この場合は<xref linkend="guc-backend-flag">を使ってフェイルオーバを避けることができます。
-以下のようにpgpool.confを設定すると、backend0のフェイルオーバが起こりません。
-   <programlisting>
-     backend_flag0 = DISALLOW_TO_FAILOVER
-    </programlisting>
-<!--
-   This will take effect by reloading or restarting
-   <productname>Pgpool-II</productname>. If this flag is set, failover
-   will not happen if the backend is not available. While the backend
-   is not available, clients wil get error message:
--->
-この設定は、<productname>Pgpool-II</productname>の再読込か再起動で有効になります。
-このフラグが設定されると、バックエンドが使用不可能になってもフェイルオーバが起きません。
-バックエンドが使用不可の間、クライアントは以下のエラーメッセージを受け取ります。
-   <programlisting>
-     psql: error: could not connect to server: FATAL:  failed to create a backend connection
-     DETAIL:  executing failover on backend
-   </programlisting>
-<!--
-   After restarting the backend, clients can connect as usual.
+  <sect2 id="using-pcp-detach-node">
+   <title>pcp_detach_nodeコマンドの活用</title>
+   <para>
+    <command>pg_ctl</command>で<productname>PostgreSQL</productname>を停止すると、<productname>Pgpool-II</productname>がそのことをヘルスチェックで検知するまではフェイルオーバが発生せず、ヘルスチェックの設定によっては<productname>PostgreSQL</productname>の切り離しに時間がかかります。
+    とりわけ<link linkend="tutorial-watchdog">Watchdog</link>が有効かつ<xref linkend="guc-failover-require-consensus">がonなら、<productname>Pgpool-II</productname>は過半数のWatchdogが<productname>PostgreSQL</productname>の停止に合意するまで、フェイルオーバを開始しません。
+    <xref linkend="pcp-detach-node">でノードを切り離せば、ヘルスチェックの設定に関わらず直ちにフェイルオーバが開始されます。
+     切り離されたノードは実際には<productname>PostgreSQL</productname>が停止しておらず、必要なら手動で停止させなければならないことに注意してください。
+   </para>
+  </sect2>
 
-   To allow failover on the backend again, you can set:
--->
-バックエンドを再起動すると、クライアントは通常通り接続ができます。
-再びフェイルオーバを有効にするには、以下を設定します。
-   <programlisting>
-     backend_flag0 = ALLOW_TO_FAILOVER
-   </programlisting>
-<!--
-   and reload or restart <productname>Pgpool-II</productname>.
--->
-そして、<productname>Pgpool-II</productname>の再読込か、再起動を行います。
-  </para>
+  <sect2 id="using-backend-flag">
+   <title>backend_flagの活用</title>
+   <para>
+    <!--
+    Stopping or restarting <productname>PostgreSQL</productname>
+    causes failover. If the running mode is not streaming replication
+    mode, or the server is a standby server in streaming replication
+    mode, probably that's not a big deal because clients can always
+    use other servers in the cluster. However if the server is primary
+    server, it will cause change of primary server by promoting one of
+    the standby servers. Moreover if there's only one server remains
+    in the cluster, there are no alternative server or standby server
+    which can be promoted.
+    -->
+    <productname>PostgreSQL</productname>を停止、再起動するとフェイルオーバが発生します。
+    ストリーミングレプリケーションモードでない場合、あるいはストリーミングレプリケーションモードであってもサーバがスタンバイサーバであればあまり大きな問題にはなりませ
+    ん。
+    しかし、サーバがクラスタのプライマリサーバなら、スタンバイサーバの一つが昇格してしまいます。
+    更には、クラスタに1台のサーバしか残っていなければ、昇格できるスタンバイサーバがないことになります。
+   </para>
 
+   <para>
+    <!--
+    In this case you can use <xref linkend="guc-backend-flag"> to avoid
+    failover.  By setting below in pgpool.conf will avoid failover of
+    backend0.
+    -->
+    この場合は<xref linkend="guc-backend-flag">を使ってフェイルオーバを避けることができます。
+     以下のようにpgpool.confを設定すると、backend0のフェイルオーバが起こりません。
+     <programlisting>
+      backend_flag0 = DISALLOW_TO_FAILOVER
+     </programlisting>
+     <!--
+     This will take effect by reloading or restarting
+     <productname>Pgpool-II</productname>. If this flag is set, failover
+     will not happen if the backend is not available. While the backend
+     is not available, clients wil get error message:
+     -->
+     この設定は、<productname>Pgpool-II</productname>の再読込か再起動で有効になります。
+     このフラグが設定されると、バックエンドが使用不可能になってもフェイルオーバが起きません。
+     バックエンドが使用不可の間、クライアントは以下のエラーメッセージを受け取ります。
+     <programlisting>
+      psql: error: could not connect to server: FATAL:  failed to create a backend connection
+      DETAIL:  executing failover on backend
+     </programlisting>
+     <!--
+     After restarting the backend, clients can connect as usual.
+
+     To allow failover on the backend again, you can set:
+     -->
+     バックエンドを再起動すると、クライアントは通常通り接続ができます。
+     再びフェイルオーバを有効にするには、以下を設定します。
+     <programlisting>
+      backend_flag0 = ALLOW_TO_FAILOVER
+     </programlisting>
+     <!--
+     and reload or restart <productname>Pgpool-II</productname>.
+     -->
+     そして、<productname>Pgpool-II</productname>の再読込か、再起動を行います。
+   </para>
+  </sect2>
  </sect1>
 
 </chapter>
index 02c7f7e3d37038c2213be35d635467b02a36f67e..91c8bffa641ae4c557d2047f46c2bcfae2ee36dc 100644 (file)
@@ -605,41 +605,64 @@ $ <userinput>pgpool -f /usr/local/etc/pgpool.conf -F /usr/local/etc/pcp.conf -m
    it. In this section how to perform the task with minimum downtime.
   </para>
 
-  <para>
-   Stopping or restarting <productname>PostgreSQL</productname>
-   causes failover. If the running mode is not streaming replication
-   mode, or the server is a standby server in streaming replication
-   mode, probably that's not a big deal because clients can always
-   use other servers in the cluster. However if the server is primary
-   server, it will cause change of primary server by promoting one of
-   the standby servers. Moreover if there's only one server remains
-   in the cluster, there are no alternative server or standby server
-   which can be promoted.
-  </para>
+  <sect2 id="using-pcp-detach-node">
+   <title>Using pcp_detach_node command</title>
+   <para>
+    If you stop <productname>PostgreSQL</productname> by using
+    <command>pg_ctl</command>, failover will not happen until
+    <productname>Pgpool-II</productname> detects it by the health
+    check depending on the health check settings and it will take
+    sometime to detach <productname>PostgreSQL</productname>.
+    Especially if <link linkend="tutorial-watchdog">Watchdog</link> is
+    enabled and <xref linkend="guc-failover-require-consensus"> is on,
+    <productname>Pgpool-II</productname> will not start failover until
+    more than half of watchdog nodes agree that
+    <productname>PostgreSQL</productname> is stopped. If you detach
+    the node by using <xref linkend="pcp-detach-node">, failover will
+    immediately start regardless the settings of health check. Please
+    note that the detached <productname>PostgreSQL</productname> node
+    is not actually stopped and if necessary, you need to manually
+    stop it.
+   </para>
+  </sect2>
 
-  <para>
-   In this case you can use <xref linkend="guc-backend-flag"> to avoid
-   failover.  By setting below in pgpool.conf will avoid failover of
-   backend0.
-   <programlisting>
-     backend_flag0 = DISALLOW_TO_FAILOVER
-    </programlisting>
-   This will take effect by reloading or restarting
-   <productname>Pgpool-II</productname>. If this flag is set, failover
-   will not happen if the backend is not available. While the backend
-   is not available, clients will get error message:
-   <programlisting>
-     psql: error: could not connect to server: FATAL:  failed to create a backend connection
-     DETAIL:  executing failover on backend
-   </programlisting>
-   After restarting the backend, clients can connect as usual.
-
-   To allow failover on the backend again, you can set:
-   <programlisting>
-     backend_flag0 = ALLOW_TO_FAILOVER
-   </programlisting>
-   and reload or restart <productname>Pgpool-II</productname>.
-  </para>
+  <sect2 id="using-backend-flag">
+   <title>Using backend_flag</title>
+   <para>
+    Stopping or restarting <productname>PostgreSQL</productname>
+    causes failover. If the running mode is not streaming replication
+    mode, or the server is a standby server in streaming replication
+    mode, probably that's not a big deal because clients can always
+    use other servers in the cluster. However if the server is primary
+    server, it will cause change of primary server by promoting one of
+    the standby servers. Moreover if there's only one server remains
+    in the cluster, there are no alternative server or standby server
+    which can be promoted.
+   </para>
+
+   <para>
+    In this case you can use <xref linkend="guc-backend-flag"> to avoid
+     failover.  By setting below in pgpool.conf will avoid failover of
+     backend0.
+     <programlisting>
+      backend_flag0 = DISALLOW_TO_FAILOVER
+     </programlisting>
+     This will take effect by reloading or restarting
+     <productname>Pgpool-II</productname>. If this flag is set, failover
+     will not happen if the backend is not available. While the backend
+     is not available, clients will get error message:
+     <programlisting>
+      psql: error: could not connect to server: FATAL:  failed to create a backend connection
+      DETAIL:  executing failover on backend
+     </programlisting>
+     After restarting the backend, clients can connect as usual.
+     To allow failover on the backend again, you can set:
+     <programlisting>
+      backend_flag0 = ALLOW_TO_FAILOVER
+     </programlisting>
+     and reload or restart <productname>Pgpool-II</productname>.
+   </para>
+  </sect2>
 
  </sect1>