pgpool2.git / summary / log / commit / refs
commit 77bb858ecc804397d4b61483bbf68e78116c8e93
Author: Tatsuo Ishii <ishii@sraoss.co.jp>
Date: Thu Aug 08 05:44:11 2019 +0000
Doc: fix indentation.
Also remove unnecessary xref label of sect2.
doc.ja/src/sgml/watchdog.sgml | 2796 ++++++++++++++++++++---------------------
doc/src/sgml/watchdog.sgml | 1774 +++++++++++++-------------
2 files changed, 2285 insertions(+), 2285 deletions(-)
diff --git a/doc.ja/src/sgml/watchdog.sgml b/doc.ja/src/sgml/watchdog.sgml
index ae6702b25..42c0aefd1 100644
--- a/doc.ja/src/sgml/watchdog.sgml
+++ b/doc.ja/src/sgml/watchdog.sgml
@@ -1,945 +1,945 @@
<!-- doc/src/sgml/config.sgml -->
<sect1 id="runtime-watchdog-config">
- <title>Watchdog</title>
+ <title>Watchdog</title>
-<indexterm zone="runtime-watchdog-config">
-<!--
+ <indexterm zone="runtime-watchdog-config">
+ <!--
<primary>configuring watchdog</primary>
--->
+ -->
<primary>Watchdogの設定</primary>
</indexterm>
- <para>
-<!--
- Watchdog configuration parameters are described in pgpool.conf.
- There is sample configuration in the WATCHDOG section of
- <filename>pgpool.conf.sample</filename> file.
- All following options are required to be specified in watchdog process.
--->
-Watchdogの設定パラメータはpgpool.confに記述されています。
-<filename>pgpool.conf.sample</filename>のWATCHDOG節に設定の例があります。
-以下のすべてのオプションがwatchdogプロセスでは指定されている必要があります。
-</para>
-
- <sect2 id="config-enable-watchdog">
-<!--
- <title>Enable watchdog</title>
--->
- <title>Watchdogを有効にする</title>
-
- <variablelist>
- <varlistentry id="guc-use-watchdog" xreflabel="use_watchdog">
- <term><varname>use_watchdog</varname> (<type>boolean</type>)
- <indexterm>
-<!--
- <primary><varname>use_watchdog</varname> configuration parameter</primary>
--->
- <primary><varname>use_watchdog</varname>設定パラメータ</primary>
- </indexterm>
- </term>
- <listitem>
- <para>
-<!--
- If on, activates the watchdog. Default is off
--->
-onならwatchdogを有効にします。
-デフォルトはoffです。
- </para>
- <para>
-<!--
- This parameter can only be set at server start.
--->
-このパラメータは、サーバ起動時にのみ設定できます。
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </sect2>
-
- <sect2 id="config-communication-watchdog">
-<!--
- <title>Watchdog communication</title>
--->
- <title>Watchdog通信</title>
-
- <variablelist>
-
- <varlistentry id="guc-wd-hostname" xreflabel="wd_hostname">
- <term><varname>wd_hostname</varname> (<type>string</type>)
- <indexterm>
-<!--
- <primary><varname>wd_hostname</varname> configuration parameter</primary>
--->
- <primary><varname>wd_hostname</varname>設定パラメータ</primary>
- </indexterm>
- </term>
- <listitem>
- <para>
-<!--
- Specifies the hostname or IP address of
- <productname>Pgpool-II</productname> server.
- This is used for sending/receiving queries and packets,
- and also as an identifier of the watchdog node.
--->
-<productname>Pgpool-II</productname>サーバのホスト名またはIPアドレスを指定します。
-クエリやパケットの送受信の他、watchdogの識別子としても用います。
- </para>
- <para>
-<!--
- This parameter can only be set at server start.
--->
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry id="guc-wd-port" xreflabel="wd_port">
- <term><varname>wd_port</varname> (<type>integer</type>)
- <indexterm>
-<!--
- <primary><varname>wd_port</varname> configuration parameter</primary>
--->
- <primary><varname>wd_port</varname> 設定パラメータ</primary>
- </indexterm>
- </term>
- <listitem>
- <para>
-<!--
- Specifies the port number to be used by watchdog
- process to listen for connections. Default is 9000.
--->
-watchdogが接続を受け付けるために監視するポート番号です。
-デフォルト値は9000です。
- </para>
- <para>
-<!--
- This parameter can only be set at server start.
--->
-このパラメータは、サーバ起動時にのみ設定できます。
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry id="guc-wd-authkey" xreflabel="wd_authkey">
- <term><varname>wd_authkey</varname> (<type>string</type>)
- <indexterm>
-<!--
- <primary><varname>wd_authkey</varname> configuration parameter</primary>
--->
- <primary><varname>wd_authkey</varname>設定パラメータ</primary>
- </indexterm>
- </term>
- <listitem>
- <para>
-<!--
- Specifies the authentication key used for all watchdog communications.
- All <productname>Pgpool-II</productname> must have the same key.
- Packets from watchdog having different key will get rejected.
- This authentication is also applied to the heatrbeat singals
- when the <literal>heartbeat</> mode is used as a lifecheck method.
--->
-wachdog間通信で用いられる認証キーを指定します。
-全ての<productname>Pgpool-II</productname>で同じキーを指定する必要があります。
-認証キーが異なるwatchdogからの通信は拒絶されます。
-死活監視を<literal>heartbeat</>モードで行う場合には、この認証はハートビート信号にも適用されます。
- </para>
- <para>
-<!--
- Since in <productname>Pgpool-II</productname><emphasis>V3.5</emphasis> or beyond
- <varname>wd_authkey</varname> is also used to authenticate
- the watchdog IPC clients,
- all clients communicating with <productname>Pgpool-II</productname>
- watchdog process needs to provide this wd_authkey value
- for <literal>"IPCAuthKey"</literal> key in the JSON data
- of the command.
--->
-<productname>Pgpool-II</productname><emphasis>V3.5</emphasis>以降では<varname>wd_authkey</varname>がwatchdog IPCクライアントの認証にも使われるため、<productname>Pgpool-II</productname>と通信するwatchdogプロセスは、<literal>"IPCAuthKey"</literal>のコマンドのJSONデータにwd_authkey値を設定しなければなりません。
- </para>
- <para>
-<!--
- Default is <literal>''</literal> (empty) which means disables
- the watchdog authentication.
--->
-デフォルトは<literal>''</literal>（空文字）で、この場合watchdogの認証は行われません。
- </para>
- <para>
-<!--
- This parameter can only be set at server start.
--->
-このパラメータは、サーバ起動時にのみ設定できます。
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </sect2>
-
- <sect2 id="config-watchdog-upstream-connections">
-<!--
- <title>Upstream server connection</title>
--->
- <title>上流サーバへの接続</title>
-
- <variablelist>
-
- <varlistentry id="guc-trusted-servers" xreflabel="trusted_servers">
- <term><varname>trusted_servers</varname> (<type>string</type>)
- <indexterm>
-<!--
- <primary><varname>trusted_servers</varname> configuration parameter</primary>
--->
- <primary><varname>trusted_servers</varname>設定パラメータ</primary>
- </indexterm>
- </term>
- <listitem>
- <para>
-<!--
- Specifies the list of trusted servers to check the up stream connections.
- Each server in the list is required to respond to ping.
- Specify a comma separated list of servers such as
- <literal>"hostA,hostB,hostC"</literal>.
- If none of the server are reachable, watchdog will regard it as
- failure of the <productname>Pgpool-II</productname>.
- Therefore, it is recommended to specify multiple servers.
--->
-上位接続を確認するための信頼できるサーバのリストを指定します。
-リスト中の各サーバは、pingの応答に答える必要があります。
-<literal>"hostA,hostB,hostC"</literal>のようにカンマで区切って複数のサーバを指定できます。
-全てのサーバに到達できなくなると、watchdogは<productname>Pgpool-II</productname>に障害が発生したと判断します。
-そのため、複数のサーバを指定することを推奨します。
- </para>
- <para>
-<!--
- This parameter can only be set at server start.
--->
-このパラメータは、サーバ起動時にのみ設定できます。
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry id="guc-ping-path" xreflabel="ping_path">
- <term><varname>ping_path</varname> (<type>string</type>)
- <indexterm>
-<!--
- <primary><varname>ping_path</varname> configuration parameter</primary>
--->
- <primary><varname>ping_path</varname>設定パラメータ</primary>
- </indexterm>
- </term>
- <listitem>
- <para>
-<!--
- Specifies the path of a ping command for monitoring
- connection to the upper servers. Set the only path of the directory containing the
- ping utility, such as <literal>"/bin"</literal> or such directory.
--->
-上位サーバへの接続監視に利用するpingコマンドのパスを指定します。
-<literal>"/bin"</literal>のようにパスだけを指定します。
- </para>
- <para>
-<!--
- This parameter can only be set at server start.
--->
-このパラメータは、サーバ起動時にのみ設定できます。
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </sect2>
-
- <sect2 id="config-watchdog-vip-control">
-<!--
- <title>Virtual IP control</title>
--->
- <title>仮想IP制御</title>
-
- <variablelist>
-
- <varlistentry id="guc-delegate-IP" xreflabel="delegate_IP">
- <term><varname>delegate_IP</varname> (<type>string</type>)
- <indexterm>
-<!--
- <primary><varname>delegate_IP</varname> configuration parameter</primary>
--->
- <primary><varname>delegate_IP</varname>設定パラメータ</primary>
- </indexterm>
- </term>
- <listitem>
- <para>
-<!--
- Specifies the virtual IP address (VIP) of pgpool-II that is
- connected from client servers (application servers etc.).
- When a <productname>Pgpool-II</productname> is switched from standby to active,
- the <productname>Pgpool-II</productname> takes over
- this VIP.
- Default is <literal>''</literal>(empty): which means virtual
- IP will never be brought up.
--->
-（アプリケーションサーバなど）クライアントサーバから接続されるpgpool-IIの仮想IP（VIP） アドレスを指定します。
-<productname>Pgpool-II</productname>がスタンバイからアクティブに切り替わった時、<productname>Pgpool-II</productname>はこのVIPを引き継ぎます。
-デフォルトは<literal>''</literal>（空文字）で、この場合仮想IPは決して立ち上がりません。
- </para>
- <para>
-<!--
- This parameter can only be set at server start.
--->
-このパラメータは、サーバ起動時にのみ設定できます。
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry id="guc-if-cmd-path" xreflabel="if_cmd_path">
- <term><varname>if_cmd_path</varname> (<type>string</type>)
- <indexterm>
-<!--
- <primary><varname>if_cmd_path</varname> configuration parameter</primary>
--->
- <primary><varname>if_cmd_path</varname>設定パラメータ</primary>
- </indexterm>
- </term>
- <listitem>
- <para>
-<!--
- Specifies the path to the command that <productname>Pgpool-II</productname>
- will use to switch the virtual IP on the system.
- Set only the path of the directory containing the binary,
- such as <literal>"/sbin"</literal> or such directory.
--->
-<productname>Pgpool-II</productname>が仮想IPを切り替えるために使用するコマンドへのパスを指定します。
-<literal>"/bin"</literal>のようにパスだけを指定します。
- </para>
- <para>
-<!--
- This parameter can only be set at server start.
--->
-このパラメータは、サーバ起動時にのみ設定できます。
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry id="guc-if-up-cmd" xreflabel="if_up_cmd">
- <term><varname>if_up_cmd</varname> (<type>string</type>)
- <indexterm>
-<!--
- <primary><varname>if_up_cmd</varname> configuration parameter</primary>
--->
- <primary><varname>if_up_cmd</varname>設定パラメータ</primary>
- </indexterm>
- </term>
- <listitem>
- <para>
-<!--
- Specifies the command to bring up the virtual IP.
- Set the command and parameters such as
- <command>"ip addr add $_IP_$/24 dev eth0 label eth0:0"</command>
- <literal>$_IP_$</literal> will get replaced by the IP address
- specified in the <xref linkend="guc-delegate-IP">.
--->
-仮想IPを起動するために実行するコマンドを指定します。
-<command>"ip addr add $_IP_$/24 dev eth0 label eth0:0"</command>のようにコマンドとパラメータを指定します。
-<literal>$_IP_$</literal>は<xref linkend="guc-delegate-IP">で指定されたIPアドレスに置換されます。
- </para>
- <para>
-このパラメータは、サーバ起動時にのみ設定できます。
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry id="guc-if-down-cmd" xreflabel="if_down_cmd">
- <term><varname>if_down_cmd</varname> (<type>string</type>)
- <indexterm>
-<!--
- <primary><varname>if_down_cmd</varname> configuration parameter</primary>
--->
- <primary><varname>if_down_cmd</varname>設定パラメータ</primary>
- </indexterm>
- </term>
- <listitem>
- <para>
-<!--
- Specifies the command to bring down the virtual IP.
- Set the command and parameters such as
- <literal>"ip addr del $_IP_$/24 dev eth0"</literal>.
--->
-仮想IPを停止するために実行するコマンドを指定します。
-<literal>"ip addr del $_IP_$/24 dev eth0"</literal>のようにコマンドとパラメータを指定します。
- </para>
- <para>
-<!--
- This parameter can only be set at server start.
--->
-このパラメータは、サーバ起動時にのみ設定できます。
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry id="guc-arping-path" xreflabel="arping_path">
- <term><varname>arping_path</varname> (<type>string</type>)
- <indexterm>
-<!--
- <primary><varname>arping_path</varname> configuration parameter</primary>
--->
- <primary><varname>arping_path</varname>設定パラメータ</primary>
- </indexterm>
- </term>
- <listitem>
- <para>
-<!--
- Specifies the path to the command that <productname>Pgpool-II</productname>
- will use to send the ARP requests after the virtual IP switch.
- Set only the path of the directory containing the binary,
- such as <literal>"/usr/sbin"</literal> or such directory.
--->
-IPアドレス切り替え後に<productname>Pgpool-II</productname>がARPリクエストを送信するコマンドへのパス指定します。
-<literal>"/usr/sbin"</literal>のようにパスだけを指定します。
- </para>
- <para>
-<!--
- This parameter can only be set at server start.
--->
-このパラメータは、サーバ起動時にのみ設定できます。
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry id="guc-arping-cmd" xreflabel="arping_cmd">
- <term><varname>arping_cmd</varname> (<type>string</type>)
- <indexterm>
-<!--
- <primary><varname>arping_cmd</varname> configuration parameter</primary>
--->
- <primary><varname>arping_cmd</varname>設定パラメータ</primary>
- </indexterm>
- </term>
- <listitem>
- <para>
-<!--
- Specifies the command to use for sending the ARP requests
- after the virtual IP switch.
- Set the command and parameters such as
- <literal>"arping -U $_IP_$ -w 1"</literal>.
- <literal>$_IP_$</literal> will get replaced by
- the IP address specified in the <varname>delegate_IP</varname>.
--->
-IPアドレス切り替え後にARPリクエストを送信するコマンドです。
-<literal>"arping -U $_IP_$ -w 1"</literal>のようにコマンドとパラメータを指定します。
-<literal>$_IP_$</literal>は<varname>delegate_IP</varname>で指定されたIPアドレスに置換されます。
- </para>
- <para>
-<!--
- This parameter can only be set at server start.
--->
-このパラメータは、サーバ起動時にのみ設定できます。
- </para>
- </listitem>
- </varlistentry>
+ <para>
+ <!--
+ Watchdog configuration parameters are described in pgpool.conf.
+ There is sample configuration in the WATCHDOG section of
+ <filename>pgpool.conf.sample</filename> file.
+ All following options are required to be specified in watchdog process.
+ -->
+ Watchdogの設定パラメータはpgpool.confに記述されています。
+ <filename>pgpool.conf.sample</filename>のWATCHDOG節に設定の例があります。
+ 以下のすべてのオプションがwatchdogプロセスでは指定されている必要があります。
+ </para>
+
+ <sect2 id="config-enable-watchdog">
+ <!--
+ <title>Enable watchdog</title>
+ -->
+ <title>Watchdogを有効にする</title>
+ <variablelist>
+ <varlistentry id="guc-use-watchdog" xreflabel="use_watchdog">
+ <term><varname>use_watchdog</varname> (<type>boolean</type>)
+ <indexterm>
+ <!--
+ <primary><varname>use_watchdog</varname> configuration parameter</primary>
+ -->
+ <primary><varname>use_watchdog</varname>設定パラメータ</primary>
+ </indexterm>
+ </term>
+ <listitem>
+ <para>
+ <!--
+ If on, activates the watchdog. Default is off
+ -->
+ onならwatchdogを有効にします。
+ デフォルトはoffです。
+ </para>
+ <para>
+ <!--
+ This parameter can only be set at server start.
+ -->
+ このパラメータは、サーバ起動時にのみ設定できます。
+ </para>
+ </listitem>
+ </varlistentry>
</variablelist>
-</sect2>
-
-<sect2 id="config-watchdog-escalation-de-escalation">
-<!--
- <title>Behaivor on escalation and de-escalation</title>
--->
- <title>昇格および降格時の振る舞い</title>
- <para>
-<!--
- Configuration about behavior when <productname>Pgpool-II</productname>
- escalates to active (virtual IP holder)
--->
-<productname>Pgpool-II</productname>がアクティブ（仮想IPを保持しているステータス）に昇格した時の振る舞いを指定します。
- </para>
-
- <variablelist>
-
- <varlistentry id="guc-clear-memqcache-on-escalation" xreflabel="clear_memqcache_on_escalation">
- <term><varname>clear_memqcache_on_escalation</varname> (<type>boolean</type>)
- <indexterm>
-<!--
- <primary><varname>clear_memqcache_on_escalation</varname> configuration parameter</primary>
--->
- <primary><varname>clear_memqcache_on_escalation</varname>設定パラメータ</primary>
- </indexterm>
- </term>
- <listitem>
- <para>
-<!--
- When set to on, watchdog clears all the query cache in the shared memory
- when pgpool-II escaltes to active. This prevents the new active <productname>Pgpool-II</productname>
- from using old query caches inconsistence to the old active.
--->
-このオプションがonの場合、pgpool-II がアクティブに昇格した時に、共有メモリ上のクエリキャッシュを全て削除します。
- これにより、新しいアクティブの<productname>Pgpool-II</productname>が旧アクティブと非整合な古いクエリキャッシュを使うことを防止します。
- </para>
- <para>
-<!--
- Default is on.
--->
-デフォルトはonです。
- </para>
- <para>
-<!--
- This works only if <xref linkend="guc-memqcache-method">
- is <literal>'shmem'</literal>.
--->
-<xref linkend="guc-memqcache-method">が'shmem'の場合のみ有効です。
- </para>
- <para>
-<!--
- This parameter can only be set at server start.
--->
-このパラメータは、サーバ起動時にのみ設定できます。
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry id="guc-wd-escalation-command" xreflabel="wd_escalation_command">
- <term><varname>wd_escalation_command</varname> (<type>string</type>)
- <indexterm>
-<!--
- <primary><varname>wd_escalation_command</varname> configuration parameter</primary>
--->
- <primary><varname>wd_escalation_command</varname>設定パラメータ</primary>
- </indexterm>
- </term>
- <listitem>
- <para>
-<!--
- Watchdog executes this command on the node that is escalated
- to the master watchdog.
--->
-マスターwatchdogに昇格した時に、ここで指定したコマンドがwatchdogによって実行されます。
- </para>
- <para>
-<!--
- This command is executed just before bringing up the
- virtual IP if that is configured on the node.
--->
-コマンドは、そのノードに仮想IPが設定されていた場合、それが立ち上がる直前のタイミングで実行されます。
- </para>
- <para>
-<!--
- This parameter can only be set at server start.
--->
-このパラメータは、サーバ起動時にのみ設定できます。
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry id="guc-wd-de-escalation-command" xreflabel="wd_de_escalation_command">
- <term><varname>wd_de_escalation_command</varname> (<type>string</type>)
- <indexterm>
-<!--
- <primary><varname>wd_de_escalation_command</varname> configuration parameter</primary>
--->
- <primary><varname>wd_de_escalation_command</varname>設定パラメータ</primary>
- </indexterm>
- </term>
- <listitem>
- <para>
-<!--
- Watchdog executes this command on the master <productname>Pgpool-II</productname>
- watchdog node when that node resigns from the master node responsibilities.
- A master watchdog node can resign from being a master node,
- when the master node <productname>Pgpool-II</productname> shuts down, detects a network
- blackout or detects the lost of quorum.
--->
-<productname>Pgpool-II</productname>のマスターwatchdogが責務を辞退し降格するときに、ここで指定したコマンドが実行されます。
-マスターwatchdogノードは、そのマスターノードの<productname>Pgpool-II</productname>が停止したとき、ネットワーク切断や<firstterm>クォーラム(quorum)</firstterm><indexterm><primary>クォーラム</primary></indexterm><indexterm><primary>quorum</primary></indexterm>が失われたことを検出した時に、マスターから辞任します。
- </para>
- <para>
-<!--
- This command is executed before bringing down the virtual/floating IP address
- if it is configured on the watchdog node.
--->
-このコマンドは、watchdogノードに仮想IPアドレスが設定されていた場合、それが停止される直前のタイミングで実行されます。
- </para>
- <para>
-<!--
- <varname>wd_de_escalation_command</varname> is not available prior to
- <productname>Pgpool-II</productname><emphasis>V3.5</emphasis>.
--->
-<varname>wd_de_escalation_command</varname>は、<productname>Pgpool-II</productname><emphasis>V3.5</emphasis>より前のバージョンには提供されていません。
- </para>
- <para>
-<!--
- This parameter can only be set at server start.
--->
-このパラメータは、サーバ起動時にのみ設定できます。
- </para>
- </listitem>
- </varlistentry>
+ </sect2>
+
+ <sect2 id="config-communication-watchdog">
+ <!--
+ <title>Watchdog communication</title>
+ -->
+ <title>Watchdog通信</title>
+
+ <variablelist>
+
+ <varlistentry id="guc-wd-hostname" xreflabel="wd_hostname">
+ <term><varname>wd_hostname</varname> (<type>string</type>)
+ <indexterm>
+ <!--
+ <primary><varname>wd_hostname</varname> configuration parameter</primary>
+ -->
+ <primary><varname>wd_hostname</varname>設定パラメータ</primary>
+ </indexterm>
+ </term>
+ <listitem>
+ <para>
+ <!--
+ Specifies the hostname or IP address of
+ <productname>Pgpool-II</productname> server.
+ This is used for sending/receiving queries and packets,
+ and also as an identifier of the watchdog node.
+ -->
+ <productname>Pgpool-II</productname>サーバのホスト名またはIPアドレスを指定します。
+ クエリやパケットの送受信の他、watchdogの識別子としても用います。
+ </para>
+ <para>
+ <!--
+ This parameter can only be set at server start.
+ -->
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry id="guc-wd-port" xreflabel="wd_port">
+ <term><varname>wd_port</varname> (<type>integer</type>)
+ <indexterm>
+ <!--
+ <primary><varname>wd_port</varname> configuration parameter</primary>
+ -->
+ <primary><varname>wd_port</varname> 設定パラメータ</primary>
+ </indexterm>
+ </term>
+ <listitem>
+ <para>
+ <!--
+ Specifies the port number to be used by watchdog
+ process to listen for connections. Default is 9000.
+ -->
+ watchdogが接続を受け付けるために監視するポート番号です。
+ デフォルト値は9000です。
+ </para>
+ <para>
+ <!--
+ This parameter can only be set at server start.
+ -->
+ このパラメータは、サーバ起動時にのみ設定できます。
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry id="guc-wd-authkey" xreflabel="wd_authkey">
+ <term><varname>wd_authkey</varname> (<type>string</type>)
+ <indexterm>
+ <!--
+ <primary><varname>wd_authkey</varname> configuration parameter</primary>
+ -->
+ <primary><varname>wd_authkey</varname>設定パラメータ</primary>
+ </indexterm>
+ </term>
+ <listitem>
+ <para>
+ <!--
+ Specifies the authentication key used for all watchdog communications.
+ All <productname>Pgpool-II</productname> must have the same key.
+ Packets from watchdog having different key will get rejected.
+ This authentication is also applied to the heatrbeat singals
+ when the <literal>heartbeat</> mode is used as a lifecheck method.
+ -->
+ wachdog間通信で用いられる認証キーを指定します。
+ 全ての<productname>Pgpool-II</productname>で同じキーを指定する必要があります。
+ 認証キーが異なるwatchdogからの通信は拒絶されます。
+ 死活監視を<literal>heartbeat</>モードで行う場合には、この認証はハートビート信号にも適用されます。
+ </para>
+ <para>
+ <!--
+ Since in <productname>Pgpool-II</productname><emphasis>V3.5</emphasis> or beyond
+ <varname>wd_authkey</varname> is also used to authenticate
+ the watchdog IPC clients,
+ all clients communicating with <productname>Pgpool-II</productname>
+ watchdog process needs to provide this wd_authkey value
+ for <literal>"IPCAuthKey"</literal> key in the JSON data
+ of the command.
+ -->
+ <productname>Pgpool-II</productname><emphasis>V3.5</emphasis>以降では<varname>wd_authkey</varname>がwatchdog IPCクライアントの認証にも使われるため、<productname>Pgpool-II</productname>と通信するwatchdogプロセスは、<literal>"IPCAuthKey"</literal>のコマンドのJSONデータにwd_authkey値を設定しなければなりません。
+ </para>
+ <para>
+ <!--
+ Default is <literal>''</literal> (empty) which means disables
+ the watchdog authentication.
+ -->
+ デフォルトは<literal>''</literal>（空文字）で、この場合watchdogの認証は行われません。
+ </para>
+ <para>
+ <!--
+ This parameter can only be set at server start.
+ -->
+ このパラメータは、サーバ起動時にのみ設定できます。
+ </para>
+ </listitem>
+ </varlistentry>
</variablelist>
- </sect2>
-
- <sect2 id="config-watchdog-failover-behavior" xreflabel="Controlling the Failover behavior">
-<!--
- <title>Controlling the Failover behavior</title>
--->
- <title>フェイルオーバの挙動の制御</title>
-
- <para>
-<!--
- These settings are used to control the behavior of backend node failover when the watchdog is enabled.
- The effect of these configurations is limited to the failover/degenerate requests initiated by
- <productname>Pgpool-II</productname> internally, while the user initiated detach backend requests
- (using PCP command) by-pass these configuration settings.
--->
-これらの設定は、<application>watchdog</application>機能が有効な場合に、バックエンドノードのフェイルオーバの動作を制御するために使用されます。
-これらの設定の影響は、内部的な<productname>Pgpool-II</productname>のフェイルオーバ/縮退要求のみに影響します。
-一方、(PCPコマンドを使った)ユーザが起動したバックエンド切り離し操作では、これらの設定項目は迂回され適用されません。
- </para>
-
- <variablelist>
-
- <varlistentry id="guc-failover-when-quorum-exists" xreflabel="failover_when_quorum_exists">
- <term><varname>failover_when_quorum_exists</varname> (<type>boolean</type>)
- <indexterm>
-<!--
- <primary><varname>failover_when_quorum_exists</varname> configuration parameter</primary>
--->
- <primary><varname>failover_when_quorum_exists</varname> 設定パラメータ</primary>
- </indexterm>
- </term>
- <listitem>
- <para>
- このパラメータを有効にすると、<productname>Pgpool-II</productname>がバックエンドノードの縮退/フェイルオーバを実行する際にクォーラム<indexterm><primary>quorum</primary></indexterm><indexterm><primary>クォーラム</primary></indexterm>が存在するかどうかを考慮するようになります。
- </para>
- <para>
- 「クォーラムが存在する」とは、生きているwatchdogノードの数(<productname>Pgpool-II</productname>の数)を全部足して、すべてのwatchdogノードの数に対して多数派を形成できる場合のことを指します。
- たとえば、watchdogノード数が5のとき、生きているノード数が3以上なら多数派を形成できるのでクォーラムは存在しますが、生きているノード数が2以下なら多数派を形成できないのでクォーラムは存在しません。
- </para>
- <para>
- クォーラムが存在すると、一つのwatchdogノードがバックエンドの障害を誤検知しても他の多数派のノードに否決されるので、障害誤検知に対して堅牢になります。
- これは<xref linkend="guc-failover-require-consensus">がオン(デフォルト)の動作ですが、設定によって多数派を形成しなくても直ちにフェイルオーバするようにすることもできます。
- バックエンドの障害を誤って検出した<productname>Pgpool-II</productname>ノードは、障害の発生したバックエンドノードを隔離します。
- </para>
- <para>
- クォーラムの存在の有無は、<xref linkend="pcp-watchdog-info">コマンドを<literal>--verbose</literal>オプション付きで起動することで確認できます。
- <literal>Quorum state</literal>が<literal>QUORUM EXIST</literal>または<literal>QUORUM IS ON THE EDGE</literal>ならクォーラムは存在します。
- <literal>Quorum state</literal>が<literal>QUORUM ABSENT</literal>ならクォーラムは存在しません。
- </para>
- <para>
- なお、watchdogノード数が偶数の場合は、生きているノード数がすべてのwatchdogノード数の半数以上ならクォーラムが存在するとみなします。
- たとえば全watchdogノード数が4で、生きているノード数が2以上ならクォーラムが存在するとみなします。
- </para>
+ </sect2>
- <para>
-クォーラムが存在しない場合、クォーラムが再び存在するまで、バックエンドの障害を検出した<productname>Pgpool-II</productname>ノードは、障害の発生したバックエンドノードを隔離します。
- </para>
+ <sect2 id="config-watchdog-upstream-connections">
+ <!--
+ <title>Upstream server connection</title>
+ -->
+ <title>上流サーバへの接続</title>
- <para>
- 隔離されたノードを<command>pcp_detach_node</command>コマンドで強制的にフェイルオーバさせることは可能ですが、<command>pcp_attach_node</command>コマンドで再びアタッチ状態にすることはできません。
- </para>
- <para>
-<!--
- The quarantine nodes behaves similar to the detached backend nodes but unlike failed/degenerated backends
- the quarantine status is not propagated to the other <productname>Pgpool-II</productname> nodes in the
- watchdog cluster, So even if the backend node is in the quarantine state on one
- <productname>Pgpool-II</productname> node, other <productname>Pgpool-II</productname> nodes may
- still continue to use that backend.
- -->
-隔離されたノードの動作は切り離されたバックエンドノードと似ていますが、フェイルオーバ/縮退と異なり、隔離ステータスはwatchdogクラスタ内の他の<productname>Pgpool-II</productname>ノードに伝播されません。
-したがって、他の<productname>Pgpool-II</productname>ノードは引き続きそのバックエンドを使用し続ける可能性があります。
- </para>
- <para>
-<!--
- Although there are many similarities in quarantine and failover operations, but they both differ in a very
- fundamental way. The quarantine operations does not executes the <xref linkend="guc-failover-command">
- and silently detaches the problematic node, So in the case when the master backend node is quarantined, the
- <productname>Pgpool-II</productname> will not promote the standby to take over the master responsibilities
- and until the master node is quarantined the <productname>Pgpool-II</productname> will not have
- any useable master backend node.
--->
-隔離とフェイルオーバ操作には多くの類似点がありますが、どちらも非常に基本的な方法で異なります。
-隔離操作は<xref linkend="guc-failover-command">を実行せず、障害の発生したノードを隔離します。
-この隔離されたノードがマスタの場合、<productname>Pgpool-II</productname>はスタンバイをマスタに昇格させないので、マスタノードが隔離されている間は、使用可能なマスタバックエンドノードはありません。
- </para>
- <para>
- 更に、障害ノードとは違い、<productname>Pgpool-II</productname>は隔離されたノードに対してはヘルスチェックを実行し続けます。
- 隔離されたノードが到達可能になり次第、そのノードは自動的に再度アタッチされます。
- </para>
+ <variablelist>
- <para>
- <productname>Pgpool-II </productname><emphasis>V4.1</emphasis>以後では、プライマリノードのフェイルオーバに関してwatchdogのマスタノードが合意形成に失敗し、その結果プライマリバックエンドが隔離状態になった場合、そのマスタノードはマスタ/コーディネータの枠割を辞退し、次のリーダの選挙の際にwd_priorityを引き下げることにより、クラスタが新しいリーダを選ぶように仕向けます。
- <note>
- <para>
- スタンバイバックエンドの障害時にマスタノードが合意形成に失敗した場合は、特にアクションは起こしません。
- watchdogマスタが管理する隔離されたスタンバイバックエンドは新しいリーダの選挙を引き起こしません。
- </para>
- </note>
- </para>
- <para>
- このパラメータがoffなら、クォーラムが存在しなくても障害が発生するとフェイルオーバします。
- </para>
+ <varlistentry id="guc-trusted-servers" xreflabel="trusted_servers">
+ <term><varname>trusted_servers</varname> (<type>string</type>)
+ <indexterm>
+ <!--
+ <primary><varname>trusted_servers</varname> configuration parameter</primary>
+ -->
+ <primary><varname>trusted_servers</varname>設定パラメータ</primary>
+ </indexterm>
+ </term>
+ <listitem>
+ <para>
+ <!--
+ Specifies the list of trusted servers to check the up stream connections.
+ Each server in the list is required to respond to ping.
+ Specify a comma separated list of servers such as
+ <literal>"hostA,hostB,hostC"</literal>.
+ If none of the server are reachable, watchdog will regard it as
+ failure of the <productname>Pgpool-II</productname>.
+ Therefore, it is recommended to specify multiple servers.
+ -->
+ 上位接続を確認するための信頼できるサーバのリストを指定します。
+ リスト中の各サーバは、pingの応答に答える必要があります。
+ <literal>"hostA,hostB,hostC"</literal>のようにカンマで区切って複数のサーバを指定できます。
+ 全てのサーバに到達できなくなると、watchdogは<productname>Pgpool-II</productname>に障害が発生したと判断します。
+ そのため、複数のサーバを指定することを推奨します。
+ </para>
+ <para>
+ <!--
+ This parameter can only be set at server start.
+ -->
+ このパラメータは、サーバ起動時にのみ設定できます。
+ </para>
+ </listitem>
+ </varlistentry>
- <para>
-<!--
- Default is on.
--->
-デフォルト値はonです。
- </para>
- <para>
-<!--
- <varname>failover_when_quorum_exists</varname> is not available prior to
- <productname>Pgpool-II </productname><emphasis>V3.7</emphasis>.
--->
-failover_when_quorum_existsは<productname>Pgpool-II </productname><emphasis>V3.7</emphasis>より前では利用できません。
- </para>
- <para>
-<!--
- This parameter can only be set at server start.
--->
-このパラメータは、サーバーの起動時にのみ設定できます。
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry id="guc-failover-require-consensus" xreflabel="failover_require_consensus">
- <term><varname>failover_require_consensus</varname> (<type>boolean</type>)
- <indexterm>
-<!--
- <primary><varname>failover_require_consensus</varname> configuration parameter</primary>
--->
- <primary><varname>failover_require_consensus</varname> 設定パラメータ</primary>
- </indexterm>
- </term>
- <listitem>
- <para>
-<!--
- When enabled, <productname>Pgpool-II</productname> will perform the degenerate/failover on a
- backend node if the watchdog quorum exists and at-least minimum number of nodes necessary
- for the quorum vote for the failover.
--->
-このパラメータを有効にすると、<productname>Pgpool-II</productname>は、<application>watchdog</application>クォーラムが存在し、少なくともクォーラム投票に必要なノードの最小数があれば、バックエンドノードで縮退/フェイルオーバを実行します。
- </para>
- <para>
-<!--
- For example, in a three node watchdog cluster, the failover will only be performed until at
- least two nodes ask for performing the failover on the particular backend node.
--->
-たとえば、3ノードの<application>watchdog</application>のクラスタでは、フェイルオーバは、少なくとも2つのノードが特定のバックエンドノードに対してフェイルオーバの実行要求をするときのみ実行されます。
- </para>
+ <varlistentry id="guc-ping-path" xreflabel="ping_path">
+ <term><varname>ping_path</varname> (<type>string</type>)
+ <indexterm>
+ <!--
+ <primary><varname>ping_path</varname> configuration parameter</primary>
+ -->
+ <primary><varname>ping_path</varname>設定パラメータ</primary>
+ </indexterm>
+ </term>
+ <listitem>
+ <para>
+ <!--
+ Specifies the path of a ping command for monitoring
+ connection to the upper servers. Set the only path of the directory containing the
+ ping utility, such as <literal>"/bin"</literal> or such directory.
+ -->
+ 上位サーバへの接続監視に利用するpingコマンドのパスを指定します。
+ <literal>"/bin"</literal>のようにパスだけを指定します。
+ </para>
+ <para>
+ <!--
+ This parameter can only be set at server start.
+ -->
+ このパラメータは、サーバ起動時にのみ設定できます。
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </sect2>
- <para>
- このパラメータがoffなら、投票で合意が取れなくてもフェイルオーバします。
- </para>
+ <sect2 id="config-watchdog-vip-control">
+ <!--
+ <title>Virtual IP control</title>
+ -->
+ <title>仮想IP制御</title>
- <para>
-<!--
- Default is on.
--->
-デフォルト値はonです。
- </para>
- <para>
-
-<!--
- <caution>
- <para>
- When <varname>failover_require_consensus</varname> is
- enabled, <productname>Pgpool-II</productname> does not
- execute the failover until it get enough votes from
- other <productname>Pgpool-II</productname> nodes. So it is
- strongly recommended to enable the backend health check on
- all
- <productname>Pgpool-II</productname> nodes to ensure
- proper detection of backend node failures. For more
- details of health check,
- see <xref linkend="runtime-config-health-check">.
- </para>
- </caution>
--->
- <caution>
- <para>
-<varname>failover_require_consensus</varname>が有効な場合、<productname>Pgpool-II</productname>は他 の<productname>Pgpool-II</productname>ノードから充分な投票を得るまでフェイルオーバしません。
-ですから、正しくバックエンドの障害を検出するために、すべての<productname>Pgpool-II</productname>ノードでヘルスチェックを有効にすることを強く推奨します。
-ヘルスチェックに関する詳細については、<xref linkend="runtime-config-health-check">をご覧ください。
- </para>
- </caution>
-<!--
- <varname>failover_require_consensus</varname> is not available prior to
- <productname>Pgpool-II </productname><emphasis>V3.7</emphasis>. and it is only
- effective when <xref linkend="guc-failover-when-quorum-exists"> is enabled
--->
-<productname>Pgpool-II</productname> <emphasis>V3.7</emphasis>より前では<varname>failover_require_consensus</varname>は利用できません。
-<xref linkend="guc-failover-when-quorum-exists">が有効な場合にのみ有効です。
- </para>
- <para>
-<!--
- This parameter can only be set at server start.
--->
-このパラメータは、サーバの起動時にのみ設定できます。
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry id="guc-allow-multiple-failover-requests-from-node" xreflabel="allow_multiple_failover_requests_from_node">
- <term><varname>allow_multiple_failover_requests_from_node</varname> (<type>boolean</type>)
- <indexterm>
-<!--
- <primary><varname>allow_multiple_failover_requests_from_node</varname> configuration parameter</primary>
--->
- <primary><varname>allow_multiple_failover_requests_from_node</varname> 設定パラメータ</primary>
- </indexterm>
- </term>
- <listitem>
- <para>
-<!--
- This parameter works in connection with the
- <xref linkend="guc-failover-require-consensus">. When enabled, a single <productname>Pgpool-II</productname>
- node can cast multiple votes for the failover.
--->
-このパラメータは、<xref linkend="guc-failover-require-consensus">と連携して動作します。
-有効にすると、単一の<productname>Pgpool-II</productname>ノードが複数のフェイルオーバ投票をできます。
- </para>
- <para>
-<!--
- For example, in a three node watchdog cluster, if one <productname>Pgpool-II</productname> node sends two
- failover requests for a particular backend node failover, Both requests will be counted as a separate
- vote in the favor of the failover and <productname>Pgpool-II</productname> will execute the failover,
- even if it does not get the vote from any other <productname>Pgpool-II</productname> node.
--->
-たとえば、3ノードの<application>watchdog</application>クラスタでは、1つの<productname>Pgpool-II</productname>ノードが特定のバックエンドノードのフェイルオーバに対して2つのフェイルオーバ要求を送信すると、両方の要求が別の投票としてカウントされ、たとえ他の<productname>Pgpool-II</productname>ノードからの投票を得なくても、<productname>Pgpool-II</productname>がフェイルオーバを実行します。
- </para>
+ <variablelist>
- <para>
- たとえば、ヘルスチェックでエラーが検出されても有効投票数に達しない場合、障害が引き続き発生していて次のヘルスチェックで再度エラーが検出されれば、都合2票が投票されることになります。ほかのwatchdogが検出しない恒久的な障害が発生した際にフェイルオーバを引き起こしたい時に有用です。
- </para>
+ <varlistentry id="guc-delegate-IP" xreflabel="delegate_IP">
+ <term><varname>delegate_IP</varname> (<type>string</type>)
+ <indexterm>
+ <!--
+ <primary><varname>delegate_IP</varname> configuration parameter</primary>
+ -->
+ <primary><varname>delegate_IP</varname>設定パラメータ</primary>
+ </indexterm>
+ </term>
+ <listitem>
+ <para>
+ <!--
+ Specifies the virtual IP address (VIP) of pgpool-II that is
+ connected from client servers (application servers etc.).
+ When a <productname>Pgpool-II</productname> is switched from standby to active,
+ the <productname>Pgpool-II</productname> takes over
+ this VIP.
+ Default is <literal>''</literal>(empty): which means virtual
+ IP will never be brought up.
+ -->
+ （アプリケーションサーバなど）クライアントサーバから接続されるpgpool-IIの仮想IP（VIP） アドレスを指定します。
+ <productname>Pgpool-II</productname>がスタンバイからアクティブに切り替わった時、<productname>Pgpool-II</productname>はこのVIPを引き継ぎます。
+ デフォルトは<literal>''</literal>（空文字）で、この場合仮想IPは決して立ち上がりません。
+ </para>
+ <para>
+ <!--
+ This parameter can only be set at server start.
+ -->
+ このパラメータは、サーバ起動時にのみ設定できます。
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry id="guc-if-cmd-path" xreflabel="if_cmd_path">
+ <term><varname>if_cmd_path</varname> (<type>string</type>)
+ <indexterm>
+ <!--
+ <primary><varname>if_cmd_path</varname> configuration parameter</primary>
+ -->
+ <primary><varname>if_cmd_path</varname>設定パラメータ</primary>
+ </indexterm>
+ </term>
+ <listitem>
+ <para>
+ <!--
+ Specifies the path to the command that <productname>Pgpool-II</productname>
+ will use to switch the virtual IP on the system.
+ Set only the path of the directory containing the binary,
+ such as <literal>"/sbin"</literal> or such directory.
+ -->
+ <productname>Pgpool-II</productname>が仮想IPを切り替えるために使用するコマンドへのパスを指定します。
+ <literal>"/bin"</literal>のようにパスだけを指定します。
+ </para>
+ <para>
+ <!--
+ This parameter can only be set at server start.
+ -->
+ このパラメータは、サーバ起動時にのみ設定できます。
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry id="guc-if-up-cmd" xreflabel="if_up_cmd">
+ <term><varname>if_up_cmd</varname> (<type>string</type>)
+ <indexterm>
+ <!--
+ <primary><varname>if_up_cmd</varname> configuration parameter</primary>
+ -->
+ <primary><varname>if_up_cmd</varname>設定パラメータ</primary>
+ </indexterm>
+ </term>
+ <listitem>
+ <para>
+ <!--
+ Specifies the command to bring up the virtual IP.
+ Set the command and parameters such as
+ <command>"ip addr add $_IP_$/24 dev eth0 label eth0:0"</command>
+ <literal>$_IP_$</literal> will get replaced by the IP address
+ specified in the <xref linkend="guc-delegate-IP">.
+ -->
+ 仮想IPを起動するために実行するコマンドを指定します。
+ <command>"ip addr add $_IP_$/24 dev eth0 label eth0:0"</command>のようにコマンドとパラメータを指定します。
+ <literal>$_IP_$</literal>は<xref linkend="guc-delegate-IP">で指定されたIPアドレスに置換されます。
+ </para>
+ <para>
+ このパラメータは、サーバ起動時にのみ設定できます。
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry id="guc-if-down-cmd" xreflabel="if_down_cmd">
+ <term><varname>if_down_cmd</varname> (<type>string</type>)
+ <indexterm>
+ <!--
+ <primary><varname>if_down_cmd</varname> configuration parameter</primary>
+ -->
+ <primary><varname>if_down_cmd</varname>設定パラメータ</primary>
+ </indexterm>
+ </term>
+ <listitem>
+ <para>
+ <!--
+ Specifies the command to bring down the virtual IP.
+ Set the command and parameters such as
+ <literal>"ip addr del $_IP_$/24 dev eth0"</literal>.
+ -->
+ 仮想IPを停止するために実行するコマンドを指定します。
+ <literal>"ip addr del $_IP_$/24 dev eth0"</literal>のようにコマンドとパラメータを指定します。
+ </para>
+ <para>
+ <!--
+ This parameter can only be set at server start.
+ -->
+ このパラメータは、サーバ起動時にのみ設定できます。
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry id="guc-arping-path" xreflabel="arping_path">
+ <term><varname>arping_path</varname> (<type>string</type>)
+ <indexterm>
+ <!--
+ <primary><varname>arping_path</varname> configuration parameter</primary>
+ -->
+ <primary><varname>arping_path</varname>設定パラメータ</primary>
+ </indexterm>
+ </term>
+ <listitem>
+ <para>
+ <!--
+ Specifies the path to the command that <productname>Pgpool-II</productname>
+ will use to send the ARP requests after the virtual IP switch.
+ Set only the path of the directory containing the binary,
+ such as <literal>"/usr/sbin"</literal> or such directory.
+ -->
+ IPアドレス切り替え後に<productname>Pgpool-II</productname>がARPリクエストを送信するコマンドへのパス指定します。
+ <literal>"/usr/sbin"</literal>のようにパスだけを指定します。
+ </para>
+ <para>
+ <!--
+ This parameter can only be set at server start.
+ -->
+ このパラメータは、サーバ起動時にのみ設定できます。
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry id="guc-arping-cmd" xreflabel="arping_cmd">
+ <term><varname>arping_cmd</varname> (<type>string</type>)
+ <indexterm>
+ <!--
+ <primary><varname>arping_cmd</varname> configuration parameter</primary>
+ -->
+ <primary><varname>arping_cmd</varname>設定パラメータ</primary>
+ </indexterm>
+ </term>
+ <listitem>
+ <para>
+ <!--
+ Specifies the command to use for sending the ARP requests
+ after the virtual IP switch.
+ Set the command and parameters such as
+ <literal>"arping -U $_IP_$ -w 1"</literal>.
+ <literal>$_IP_$</literal> will get replaced by
+ the IP address specified in the <varname>delegate_IP</varname>.
+ -->
+ IPアドレス切り替え後にARPリクエストを送信するコマンドです。
+ <literal>"arping -U $_IP_$ -w 1"</literal>のようにコマンドとパラメータを指定します。
+ <literal>$_IP_$</literal>は<varname>delegate_IP</varname>で指定されたIPアドレスに置換されます。
+ </para>
+ <para>
+ <!--
+ This parameter can only be set at server start.
+ -->
+ このパラメータは、サーバ起動時にのみ設定できます。
+ </para>
+ </listitem>
+ </varlistentry>
+
+ </variablelist>
+ </sect2>
+
+ <sect2 id="config-watchdog-escalation-de-escalation">
+ <!--
+ <title>Behaivor on escalation and de-escalation</title>
+ -->
+ <title>昇格および降格時の振る舞い</title>
+ <para>
+ <!--
+ Configuration about behavior when <productname>Pgpool-II</productname>
+ escalates to active (virtual IP holder)
+ -->
+ <productname>Pgpool-II</productname>がアクティブ（仮想IPを保持しているステータス）に昇格した時の振る舞いを指定します。
+ </para>
+
+ <variablelist>
- <para>
-<!--
- Default is off.
--->
-デフォルト値はoffです。
- </para>
- <para>
-<!--
- <varname>allow_multiple_failover_requests_from_node</varname> is not available prior to
- <productname>Pgpool-II </productname><emphasis>V3.7</emphasis>. and it is only
- effective when both <xref linkend="guc-failover-when-quorum-exists"> and
- <xref linkend="guc-failover-require-consensus"> are enabled
--->
-<varname>allow_multiple_failover_requests_from_node</varname>は、<productname>Pgpool-II </productname><emphasis>V3.7</emphasis>以前では利用できません。
-<xref linkend="guc-failover-when-quorum-exists">と<xref linkend="guc-failover-require-consensus">の両方が有効な場合にのみ有効です。
- </para>
- <para>
-<!--
- This parameter can only be set at server start.
--->
-このパラメータは、サーバの起動時にのみ設定できます。
- </para>
- </listitem>
- </varlistentry>
+ <varlistentry id="guc-clear-memqcache-on-escalation" xreflabel="clear_memqcache_on_escalation">
+ <term><varname>clear_memqcache_on_escalation</varname> (<type>boolean</type>)
+ <indexterm>
+ <!--
+ <primary><varname>clear_memqcache_on_escalation</varname> configuration parameter</primary>
+ -->
+ <primary><varname>clear_memqcache_on_escalation</varname>設定パラメータ</primary>
+ </indexterm>
+ </term>
+ <listitem>
+ <para>
+ <!--
+ When set to on, watchdog clears all the query cache in the shared memory
+ when pgpool-II escaltes to active. This prevents the new active <productname>Pgpool-II</productname>
+ from using old query caches inconsistence to the old active.
+ -->
+ このオプションがonの場合、pgpool-II がアクティブに昇格した時に、共有メモリ上のクエリキャッシュを全て削除します。
+ これにより、新しいアクティブの<productname>Pgpool-II</productname>が旧アクティブと非整合な古いクエリキャッシュを使うことを防止します。
+ </para>
+ <para>
+ <!--
+ Default is on.
+ -->
+ デフォルトはonです。
+ </para>
+ <para>
+ <!--
+ This works only if <xref linkend="guc-memqcache-method">
+ is <literal>'shmem'</literal>.
+ -->
+ <xref linkend="guc-memqcache-method">が'shmem'の場合のみ有効です。
+ </para>
+ <para>
+ <!--
+ This parameter can only be set at server start.
+ -->
+ このパラメータは、サーバ起動時にのみ設定できます。
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry id="guc-wd-escalation-command" xreflabel="wd_escalation_command">
+ <term><varname>wd_escalation_command</varname> (<type>string</type>)
+ <indexterm>
+ <!--
+ <primary><varname>wd_escalation_command</varname> configuration parameter</primary>
+ -->
+ <primary><varname>wd_escalation_command</varname>設定パラメータ</primary>
+ </indexterm>
+ </term>
+ <listitem>
+ <para>
+ <!--
+ Watchdog executes this command on the node that is escalated
+ to the master watchdog.
+ -->
+ マスターwatchdogに昇格した時に、ここで指定したコマンドがwatchdogによって実行されます。
+ </para>
+ <para>
+ <!--
+ This command is executed just before bringing up the
+ virtual IP if that is configured on the node.
+ -->
+ コマンドは、そのノードに仮想IPが設定されていた場合、それが立ち上がる直前のタイミングで実行されます。
+ </para>
+ <para>
+ <!--
+ This parameter can only be set at server start.
+ -->
+ このパラメータは、サーバ起動時にのみ設定できます。
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry id="guc-wd-de-escalation-command" xreflabel="wd_de_escalation_command">
+ <term><varname>wd_de_escalation_command</varname> (<type>string</type>)
+ <indexterm>
+ <!--
+ <primary><varname>wd_de_escalation_command</varname> configuration parameter</primary>
+ -->
+ <primary><varname>wd_de_escalation_command</varname>設定パラメータ</primary>
+ </indexterm>
+ </term>
+ <listitem>
+ <para>
+ <!--
+ Watchdog executes this command on the master <productname>Pgpool-II</productname>
+ watchdog node when that node resigns from the master node responsibilities.
+ A master watchdog node can resign from being a master node,
+ when the master node <productname>Pgpool-II</productname> shuts down, detects a network
+ blackout or detects the lost of quorum.
+ -->
+ <productname>Pgpool-II</productname>のマスターwatchdogが責務を辞退し降格するときに、ここで指定したコマンドが実行されます。
+ マスターwatchdogノードは、そのマスターノードの<productname>Pgpool-II</productname>が停止したとき、ネットワーク切断や<firstterm>クォーラム(quorum)</firstterm><indexterm><primary>クォーラム</primary></indexterm><indexterm><primary>quorum</primary></indexterm>が失われたことを検出した時に、マスターから辞任します。
+ </para>
+ <para>
+ <!--
+ This command is executed before bringing down the virtual/floating IP address
+ if it is configured on the watchdog node.
+ -->
+ このコマンドは、watchdogノードに仮想IPアドレスが設定されていた場合、それが停止される直前のタイミングで実行されます。
+ </para>
+ <para>
+ <!--
+ <varname>wd_de_escalation_command</varname> is not available prior to
+ <productname>Pgpool-II</productname><emphasis>V3.5</emphasis>.
+ -->
+ <varname>wd_de_escalation_command</varname>は、<productname>Pgpool-II</productname><emphasis>V3.5</emphasis>より前のバージョンには提供されていません。
+ </para>
+ <para>
+ <!--
+ This parameter can only be set at server start.
+ -->
+ このパラメータは、サーバ起動時にのみ設定できます。
+ </para>
+ </listitem>
+ </varlistentry>
</variablelist>
- </sect2>
+ </sect2>
+
+ <sect2 id="config-watchdog-failover-behavior">
+ <!--
+ <title>Controlling the Failover behavior</title>
+ -->
+ <title>フェイルオーバの挙動の制御</title>
+
+ <para>
+ <!--
+ These settings are used to control the behavior of backend node failover when the watchdog is enabled.
+ The effect of these configurations is limited to the failover/degenerate requests initiated by
+ <productname>Pgpool-II</productname> internally, while the user initiated detach backend requests
+ (using PCP command) by-pass these configuration settings.
+ -->
+ これらの設定は、<application>watchdog</application>機能が有効な場合に、バックエンドノードのフェイルオーバの動作を制御するために使用されます。
+ これらの設定の影響は、内部的な<productname>Pgpool-II</productname>のフェイルオーバ/縮退要求のみに影響します。
+ 一方、(PCPコマンドを使った)ユーザが起動したバックエンド切り離し操作では、これらの設定項目は迂回され適用されません。
+ </para>
-<sect2 id="config-watchdog-lifecheck">
-<!--
- <title>Life checking <productname>Pgpool-II</productname> </title>
--->
- <title><productname>Pgpool-II</productname>の死活監視</title>
+ <variablelist>
+ <varlistentry id="guc-failover-when-quorum-exists" xreflabel="failover_when_quorum_exists">
+ <term><varname>failover_when_quorum_exists</varname> (<type>boolean</type>)
+ <indexterm>
+ <!--
+ <primary><varname>failover_when_quorum_exists</varname> configuration parameter</primary>
+ -->
+ <primary><varname>failover_when_quorum_exists</varname> 設定パラメータ</primary>
+ </indexterm>
+ </term>
+ <listitem>
+ <para>
+ このパラメータを有効にすると、<productname>Pgpool-II</productname>がバックエンドノードの縮退/フェイルオーバを実行する際にクォーラム<indexterm><primary>quorum</primary></indexterm><indexterm><primary>クォーラム</primary></indexterm>が存在するかどうかを考慮するようになります。
+ </para>
+ <para>
+ 「クォーラムが存在する」とは、生きているwatchdogノードの数(<productname>Pgpool-II</productname>の数)を全部足して、すべてのwatchdogノードの数に対して多数派を形成できる場合のことを指します。
+ たとえば、watchdogノード数が5のとき、生きているノード数が3以上なら多数派を形成できるのでクォーラムは存在しますが、生きているノード数が2以下なら多数派を形成できないのでクォーラムは存在しません。
+ </para>
+ <para>
+ クォーラムが存在すると、一つのwatchdogノードがバックエンドの障害を誤検知しても他の多数派のノードに否決されるので、障害誤検知に対して堅牢になります。
+ これは<xref linkend="guc-failover-require-consensus">がオン(デフォルト)の動作ですが、設定によって多数派を形成しなくても直ちにフェイルオーバするようにすることもできます。
+ バックエンドの障害を誤って検出した<productname>Pgpool-II</productname>ノードは、障害の発生したバックエンドノードを隔離します。
+ </para>
+ <para>
+ クォーラムの存在の有無は、<xref linkend="pcp-watchdog-info">コマンドを<literal>--verbose</literal>オプション付きで起動することで確認できます。
+ <literal>Quorum state</literal>が<literal>QUORUM EXIST</literal>または<literal>QUORUM IS ON THE EDGE</literal>ならクォーラムは存在します。
+ <literal>Quorum state</literal>が<literal>QUORUM ABSENT</literal>ならクォーラムは存在しません。
+ </para>
+ <para>
+ なお、watchdogノード数が偶数の場合は、生きているノード数がすべてのwatchdogノード数の半数以上ならクォーラムが存在するとみなします。
+ たとえば全watchdogノード数が4で、生きているノード数が2以上ならクォーラムが存在するとみなします。
+ </para>
+
+ <para>
+ クォーラムが存在しない場合、クォーラムが再び存在するまで、バックエンドの障害を検出した<productname>Pgpool-II</productname>ノードは、障害の発生したバックエンドノードを隔離します。
+ </para>
+
+ <para>
+ 隔離されたノードを<command>pcp_detach_node</command>コマンドで強制的にフェイルオーバさせることは可能ですが、<command>pcp_attach_node</command>コマンドで再びアタッチ状態にすることはできません。
+ </para>
+ <para>
+ <!--
+ The quarantine nodes behaves similar to the detached backend nodes but unlike failed/degenerated backends
+ the quarantine status is not propagated to the other <productname>Pgpool-II</productname> nodes in the
+ watchdog cluster, So even if the backend node is in the quarantine state on one
+ <productname>Pgpool-II</productname> node, other <productname>Pgpool-II</productname> nodes may
+ still continue to use that backend.
+ -->
+ 隔離されたノードの動作は切り離されたバックエンドノードと似ていますが、フェイルオーバ/縮退と異なり、隔離ステータスはwatchdogクラスタ内の他の<productname>Pgpool-II</productname>ノードに伝播されません。
+ したがって、他の<productname>Pgpool-II</productname>ノードは引き続きそのバックエンドを使用し続ける可能性があります。
+ </para>
+ <para>
+ <!--
+ Although there are many similarities in quarantine and failover operations, but they both differ in a very
+ fundamental way. The quarantine operations does not executes the <xref linkend="guc-failover-command">
+ and silently detaches the problematic node, So in the case when the master backend node is quarantined, the
+ <productname>Pgpool-II</productname> will not promote the standby to take over the master responsibilities
+ and until the master node is quarantined the <productname>Pgpool-II</productname> will not have
+ any useable master backend node.
+ -->
+ 隔離とフェイルオーバ操作には多くの類似点がありますが、どちらも非常に基本的な方法で異なります。
+ 隔離操作は<xref linkend="guc-failover-command">を実行せず、障害の発生したノードを隔離します。
+ この隔離されたノードがマスタの場合、<productname>Pgpool-II</productname>はスタンバイをマスタに昇格させないので、マスタノードが隔離されている間は、使用可能なマスタバックエンドノードはありません。
+ </para>
+ <para>
+ 更に、障害ノードとは違い、<productname>Pgpool-II</productname>は隔離されたノードに対してはヘルスチェックを実行し続けます。
+ 隔離されたノードが到達可能になり次第、そのノードは自動的に再度アタッチされます。
+ </para>
+
+ <para>
+ <productname>Pgpool-II </productname><emphasis>V4.1</emphasis>以後では、プライマリノードのフェイルオーバに関してwatchdogのマスタノードが合意形成に失敗し、その結果プライマリバックエンドが隔離状態になった場合、そのマスタノードはマスタ/コーディネータの枠割を辞退し、次のリーダの選挙の際にwd_priorityを引き下げることにより、クラスタが新しいリーダを選ぶように仕向けます。
+ <note>
+ <para>
+ スタンバイバックエンドの障害時にマスタノードが合意形成に失敗した場合は、特にアクションは起こしません。
+ watchdogマスタが管理する隔離されたスタンバイバックエンドは新しいリーダの選挙を引き起こしません。
+ </para>
+ </note>
+ </para>
+ <para>
+ このパラメータがoffなら、クォーラムが存在しなくても障害が発生するとフェイルオーバします。
+ </para>
+
+ <para>
+ <!--
+ Default is on.
+ -->
+ デフォルト値はonです。
+ </para>
+ <para>
+ <!--
+ <varname>failover_when_quorum_exists</varname> is not available prior to
+ <productname>Pgpool-II </productname><emphasis>V3.7</emphasis>.
+ -->
+ failover_when_quorum_existsは<productname>Pgpool-II </productname><emphasis>V3.7</emphasis>より前では利用できません。
+ </para>
+ <para>
+ <!--
+ This parameter can only be set at server start.
+ -->
+ このパラメータは、サーバーの起動時にのみ設定できます。
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry id="guc-failover-require-consensus" xreflabel="failover_require_consensus">
+ <term><varname>failover_require_consensus</varname> (<type>boolean</type>)
+ <indexterm>
+ <!--
+ <primary><varname>failover_require_consensus</varname> configuration parameter</primary>
+ -->
+ <primary><varname>failover_require_consensus</varname> 設定パラメータ</primary>
+ </indexterm>
+ </term>
+ <listitem>
+ <para>
+ <!--
+ When enabled, <productname>Pgpool-II</productname> will perform the degenerate/failover on a
+ backend node if the watchdog quorum exists and at-least minimum number of nodes necessary
+ for the quorum vote for the failover.
+ -->
+ このパラメータを有効にすると、<productname>Pgpool-II</productname>は、<application>watchdog</application>クォーラムが存在し、少なくともクォーラム投票に必要なノードの最小数があれば、バックエンドノードで縮退/フェイルオーバを実行します。
+ </para>
+ <para>
+ <!--
+ For example, in a three node watchdog cluster, the failover will only be performed until at
+ least two nodes ask for performing the failover on the particular backend node.
+ -->
+ たとえば、3ノードの<application>watchdog</application>のクラスタでは、フェイルオーバは、少なくとも2つのノードが特定のバックエンドノードに対してフェイルオーバの実行要求をするときのみ実行されます。
+ </para>
+
+ <para>
+ このパラメータがoffなら、投票で合意が取れなくてもフェイルオーバします。
+ </para>
+
+ <para>
+ <!--
+ Default is on.
+ -->
+ デフォルト値はonです。
+ </para>
+ <para>
+
+ <!--
+ <caution>
<para>
-<!--
- Watchdog checks pgpool-II status periodically. This is called "life check".
--->
-Watchdogは、定期的にpgpool-IIの状態を監視します。
+ When <varname>failover_require_consensus</varname> is
+ enabled, <productname>Pgpool-II</productname> does not
+ execute the failover until it get enough votes from
+ other <productname>Pgpool-II</productname> nodes. So it is
+ strongly recommended to enable the backend health check on
+ all
+ <productname>Pgpool-II</productname> nodes to ensure
+ proper detection of backend node failures. For more
+ details of health check,
+ see <xref linkend="runtime-config-health-check">.
+ </para>
+ </caution>
+ -->
+ <caution>
+ <para>
+ <varname>failover_require_consensus</varname>が有効な場合、<productname>Pgpool-II</productname>は他 の<productname>Pgpool-II</productname>ノードから充分な投票を得るまでフェイルオーバしません。
+ ですから、正しくバックエンドの障害を検出するために、すべての<productname>Pgpool-II</productname>ノードでヘルスチェックを有効にすることを強く推奨します。
+ ヘルスチェックに関する詳細については、<xref linkend="runtime-config-health-check">をご覧ください。
+ </para>
+ </caution>
+ <!--
+ <varname>failover_require_consensus</varname> is not available prior to
+ <productname>Pgpool-II </productname><emphasis>V3.7</emphasis>. and it is only
+ effective when <xref linkend="guc-failover-when-quorum-exists"> is enabled
+ -->
+ <productname>Pgpool-II</productname> <emphasis>V3.7</emphasis>より前では<varname>failover_require_consensus</varname>は利用できません。
+ <xref linkend="guc-failover-when-quorum-exists">が有効な場合にのみ有効です。
+ </para>
+ <para>
+ <!--
+ This parameter can only be set at server start.
+ -->
+ このパラメータは、サーバの起動時にのみ設定できます。
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry id="guc-allow-multiple-failover-requests-from-node" xreflabel="allow_multiple_failover_requests_from_node">
+ <term><varname>allow_multiple_failover_requests_from_node</varname> (<type>boolean</type>)
+ <indexterm>
+ <!--
+ <primary><varname>allow_multiple_failover_requests_from_node</varname> configuration parameter</primary>
+ -->
+ <primary><varname>allow_multiple_failover_requests_from_node</varname> 設定パラメータ</primary>
+ </indexterm>
+ </term>
+ <listitem>
+ <para>
+ <!--
+ This parameter works in connection with the
+ <xref linkend="guc-failover-require-consensus">. When enabled, a single <productname>Pgpool-II</productname>
+ node can cast multiple votes for the failover.
+ -->
+ このパラメータは、<xref linkend="guc-failover-require-consensus">と連携して動作します。
+ 有効にすると、単一の<productname>Pgpool-II</productname>ノードが複数のフェイルオーバ投票をできます。
+ </para>
+ <para>
+ <!--
+ For example, in a three node watchdog cluster, if one <productname>Pgpool-II</productname> node sends two
+ failover requests for a particular backend node failover, Both requests will be counted as a separate
+ vote in the favor of the failover and <productname>Pgpool-II</productname> will execute the failover,
+ even if it does not get the vote from any other <productname>Pgpool-II</productname> node.
+ -->
+ たとえば、3ノードの<application>watchdog</application>クラスタでは、1つの<productname>Pgpool-II</productname>ノードが特定のバックエンドノードのフェイルオーバに対して2つのフェイルオーバ要求を送信すると、両方の要求が別の投票としてカウントされ、たとえ他の<productname>Pgpool-II</productname>ノードからの投票を得なくても、<productname>Pgpool-II</productname>がフェイルオーバを実行します。
+ </para>
+
+ <para>
+ たとえば、ヘルスチェックでエラーが検出されても有効投票数に達しない場合、障害が引き続き発生していて次のヘルスチェックで再度エラーが検出されれば、都合2票が投票されることになります。ほかのwatchdogが検出しない恒久的な障害が発生した際にフェイルオーバを引き起こしたい時に有用です。
+ </para>
+
+ <para>
+ <!--
+ Default is off.
+ -->
+ デフォルト値はoffです。
+ </para>
+ <para>
+ <!--
+ <varname>allow_multiple_failover_requests_from_node</varname> is not available prior to
+ <productname>Pgpool-II </productname><emphasis>V3.7</emphasis>. and it is only
+ effective when both <xref linkend="guc-failover-when-quorum-exists"> and
+ <xref linkend="guc-failover-require-consensus"> are enabled
+ -->
+ <varname>allow_multiple_failover_requests_from_node</varname>は、<productname>Pgpool-II </productname><emphasis>V3.7</emphasis>以前では利用できません。
+ <xref linkend="guc-failover-when-quorum-exists">と<xref linkend="guc-failover-require-consensus">の両方が有効な場合にのみ有効です。
+ </para>
+ <para>
+ <!--
+ This parameter can only be set at server start.
+ -->
+ このパラメータは、サーバの起動時にのみ設定できます。
+ </para>
+ </listitem>
+ </varlistentry>
- </para>
+ </variablelist>
+ </sect2>
+
+ <sect2 id="config-watchdog-lifecheck">
+ <!--
+ <title>Life checking <productname>Pgpool-II</productname> </title>
+ -->
+ <title><productname>Pgpool-II</productname>の死活監視</title>
- <variablelist>
+ <para>
+ <!--
+ Watchdog checks pgpool-II status periodically. This is called "life check".
+ -->
+ Watchdogは、定期的にpgpool-IIの状態を監視します。
- <varlistentry id="guc-wd-lifecheck-method" xreflabel="wd_lifecheck_method">
- <term><varname>wd_lifecheck_method</varname> (<type>string</type>)
- <indexterm>
-<!--
+ </para>
+
+ <variablelist>
+
+ <varlistentry id="guc-wd-lifecheck-method" xreflabel="wd_lifecheck_method">
+ <term><varname>wd_lifecheck_method</varname> (<type>string</type>)
+ <indexterm>
+ <!--
<primary><varname>wd_lifecheck_method</varname> configuration parameter</primary>
--->
+ -->
<primary><varname>wd_lifecheck_method</varname>設定パラメータ</primary>
- </indexterm>
- </term>
- <listitem>
- <para>
-<!--
+ </indexterm>
+ </term>
+ <listitem>
+ <para>
+ <!--
Specifies the method of life check. This can be either of <literal>'heartbeat'</literal> (default),
<literal>'query'</literal> or <literal>'external'</literal>.
--->
-死活監視の方法を指定します。
-指定できる値は <literal>'heartbeat'</literal> (デフォルト)、<literal>'query'</literal>、または<literal>'external'</literal> です。
- </para>
- <para>
-<!--
- <literal>heartbeat</literal>: In this mode, watchdog sends the heartbeat singals (<acronym>UDP</acronym> packets)
- periodically to other <productname>Pgpool-II</productname>. Similarly watchdog also receives the signals
- from other <productname>Pgpool-II</productname> .
- If there are no signal for a certain period, watchdog regards is as failure
- of the <productname>Pgpool-II</productname> .
--->
-<literal>'heartbeat'</literal>を指定した場合には、監視は「ハートビートモード」で行われます。
-watchdog は一定間隔でハートビート信号（UDP パケット）を他の<productname>Pgpool-II</productname>へ送信します。
-またwatchdogは他の<productname>Pgpool-II</productname>から送られてくる信号を受信します。
-これが一定時間以上途絶えた場合にはその<productname>Pgpool-II</productname>に障害が発生したと判断します。
- </para>
- <para>
-<!--
- <literal>query</literal>: In this mode, watchdog sends the monitoring queries
- to other <productname>Pgpool-II</productname> and checks the response.
- When installation location between <productname>Pgpool-II</productname>
- servers is far, <literal>query</literal> may be useful.
--->
-<literal>query</literal>: このモードではwatchdogは監視用のクエリを<productname>Pgpool-II</productname>に発行し、それが成功するかどうかで pgpool-II が生きているかどうかを判断します。
-<productname>Pgpool-II</productname>サーバ間の設置場所が離れている場合、<literal>query</literal>モードが有効かもしれません。
- <caution>
+ -->
+ 死活監視の方法を指定します。
+ 指定できる値は <literal>'heartbeat'</literal> (デフォルト)、<literal>'query'</literal>、または<literal>'external'</literal> です。
+ </para>
+ <para>
+ <!--
+ <literal>heartbeat</literal>: In this mode, watchdog sends the heartbeat singals (<acronym>UDP</acronym> packets)
+ periodically to other <productname>Pgpool-II</productname>. Similarly watchdog also receives the signals
+ from other <productname>Pgpool-II</productname> .
+ If there are no signal for a certain period, watchdog regards is as failure
+ of the <productname>Pgpool-II</productname> .
+ -->
+ <literal>'heartbeat'</literal>を指定した場合には、監視は「ハートビートモード」で行われます。
+ watchdog は一定間隔でハートビート信号（UDP パケット）を他の<productname>Pgpool-II</productname>へ送信します。
+ またwatchdogは他の<productname>Pgpool-II</productname>から送られてくる信号を受信します。
+ これが一定時間以上途絶えた場合にはその<productname>Pgpool-II</productname>に障害が発生したと判断します。
+ </para>
+ <para>
+ <!--
+ <literal>query</literal>: In this mode, watchdog sends the monitoring queries
+ to other <productname>Pgpool-II</productname> and checks the response.
+ When installation location between <productname>Pgpool-II</productname>
+ servers is far, <literal>query</literal> may be useful.
+ -->
+ <literal>query</literal>: このモードではwatchdogは監視用のクエリを<productname>Pgpool-II</productname>に発行し、それが成功するかどうかで pgpool-II が生きているかどうかを判断します。
+ <productname>Pgpool-II</productname>サーバ間の設置場所が離れている場合、<literal>query</literal>モードが有効かもしれません。
+ <caution>
<para>
-<!--
+ <!--
In query mode, you need to set <xref linkend="guc-num-init-children">
large enough if you plan to use watchdog.
This is because the watchdog process connects to
<productname>Pgpool-II</productname> as a client.
--->
-クエリモードでは、<xref linkend="guc-num-init-children">を十分大きな値にしてください。
-watchdogプロセスも<productname>Pgpool-II</productname>にクライアントとして接続するからです。
- </para>
+ -->
+ クエリモードでは、<xref linkend="guc-num-init-children">を十分大きな値にしてください。
+ watchdogプロセスも<productname>Pgpool-II</productname>にクライアントとして接続するからです。
+ </para>
</caution>
- </para>
- <para>
-<!--
+ </para>
+ <para>
+ <!--
<literal>external</literal>: This mode disables the built
in lifecheck of <productname>Pgpool-II</productname> watchdog
and relies on external system to provide node health checking
of local and remote watchdog nodes.
--->
-<literal>external</literal>: このモードでは、<productname>Pgpool-II</productname>に組み込みの死活監視は無効になり、watchdogはローカルとリモートのノード死活監視を行うために外部システムを使います。
- </para>
+ -->
+ <literal>external</literal>: このモードでは、<productname>Pgpool-II</productname>に組み込みの死活監視は無効になり、watchdogはローカルとリモートのノード死活監視を行うために外部システムを使います。
+ </para>
- <para>
-<!--
+ <para>
+ <!--
<literal>external</literal> mode is not available in versions prior to
<productname>Pgpool-II</productname> <emphasis>V3.5</emphasis>.
--->
-<literal>external</literal>モードは<productname>Pgpool-II</productname> <emphasis>V3.5</emphasis>よりも前のバージョンでは提供されていません。
- </para>
+ -->
+ <literal>external</literal>モードは<productname>Pgpool-II</productname> <emphasis>V3.5</emphasis>よりも前のバージョンでは提供されていません。
+ </para>
- <para>
-<!--
+ <para>
+ <!--
This parameter can only be set at server start.
--->
-このパラメータは、サーバ起動時にのみ設定できます。
- </para>
- </listitem>
- </varlistentry>
+ -->
+ このパラメータは、サーバ起動時にのみ設定できます。
+ </para>
+ </listitem>
+ </varlistentry>
- <varlistentry id="guc-wd-monitoring-interfaces-list" xreflabel="wd_monitoring_interfaces_list">
+ <varlistentry id="guc-wd-monitoring-interfaces-list" xreflabel="wd_monitoring_interfaces_list">
<term><varname>wd_monitoring_interfaces_list</varname> (<type>string</type>)
- <indexterm>
-<!--
+ <indexterm>
+ <!--
<primary><varname>wd_monitoring_interfaces_list</varname> configuration parameter</primary>
--->
+ -->
<primary><varname>wd_monitoring_interfaces_list</varname>設定パラメータ</primary>
- </indexterm>
+ </indexterm>
</term>
<listitem>
- <para>
-<!--
+ <para>
+ <!--
Specify a comma separated list of network device names, to be monitored by the watchdog process
for the network link state. If all network interfaces in the list becomes inactive
(disabled or cable unplugged), the watchdog will consider it as a complete network failure
@@ -947,683 +947,683 @@ watchdogプロセスも<productname>Pgpool-II</productname>にクライアント
Specifying an <literal>''</literal>(empty) list disables the network interface monitoring.
Setting it to <literal>'any'</literal> enables the monitoring on all available network interfaces
except the loopback. Default is <literal>''</literal> empty list (monitoring disabled).
--->
-watchdogプロセスがネットワークリンクの状態を監視するネットワークデバイス名をカンマ区切りのリストで指定します。
-リスト中の全てのネットワークインタフェースが（無効化あるいはケーブルを抜かれることで）非アクティブになると、watchdog はネットワークが完全に故障したと見なし自らを停止させませす。
-<literal>''</literal>（空文字）を指定するとネットワークインタフェースの監視が無効になります。
-<literal>'any'</literal>を指定すると、ループバック以外の存在する全てのネットワークインタフェースを監視します。
-デフォルトの値は<literal>''</literal>空リスト '' （監視は無効）です。
- </para>
-
- <para>
-<!--
+ -->
+ watchdogプロセスがネットワークリンクの状態を監視するネットワークデバイス名をカンマ区切りのリストで指定します。
+ リスト中の全てのネットワークインタフェースが（無効化あるいはケーブルを抜かれることで）非アクティブになると、watchdog はネットワークが完全に故障したと見なし自らを停止させませす。
+ <literal>''</literal>（空文字）を指定するとネットワークインタフェースの監視が無効になります。
+ <literal>'any'</literal>を指定すると、ループバック以外の存在する全てのネットワークインタフェースを監視します。
+ デフォルトの値は<literal>''</literal>空リスト '' （監視は無効）です。
+ </para>
+
+ <para>
+ <!--
<varname>wd_monitoring_interfaces_list</varname> is not available in versions prior to
<productname>Pgpool-II</productname> <emphasis>V3.5</emphasis>.
--->
-<varname>wd_monitoring_interfaces_list</varname>は、<productname>Pgpool-II</productname> <emphasis>V3.5</emphasis>よりも前のバージョンでは提供されていません。
- </para>
+ -->
+ <varname>wd_monitoring_interfaces_list</varname>は、<productname>Pgpool-II</productname> <emphasis>V3.5</emphasis>よりも前のバージョンでは提供されていません。
+ </para>
- <para>
-<!--
+ <para>
+ <!--
This parameter can only be set at server start.
--->
-このパラメータは、サーバ起動時にのみ設定できます。
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry id="guc-wd-interval" xreflabel="wd_interval">
- <term><varname>wd_interval</varname> (<type>integer</type>)
- <indexterm>
+ -->
+ このパラメータは、サーバ起動時にのみ設定できます。
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry id="guc-wd-interval" xreflabel="wd_interval">
+ <term><varname>wd_interval</varname> (<type>integer</type>)
+ <indexterm>
<primary><varname>wd_interval</varname> configuration parameter</primary>
-<!--
+ <!--
<primary><varname>wd_interval</varname>設定パラメータ</primary>
--->
- </indexterm>
- </term>
- <listitem>
- <para>
-<!--
+ -->
+ </indexterm>
+ </term>
+ <listitem>
+ <para>
+ <!--
Specifies the interval between life checks of <productname>Pgpool-II</productname>
in seconds. (A number greater than or equal to 1) Default is 10.
--->
-<productname>Pgpool-II</productname>が死活監視を行う間隔を秒単位で指定します（１以上の数字）。
-デフォルトは10です。
- </para>
+ -->
+ <productname>Pgpool-II</productname>が死活監視を行う間隔を秒単位で指定します（１以上の数字）。
+ デフォルトは10です。
+ </para>
- <para>
-<!--
+ <para>
+ <!--
This parameter can only be set at server start.
--->
-このパラメータは、サーバ起動時にのみ設定できます。
- </para>
- </listitem>
+ -->
+ このパラメータは、サーバ起動時にのみ設定できます。
+ </para>
+ </listitem>
</varlistentry>
- <varlistentry id="guc-wd-priority" xreflabel="wd_priority">
- <term><varname>wd_priority</varname> (<type>integer</type>)
- <indexterm>
-<!--
+ <varlistentry id="guc-wd-priority" xreflabel="wd_priority">
+ <term><varname>wd_priority</varname> (<type>integer</type>)
+ <indexterm>
+ <!--
<primary><varname>wd_priority</varname> configuration parameter</primary>
--->
+ -->
<primary><varname>wd_priority</varname>設定パラメータ</primary>
- </indexterm>
- </term>
- <listitem>
- <para>
-<!--
+ </indexterm>
+ </term>
+ <listitem>
+ <para>
+ <!--
This parameter can be used to elevate the local watchdog node priority in the elections
to select master watchdog node.
The node with the higher <varname>wd_priority</varname> value will get selected
as master watchdog node when cluster will be electing its new master node
at the time of cluster startup or in the event of old master watchdog node failure
--->
-このパラメータによってローカルのwatchdogノードがマスターに選ばれる優先度を上げることができます。
-クラスタの初期起動時や古いマスターノードが故障した状況でクラスタがマスターノードの選択を行う際に、<varname>wd_priority</varname>が高いノードがマスターwatchdogノードに選ばれます。
- </para>
- <para>
-<!--
- <varname>wd_priority</varname> is not available in versions prior to
- <productname>Pgpool-II</productname> <emphasis>V3.5</emphasis>.
--->
-<varname>wd_priority</varname>は、<productname>Pgpool-II</productname> <emphasis>V3.5</emphasis>よりも前のバージョンでは提供されていません。
- </para>
+ -->
+ このパラメータによってローカルのwatchdogノードがマスターに選ばれる優先度を上げることができます。
+ クラスタの初期起動時や古いマスターノードが故障した状況でクラスタがマスターノードの選択を行う際に、<varname>wd_priority</varname>が高いノードがマスターwatchdogノードに選ばれます。
+ </para>
+ <para>
+ <!--
+ <varname>wd_priority</varname> is not available in versions prior to
+ <productname>Pgpool-II</productname> <emphasis>V3.5</emphasis>.
+ -->
+ <varname>wd_priority</varname>は、<productname>Pgpool-II</productname> <emphasis>V3.5</emphasis>よりも前のバージョンでは提供されていません。
+ </para>
- <para>
-<!--
+ <para>
+ <!--
This parameter can only be set at server start.
--->
-このパラメータは、サーバ起動時にのみ設定できます。
- </para>
- </listitem>
- </varlistentry>
+ -->
+ このパラメータは、サーバ起動時にのみ設定できます。
+ </para>
+ </listitem>
+ </varlistentry>
- <varlistentry id="guc-wd-ipc-socket-dir" xreflabel="wd_ipc_socket_dir">
- <term><varname>wd_ipc_socket_dir</varname> (<type>string</type>)
- <indexterm>
-<!--
+ <varlistentry id="guc-wd-ipc-socket-dir" xreflabel="wd_ipc_socket_dir">
+ <term><varname>wd_ipc_socket_dir</varname> (<type>string</type>)
+ <indexterm>
+ <!--
<primary><varname>wd_ipc_socket_dir</varname> configuration parameter</primary>
--->
+ -->
<primary><varname>wd_ipc_socket_dir</varname>設定パラメータ</primary>
- </indexterm>
- </term>
- <listitem>
- <para>
-<!--
+ </indexterm>
+ </term>
+ <listitem>
+ <para>
+ <!--
The directory where the <acronym>UNIX</acronym> domain socket
- accepting <productname>Pgpool-II</productname>
+ accepting <productname>Pgpool-II</productname>
watchdog <acronym>IPC</acronym> connections will be created.
Default is <literal>'/tmp'</literal>.
Be aware that this socket might be deleted by a cron job.
We recommend to set this value to <literal>'/var/run'</literal> or such directory.
--->
-<productname>Pgpool-II</productname> watchdog の<acronym>IPC</acronym>通信で受け付ける UNIX ドメインソケットが作成されるディレクトリを指定します。
-デフォルトは<literal>'/tmp'</literal>です。
-このソケットが cron ジョブで削除されることのないよう気をつけてください。
-この値は <literal>'/var/run'</literal>などのディレクトリに設定することを推奨します。
- </para>
- <para>
-<!--
+ -->
+ <productname>Pgpool-II</productname> watchdog の<acronym>IPC</acronym>通信で受け付ける UNIX ドメインソケットが作成されるディレクトリを指定します。
+ デフォルトは<literal>'/tmp'</literal>です。
+ このソケットが cron ジョブで削除されることのないよう気をつけてください。
+ この値は <literal>'/var/run'</literal>などのディレクトリに設定することを推奨します。
+ </para>
+ <para>
+ <!--
<varname>wd_ipc_socket_dir</varname> is not available in versions prior to
<productname>Pgpool-II</productname> <emphasis>V3.5</emphasis>.
--->
-<varname>wd_ipc_socket_dir</varname>は、<productname>Pgpool-II</productname> <emphasis>V3.5</emphasis>よりも前のバージョンでは提供されていません。
- </para>
- <para>
-<!--
+ -->
+ <varname>wd_ipc_socket_dir</varname>は、<productname>Pgpool-II</productname> <emphasis>V3.5</emphasis>よりも前のバージョンでは提供されていません。
+ </para>
+ <para>
+ <!--
This parameter can only be set at server start.
--->
-このパラメータは、サーバ起動時にのみ設定できます。
- </para>
+ -->
+ このパラメータは、サーバ起動時にのみ設定できます。
+ </para>
</listitem>
- </varlistentry>
-
- </variablelist>
- </sect2>
-
- <sect2 id="config-watchdog-lifecheck-heartbeat">
-<!--
- <title>Lifecheck Heartbeat mode configuration</title>
--->
- <title>死活監視：ハートビートモードの設定</title>
-
- <variablelist>
- <varlistentry id="guc-wd-heartbeat-port" xreflabel="wd_heartbeat_port">
- <term><varname>wd_heartbeat_port</varname> (<type>integer</type>)
- <indexterm>
-<!--
+ </varlistentry>
+
+ </variablelist>
+ </sect2>
+
+ <sect2 id="config-watchdog-lifecheck-heartbeat">
+ <!--
+ <title>Lifecheck Heartbeat mode configuration</title>
+ -->
+ <title>死活監視：ハートビートモードの設定</title>
+
+ <variablelist>
+ <varlistentry id="guc-wd-heartbeat-port" xreflabel="wd_heartbeat_port">
+ <term><varname>wd_heartbeat_port</varname> (<type>integer</type>)
+ <indexterm>
+ <!--
<primary><varname>wd_heartbeat_port</varname> configuration parameter</primary>
--->
+ -->
<primary><varname>wd_heartbeat_port</varname>設定パラメータ</primary>
- </indexterm>
- </term>
- <listitem>
- <para>
-<!--
+ </indexterm>
+ </term>
+ <listitem>
+ <para>
+ <!--
Specifies the <acronym>UDP</acronym> port number to receive heartbeat signals.
Default is 9694.
<varname>wd_heartbeat_port</varname> is only applicable if the
<xref linkend="guc-wd-lifecheck-method"> is set to <literal>'heartbeat'</literal>
--->
-ハートビート信号を受信する<acronym>UDP</acronym>ポート番号を指定します。
-デフォルトは 9694 です。
-<xref linkend="guc-wd-lifecheck-method">が<literal>'heartbeat'</literal>に設定されている場合のみ有効です。
- </para>
- <para>
-<!--
+ -->
+ ハートビート信号を受信する<acronym>UDP</acronym>ポート番号を指定します。
+ デフォルトは 9694 です。
+ <xref linkend="guc-wd-lifecheck-method">が<literal>'heartbeat'</literal>に設定されている場合のみ有効です。
+ </para>
+ <para>
+ <!--
This parameter can only be set at server start.
--->
-このパラメータは、サーバ起動時にのみ設定できます。
- </para>
- </listitem>
-</varlistentry>
-
- <varlistentry id="guc-wd-heartbeat-keepalive" xreflabel="wd_heartbeat_keepalive">
- <term><varname>wd_heartbeat_keepalive</varname> (<type>integer</type>)
- <indexterm>
-<!--
+ -->
+ このパラメータは、サーバ起動時にのみ設定できます。
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry id="guc-wd-heartbeat-keepalive" xreflabel="wd_heartbeat_keepalive">
+ <term><varname>wd_heartbeat_keepalive</varname> (<type>integer</type>)
+ <indexterm>
+ <!--
<primary><varname>wd_heartbeat_keepalive</varname> configuration parameter</primary>
--->
+ -->
<primary><varname>wd_heartbeat_keepalive</varname>設定パラメータ</primary>
- </indexterm>
- </term>
- <listitem>
- <para>
-<!--
+ </indexterm>
+ </term>
+ <listitem>
+ <para>
+ <!--
Specifies the interval time in seconds between sending the heartbeat signals.
Default is 2.
<varname>wd_heartbeat_keepalive</varname> is only applicable if the
<xref linkend="guc-wd-lifecheck-method"> is set to <literal>'heartbeat'</literal>
--->
-ハートビート信号を送信する間隔（秒）を指定します。
-デフォルトは2です。
-<varname>wd_heartbeat_keepalive</varname>は、<xref linkend="guc-wd-lifecheck-method">が<literal>'heartbeat'</literal>に設定されている場合のみ有効です。
- </para>
-
- <para>
-<!--
+ -->
+ ハートビート信号を送信する間隔（秒）を指定します。
+ デフォルトは2です。
+ <varname>wd_heartbeat_keepalive</varname>は、<xref linkend="guc-wd-lifecheck-method">が<literal>'heartbeat'</literal>に設定されている場合のみ有効です。
+ </para>
+
+ <para>
+ <!--
This parameter can only be set at server start.
--->
-このパラメータは、サーバ起動時にのみ設定できます。
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry id="guc-wd-heartbeat-deadtime" xreflabel="wd_heartbeat_deadtime">
- <term><varname>wd_heartbeat_deadtime</varname> (<type>integer</type>)
- <indexterm>
-<!--
+ -->
+ このパラメータは、サーバ起動時にのみ設定できます。
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry id="guc-wd-heartbeat-deadtime" xreflabel="wd_heartbeat_deadtime">
+ <term><varname>wd_heartbeat_deadtime</varname> (<type>integer</type>)
+ <indexterm>
+ <!--
<primary><varname>wd_heartbeat_deadtime</varname> configuration parameter</primary>
--->
+ -->
<primary><varname>wd_heartbeat_deadtime</varname>設定パラメータ</primary>
- </indexterm>
- </term>
- <listitem>
- <para>
-<!--
+ </indexterm>
+ </term>
+ <listitem>
+ <para>
+ <!--
Specifies the time in seconds before marking the remote watchdog node as failed/dead node,
if no heartbeat signal is received within that time.
DDefault is <literal>30</literal>
<varname>wd_heartbeat_deadtime</varname> is only applicable if the
<xref linkend="guc-wd-lifecheck-method"> is set to <literal>'heartbeat'</literal>
--->
-このオプションで指定された間隔（秒）の間ハートビート信号が途絶えた場合、リモートのwatchdogに障害が発生したとみなされます。
-デフォルトは<literal>30</literal>です。
- </para>
- <para>
-<!--
+ -->
+ このオプションで指定された間隔（秒）の間ハートビート信号が途絶えた場合、リモートのwatchdogに障害が発生したとみなされます。
+ デフォルトは<literal>30</literal>です。
+ </para>
+ <para>
+ <!--
This parameter can only be set at server start.
--->
-このパラメータは、サーバ起動時にのみ設定できます。
- </para>
-
- </listitem>
- </varlistentry>
- <varlistentry id="guc-heartbeat-destination" xreflabel="heartbeat_destination<emphasis>0</emphasis>">
- <term><varname>heartbeat_destination0</varname> (<type>string</type>)
+ -->
+ このパラメータは、サーバ起動時にのみ設定できます。
+ </para>
+
+ </listitem>
+ </varlistentry>
+ <varlistentry id="guc-heartbeat-destination" xreflabel="heartbeat_destination<emphasis>0</emphasis>">
+ <term><varname>heartbeat_destination0</varname> (<type>string</type>)
<indexterm>
-<!--
+ <!--
<primary><varname>heartbeat_destination</varname> configuration parameter</primary>
--->
+ -->
<primary><varname>heartbeat_destination</varname>設定パラメータ</primary>
- </indexterm>
- </term>
- <listitem>
- <para>
-<!--
+ </indexterm>
+ </term>
+ <listitem>
+ <para>
+ <!--
Specifies the <acronym>IP</acronym> address or <acronym>hostname</acronym> of destination the remote
<productname>Pgpool-II</productname> for sending the heartbeat signals.
Multiple destinations can be configured for the heartbeat singnals,
- the number at the end of the parameter name is
+ the number at the end of the parameter name is
referred as the "destination number", that starts from 0.
--->
-ハートビート信号の送る先の<acronym>IP</acronym>アドレスまたは <acronym>ホスト名</acronym>を指定します。
-複数のハートビート信号の送り先が指定可能です。
-0から始まるパラメータの最後の部分は送り先の番号です。
- </para>
- <para>
-<!--
+ -->
+ ハートビート信号の送る先の<acronym>IP</acronym>アドレスまたは <acronym>ホスト名</acronym>を指定します。
+ 複数のハートビート信号の送り先が指定可能です。
+ 0から始まるパラメータの最後の部分は送り先の番号です。
+ </para>
+ <para>
+ <!--
<varname>heartbeat_destination</varname> is only applicable if the
<xref linkend="guc-wd-lifecheck-method"> is set to <literal>'heartbeat'</literal>
--->
-<varname>heartbeat_destination</varname>は、<xref linkend="guc-wd-lifecheck-method">が<literal>'heartbeat'</literal>に設定されている場合のみ有効です。
- </para>
- <para>
-<!--
+ -->
+ <varname>heartbeat_destination</varname>は、<xref linkend="guc-wd-lifecheck-method">が<literal>'heartbeat'</literal>に設定されている場合のみ有効です。
+ </para>
+ <para>
+ <!--
This parameter can only be set at server start.
--->
-このパラメータは、サーバ起動時にのみ設定できます。
- </para>
- </listitem>
- </varlistentry>
+ -->
+ このパラメータは、サーバ起動時にのみ設定できます。
+ </para>
+ </listitem>
+ </varlistentry>
- <varlistentry id="guc-heartbeat-destination-port" xreflabel="heartbeat_destination_port<emphasis>0</emphasis>">
- <term><varname>heartbeat_destination_port0</varname> (<type>integer</type>)
- <indexterm>
-<!--
+ <varlistentry id="guc-heartbeat-destination-port" xreflabel="heartbeat_destination_port<emphasis>0</emphasis>">
+ <term><varname>heartbeat_destination_port0</varname> (<type>integer</type>)
+ <indexterm>
+ <!--
<primary><varname>heartbeat_destination_port</varname> configuration parameter</primary>
--->
+ -->
<primary><varname>heartbeat_destination_port</varname>設定パラメータ</primary>
- </indexterm>
- </term>
- <listitem>
- <para>
-<!--
+ </indexterm>
+ </term>
+ <listitem>
+ <para>
+ <!--
Specifies the destination port number for the heartbeat_destinationX of the remote
<productname>Pgpool-II</productname> for sending the heartbeat signals.
Multiple destinations can be configured for the heartbeat singnals,
- the number at the end of the parameter name is
+ the number at the end of the parameter name is
referred as the "destination number", that starts from 0.
--->
-ハートビート信号の送る先のポート番号を指定します。
-複数のハートビート信号の送り先が指定可能です。
-0から始まるパラメータの最後の部分は送り先の番号です。
- </para>
- <para>
-<!--
+ -->
+ ハートビート信号の送る先のポート番号を指定します。
+ 複数のハートビート信号の送り先が指定可能です。
+ 0から始まるパラメータの最後の部分は送り先の番号です。
+ </para>
+ <para>
+ <!--
<varname>heartbeat_destination_port</varname> is only applicable if the
<xref linkend="guc-wd-lifecheck-method"> is set to <literal>'heartbeat'</literal>
--->
+ -->
<varname>heartbeat_destination_port</varname>は、<xref linkend="guc-wd-lifecheck-method"> が <literal>'heartbeat'</literal>に設定されている場合のみ有効です。
- </para>
- <para>
-<!--
+ </para>
+ <para>
+ <!--
This parameter can only be set at server start.
--->
-このパラメータは、サーバ起動時にのみ設定できます。
- </para>
+ -->
+ このパラメータは、サーバ起動時にのみ設定できます。
+ </para>
</listitem>
- </varlistentry>
+ </varlistentry>
- <varlistentry id="guc-heartbeat-device" xreflabel="heartbeat_device">
- <term><varname>heartbeat_device0</varname> (<type>string</type>)
- <indexterm>
-<!--
+ <varlistentry id="guc-heartbeat-device" xreflabel="heartbeat_device">
+ <term><varname>heartbeat_device0</varname> (<type>string</type>)
+ <indexterm>
+ <!--
<primary><varname>heartbeat_device</varname> configuration parameter</primary>
--->
+ -->
<primary><varname>heartbeat_device</varname>設定パラメータ</primary>
- </indexterm>
- </term>
- <listitem>
- <para>
-<!--
+ </indexterm>
+ </term>
+ <listitem>
+ <para>
+ <!--
Specifies the network device name for sending the heartbeat signals to the destination specified by
heartbeat_destinationX:heartbeat_destination_portX.
Different heartbeat devices can be configured for each heartbeat destination
by changing the value of X(destination number)
at the end of parameter name. The destination index number starts from 0.
--->
-heartbeat_destinationX:heartbeat_destination_portXで指定されるハートビートの送信先に用いるネットワークデバイス名を指定します。
-パラメータ名の最後にあるXの値（送信先番号）を変えることにより、ハートビートの送信先ごとに異なるハートビートデバイス番号を設定することが可能です。
-送信先番号は0から始まります。
- </para>
- <para>
-<!--
+ -->
+ heartbeat_destinationX:heartbeat_destination_portXで指定されるハートビートの送信先に用いるネットワークデバイス名を指定します。
+ パラメータ名の最後にあるXの値（送信先番号）を変えることにより、ハートビートの送信先ごとに異なるハートビートデバイス番号を設定することが可能です。
+ 送信先番号は0から始まります。
+ </para>
+ <para>
+ <!--
<varname>heartbeat_device</varname> is only applicable if the
<xref linkend="guc-wd-lifecheck-method"> is set to <literal>'heartbeat'</literal>
--->
-<varname>heartbeat_device</varname>は、<xref linkend="guc-wd-lifecheck-method">が<literal>'heartbeat'</literal>に設定されている場合のみ有効です。
- </para>
- <para>
-<!--
+ -->
+ <varname>heartbeat_device</varname>は、<xref linkend="guc-wd-lifecheck-method">が<literal>'heartbeat'</literal>に設定されている場合のみ有効です。
+ </para>
+ <para>
+ <!--
This parameter can only be set at server start.
--->
-このパラメータは、サーバ起動時にのみ設定できます。
- </para>
+ -->
+ このパラメータは、サーバ起動時にのみ設定できます。
+ </para>
</listitem>
- </varlistentry>
+ </varlistentry>
- </variablelist>
- </sect2>
+ </variablelist>
+ </sect2>
- <sect2 id="config-watchdog-lifecheck-query">
- <title>死活監視：クエリモードの設定</title>
+ <sect2 id="config-watchdog-lifecheck-query">
+ <title>死活監視：クエリモードの設定</title>
<variablelist>
-<varlistentry id="guc-wd-life-point" xreflabel="wd_life_point">
- <term><varname>wd_life_point</varname> (<type>integer</type>)
- <indexterm>
-<!--
+ <varlistentry id="guc-wd-life-point" xreflabel="wd_life_point">
+ <term><varname>wd_life_point</varname> (<type>integer</type>)
+ <indexterm>
+ <!--
<primary><varname>wd_life_point</varname> configuration parameter</primary>
--->
+ -->
<primary><varname>wd_life_point</varname>設定パラメータ</primary>
- </indexterm>
- </term>
- <listitem>
- <para>
-<!--
+ </indexterm>
+ </term>
+ <listitem>
+ <para>
+ <!--
Specifies the number of times to retry a failed life check of pgpool-II.
Valid value could be a number greater than or equal to 1.
Default is 3.
--->
-監視クエリの応答が得られなかった場合のリトライ回数を指定します。
-有効な値は1以上の整数です。
- </para>
- <para>
-<!--
+ -->
+ 監視クエリの応答が得られなかった場合のリトライ回数を指定します。
+ 有効な値は1以上の整数です。
+ </para>
+ <para>
+ <!--
<varname>wd_life_point</varname> is only applicable if the
<xref linkend="guc-wd-lifecheck-method"> is set to <literal>'query'</literal>
--->
-<xref linkend="guc-wd-lifecheck-method">が<literal>'query'</literal>の場合のみ、<varname>wd_life_point</varname>は有効です。
- </para>
- <para>
-<!--
+ -->
+ <xref linkend="guc-wd-lifecheck-method">が<literal>'query'</literal>の場合のみ、<varname>wd_life_point</varname>は有効です。
+ </para>
+ <para>
+ <!--
This parameter can only be set at server start.
--->
-このパラメータは、サーバ起動時にのみ設定できます。
- </para>
+ -->
+ このパラメータは、サーバ起動時にのみ設定できます。
+ </para>
</listitem>
- </varlistentry>
+ </varlistentry>
-<varlistentry id="guc-wd-lifecheck-query" xreflabel="wd_lifecheck_query">
- <term><varname>wd_lifecheck_query</varname> (<type>string</type>)
- <indexterm>
-<!--
+ <varlistentry id="guc-wd-lifecheck-query" xreflabel="wd_lifecheck_query">
+ <term><varname>wd_lifecheck_query</varname> (<type>string</type>)
+ <indexterm>
+ <!--
<primary><varname>wd_lifecheck_query</varname> configuration parameter</primary>
--->
+ -->
<primary><varname>wd_lifecheck_query</varname>設定パラメータ</primary>
- </indexterm>
- </term>
- <listitem>
- <para>
-<!--
+ </indexterm>
+ </term>
+ <listitem>
+ <para>
+ <!--
Specifies the query to use for the life check of remote <productname>Pgpool-II</productname>.
Default is <literal>"SELECT 1"</literal>.
--->
-リモートの<productname>Pgpool-II</productname>の死活監視に使うクエリを指定します。
-デフォルトは<literal>"SELECT 1"</literal>です。
- </para>
- <para>
-<!--
+ -->
+ リモートの<productname>Pgpool-II</productname>の死活監視に使うクエリを指定します。
+ デフォルトは<literal>"SELECT 1"</literal>です。
+ </para>
+ <para>
+ <!--
<varname>wd_lifecheck_query</varname> is only applicable if the
<xref linkend="guc-wd-lifecheck-method"> is set to <literal>'query'</literal>
--->
-<xref linkend="guc-wd-lifecheck-method">が<literal>'query'</literal>の場合のみ、<varname>wd_life_check_query</varname>は有効です。
- </para>
- <para>
-<!--
+ -->
+ <xref linkend="guc-wd-lifecheck-method">が<literal>'query'</literal>の場合のみ、<varname>wd_life_check_query</varname>は有効です。
+ </para>
+ <para>
+ <!--
This parameter can only be set at server start.
--->
-このパラメータは、サーバ起動時にのみ設定できます。
- </para>
+ -->
+ このパラメータは、サーバ起動時にのみ設定できます。
+ </para>
</listitem>
- </varlistentry>
+ </varlistentry>
- <varlistentry id="guc-wd-lifecheck-dbname" xreflabel="wd_lifecheck_dbname">
- <term><varname>wd_lifecheck_dbname</varname> (<type>string</type>)
- <indexterm>
-<!--
+ <varlistentry id="guc-wd-lifecheck-dbname" xreflabel="wd_lifecheck_dbname">
+ <term><varname>wd_lifecheck_dbname</varname> (<type>string</type>)
+ <indexterm>
+ <!--
<primary><varname>wd_lifecheck_dbname</varname> configuration parameter</primary>
--->
+ -->
<primary><varname>wd_lifecheck_dbname</varname>設定パラメータ</primary>
- </indexterm>
- </term>
- <listitem>
- <para>
-<!--
+ </indexterm>
+ </term>
+ <listitem>
+ <para>
+ <!--
Specifies the database name for the connection used for the
- life check of remote <productname>Pgpool-II</productname>.
+ life check of remote <productname>Pgpool-II</productname>.
Default is <literal>"template1"</literal>.
--->
-リモートの<productname>Pgpool-II</productname>の死活監視用の接続先のデータベース名です。
-デフォルトは<literal>'template1'</literal>です。
- </para>
- <para>
-<!--
+ -->
+ リモートの<productname>Pgpool-II</productname>の死活監視用の接続先のデータベース名です。
+ デフォルトは<literal>'template1'</literal>です。
+ </para>
+ <para>
+ <!--
<varname>wd_lifecheck_dbname</varname> is only applicable if the
<xref linkend="guc-wd-lifecheck-method"> is set to <literal>'query'</literal>
--->
-<xref linkend="guc-wd-lifecheck-method">が<literal>'query'</literal>の場合のみ、<varname>wd_life_check_dbname</varname>は有効です。
- </para>
- <para>
-<!--
+ -->
+ <xref linkend="guc-wd-lifecheck-method">が<literal>'query'</literal>の場合のみ、<varname>wd_life_check_dbname</varname>は有効です。
+ </para>
+ <para>
+ <!--
This parameter can only be set at server start.
--->
-このパラメータは、サーバ起動時にのみ設定できます。
- </para>
+ -->
+ このパラメータは、サーバ起動時にのみ設定できます。
+ </para>
</listitem>
- </varlistentry>
+ </varlistentry>
-<varlistentry id="guc-wd-lifecheck-user" xreflabel="wd_lifecheck_user">
- <term><varname>wd_lifecheck_user</varname> (<type>string</type>)
- <indexterm>
-<!--
+ <varlistentry id="guc-wd-lifecheck-user" xreflabel="wd_lifecheck_user">
+ <term><varname>wd_lifecheck_user</varname> (<type>string</type>)
+ <indexterm>
+ <!--
<primary><varname>wd_lifecheck_user</varname> configuration parameter</primary>
--->
+ -->
<primary><varname>wd_lifecheck_user</varname>設定パラメータ</primary>
- </indexterm>
- </term>
- <listitem>
- <para>
-<!--
+ </indexterm>
+ </term>
+ <listitem>
+ <para>
+ <!--
Specifies the user name for the connection used for the life
- check of remote <productname>Pgpool-II</productname>.
+ check of remote <productname>Pgpool-II</productname>.
Default is <literal>"nobody"</literal>.
--->
-リモートの<productname>Pgpool-II</productname>の死活監視用の接続先のユーザ名です。
-デフォルトは<literal>'nobody'</literal>です。
- </para>
- <para>
-<!--
+ -->
+ リモートの<productname>Pgpool-II</productname>の死活監視用の接続先のユーザ名です。
+ デフォルトは<literal>'nobody'</literal>です。
+ </para>
+ <para>
+ <!--
<varname>wd_lifecheck_user</varname> is only applicable if the
<xref linkend="guc-wd-lifecheck-method"> is set to <literal>'query'</literal>
--->
-<xref linkend="guc-wd-lifecheck-method">が<literal>'query'</literal>の場合のみ、<varname>wd_life_check_user</varname>は有効です。
- </para>
- <para>
-<!--
+ -->
+ <xref linkend="guc-wd-lifecheck-method">が<literal>'query'</literal>の場合のみ、<varname>wd_life_check_user</varname>は有効です。
+ </para>
+ <para>
+ <!--
This parameter can only be set at server start.
--->
-このパラメータは、サーバ起動時にのみ設定できます。
- </para>
+ -->
+ このパラメータは、サーバ起動時にのみ設定できます。
+ </para>
</listitem>
- </varlistentry>
+ </varlistentry>
- <varlistentry id="guc-wd-lifecheck-password" xreflabel="wd_lifecheck_password">
- <term><varname>wd_lifecheck_password</varname> (<type>string</type>)
- <indexterm>
-<!--
+ <varlistentry id="guc-wd-lifecheck-password" xreflabel="wd_lifecheck_password">
+ <term><varname>wd_lifecheck_password</varname> (<type>string</type>)
+ <indexterm>
+ <!--
<primary><varname>wd_lifecheck_password</varname> configuration parameter</primary>
--->
+ -->
<primary><varname>wd_lifecheck_password</varname>設定パラメータ</primary>
- </indexterm>
- </term>
- <listitem>
- <para>
-<!--
+ </indexterm>
+ </term>
+ <listitem>
+ <para>
+ <!--
Specifies the password for the user used for the life check of remote <productname>Pgpool-II</productname>.
Default is <literal>''</literal>(empty).
--->
-リモートの<productname>Pgpool-II</productname>の死活監視用の接続先のパスワードです。
-デフォルトは<literal>''</literal>（空文字）です。
- </para>
- <para>
-<!--
- If <varname>wd_lifecheck_password</varname> is left blank <productname>Pgpool-II</productname>
- will first try to get the password for <xref linkend="guc-wd-lifecheck-user"> from
- <xref linkend="guc-pool-passwd"> file before using the empty password.
--->
-<varname>wd_lifecheck_password</varname>が空白のままであった場合、<productname>Pgpool-II</productname>は空のパスワードを使用する前に<xref linkend="guc-pool-passwd">ファイルから<xref linkend="guc-wd-lifecheck-user">のパスワードの取得を試みます。
- </para>
- <para>
-<!--
- You can also specify AES256-CBC encrypted password in <varname>wd_lifecheck_password</varname> field.
- To specify the <literal>AES</literal> encrypted password, password string must be prefixed with
- <literal>AES</literal> after encrypting (using <literal>aes-256-cbc</literal> algorithm) and
- encoding to <literal>base64</literal>.
--->
-<varname>wd_lifecheck_password</varname>にAES256-CBCで暗号化されたパスワードも指定することができます。
-AESで暗号化されたパスワードを指定するためには、パスワード文字列は暗号化（<literal>aes-256-cbc</literal>アルゴリズムを使用）および<literal>base64</literal>でエンコードした後、<literal>AES</literal>を接頭辞として付けなければいけません。
- </para>
- <para>
-<!--
- To specify the unencrypted clear text password, prefix the password string with
- <literal>TEXT</literal>. For example if you want to set <literal>mypass</literal> as
- a password, you should specify <literal>TEXTmypass</literal> in the password field.
- In the absence of a valid prefix, <productname>Pgpool-II</productname> will considered
- the string as a plain text password.
--->
-暗号化されていないクリアテキストパスワードを指定するためには、<literal>TEXT</literal>をパスワード文字列の前に付けます。
-例えば、パスワードとして<literal>mypass</literal>を設定したい場合、パスワードフィールドに<literal>TEXTmypass</literal>と指定すべきです。
- </para>
- <para>
-<!--
- You can also use <xref linkend="PG-ENC"> utility to create the correctly formatted
- <literal>AES</literal> encrypted password strings.
--->
-正しくフォーマットされたAESで暗号化されたパスワード文字列を<xref linkend="PG-ENC">コマンドを使用して作成することもできます。
+ -->
+ リモートの<productname>Pgpool-II</productname>の死活監視用の接続先のパスワードです。
+ デフォルトは<literal>''</literal>（空文字）です。
+ </para>
+ <para>
+ <!--
+ If <varname>wd_lifecheck_password</varname> is left blank <productname>Pgpool-II</productname>
+ will first try to get the password for <xref linkend="guc-wd-lifecheck-user"> from
+ <xref linkend="guc-pool-passwd"> file before using the empty password.
+ -->
+ <varname>wd_lifecheck_password</varname>が空白のままであった場合、<productname>Pgpool-II</productname>は空のパスワードを使用する前に<xref linkend="guc-pool-passwd">ファイルから<xref linkend="guc-wd-lifecheck-user">のパスワードの取得を試みます。
+ </para>
+ <para>
+ <!--
+ You can also specify AES256-CBC encrypted password in <varname>wd_lifecheck_password</varname> field.
+ To specify the <literal>AES</literal> encrypted password, password string must be prefixed with
+ <literal>AES</literal> after encrypting (using <literal>aes-256-cbc</literal> algorithm) and
+ encoding to <literal>base64</literal>.
+ -->
+ <varname>wd_lifecheck_password</varname>にAES256-CBCで暗号化されたパスワードも指定することができます。
+ AESで暗号化されたパスワードを指定するためには、パスワード文字列は暗号化（<literal>aes-256-cbc</literal>アルゴリズムを使用）および<literal>base64</literal>でエンコードした後、<literal>AES</literal>を接頭辞として付けなければいけません。
+ </para>
+ <para>
+ <!--
+ To specify the unencrypted clear text password, prefix the password string with
+ <literal>TEXT</literal>. For example if you want to set <literal>mypass</literal> as
+ a password, you should specify <literal>TEXTmypass</literal> in the password field.
+ In the absence of a valid prefix, <productname>Pgpool-II</productname> will considered
+ the string as a plain text password.
+ -->
+ 暗号化されていないクリアテキストパスワードを指定するためには、<literal>TEXT</literal>をパスワード文字列の前に付けます。
+ 例えば、パスワードとして<literal>mypass</literal>を設定したい場合、パスワードフィールドに<literal>TEXTmypass</literal>と指定すべきです。
+ </para>
+ <para>
+ <!--
+ You can also use <xref linkend="PG-ENC"> utility to create the correctly formatted
+ <literal>AES</literal> encrypted password strings.
+ -->
+ 正しくフォーマットされたAESで暗号化されたパスワード文字列を<xref linkend="PG-ENC">コマンドを使用して作成することもできます。
<note>
- <para>
-<!--
- <productname>Pgpool-II</productname> will require a valid decryption key at the
- startup to use the encrypted passwords.
- see <xref linkend="auth-aes-decryption-key"> for more details on providing the
- decryption key to <productname>Pgpool-II</productname>
--->
-<productname>Pgpool-II</productname>は暗号化されたパスワードを使うために起動時に有効な復号鍵を要求します。
-<productname>Pgpool-II</productname>に復号鍵を提供する方法の詳細は<xref linkend="auth-aes-decryption-key">を参照してください。
- </para>
+ <para>
+ <!--
+ <productname>Pgpool-II</productname> will require a valid decryption key at the
+ startup to use the encrypted passwords.
+ see <xref linkend="auth-aes-decryption-key"> for more details on providing the
+ decryption key to <productname>Pgpool-II</productname>
+ -->
+ <productname>Pgpool-II</productname>は暗号化されたパスワードを使うために起動時に有効な復号鍵を要求します。
+ <productname>Pgpool-II</productname>に復号鍵を提供する方法の詳細は<xref linkend="auth-aes-decryption-key">を参照してください。
+ </para>
</note>
- </para>
- <para>
+ </para>
+ <para>
-<!--
+ <!--
<varname>wd_lifecheck_password</varname> is only applicable if the
<xref linkend="guc-wd-lifecheck-method"> is set to <literal>'query'</literal>
--->
-<xref linkend="guc-wd-lifecheck-method">が<literal>'query'</literal>の場合のみ、<varname>wd_life_check_password</varname>は有効です。
- </para>
- <para>
-<!--
+ -->
+ <xref linkend="guc-wd-lifecheck-method">が<literal>'query'</literal>の場合のみ、<varname>wd_life_check_password</varname>は有効です。
+ </para>
+ <para>
+ <!--
This parameter can only be set at server start.
--->
-このパラメータは、サーバ起動時にのみ設定できます。
- </para>
- <para>
-<!--
+ -->
+ このパラメータは、サーバ起動時にのみ設定できます。
+ </para>
+ <para>
+ <!--
Default is <literal>''</literal>(empty).
--->
-デフォルトは<literal>''</literal>（空文字）です.
- </para>
+ -->
+ デフォルトは<literal>''</literal>（空文字）です.
+ </para>
</listitem>
- </varlistentry>
+ </varlistentry>
- </variablelist>
- </sect2>
+ </variablelist>
+ </sect2>
- <sect2 id="config-watchdog-server-configuration">
-<!--
- <title>Watchdog servers configurations</title>
--->
- <title>Watchdogサーバの設定</title>
+ <sect2 id="config-watchdog-server-configuration">
+ <!--
+ <title>Watchdog servers configurations</title>
+ -->
+ <title>Watchdogサーバの設定</title>
<variablelist>
- <varlistentry id="guc-other-pgpool-hostname" xreflabel="other_pgpool_hostname">
- <term><varname>other_pgpool_hostname0</varname> (<type>string</type>)
- <indexterm>
-<!--
+ <varlistentry id="guc-other-pgpool-hostname" xreflabel="other_pgpool_hostname">
+ <term><varname>other_pgpool_hostname0</varname> (<type>string</type>)
+ <indexterm>
+ <!--
<primary><varname>other_pgpool_hostname</varname> configuration parameter</primary>
--->
+ -->
<primary><varname>other_pgpool_hostname</varname>設定パラメータ</primary>
- </indexterm>
- </term>
- <listitem>
- <para>
-<!--
+ </indexterm>
+ </term>
+ <listitem>
+ <para>
+ <!--
Specifies the hostname of remote <productname>Pgpool-II</productname> server for watchdog node.
The number at the end of the parameter name is referred as "server id", and it starts from 0.
--->
-リモートのwatchdogノードに対する<productname>Pgpool-II</productname>サーバのホスト名を指定します。
-パラメータ名の最後にある数字は「サーバ番号」で、0から始まります。
- </para>
- <para>
-<!--
+ -->
+ リモートのwatchdogノードに対する<productname>Pgpool-II</productname>サーバのホスト名を指定します。
+ パラメータ名の最後にある数字は「サーバ番号」で、0から始まります。
+ </para>
+ <para>
+ <!--
This parameter can only be set at server start.
--->
-このパラメータは、サーバ起動時にのみ設定できます。
- </para>
+ -->
+ このパラメータは、サーバ起動時にのみ設定できます。
+ </para>
</listitem>
- </varlistentry>
+ </varlistentry>
- <varlistentry id="guc-other-pgpool-port" xreflabel="other_pgpool_port">
- <term><varname>other_pgpool_port0</varname> (<type>integer</type>)
- <indexterm>
-<!--
+ <varlistentry id="guc-other-pgpool-port" xreflabel="other_pgpool_port">
+ <term><varname>other_pgpool_port0</varname> (<type>integer</type>)
+ <indexterm>
+ <!--
<primary><varname>other_pgpool_port</varname> configuration parameter</primary>
--->
+ -->
<primary><varname>other_pgpool_port</varname>設定パラメータ</primary>
- </indexterm>
- </term>
- <listitem>
- <para>
-<!--
+ </indexterm>
+ </term>
+ <listitem>
+ <para>
+ <!--
Specifies the port number of the remote <productname>Pgpool-II</productname>
server for watchdog node.
The number at the end of the parameter name is referred
as "server id", and it starts from 0.
--->
-リモートのwatchdogノードに対する<productname>Pgpool-II</productname>サーバのポート番号を指定します。
-パラメータ名の最後にある数字は「サーバ番号」で、0から始まります。
- </para>
- <para>
-<!--
+ -->
+ リモートのwatchdogノードに対する<productname>Pgpool-II</productname>サーバのポート番号を指定します。
+ パラメータ名の最後にある数字は「サーバ番号」で、0から始まります。
+ </para>
+ <para>
+ <!--
This parameter can only be set at server start.
--->
-このパラメータは、サーバ起動時にのみ設定できます。
- </para>
+ -->
+ このパラメータは、サーバ起動時にのみ設定できます。
+ </para>
</listitem>
- </varlistentry>
+ </varlistentry>
- <varlistentry id="guc-other-wd-port" xreflabel="other_wd_port">
- <term><varname>other_wd_port0</varname> (<type>integer</type>)
- <indexterm>
-<!--
+ <varlistentry id="guc-other-wd-port" xreflabel="other_wd_port">
+ <term><varname>other_wd_port0</varname> (<type>integer</type>)
+ <indexterm>
+ <!--
<primary><varname>other_wd_port0</varname> configuration parameter</primary>
--->
+ -->
<primary><varname>other_wd_port0</varname>設定パラメータ</primary>
- </indexterm>
- </term>
- <listitem>
- <para>
-<!--
+ </indexterm>
+ </term>
+ <listitem>
+ <para>
+ <!--
Specifies the watchdog port number of the remote
<productname>Pgpool-II</productname> server for watchdog node.
The number at the end of the parameter name is referred
as "server id", and it starts from 0.
--->
-リモートの<productname>Pgpool-II</productname>サーバにおけるwatchdogのポート番号を指定します。
-パラメータ名の最後にある数字は「サーバ番号」で、0から始まります。
- </para>
- <para>
-<!--
+ -->
+ リモートの<productname>Pgpool-II</productname>サーバにおけるwatchdogのポート番号を指定します。
+ パラメータ名の最後にある数字は「サーバ番号」で、0から始まります。
+ </para>
+ <para>
+ <!--
This parameter can only be set at server start.
--->
-このパラメータは、サーバ起動時にのみ設定できます。
- </para>
+ -->
+ このパラメータは、サーバ起動時にのみ設定できます。
+ </para>
</listitem>
- </varlistentry>
+ </varlistentry>
- </variablelist>
- </sect2>
+ </variablelist>
+ </sect2>
</sect1>
diff --git a/doc/src/sgml/watchdog.sgml b/doc/src/sgml/watchdog.sgml
index 5bb30ca70..2e5ba046f 100644
--- a/doc/src/sgml/watchdog.sgml
+++ b/doc/src/sgml/watchdog.sgml
@@ -1,655 +1,655 @@
<!-- doc/src/sgml/config.sgml -->
<sect1 id="runtime-watchdog-config">
- <title>Watchdog</title>
+ <title>Watchdog</title>
-<indexterm zone="runtime-watchdog-config">
+ <indexterm zone="runtime-watchdog-config">
<primary>configuring watchdog</primary>
</indexterm>
- <para>
- Watchdog configuration parameters are described in pgpool.conf.
- There is sample configuration in the WATCHDOG section of
- <filename>pgpool.conf.sample</filename> file.
- All following options are required to be specified in watchdog process.
-</para>
-
- <sect2 id="config-enable-watchdog">
- <title>Enable watchdog</title>
-
- <variablelist>
- <varlistentry id="guc-use-watchdog" xreflabel="use_watchdog">
- <term><varname>use_watchdog</varname> (<type>boolean</type>)
- <indexterm>
- <primary><varname>use_watchdog</varname> configuration parameter</primary>
- </indexterm>
- </term>
- <listitem>
- <para>
- If on, activates the watchdog. Default is off
- </para>
- <para>
- This parameter can only be set at server start.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </sect2>
-
- <sect2 id="config-communication-watchdog">
- <title>Watchdog communication</title>
-
- <variablelist>
-
- <varlistentry id="guc-wd-hostname" xreflabel="wd_hostname">
- <term><varname>wd_hostname</varname> (<type>string</type>)
- <indexterm>
- <primary><varname>wd_hostname</varname> configuration parameter</primary>
- </indexterm>
- </term>
- <listitem>
- <para>
- Specifies the hostname or IP address of
- <productname>Pgpool-II</productname> server.
- This is used for sending/receiving queries and packets,
- and also as an identifier of the watchdog node.
- </para>
- <para>
- This parameter can only be set at server start.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry id="guc-wd-port" xreflabel="wd_port">
- <term><varname>wd_port</varname> (<type>integer</type>)
- <indexterm>
- <primary><varname>wd_port</varname> configuration parameter</primary>
- </indexterm>
- </term>
- <listitem>
- <para>
- Specifies the port number to be used by watchdog
- process to listen for connections. Default is 9000.
- </para>
- <para>
- This parameter can only be set at server start.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry id="guc-wd-authkey" xreflabel="wd_authkey">
- <term><varname>wd_authkey</varname> (<type>string</type>)
- <indexterm>
- <primary><varname>wd_authkey</varname> configuration parameter</primary>
- </indexterm>
- </term>
- <listitem>
- <para>
- Specifies the authentication key used for all watchdog communications.
- All <productname>Pgpool-II</productname> must have the same key.
- Packets from watchdog having different key will get rejected.
- This authentication is also applied to the heartbeat signals
- when the <literal>heartbeat</> mode is used as a lifecheck method.
- </para>
- <para>
- Since in <productname>Pgpool-II</productname><emphasis>V3.5</emphasis> or beyond
- <varname>wd_authkey</varname> is also used to authenticate
- the watchdog IPC clients,
- all clients communicating with <productname>Pgpool-II</productname>
- watchdog process needs to provide this wd_authkey value
- for <literal>"IPCAuthKey"</literal> key in the JSON data
- of the command.
- </para>
- <para>
- Default is <literal>''</literal> (empty) which means disables
- the watchdog authentication.
- </para>
- <para>
- This parameter can only be set at server start.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </sect2>
-
- <sect2 id="config-watchdog-upstream-connections">
- <title>Upstream server connection</title>
-
- <variablelist>
-
- <varlistentry id="guc-trusted-servers" xreflabel="trusted_servers">
- <term><varname>trusted_servers</varname> (<type>string</type>)
- <indexterm>
- <primary><varname>trusted_servers</varname> configuration parameter</primary>
- </indexterm>
- </term>
- <listitem>
- <para>
- Specifies the list of trusted servers to check the up stream connections.
- Each server in the list is required to respond to ping.
- Specify a comma separated list of servers such as
- <literal>"hostA,hostB,hostC"</literal>.
- If none of the server are reachable, watchdog will regard it as
- failure of the <productname>Pgpool-II</productname>.
- Therefore, it is recommended to specify multiple servers.
- </para>
- <para>
- This parameter can only be set at server start.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry id="guc-ping-path" xreflabel="ping_path">
- <term><varname>ping_path</varname> (<type>string</type>)
- <indexterm>
- <primary><varname>ping_path</varname> configuration parameter</primary>
- </indexterm>
- </term>
- <listitem>
- <para>
- Specifies the path of a ping command for monitoring
- connection to the upper servers. Set the only path of the directory containing the
- ping utility, such as <literal>"/bin"</literal> or such directory.
- </para>
- <para>
- This parameter can only be set at server start.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </sect2>
-
- <sect2 id="config-watchdog-vip-control">
- <title>Virtual IP control</title>
-
- <variablelist>
-
- <varlistentry id="guc-delegate-IP" xreflabel="delegate_IP">
- <term><varname>delegate_IP</varname> (<type>string</type>)
- <indexterm>
- <primary><varname>delegate_IP</varname> configuration parameter</primary>
- </indexterm>
- </term>
- <listitem>
- <para>
- Specifies the virtual IP address (VIP) of pgpool-II that is
- connected from client servers (application servers etc.).
- When a <productname>Pgpool-II</productname> is switched from standby to active,
- the <productname>Pgpool-II</productname> takes over
- this VIP.
- Default is <literal>''</literal>(empty): which means virtual
- IP will never be brought up.
- </para>
- <para>
- This parameter can only be set at server start.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry id="guc-if-cmd-path" xreflabel="if_cmd_path">
- <term><varname>if_cmd_path</varname> (<type>string</type>)
- <indexterm>
- <primary><varname>if_cmd_path</varname> configuration parameter</primary>
- </indexterm>
- </term>
- <listitem>
- <para>
- Specifies the path to the command that <productname>Pgpool-II</productname>
- will use to switch the virtual IP on the system.
- Set only the path of the directory containing the binary,
- such as <literal>"/sbin"</literal> or such directory.
- </para>
- <para>
- This parameter can only be set at server start.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry id="guc-if-up-cmd" xreflabel="if_up_cmd">
- <term><varname>if_up_cmd</varname> (<type>string</type>)
- <indexterm>
- <primary><varname>if_up_cmd</varname> configuration parameter</primary>
- </indexterm>
- </term>
- <listitem>
- <para>
- Specifies the command to bring up the virtual IP.
- Set the command and parameters such as
- <command>"ip addr add $_IP_$/24 dev eth0 label eth0:0"</command>
- <literal>$_IP_$</literal> will get replaced by the IP address
- specified in the <xref linkend="guc-delegate-IP">.
- </para>
- <para>
- This parameter can only be set at server start.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry id="guc-if-down-cmd" xreflabel="if_down_cmd">
- <term><varname>if_down_cmd</varname> (<type>string</type>)
- <indexterm>
- <primary><varname>if_down_cmd</varname> configuration parameter</primary>
- </indexterm>
- </term>
- <listitem>
- <para>
- Specifies the command to bring down the virtual IP.
- Set the command and parameters such as
- <literal>"ip addr del $_IP_$/24 dev eth0"</literal>.
- </para>
- <para>
- This parameter can only be set at server start.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry id="guc-arping-path" xreflabel="arping_path">
- <term><varname>arping_path</varname> (<type>string</type>)
- <indexterm>
- <primary><varname>arping_path</varname> configuration parameter</primary>
- </indexterm>
- </term>
- <listitem>
- <para>
- Specifies the path to the command that <productname>Pgpool-II</productname>
- will use to send the ARP requests after the virtual IP switch.
- Set only the path of the directory containing the binary,
- such as <literal>"/usr/sbin"</literal> or such directory.
- </para>
- <para>
- This parameter can only be set at server start.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry id="guc-arping-cmd" xreflabel="arping_cmd">
- <term><varname>arping_cmd</varname> (<type>string</type>)
- <indexterm>
- <primary><varname>arping_cmd</varname> configuration parameter</primary>
- </indexterm>
- </term>
- <listitem>
- <para>
- Specifies the command to use for sending the ARP requests
- after the virtual IP switch.
- Set the command and parameters such as
- <literal>"arping -U $_IP_$ -w 1"</literal>.
- <literal>$_IP_$</literal> will get replaced by
- the IP address specified in the <varname>delegate_IP</varname>.
- </para>
- <para>
- This parameter can only be set at server start.
- </para>
- </listitem>
- </varlistentry>
+ <para>
+ Watchdog configuration parameters are described in pgpool.conf.
+ There is sample configuration in the WATCHDOG section of
+ <filename>pgpool.conf.sample</filename> file.
+ All following options are required to be specified in watchdog process.
+ </para>
+
+ <sect2 id="config-enable-watchdog">
+ <title>Enable watchdog</title>
+ <variablelist>
+ <varlistentry id="guc-use-watchdog" xreflabel="use_watchdog">
+ <term><varname>use_watchdog</varname> (<type>boolean</type>)
+ <indexterm>
+ <primary><varname>use_watchdog</varname> configuration parameter</primary>
+ </indexterm>
+ </term>
+ <listitem>
+ <para>
+ If on, activates the watchdog. Default is off
+ </para>
+ <para>
+ This parameter can only be set at server start.
+ </para>
+ </listitem>
+ </varlistentry>
</variablelist>
-</sect2>
-
-<sect2 id="config-watchdog-escalation-de-escalation">
- <title>Behaivor on escalation and de-escalation</title>
-
- <para>
- Configuration about behavior when <productname>Pgpool-II</productname>
- escalates to active (virtual IP holder)
- </para>
-
- <variablelist>
-
- <varlistentry id="guc-clear-memqcache-on-escalation" xreflabel="clear_memqcache_on_escalation">
- <term><varname>clear_memqcache_on_escalation</varname> (<type>boolean</type>)
- <indexterm>
- <primary><varname>clear_memqcache_on_escalation</varname> configuration parameter</primary>
- </indexterm>
- </term>
- <listitem>
- <para>
- When set to on, watchdog clears all the query cache in the shared memory
- when pgpool-II escaltes to active. This prevents the new active <productname>Pgpool-II</productname>
- from using old query caches inconsistence to the old active.
- </para>
- <para>
- Default is on.
- </para>
- <para>
- This works only if <xref linkend="guc-memqcache-method">
- is <literal>'shmem'</literal>.
- </para>
- <para>
- This parameter can only be set at server start.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry id="guc-wd-escalation-command" xreflabel="wd_escalation_command">
- <term><varname>wd_escalation_command</varname> (<type>string</type>)
- <indexterm>
- <primary><varname>wd_escalation_command</varname> configuration parameter</primary>
- </indexterm>
- </term>
- <listitem>
- <para>
- Watchdog executes this command on the node that is escalated
- to the master watchdog.
- </para>
- <para>
- This command is executed just before bringing up the
- virtual IP if that is configured on the node.
- </para>
- <para>
- This parameter can only be set at server start.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry id="guc-wd-de-escalation-command" xreflabel="wd_de_escalation_command">
- <term><varname>wd_de_escalation_command</varname> (<type>string</type>)
- <indexterm>
- <primary><varname>wd_de_escalation_command</varname> configuration parameter</primary>
- </indexterm>
- </term>
- <listitem>
- <para>
- Watchdog executes this command on the master <productname>Pgpool-II</productname>
- watchdog node when that node resigns from the master node responsibilities.
- A master watchdog node can resign from being a master node,
- when the master node <productname>Pgpool-II</productname> shuts down, detects a network
- blackout or detects the lost of <indexterm><primary>quorum</primary></indexterm><firstterm>quorum</firstterm>.
- </para>
- <para>
- This command is executed before bringing down the virtual/floating IP address
- if it is configured on the watchdog node.
- </para>
- <para>
- <varname>wd_de_escalation_command</varname> is not available prior to
- <productname>Pgpool-II </productname><emphasis>V3.5</emphasis>.
- </para>
- <para>
- This parameter can only be set at server start.
- </para>
- </listitem>
- </varlistentry>
+ </sect2>
+
+ <sect2 id="config-communication-watchdog">
+ <title>Watchdog communication</title>
+
+ <variablelist>
+
+ <varlistentry id="guc-wd-hostname" xreflabel="wd_hostname">
+ <term><varname>wd_hostname</varname> (<type>string</type>)
+ <indexterm>
+ <primary><varname>wd_hostname</varname> configuration parameter</primary>
+ </indexterm>
+ </term>
+ <listitem>
+ <para>
+ Specifies the hostname or IP address of
+ <productname>Pgpool-II</productname> server.
+ This is used for sending/receiving queries and packets,
+ and also as an identifier of the watchdog node.
+ </para>
+ <para>
+ This parameter can only be set at server start.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry id="guc-wd-port" xreflabel="wd_port">
+ <term><varname>wd_port</varname> (<type>integer</type>)
+ <indexterm>
+ <primary><varname>wd_port</varname> configuration parameter</primary>
+ </indexterm>
+ </term>
+ <listitem>
+ <para>
+ Specifies the port number to be used by watchdog
+ process to listen for connections. Default is 9000.
+ </para>
+ <para>
+ This parameter can only be set at server start.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry id="guc-wd-authkey" xreflabel="wd_authkey">
+ <term><varname>wd_authkey</varname> (<type>string</type>)
+ <indexterm>
+ <primary><varname>wd_authkey</varname> configuration parameter</primary>
+ </indexterm>
+ </term>
+ <listitem>
+ <para>
+ Specifies the authentication key used for all watchdog communications.
+ All <productname>Pgpool-II</productname> must have the same key.
+ Packets from watchdog having different key will get rejected.
+ This authentication is also applied to the heartbeat signals
+ when the <literal>heartbeat</> mode is used as a lifecheck method.
+ </para>
+ <para>
+ Since in <productname>Pgpool-II</productname><emphasis>V3.5</emphasis> or beyond
+ <varname>wd_authkey</varname> is also used to authenticate
+ the watchdog IPC clients,
+ all clients communicating with <productname>Pgpool-II</productname>
+ watchdog process needs to provide this wd_authkey value
+ for <literal>"IPCAuthKey"</literal> key in the JSON data
+ of the command.
+ </para>
+ <para>
+ Default is <literal>''</literal> (empty) which means disables
+ the watchdog authentication.
+ </para>
+ <para>
+ This parameter can only be set at server start.
+ </para>
+ </listitem>
+ </varlistentry>
</variablelist>
- </sect2>
-
-<sect2 id="config-watchdog-failover-behavior" xreflabel="Controlling the Failover behavior">
- <title>Controlling the Failover behavior</title>
-
- <para>
- These settings are used to control the behavior of backend node failover when the watchdog is enabled.
- The effect of these configurations is limited to the failover/degenerate requests initiated by
- <productname>Pgpool-II</productname> internally, while the user initiated detach backend requests
- (using PCP command) by-pass these configuration settings.
- </para>
-
- <variablelist>
-
- <varlistentry id="guc-failover-when-quorum-exists" xreflabel="failover_when_quorum_exists">
- <term><varname>failover_when_quorum_exists</varname> (<type>boolean</type>)
- <indexterm>
- <primary><varname>failover_when_quorum_exists</varname> configuration parameter</primary>
- </indexterm>
- </term>
- <listitem>
- <para>
- When enabled, <productname>Pgpool-II</productname> will consider <indexterm><primary>quorum</primary></indexterm>quorum when it performs the degenerate/failover on backend node.
- </para>
- <para>
- We can say that "quorum exists" if the number of live
- watchdog nodes (that is number
- of <productname>Pgpool-II</productname> nodes) can be a
- majority against the total number of watchdog nodes. For
- example, suppose number of watchdog nodes is 5. If number of
- live nodes is greater than or equal to 3, then quorum
- exists. On the other hand if number of live nodes is 2 or
- lower, quorum does not exist since it never be
- majority.
- </para>
- <para>
- If the quorum exists, <productname>Pgpool-II</productname>
- could work better on failure detection because even if a
- watchdog node mistakenly detects a failure of backend node,
- it would be denied by other major watchdog nodes.
- <productname>Pgpool-II</productname> works that way
- when <xref linkend="guc-failover-require-consensus"> is on
- (the default), but you can change it so that immediate
- failover happens when a failure is detected.
- A <productname>Pgpool-II</productname> node which mistakenly
- detects failure of backend node will quarantine the backend
- node.
- </para>
- <para>
- The existence of quorum can be shown by invoking <xref linkend="pcp-watchdog-info"> command with <literal>--verbose</literal> option.
- If <literal>Quorum state</literal> is <literal>QUORUM EXIST</literal> or <literal>QUORUM IS ON THE EDGE</literal>, then the quorum exists.
- If <literal>Quorum state</literal> is <literal>QUORUM ABSENT</literal>, then the quorum does not exist.
- </para>
- <para>
- Please note that if the number of watchdog nodes is even, we
- regard that quorum exists when the number of live nodes is
- greater than or equal to half of total watchdog nodes.
- </para>
- <para>
- In the absence of the
- quorum, <productname>Pgpool-II</productname> node that
- detects the backend failure will quarantine the failed
- backend node until the quorum exists again.
- </para>
- <para>
- Although it is possible to force detaching the quarantine
- node by using <command>pcp_detach_node</command> command, it
- is not possible to attach the node again by
- using <command>pcp_attach_node</command> command.
- </para>
- <para>
- The quarantine nodes behaves similar to the detached backend nodes but unlike failed/degenerated backends
- the quarantine status is not propagated to the other <productname>Pgpool-II</productname> nodes in the
- watchdog cluster, So even if the backend node is in the quarantine state on one
- <productname>Pgpool-II</productname> node, other <productname>Pgpool-II</productname> nodes may
- still continue to use that backend.
- </para>
- <para>
- Although there are many similarities in quarantine and failover operations, but they both differ in a very
- fundamental way. The quarantine operations does not executes the <xref linkend="guc-failover-command">
- and silently detaches the problematic node, So in the case when the master backend node is quarantined, the
- <productname>Pgpool-II</productname> will not promote the standby to take over the master responsibilities
- and until the master node is quarantined the <productname>Pgpool-II</productname> will not have
- any usable master backend node.
- </para>
- <para>
- Moreover, unlike for the failed
- nodes, <productname>Pgpool-II</productname> keeps the
- health-check running on the quarantined nodes and as soon as
- the quarantined node becomes reachable again it gets
- automatically re-attached.
- </para>
- <para>
- From <productname>Pgpool-II </productname><emphasis>V4.1</emphasis> onwards, if the watchdog-master node
- fails to build the consensus for primary backend node failover and the primary backend node gets into a
- quarantine state, then it resigns from its master/coordinator responsibilities and lowers its wd_priority
- for next leader election and let the cluster elect some different new leader.
- <note>
- <para>
- When the master node fails to build the consensus for standby backend node failure, it takes no action
- and similarly quarantined standby backend nodes on watchdog-master do not trigger a new leader election.
- </para>
- </note>
- </para>
- <para>
- If this parameter is off, failover will be triggered even if
- quorum does not exist.
- </para>
- <para>
- Default is on.
- </para>
- <para>
- <varname>failover_when_quorum_exists</varname> is not available prior to
- <productname>Pgpool-II </productname><emphasis>V3.7</emphasis>.
- </para>
- <para>
- This parameter can only be set at server start.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry id="guc-failover-require-consensus" xreflabel="failover_require_consensus">
- <term><varname>failover_require_consensus</varname> (<type>boolean</type>)
- <indexterm>
- <primary><varname>failover_require_consensus</varname> configuration parameter</primary>
- </indexterm>
- </term>
- <listitem>
- <para>
- When enabled, <productname>Pgpool-II</productname> will perform the degenerate/failover on a
- backend node if the watchdog quorum exists and at-least minimum number of nodes necessary
- for the quorum vote for the failover.
- </para>
- <para>
- For example, in a three node watchdog cluster, the failover will only be performed until at
- least two nodes ask for performing the failover on the particular backend node.
- </para>
- <para>
- If this parameter is off, failover will be triggered even if
- there's no consensus.
- </para>
- <para>
- Default is on.
- </para>
-
- <caution>
- <para>
- When <varname>failover_require_consensus</varname> is
- enabled, <productname>Pgpool-II</productname> does not
- execute the failover until it get enough votes from
- other <productname>Pgpool-II</productname> nodes. So it is
- strongly recommended to enable the backend health check on
- all
- <productname>Pgpool-II</productname> nodes to ensure
- proper detection of backend node failures. For more
- details of health check,
- see <xref linkend="runtime-config-health-check">.
- </para>
- </caution>
-
- <para>
- <varname>failover_require_consensus</varname> is not available prior to
- <productname>Pgpool-II </productname><emphasis>V3.7</emphasis>. and it is only
- effective when <xref linkend="guc-failover-when-quorum-exists"> is enabled
- </para>
- <para>
- This parameter can only be set at server start.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry id="guc-allow-multiple-failover-requests-from-node" xreflabel="allow_multiple_failover_requests_from_node">
- <term><varname>allow_multiple_failover_requests_from_node</varname> (<type>boolean</type>)
- <indexterm>
- <primary><varname>allow_multiple_failover_requests_from_node</varname> configuration parameter</primary>
- </indexterm>
- </term>
- <listitem>
- <para>
- This parameter works in connection with the
- <xref linkend="guc-failover-require-consensus">. When enabled, a single <productname>Pgpool-II</productname>
- node can cast multiple votes for the failover.
- </para>
- <para>
- For example, in a three node watchdog cluster, if one <productname>Pgpool-II</productname> node sends two
- failover requests for a particular backend node failover, Both requests will be counted as a separate
- vote in the favor of the failover and <productname>Pgpool-II</productname> will execute the failover,
- even if it does not get the vote from any other <productname>Pgpool-II</productname> node.
- </para>
- <para>
- For example, if an error found in a health check round does
- not get enough vote and the error still persists, next round
- of health check will give one more vote. This parameter is
- useful if you want to detect a persistent error which might
- not be found by other watchdog nodes.
- </para>
- <para>
- Default is off.
- </para>
- <para>
- <varname>allow_multiple_failover_requests_from_node</varname> is not available prior to
- <productname>Pgpool-II </productname><emphasis>V3.7</emphasis>. and it is only
- effective when both <xref linkend="guc-failover-when-quorum-exists"> and
- <xref linkend="guc-failover-require-consensus"> are enabled
- </para>
- <para>
- This parameter can only be set at server start.
- </para>
- </listitem>
- </varlistentry>
+ </sect2>
+ <sect2 id="config-watchdog-upstream-connections">
+ <title>Upstream server connection</title>
+
+ <variablelist>
+
+ <varlistentry id="guc-trusted-servers" xreflabel="trusted_servers">
+ <term><varname>trusted_servers</varname> (<type>string</type>)
+ <indexterm>
+ <primary><varname>trusted_servers</varname> configuration parameter</primary>
+ </indexterm>
+ </term>
+ <listitem>
+ <para>
+ Specifies the list of trusted servers to check the up stream connections.
+ Each server in the list is required to respond to ping.
+ Specify a comma separated list of servers such as
+ <literal>"hostA,hostB,hostC"</literal>.
+ If none of the server are reachable, watchdog will regard it as
+ failure of the <productname>Pgpool-II</productname>.
+ Therefore, it is recommended to specify multiple servers.
+ </para>
+ <para>
+ This parameter can only be set at server start.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry id="guc-ping-path" xreflabel="ping_path">
+ <term><varname>ping_path</varname> (<type>string</type>)
+ <indexterm>
+ <primary><varname>ping_path</varname> configuration parameter</primary>
+ </indexterm>
+ </term>
+ <listitem>
+ <para>
+ Specifies the path of a ping command for monitoring
+ connection to the upper servers. Set the only path of the directory containing the
+ ping utility, such as <literal>"/bin"</literal> or such directory.
+ </para>
+ <para>
+ This parameter can only be set at server start.
+ </para>
+ </listitem>
+ </varlistentry>
</variablelist>
- </sect2>
+ </sect2>
+
+ <sect2 id="config-watchdog-vip-control">
+ <title>Virtual IP control</title>
-<sect2 id="config-watchdog-lifecheck">
- <title>Life checking <productname>Pgpool-II</productname> </title>
+ <variablelist>
+ <varlistentry id="guc-delegate-IP" xreflabel="delegate_IP">
+ <term><varname>delegate_IP</varname> (<type>string</type>)
+ <indexterm>
+ <primary><varname>delegate_IP</varname> configuration parameter</primary>
+ </indexterm>
+ </term>
+ <listitem>
+ <para>
+ Specifies the virtual IP address (VIP) of pgpool-II that is
+ connected from client servers (application servers etc.).
+ When a <productname>Pgpool-II</productname> is switched from standby to active,
+ the <productname>Pgpool-II</productname> takes over
+ this VIP.
+ Default is <literal>''</literal>(empty): which means virtual
+ IP will never be brought up.
+ </para>
+ <para>
+ This parameter can only be set at server start.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry id="guc-if-cmd-path" xreflabel="if_cmd_path">
+ <term><varname>if_cmd_path</varname> (<type>string</type>)
+ <indexterm>
+ <primary><varname>if_cmd_path</varname> configuration parameter</primary>
+ </indexterm>
+ </term>
+ <listitem>
+ <para>
+ Specifies the path to the command that <productname>Pgpool-II</productname>
+ will use to switch the virtual IP on the system.
+ Set only the path of the directory containing the binary,
+ such as <literal>"/sbin"</literal> or such directory.
+ </para>
+ <para>
+ This parameter can only be set at server start.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry id="guc-if-up-cmd" xreflabel="if_up_cmd">
+ <term><varname>if_up_cmd</varname> (<type>string</type>)
+ <indexterm>
+ <primary><varname>if_up_cmd</varname> configuration parameter</primary>
+ </indexterm>
+ </term>
+ <listitem>
+ <para>
+ Specifies the command to bring up the virtual IP.
+ Set the command and parameters such as
+ <command>"ip addr add $_IP_$/24 dev eth0 label eth0:0"</command>
+ <literal>$_IP_$</literal> will get replaced by the IP address
+ specified in the <xref linkend="guc-delegate-IP">.
+ </para>
+ <para>
+ This parameter can only be set at server start.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry id="guc-if-down-cmd" xreflabel="if_down_cmd">
+ <term><varname>if_down_cmd</varname> (<type>string</type>)
+ <indexterm>
+ <primary><varname>if_down_cmd</varname> configuration parameter</primary>
+ </indexterm>
+ </term>
+ <listitem>
+ <para>
+ Specifies the command to bring down the virtual IP.
+ Set the command and parameters such as
+ <literal>"ip addr del $_IP_$/24 dev eth0"</literal>.
+ </para>
+ <para>
+ This parameter can only be set at server start.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry id="guc-arping-path" xreflabel="arping_path">
+ <term><varname>arping_path</varname> (<type>string</type>)
+ <indexterm>
+ <primary><varname>arping_path</varname> configuration parameter</primary>
+ </indexterm>
+ </term>
+ <listitem>
+ <para>
+ Specifies the path to the command that <productname>Pgpool-II</productname>
+ will use to send the ARP requests after the virtual IP switch.
+ Set only the path of the directory containing the binary,
+ such as <literal>"/usr/sbin"</literal> or such directory.
+ </para>
+ <para>
+ This parameter can only be set at server start.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry id="guc-arping-cmd" xreflabel="arping_cmd">
+ <term><varname>arping_cmd</varname> (<type>string</type>)
+ <indexterm>
+ <primary><varname>arping_cmd</varname> configuration parameter</primary>
+ </indexterm>
+ </term>
+ <listitem>
+ <para>
+ Specifies the command to use for sending the ARP requests
+ after the virtual IP switch.
+ Set the command and parameters such as
+ <literal>"arping -U $_IP_$ -w 1"</literal>.
+ <literal>$_IP_$</literal> will get replaced by
+ the IP address specified in the <varname>delegate_IP</varname>.
+ </para>
+ <para>
+ This parameter can only be set at server start.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ </variablelist>
+ </sect2>
+
+ <sect2 id="config-watchdog-escalation-de-escalation">
+ <title>Behaivor on escalation and de-escalation</title>
+
+ <para>
+ Configuration about behavior when <productname>Pgpool-II</productname>
+ escalates to active (virtual IP holder)
+ </para>
+
+ <variablelist>
+
+ <varlistentry id="guc-clear-memqcache-on-escalation" xreflabel="clear_memqcache_on_escalation">
+ <term><varname>clear_memqcache_on_escalation</varname> (<type>boolean</type>)
+ <indexterm>
+ <primary><varname>clear_memqcache_on_escalation</varname> configuration parameter</primary>
+ </indexterm>
+ </term>
+ <listitem>
+ <para>
+ When set to on, watchdog clears all the query cache in the shared memory
+ when pgpool-II escaltes to active. This prevents the new active <productname>Pgpool-II</productname>
+ from using old query caches inconsistence to the old active.
+ </para>
+ <para>
+ Default is on.
+ </para>
+ <para>
+ This works only if <xref linkend="guc-memqcache-method">
+ is <literal>'shmem'</literal>.
+ </para>
+ <para>
+ This parameter can only be set at server start.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry id="guc-wd-escalation-command" xreflabel="wd_escalation_command">
+ <term><varname>wd_escalation_command</varname> (<type>string</type>)
+ <indexterm>
+ <primary><varname>wd_escalation_command</varname> configuration parameter</primary>
+ </indexterm>
+ </term>
+ <listitem>
+ <para>
+ Watchdog executes this command on the node that is escalated
+ to the master watchdog.
+ </para>
+ <para>
+ This command is executed just before bringing up the
+ virtual IP if that is configured on the node.
+ </para>
+ <para>
+ This parameter can only be set at server start.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry id="guc-wd-de-escalation-command" xreflabel="wd_de_escalation_command">
+ <term><varname>wd_de_escalation_command</varname> (<type>string</type>)
+ <indexterm>
+ <primary><varname>wd_de_escalation_command</varname> configuration parameter</primary>
+ </indexterm>
+ </term>
+ <listitem>
+ <para>
+ Watchdog executes this command on the master <productname>Pgpool-II</productname>
+ watchdog node when that node resigns from the master node responsibilities.
+ A master watchdog node can resign from being a master node,
+ when the master node <productname>Pgpool-II</productname> shuts down, detects a network
+ blackout or detects the lost of <indexterm><primary>quorum</primary></indexterm><firstterm>quorum</firstterm>.
+ </para>
+ <para>
+ This command is executed before bringing down the virtual/floating IP address
+ if it is configured on the watchdog node.
+ </para>
+ <para>
+ <varname>wd_de_escalation_command</varname> is not available prior to
+ <productname>Pgpool-II </productname><emphasis>V3.5</emphasis>.
+ </para>
+ <para>
+ This parameter can only be set at server start.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </sect2>
+
+ <sect2 id="config-watchdog-failover-behavior">
+ <title>Controlling the Failover behavior</title>
+
+ <para>
+ These settings are used to control the behavior of backend node failover when the watchdog is enabled.
+ The effect of these configurations is limited to the failover/degenerate requests initiated by
+ <productname>Pgpool-II</productname> internally, while the user initiated detach backend requests
+ (using PCP command) by-pass these configuration settings.
+ </para>
+
+ <variablelist>
+
+ <varlistentry id="guc-failover-when-quorum-exists" xreflabel="failover_when_quorum_exists">
+ <term><varname>failover_when_quorum_exists</varname> (<type>boolean</type>)
+ <indexterm>
+ <primary><varname>failover_when_quorum_exists</varname> configuration parameter</primary>
+ </indexterm>
+ </term>
+ <listitem>
+ <para>
+ When enabled, <productname>Pgpool-II</productname> will consider <indexterm><primary>quorum</primary></indexterm>quorum when it performs the degenerate/failover on backend node.
+ </para>
+ <para>
+ We can say that "quorum exists" if the number of live
+ watchdog nodes (that is number
+ of <productname>Pgpool-II</productname> nodes) can be a
+ majority against the total number of watchdog nodes. For
+ example, suppose number of watchdog nodes is 5. If number of
+ live nodes is greater than or equal to 3, then quorum
+ exists. On the other hand if number of live nodes is 2 or
+ lower, quorum does not exist since it never be
+ majority.
+ </para>
+ <para>
+ If the quorum exists, <productname>Pgpool-II</productname>
+ could work better on failure detection because even if a
+ watchdog node mistakenly detects a failure of backend node,
+ it would be denied by other major watchdog nodes.
+ <productname>Pgpool-II</productname> works that way
+ when <xref linkend="guc-failover-require-consensus"> is on
+ (the default), but you can change it so that immediate
+ failover happens when a failure is detected.
+ A <productname>Pgpool-II</productname> node which mistakenly
+ detects failure of backend node will quarantine the backend
+ node.
+ </para>
+ <para>
+ The existence of quorum can be shown by invoking <xref linkend="pcp-watchdog-info"> command with <literal>--verbose</literal> option.
+ If <literal>Quorum state</literal> is <literal>QUORUM EXIST</literal> or <literal>QUORUM IS ON THE EDGE</literal>, then the quorum exists.
+ If <literal>Quorum state</literal> is <literal>QUORUM ABSENT</literal>, then the quorum does not exist.
+ </para>
+ <para>
+ Please note that if the number of watchdog nodes is even, we
+ regard that quorum exists when the number of live nodes is
+ greater than or equal to half of total watchdog nodes.
+ </para>
+ <para>
+ In the absence of the
+ quorum, <productname>Pgpool-II</productname> node that
+ detects the backend failure will quarantine the failed
+ backend node until the quorum exists again.
+ </para>
+ <para>
+ Although it is possible to force detaching the quarantine
+ node by using <command>pcp_detach_node</command> command, it
+ is not possible to attach the node again by
+ using <command>pcp_attach_node</command> command.
+ </para>
+ <para>
+ The quarantine nodes behaves similar to the detached backend nodes but unlike failed/degenerated backends
+ the quarantine status is not propagated to the other <productname>Pgpool-II</productname> nodes in the
+ watchdog cluster, So even if the backend node is in the quarantine state on one
+ <productname>Pgpool-II</productname> node, other <productname>Pgpool-II</productname> nodes may
+ still continue to use that backend.
+ </para>
+ <para>
+ Although there are many similarities in quarantine and failover operations, but they both differ in a very
+ fundamental way. The quarantine operations does not executes the <xref linkend="guc-failover-command">
+ and silently detaches the problematic node, So in the case when the master backend node is quarantined, the
+ <productname>Pgpool-II</productname> will not promote the standby to take over the master responsibilities
+ and until the master node is quarantined the <productname>Pgpool-II</productname> will not have
+ any usable master backend node.
+ </para>
+ <para>
+ Moreover, unlike for the failed
+ nodes, <productname>Pgpool-II</productname> keeps the
+ health-check running on the quarantined nodes and as soon as
+ the quarantined node becomes reachable again it gets
+ automatically re-attached.
+ </para>
+ <para>
+ From <productname>Pgpool-II </productname><emphasis>V4.1</emphasis> onwards, if the watchdog-master node
+ fails to build the consensus for primary backend node failover and the primary backend node gets into a
+ quarantine state, then it resigns from its master/coordinator responsibilities and lowers its wd_priority
+ for next leader election and let the cluster elect some different new leader.
+ <note>
+ <para>
+ When the master node fails to build the consensus for standby backend node failure, it takes no action
+ and similarly quarantined standby backend nodes on watchdog-master do not trigger a new leader election.
+ </para>
+ </note>
+ </para>
+ <para>
+ If this parameter is off, failover will be triggered even if
+ quorum does not exist.
+ </para>
+ <para>
+ Default is on.
+ </para>
+ <para>
+ <varname>failover_when_quorum_exists</varname> is not available prior to
+ <productname>Pgpool-II </productname><emphasis>V3.7</emphasis>.
+ </para>
+ <para>
+ This parameter can only be set at server start.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry id="guc-failover-require-consensus" xreflabel="failover_require_consensus">
+ <term><varname>failover_require_consensus</varname> (<type>boolean</type>)
+ <indexterm>
+ <primary><varname>failover_require_consensus</varname> configuration parameter</primary>
+ </indexterm>
+ </term>
+ <listitem>
+ <para>
+ When enabled, <productname>Pgpool-II</productname> will perform the degenerate/failover on a
+ backend node if the watchdog quorum exists and at-least minimum number of nodes necessary
+ for the quorum vote for the failover.
+ </para>
+ <para>
+ For example, in a three node watchdog cluster, the failover will only be performed until at
+ least two nodes ask for performing the failover on the particular backend node.
+ </para>
+ <para>
+ If this parameter is off, failover will be triggered even if
+ there's no consensus.
+ </para>
+ <para>
+ Default is on.
+ </para>
+
+ <caution>
<para>
- Watchdog checks pgpool-II status periodically. This is called "life check".
+ When <varname>failover_require_consensus</varname> is
+ enabled, <productname>Pgpool-II</productname> does not
+ execute the failover until it get enough votes from
+ other <productname>Pgpool-II</productname> nodes. So it is
+ strongly recommended to enable the backend health check on
+ all
+ <productname>Pgpool-II</productname> nodes to ensure
+ proper detection of backend node failures. For more
+ details of health check,
+ see <xref linkend="runtime-config-health-check">.
</para>
+ </caution>
+
+ <para>
+ <varname>failover_require_consensus</varname> is not available prior to
+ <productname>Pgpool-II </productname><emphasis>V3.7</emphasis>. and it is only
+ effective when <xref linkend="guc-failover-when-quorum-exists"> is enabled
+ </para>
+ <para>
+ This parameter can only be set at server start.
+ </para>
+ </listitem>
+ </varlistentry>
- <variablelist>
+ <varlistentry id="guc-allow-multiple-failover-requests-from-node" xreflabel="allow_multiple_failover_requests_from_node">
+ <term><varname>allow_multiple_failover_requests_from_node</varname> (<type>boolean</type>)
+ <indexterm>
+ <primary><varname>allow_multiple_failover_requests_from_node</varname> configuration parameter</primary>
+ </indexterm>
+ </term>
+ <listitem>
+ <para>
+ This parameter works in connection with the
+ <xref linkend="guc-failover-require-consensus">. When enabled, a single <productname>Pgpool-II</productname>
+ node can cast multiple votes for the failover.
+ </para>
+ <para>
+ For example, in a three node watchdog cluster, if one <productname>Pgpool-II</productname> node sends two
+ failover requests for a particular backend node failover, Both requests will be counted as a separate
+ vote in the favor of the failover and <productname>Pgpool-II</productname> will execute the failover,
+ even if it does not get the vote from any other <productname>Pgpool-II</productname> node.
+ </para>
+ <para>
+ For example, if an error found in a health check round does
+ not get enough vote and the error still persists, next round
+ of health check will give one more vote. This parameter is
+ useful if you want to detect a persistent error which might
+ not be found by other watchdog nodes.
+ </para>
+ <para>
+ Default is off.
+ </para>
+ <para>
+ <varname>allow_multiple_failover_requests_from_node</varname> is not available prior to
+ <productname>Pgpool-II </productname><emphasis>V3.7</emphasis>. and it is only
+ effective when both <xref linkend="guc-failover-when-quorum-exists"> and
+ <xref linkend="guc-failover-require-consensus"> are enabled
+ </para>
+ <para>
+ This parameter can only be set at server start.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ </variablelist>
+ </sect2>
+
+ <sect2 id="config-watchdog-lifecheck">
+ <title>Life checking <productname>Pgpool-II</productname> </title>
- <varlistentry id="guc-wd-lifecheck-method" xreflabel="wd_lifecheck_method">
- <term><varname>wd_lifecheck_method</varname> (<type>string</type>)
- <indexterm>
+ <para>
+ Watchdog checks pgpool-II status periodically. This is called "life check".
+ </para>
+
+ <variablelist>
+
+ <varlistentry id="guc-wd-lifecheck-method" xreflabel="wd_lifecheck_method">
+ <term><varname>wd_lifecheck_method</varname> (<type>string</type>)
+ <indexterm>
<primary><varname>wd_lifecheck_method</varname> configuration parameter</primary>
- </indexterm>
- </term>
- <listitem>
- <para>
+ </indexterm>
+ </term>
+ <listitem>
+ <para>
Specifies the method of life check. This can be either of <literal>'heartbeat'</literal> (default),
<literal>'query'</literal> or <literal>'external'</literal>.
- </para>
- <para>
- <literal>heartbeat</literal>: In this mode, watchdog sends the heartbeat signals (<acronym>UDP</acronym> packets)
- periodically to other <productname>Pgpool-II</productname>. Similarly watchdog also receives the signals
- from other <productname>Pgpool-II</productname> .
- If there are no signal for a certain period, watchdog regards is as failure
- of the <productname>Pgpool-II</productname> .
- </para>
- <para>
- <literal>query</literal>: In this mode, watchdog sends the monitoring queries
- to other <productname>Pgpool-II</productname> and checks the response.
- When installation location between <productname>Pgpool-II</productname>
- servers is far, <literal>query</literal> may be useful.
- <caution>
+ </para>
+ <para>
+ <literal>heartbeat</literal>: In this mode, watchdog sends the heartbeat signals (<acronym>UDP</acronym> packets)
+ periodically to other <productname>Pgpool-II</productname>. Similarly watchdog also receives the signals
+ from other <productname>Pgpool-II</productname> .
+ If there are no signal for a certain period, watchdog regards is as failure
+ of the <productname>Pgpool-II</productname> .
+ </para>
+ <para>
+ <literal>query</literal>: In this mode, watchdog sends the monitoring queries
+ to other <productname>Pgpool-II</productname> and checks the response.
+ When installation location between <productname>Pgpool-II</productname>
+ servers is far, <literal>query</literal> may be useful.
+ <caution>
<para>
In query mode, you need to set <xref linkend="guc-num-init-children">
- large enough if you plan to use watchdog.
- This is because the watchdog process connects to
- <productname>Pgpool-II</productname> as a client.
- </para>
+ large enough if you plan to use watchdog.
+ This is because the watchdog process connects to
+ <productname>Pgpool-II</productname> as a client.
+ </para>
</caution>
- </para>
- <para>
+ </para>
+ <para>
<literal>external</literal>: This mode disables the built
in lifecheck of <productname>Pgpool-II</productname> watchdog
and relies on external system to provide node health checking
of local and remote watchdog nodes.
- </para>
+ </para>
- <para>
+ <para>
<literal>external</literal> mode is not available in versions prior to
<productname>Pgpool-II</productname> <emphasis>V3.5</emphasis>.
- </para>
+ </para>
- <para>
+ <para>
This parameter can only be set at server start.
- </para>
- </listitem>
- </varlistentry>
+ </para>
+ </listitem>
+ </varlistentry>
- <varlistentry id="guc-wd-monitoring-interfaces-list" xreflabel="wd_monitoring_interfaces_list">
+ <varlistentry id="guc-wd-monitoring-interfaces-list" xreflabel="wd_monitoring_interfaces_list">
<term><varname>wd_monitoring_interfaces_list</varname> (<type>string</type>)
- <indexterm>
+ <indexterm>
<primary><varname>wd_monitoring_interfaces_list</varname> configuration parameter</primary>
- </indexterm>
+ </indexterm>
</term>
<listitem>
- <para>
+ <para>
Specify a comma separated list of network device names, to be monitored by the watchdog process
for the network link state. If all network interfaces in the list becomes inactive
(disabled or cable unplugged), the watchdog will consider it as a complete network failure
@@ -657,434 +657,434 @@
Specifying an <literal>''</literal>(empty) list disables the network interface monitoring.
Setting it to <literal>'any'</literal> enables the monitoring on all available network interfaces
except the loopback. Default is <literal>''</literal> empty list (monitoring disabled).
- </para>
+ </para>
- <para>
+ <para>
<varname>wd_monitoring_interfaces_list</varname> is not available in versions prior to
<productname>Pgpool-II</productname> <emphasis>V3.5</emphasis>.
- </para>
+ </para>
- <para>
+ <para>
This parameter can only be set at server start.
- </para>
- </listitem>
- </varlistentry>
+ </para>
+ </listitem>
+ </varlistentry>
- <varlistentry id="guc-wd-interval" xreflabel="wd_interval">
- <term><varname>wd_interval</varname> (<type>integer</type>)
- <indexterm>
+ <varlistentry id="guc-wd-interval" xreflabel="wd_interval">
+ <term><varname>wd_interval</varname> (<type>integer</type>)
+ <indexterm>
<primary><varname>wd_interval</varname> configuration parameter</primary>
- </indexterm>
- </term>
- <listitem>
- <para>
+ </indexterm>
+ </term>
+ <listitem>
+ <para>
Specifies the interval between life checks of <productname>Pgpool-II</productname>
in seconds. (A number greater than or equal to 1) Default is 10.
- </para>
+ </para>
- <para>
+ <para>
This parameter can only be set at server start.
- </para>
- </listitem>
+ </para>
+ </listitem>
</varlistentry>
- <varlistentry id="guc-wd-priority" xreflabel="wd_priority">
- <term><varname>wd_priority</varname> (<type>integer</type>)
- <indexterm>
+ <varlistentry id="guc-wd-priority" xreflabel="wd_priority">
+ <term><varname>wd_priority</varname> (<type>integer</type>)
+ <indexterm>
<primary><varname>wd_priority</varname> configuration parameter</primary>
- </indexterm>
- </term>
- <listitem>
- <para>
+ </indexterm>
+ </term>
+ <listitem>
+ <para>
This parameter can be used to elevate the local watchdog node priority in the elections
to select master watchdog node.
The node with the higher <varname>wd_priority</varname> value will get selected
as master watchdog node when cluster will be electing its new master node
at the time of cluster startup or in the event of old master watchdog node failure
- </para>
- <para>
- <varname>wd_priority</varname> is not available in versions prior to
- <productname>Pgpool-II</productname> <emphasis>V3.5</emphasis>.
- </para>
+ </para>
+ <para>
+ <varname>wd_priority</varname> is not available in versions prior to
+ <productname>Pgpool-II</productname> <emphasis>V3.5</emphasis>.
+ </para>
- <para>
+ <para>
This parameter can only be set at server start.
- </para>
- </listitem>
- </varlistentry>
+ </para>
+ </listitem>
+ </varlistentry>
- <varlistentry id="guc-wd-ipc-socket-dir" xreflabel="wd_ipc_socket_dir">
- <term><varname>wd_ipc_socket_dir</varname> (<type>string</type>)
- <indexterm>
+ <varlistentry id="guc-wd-ipc-socket-dir" xreflabel="wd_ipc_socket_dir">
+ <term><varname>wd_ipc_socket_dir</varname> (<type>string</type>)
+ <indexterm>
<primary><varname>wd_ipc_socket_dir</varname> configuration parameter</primary>
- </indexterm>
- </term>
- <listitem>
- <para>
+ </indexterm>
+ </term>
+ <listitem>
+ <para>
The directory where the <acronym>UNIX</acronym> domain socket
- accepting <productname>Pgpool-II</productname>
+ accepting <productname>Pgpool-II</productname>
watchdog <acronym>IPC</acronym> connections will be created.
Default is <literal>'/tmp'</literal>.
Be aware that this socket might be deleted by a cron job.
We recommend to set this value to <literal>'/var/run'</literal> or such directory.
- </para>
- <para>
+ </para>
+ <para>
<varname>wd_ipc_socket_dir</varname> is not available in versions prior to
<productname>Pgpool-II</productname> <emphasis>V3.5</emphasis>.
- </para>
- <para>
+ </para>
+ <para>
This parameter can only be set at server start.
- </para>
+ </para>
</listitem>
- </varlistentry>
+ </varlistentry>
- </variablelist>
- </sect2>
+ </variablelist>
+ </sect2>
- <sect2 id="config-watchdog-lifecheck-heartbeat">
- <title>Lifecheck Heartbeat mode configuration</title>
+ <sect2 id="config-watchdog-lifecheck-heartbeat">
+ <title>Lifecheck Heartbeat mode configuration</title>
- <variablelist>
- <varlistentry id="guc-wd-heartbeat-port" xreflabel="wd_heartbeat_port">
- <term><varname>wd_heartbeat_port</varname> (<type>integer</type>)
- <indexterm>
+ <variablelist>
+ <varlistentry id="guc-wd-heartbeat-port" xreflabel="wd_heartbeat_port">
+ <term><varname>wd_heartbeat_port</varname> (<type>integer</type>)
+ <indexterm>
<primary><varname>wd_heartbeat_port</varname> configuration parameter</primary>
- </indexterm>
- </term>
- <listitem>
- <para>
+ </indexterm>
+ </term>
+ <listitem>
+ <para>
Specifies the <acronym>UDP</acronym> port number to receive heartbeat signals.
Default is 9694.
<varname>wd_heartbeat_port</varname> is only applicable if the
<xref linkend="guc-wd-lifecheck-method"> is set to <literal>'heartbeat'</literal>
- </para>
- <para>
+ </para>
+ <para>
This parameter can only be set at server start.
- </para>
- </listitem>
-</varlistentry>
+ </para>
+ </listitem>
+ </varlistentry>
- <varlistentry id="guc-wd-heartbeat-keepalive" xreflabel="wd_heartbeat_keepalive">
- <term><varname>wd_heartbeat_keepalive</varname> (<type>integer</type>)
- <indexterm>
+ <varlistentry id="guc-wd-heartbeat-keepalive" xreflabel="wd_heartbeat_keepalive">
+ <term><varname>wd_heartbeat_keepalive</varname> (<type>integer</type>)
+ <indexterm>
<primary><varname>wd_heartbeat_keepalive</varname> configuration parameter</primary>
- </indexterm>
- </term>
- <listitem>
- <para>
+ </indexterm>
+ </term>
+ <listitem>
+ <para>
Specifies the interval time in seconds between sending the heartbeat signals.
Default is 2.
<varname>wd_heartbeat_keepalive</varname> is only applicable if the
<xref linkend="guc-wd-lifecheck-method"> is set to <literal>'heartbeat'</literal>
- </para>
+ </para>
- <para>
+ <para>
This parameter can only be set at server start.
- </para>
- </listitem>
- </varlistentry>
+ </para>
+ </listitem>
+ </varlistentry>
- <varlistentry id="guc-wd-heartbeat-deadtime" xreflabel="wd_heartbeat_deadtime">
- <term><varname>wd_heartbeat_deadtime</varname> (<type>integer</type>)
- <indexterm>
+ <varlistentry id="guc-wd-heartbeat-deadtime" xreflabel="wd_heartbeat_deadtime">
+ <term><varname>wd_heartbeat_deadtime</varname> (<type>integer</type>)
+ <indexterm>
<primary><varname>wd_heartbeat_deadtime</varname> configuration parameter</primary>
- </indexterm>
- </term>
- <listitem>
- <para>
+ </indexterm>
+ </term>
+ <listitem>
+ <para>
Specifies the time in seconds before marking the remote watchdog node as failed/dead node,
if no heartbeat signal is received within that time.
Default is <literal>30</literal>
<varname>wd_heartbeat_deadtime</varname> is only applicable if the
<xref linkend="guc-wd-lifecheck-method"> is set to <literal>'heartbeat'</literal>
- </para>
- <para>
+ </para>
+ <para>
This parameter can only be set at server start.
- </para>
+ </para>
- </listitem>
- </varlistentry>
- <varlistentry id="guc-heartbeat-destination" xreflabel="heartbeat_destination<emphasis>0</emphasis>">
- <term><varname>heartbeat_destination0</varname> (<type>string</type>)
+ </listitem>
+ </varlistentry>
+ <varlistentry id="guc-heartbeat-destination" xreflabel="heartbeat_destination<emphasis>0</emphasis>">
+ <term><varname>heartbeat_destination0</varname> (<type>string</type>)
<indexterm>
<primary><varname>heartbeat_destination</varname> configuration parameter</primary>
- </indexterm>
- </term>
- <listitem>
- <para>
+ </indexterm>
+ </term>
+ <listitem>
+ <para>
Specifies the <acronym>IP</acronym> address or <acronym>hostname</acronym> of destination the remote
<productname>Pgpool-II</productname> for sending the heartbeat signals.
Multiple destinations can be configured for the heartbeat signals,
- the number at the end of the parameter name is
+ the number at the end of the parameter name is
referred as the "destination number", that starts from 0.
- </para>
- <para>
+ </para>
+ <para>
<varname>heartbeat_destination</varname> is only applicable if the
<xref linkend="guc-wd-lifecheck-method"> is set to <literal>'heartbeat'</literal>
- </para>
- <para>
+ </para>
+ <para>
This parameter can only be set at server start.
- </para>
- </listitem>
- </varlistentry>
+ </para>
+ </listitem>
+ </varlistentry>
- <varlistentry id="guc-heartbeat-destination-port" xreflabel="heartbeat_destination_port<emphasis>0</emphasis>">
- <term><varname>heartbeat_destination_port0</varname> (<type>integer</type>)
- <indexterm>
+ <varlistentry id="guc-heartbeat-destination-port" xreflabel="heartbeat_destination_port<emphasis>0</emphasis>">
+ <term><varname>heartbeat_destination_port0</varname> (<type>integer</type>)
+ <indexterm>
<primary><varname>heartbeat_destination_port</varname> configuration parameter</primary>
- </indexterm>
- </term>
- <listitem>
- <para>
+ </indexterm>
+ </term>
+ <listitem>
+ <para>
Specifies the destination port number of the remote
<productname>Pgpool-II</productname> for sending the heartbeat signals.
Multiple destinations can be configured for the heartbeat signals,
- the number at the end of the parameter name is
+ the number at the end of the parameter name is
referred as the "destination number", that starts from 0.
- </para>
- <para>
+ </para>
+ <para>
<varname>heartbeat_destination_port</varname> is only applicable if the
<xref linkend="guc-wd-lifecheck-method"> is set to <literal>'heartbeat'</literal>
- </para>
- <para>
+ </para>
+ <para>
This parameter can only be set at server start.
- </para>
+ </para>
</listitem>
- </varlistentry>
+ </varlistentry>
- <varlistentry id="guc-heartbeat-device" xreflabel="heartbeat_device">
- <term><varname>heartbeat_device0</varname> (<type>string</type>)
- <indexterm>
+ <varlistentry id="guc-heartbeat-device" xreflabel="heartbeat_device">
+ <term><varname>heartbeat_device0</varname> (<type>string</type>)
+ <indexterm>
<primary><varname>heartbeat_device</varname> configuration parameter</primary>
- </indexterm>
- </term>
- <listitem>
- <para>
+ </indexterm>
+ </term>
+ <listitem>
+ <para>
Specifies the network device name for sending the heartbeat signals to the destination specified by
heartbeat_destinationX:heartbeat_destination_portX
Different heartbeat devices can be configured for each heartbeat destination
by changing the value of X(destination number).
at the end of parameter name. The destination index number starts from 0.
- </para>
- <para>
+ </para>
+ <para>
<varname>heartbeat_device</varname> is only applicable if the
<xref linkend="guc-wd-lifecheck-method"> is set to <literal>'heartbeat'</literal>
- </para>
- <para>
+ </para>
+ <para>
This parameter can only be set at server start.
- </para>
+ </para>
</listitem>
- </varlistentry>
+ </varlistentry>
- </variablelist>
- </sect2>
+ </variablelist>
+ </sect2>
- <sect2 id="config-watchdog-lifecheck-query">
- <title>Lifecheck Query mode configuration</title>
+ <sect2 id="config-watchdog-lifecheck-query">
+ <title>Lifecheck Query mode configuration</title>
<variablelist>
-<varlistentry id="guc-wd-life-point" xreflabel="wd_life_point">
- <term><varname>wd_life_point</varname> (<type>integer</type>)
- <indexterm>
+ <varlistentry id="guc-wd-life-point" xreflabel="wd_life_point">
+ <term><varname>wd_life_point</varname> (<type>integer</type>)
+ <indexterm>
<primary><varname>wd_life_point</varname> configuration parameter</primary>
- </indexterm>
- </term>
- <listitem>
- <para>
+ </indexterm>
+ </term>
+ <listitem>
+ <para>
Specifies the number of times to retry a failed life check of pgpool-II.
Valid value could be a number greater than or equal to 1.
Default is 3.
- </para>
- <para>
+ </para>
+ <para>
<varname>wd_life_point</varname> is only applicable if the
<xref linkend="guc-wd-lifecheck-method"> is set to <literal>'query'</literal>
- </para>
- <para>
+ </para>
+ <para>
This parameter can only be set at server start.
- </para>
+ </para>
</listitem>
- </varlistentry>
+ </varlistentry>
-<varlistentry id="guc-wd-lifecheck-query" xreflabel="wd_lifecheck_query">
- <term><varname>wd_lifecheck_query</varname> (<type>string</type>)
- <indexterm>
+ <varlistentry id="guc-wd-lifecheck-query" xreflabel="wd_lifecheck_query">
+ <term><varname>wd_lifecheck_query</varname> (<type>string</type>)
+ <indexterm>
<primary><varname>wd_lifecheck_query</varname> configuration parameter</primary>
- </indexterm>
- </term>
- <listitem>
- <para>
+ </indexterm>
+ </term>
+ <listitem>
+ <para>
Specifies the query to use for the life check of remote <productname>Pgpool-II</productname>.
Default is <literal>"SELECT 1"</literal>.
- </para>
- <para>
+ </para>
+ <para>
<varname>wd_lifecheck_query</varname> is only applicable if the
<xref linkend="guc-wd-lifecheck-method"> is set to <literal>'query'</literal>
- </para>
- <para>
+ </para>
+ <para>
This parameter can only be set at server start.
- </para>
+ </para>
</listitem>
- </varlistentry>
+ </varlistentry>
- <varlistentry id="guc-wd-lifecheck-dbname" xreflabel="wd_lifecheck_dbname">
- <term><varname>wd_lifecheck_dbname</varname> (<type>string</type>)
- <indexterm>
+ <varlistentry id="guc-wd-lifecheck-dbname" xreflabel="wd_lifecheck_dbname">
+ <term><varname>wd_lifecheck_dbname</varname> (<type>string</type>)
+ <indexterm>
<primary><varname>wd_lifecheck_dbname</varname> configuration parameter</primary>
- </indexterm>
- </term>
- <listitem>
- <para>
+ </indexterm>
+ </term>
+ <listitem>
+ <para>
Specifies the database name for the connection used for the
- life check of remote <productname>Pgpool-II</productname>.
+ life check of remote <productname>Pgpool-II</productname>.
Default is <literal>"template1"</literal>.
- </para>
- <para>
+ </para>
+ <para>
<varname>wd_lifecheck_dbname</varname> is only applicable if the
<xref linkend="guc-wd-lifecheck-method"> is set to <literal>'query'</literal>
- </para>
- <para>
+ </para>
+ <para>
This parameter can only be set at server start.
- </para>
+ </para>
</listitem>
- </varlistentry>
+ </varlistentry>
-<varlistentry id="guc-wd-lifecheck-user" xreflabel="wd_lifecheck_user">
- <term><varname>wd_lifecheck_user</varname> (<type>string</type>)
- <indexterm>
+ <varlistentry id="guc-wd-lifecheck-user" xreflabel="wd_lifecheck_user">
+ <term><varname>wd_lifecheck_user</varname> (<type>string</type>)
+ <indexterm>
<primary><varname>wd_lifecheck_user</varname> configuration parameter</primary>
- </indexterm>
- </term>
- <listitem>
- <para>
+ </indexterm>
+ </term>
+ <listitem>
+ <para>
Specifies the user name for the connection used for the life
- check of remote <productname>Pgpool-II</productname>.
+ check of remote <productname>Pgpool-II</productname>.
Default is <literal>"nobody"</literal>.
- </para>
- <para>
+ </para>
+ <para>
<varname>wd_lifecheck_user</varname> is only applicable if the
<xref linkend="guc-wd-lifecheck-method"> is set to <literal>'query'</literal>
- </para>
- <para>
+ </para>
+ <para>
This parameter can only be set at server start.
- </para>
+ </para>
</listitem>
- </varlistentry>
+ </varlistentry>
- <varlistentry id="guc-wd-lifecheck-password" xreflabel="wd_lifecheck_password">
- <term><varname>wd_lifecheck_password</varname> (<type>string</type>)
- <indexterm>
+ <varlistentry id="guc-wd-lifecheck-password" xreflabel="wd_lifecheck_password">
+ <term><varname>wd_lifecheck_password</varname> (<type>string</type>)
+ <indexterm>
<primary><varname>wd_lifecheck_password</varname> configuration parameter</primary>
- </indexterm>
- </term>
- <listitem>
- <para>
+ </indexterm>
+ </term>
+ <listitem>
+ <para>
Specifies the password for the user used for the life check of remote <productname>Pgpool-II</productname>.
- </para>
- <para>
- If <varname>wd_lifecheck_password</varname> is left blank <productname>Pgpool-II</productname>
- will first try to get the password for <xref linkend="guc-wd-lifecheck-user"> from
- <xref linkend="guc-pool-passwd"> file before using the empty password.
- </para>
- <para>
- You can also specify AES256-CBC encrypted password in <varname>wd_lifecheck_password</varname> field.
- To specify the <literal>AES</literal> encrypted password, password string must be prefixed with
- <literal>AES</literal> after encrypting (using <literal>aes-256-cbc</literal> algorithm) and
- encoding to <literal>base64</literal>.
- </para>
- <para>
- To specify the unencrypted clear text password, prefix the password string with
- <literal>TEXT</literal>. For example if you want to set <literal>mypass</literal> as
- a password, you should specify <literal>TEXTmypass</literal> in the password field.
- In the absence of a valid prefix, <productname>Pgpool-II</productname> will considered
- the string as a plain text password.
- </para>
- <para>
- You can also use <xref linkend="PG-ENC"> utility to create the correctly formatted
- <literal>AES</literal> encrypted password strings.
- <note>
- <para>
- <productname>Pgpool-II</productname> will require a valid decryption key at the
- startup to use the encrypted passwords.
- see <xref linkend="auth-aes-decryption-key"> for more details on providing the
- decryption key to <productname>Pgpool-II</productname>
- </para>
- </note>
- </para>
- <para>
+ </para>
+ <para>
+ If <varname>wd_lifecheck_password</varname> is left blank <productname>Pgpool-II</productname>
+ will first try to get the password for <xref linkend="guc-wd-lifecheck-user"> from
+ <xref linkend="guc-pool-passwd"> file before using the empty password.
+ </para>
+ <para>
+ You can also specify AES256-CBC encrypted password in <varname>wd_lifecheck_password</varname> field.
+ To specify the <literal>AES</literal> encrypted password, password string must be prefixed with
+ <literal>AES</literal> after encrypting (using <literal>aes-256-cbc</literal> algorithm) and
+ encoding to <literal>base64</literal>.
+ </para>
+ <para>
+ To specify the unencrypted clear text password, prefix the password string with
+ <literal>TEXT</literal>. For example if you want to set <literal>mypass</literal> as
+ a password, you should specify <literal>TEXTmypass</literal> in the password field.
+ In the absence of a valid prefix, <productname>Pgpool-II</productname> will considered
+ the string as a plain text password.
+ </para>
+ <para>
+ You can also use <xref linkend="PG-ENC"> utility to create the correctly formatted
+ <literal>AES</literal> encrypted password strings.
+ <note>
+ <para>
+ <productname>Pgpool-II</productname> will require a valid decryption key at the
+ startup to use the encrypted passwords.
+ see <xref linkend="auth-aes-decryption-key"> for more details on providing the
+ decryption key to <productname>Pgpool-II</productname>
+ </para>
+ </note>
+ </para>
+ <para>
<varname>wd_lifecheck_password</varname> is only applicable if the
<xref linkend="guc-wd-lifecheck-method"> is set to <literal>'query'</literal>
- </para>
- <para>
+ </para>
+ <para>
This parameter can only be set at server start.
- </para>
- <para>
+ </para>
+ <para>
Default is <literal>''</literal>(empty).
- </para>
+ </para>
</listitem>
- </varlistentry>
+ </varlistentry>
- </variablelist>
- </sect2>
+ </variablelist>
+ </sect2>
- <sect2 id="config-watchdog-server-configuration">
- <title>Watchdog servers configurations</title>
+ <sect2 id="config-watchdog-server-configuration">
+ <title>Watchdog servers configurations</title>
<variablelist>
- <varlistentry id="guc-other-pgpool-hostname" xreflabel="other_pgpool_hostname">
- <term><varname>other_pgpool_hostname0</varname> (<type>string</type>)
- <indexterm>
+ <varlistentry id="guc-other-pgpool-hostname" xreflabel="other_pgpool_hostname">
+ <term><varname>other_pgpool_hostname0</varname> (<type>string</type>)
+ <indexterm>
<primary><varname>other_pgpool_hostname</varname> configuration parameter</primary>
- </indexterm>
- </term>
- <listitem>
- <para>
+ </indexterm>
+ </term>
+ <listitem>
+ <para>
Specifies the hostname of remote <productname>Pgpool-II</productname> server for watchdog node.
The number at the end of the parameter name is referred as "server id", and it starts from 0.
- </para>
- <para>
+ </para>
+ <para>
This parameter can only be set at server start.
- </para>
+ </para>
</listitem>
- </varlistentry>
+ </varlistentry>
- <varlistentry id="guc-other-pgpool-port" xreflabel="other_pgpool_port">
- <term><varname>other_pgpool_port0</varname> (<type>integer</type>)
- <indexterm>
+ <varlistentry id="guc-other-pgpool-port" xreflabel="other_pgpool_port">
+ <term><varname>other_pgpool_port0</varname> (<type>integer</type>)
+ <indexterm>
<primary><varname>other_pgpool_port</varname> configuration parameter</primary>
- </indexterm>
- </term>
- <listitem>
- <para>
+ </indexterm>
+ </term>
+ <listitem>
+ <para>
Specifies the port number of the remote <productname>Pgpool-II</productname>
server for watchdog node.
The number at the end of the parameter name is referred
as "server id", and it starts from 0.
- </para>
- <para>
+ </para>
+ <para>
This parameter can only be set at server start.
- </para>
+ </para>
</listitem>
- </varlistentry>
+ </varlistentry>
- <varlistentry id="guc-other-wd-port" xreflabel="other_wd_port">
- <term><varname>other_wd_port0</varname> (<type>integer</type>)
- <indexterm>
+ <varlistentry id="guc-other-wd-port" xreflabel="other_wd_port">
+ <term><varname>other_wd_port0</varname> (<type>integer</type>)
+ <indexterm>
<primary><varname>other_wd_port0</varname> configuration parameter</primary>
- </indexterm>
- </term>
- <listitem>
- <para>
+ </indexterm>
+ </term>
+ <listitem>
+ <para>
Specifies the watchdog port number of the remote
<productname>Pgpool-II</productname> server for watchdog node.
The number at the end of the parameter name is referred
as "server id", and it starts from 0.
- </para>
- <para>
+ </para>
+ <para>
This parameter can only be set at server start.
- </para>
+ </para>
</listitem>
- </varlistentry>
+ </varlistentry>
- </variablelist>
- </sect2>
+ </variablelist>
+ </sect2>
</sect1>
[parent: b3d499e59c3c]