pgpool2.git / summary / log / commit / refs
commit 5073187d401e8df26a18dce541aaa68736a7bd46
Author: Tatsuo Ishii <ishii@sraoss.co.jp>
Date: Wed Sep 16 23:44:06 2020 +0000
Add wd_cli Japanese doc.
Also small tweaks to English doc.
doc.ja/src/sgml/ref/allfiles.sgml | 1 +
doc.ja/src/sgml/ref/wd_cli.sgml | 364 ++++++++++++++++++++++++++++++++++++++
doc.ja/src/sgml/reference.sgml | 1 +
3 files changed, 366 insertions(+)
diff --git a/doc.ja/src/sgml/ref/allfiles.sgml b/doc.ja/src/sgml/ref/allfiles.sgml
index 337a3f75c..69bf19226 100644
--- a/doc.ja/src/sgml/ref/allfiles.sgml
+++ b/doc.ja/src/sgml/ref/allfiles.sgml
@@ -20,6 +20,7 @@ Complete list of usable sgml source files in this directory.
<!ENTITY pcpReloadConfig SYSTEM "pcp_reload_config.sgml">
<!ENTITY pgMd5 SYSTEM "pg_md5.sgml">
<!ENTITY pgEnc SYSTEM "pg_enc.sgml">
+<!ENTITY wdCli SYSTEM "wd_cli.sgml">
<!ENTITY pgproto SYSTEM "pgproto.sgml">
<!ENTITY pgpool SYSTEM "pgpool.sgml">
<!ENTITY pgpoolSetup SYSTEM "pgpool_setup.sgml">
diff --git a/doc.ja/src/sgml/ref/wd_cli.sgml b/doc.ja/src/sgml/ref/wd_cli.sgml
new file mode 100644
index 000000000..3cc6902ba
--- /dev/null
+++ b/doc.ja/src/sgml/ref/wd_cli.sgml
@@ -0,0 +1,364 @@
+<!--
+doc/src/sgml/ref/wd_cli.sgml
+Pgpool-II documentation
+-->
+
+<refentry id="WD-CLI">
+ <indexterm zone="wd-cli">
+ <primary>wd_cli</primary>
+ </indexterm>
+
+ <refmeta>
+ <refentrytitle>wd_cli</refentrytitle>
+ <manvolnum>1</manvolnum>
+ <refmiscinfo>Other Commands</refmiscinfo>
+ </refmeta>
+
+ <refnamediv>
+ <refname>wd_cli</refname>
+ <refpurpose>
+<!--
+ Watchdog Command Line Interface (CLI) utility for the
+ external health-check system integration.
+-->
+外部ヘルスチェックシステムとの統合に用いるためのWatchdog Command Line Interface (CLI)ユーティリティ
+ </refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ <command>wd_cli</command>
+ <arg rep="repeat"><replaceable>operation</replaceable></arg>
+ <arg rep="repeat"><replaceable>node search option</replaceable></arg>
+ <arg rep="repeat"><replaceable>option</replaceable></arg>
+ </cmdsynopsis>
+ </refsynopsisdiv>
+
+ <refsect1 id="R1-WD-CLI-1">
+ <title>Description</title>
+ <para>
+ <command>wd_cli</command>
+<!--
+ Provides a convenient and easy to use interface to interact with
+ watchdog and perform health check related node operations.
+-->
+watchdogとヘルスチェック関連のノード操作を行うための便利で使いやすいインターフェイスを提供します。
+ </para>
+ </refsect1>
+
+ <refsect1>
+<!--
+ <title>Operations</title>
+-->
+ <title>操作</title>
+ <para>
+ <variablelist>
+
+ <varlistentry>
+ <term><option>-i</option></term>
+ <term><option>--info</option></term>
+ <listitem>
+ <para>
+<!--
+ Get the node status for node(s) based on node search criteria
+-->
+ノードの検索条件に基づいてノード状態を取得します。
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-I <replaceable class="parameter">NEW_STATUS</replaceable></option></term>
+ <term><option>--inform=<replaceable class="parameter">NEW_STATUS</replaceable></option></term>
+ <listitem>
+ <para>
+<!--
+ Update the watchdog node status.
+ Allowed values are <literal>DEAD</literal> and <literal>ALIVE</literal>
+-->
+watchdogノード状態を更新します。
+受付可能な値は<literal>DEAD</literal>と<literal>ALIVE</literal>です。
+ </para>
+ </listitem>
+ </varlistentry>
+
+ </variablelist>
+ </para>
+ </refsect1>
+
+ <refsect1>
+<!--
+ <title>Node Search Options</title>
+-->
+ <title>ノード検索操作</title>
+ <para>
+ <variablelist>
+
+ <varlistentry>
+ <term><option>-a </option></term>
+ <term><option>--all</option></term>
+ <listitem>
+ <para>
+<!--
+ Select all nodes (only available with <literal>--info</literal> operation)
+-->
+すべてのノードを選択します。（<literal>--info</literal>操作でのみ可能です）
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-n <replaceable class="parameter">WATCHDOG_NODE_ID</replaceable></option></term>
+ <term><option>--node-id=<replaceable class="parameter">WATCHDOG_NODE_ID</replaceable></option></term>
+ <listitem>
+ <para>
+<!--
+ Select watchdog node by node_id.
+-->
+node_idでwatchdogノードを検索します。
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-N <replaceable class="parameter">NODE_NAME</replaceable></option></term>
+ <term><option>--node-name=<replaceable class="parameter">NODE_NAME</replaceable></option></term>
+ <listitem>
+ <para>
+<!--
+ Select watchdog node by name.
+-->
+名前でwatchdogノードを検索します。
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-H <replaceable class="parameter">HOSTNAME</replaceable></option></term>
+ <term><option>--node-host=<replaceable class="parameter">HOSTNAME</replaceable></option></term>
+ <listitem>
+ <para>
+<!--
+ Select watchdog node by hostname.
+-->
+ホスト名でwatchdogノードを検索します。
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-P <replaceable class="parameter">PORT_NO</replaceable></option></term>
+ <term><option>--node-port=<replaceable class="parameter">PORT_NO</replaceable></option></term>
+ <listitem>
+ <para>
+<!--
+ Select watchdog node by port number.
+-->
+ポート番号でwatchdogノードを検索します。
+ </para>
+ </listitem>
+ </varlistentry>
+
+
+ </variablelist>
+ </para>
+ </refsect1>
+
+ <refsect1>
+<!--
+ <title>Options</title>
+-->
+ <title>操作</title>
+ <para>
+ <variablelist>
+
+ <varlistentry>
+ <term><option>-k <replaceable class="parameter">KEY</replaceable></option></term>
+ <term><option>--auth-key=<replaceable class="parameter">KEY</replaceable></option></term>
+ <listitem>
+ <para>
+<!--
+ Watchdog auth key.
+ Specifying auth-key over rides the <literal>pgpool.conf->wd_authkey</literal> value.
+-->
+watchdog認証キー。
+この認証キーを指定すると<literal>pgpool.conf->wd_authkey</literal>の値に優先します。
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-f <replaceable class="parameter">CONFIG_FILE</replaceable></option></term>
+ <term><option>--config-file=<replaceable class="parameter">CONFIG_FILE</replaceable></option></term>
+ <listitem>
+ <para>
+<!--
+ Specifies the <filename>pgpool.conf</filename> file.
+-->
+<filename>pgpool.conf</filename> file.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-s <replaceable class="parameter">SOCKET_DIR</replaceable></option></term>
+ <term><option>--socket-dir=<replaceable class="parameter">SOCKET_DIR</replaceable></option></term>
+ <listitem>
+ <para>
+<!--
+ Path to the watchdog IPC socket directory.
+ Specifying socket-dir over rides the <literal>pgpool.conf->wd_ipc_socket_dir</literal> value.
+-->
+watchdog IPCソケットディレクトリのパスです。
+このパスを指定すると<literal>pgpool.conf->wd_ipc_socket_dir</literal>の値に優先します。
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-p <replaceable class="parameter">PORT_NO</replaceable></option></term>
+ <term><option>--ipc-port=<replaceable class="parameter">PORT_NO</replaceable></option></term>
+ <listitem>
+ <para>
+<!--
+ Port number of watchdog IPC socket.
+ Specifying ipc-port over rides the <literal>pgpool.conf->wd_port</literal> value.
+-->
+watchdog IPCソケットのポート番号です。
+このポート番号を指定すると<literal>pgpool.conf->wd_port</literal>の値に優先します。
+ </para>
+ </listitem>
+ </varlistentry>
+
+
+ <varlistentry>
+ <term><option>-m <replaceable class="parameter">message_string</replaceable></option></term>
+ <term><option>--message=<replaceable class="parameter">message_string</replaceable></option></term>
+ <listitem>
+ <para>
+<!--
+ Optional message string to be passed to <productname>Pgpool-II</productname> along with the node status.
+-->
+ノード状態とともに<productname>Pgpool-II</productname>に渡す追加のメッセージ文字列です。
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-v</option></term>
+ <term><option>--verbose</option></term>
+ <listitem>
+ <para>
+<!--
+ Enable verbose messages.
+-->
+冗長なメッセージを有効にします。
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-V</option></term>
+ <term><option>--version</option></term>
+ <listitem>
+ <para>
+<!--
+ Prints version information.
+-->
+バージョン情報を表示します。
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-d</option></term>
+ <term><option>--debug</option></term>
+ <listitem>
+ <para>
+<!--
+ Enable debug output.
+-->
+デバッグ表示を有効にします。
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-h</option></term>
+ <term><option>--help</option></term>
+ <listitem>
+ <para>
+<!--
+ Prints the help for <literal>wd_cli</literal>.
+-->
+<command>wd_cli</command>のヘルプを表示します。
+ </para>
+ </listitem>
+ </varlistentry>
+
+ </variablelist>
+ </para>
+ </refsect1>
+
+ <refsect1>
+<!--
+ <title>Example</title>
+-->
+ <title>例</title>
+ <para>
+<!--
+ When some external health-check system is configured
+ to monitor the health of <productname>Pgpool-II</productname> cluster
+ and it detects a node failure. <literal>wd_cli</literal> utility can
+ be used to pass this information to <productname>Pgpool-II</productname>
+ cluster so that it can take the appropriate actions.
+-->
+<productname>Pgpool-II</productname>クラスタを監視するために外部ヘルスチェックシステムが設定されていて、ノード障害を検出しました。
+この情報を<productname>Pgpool-II</productname>クラスタに渡して適切な対応を行うことができるように<literal>wd_cli</literal>ユーティリティを使用することができます。
+
+ <programlisting>
+ #inform Pgpool-II about node named RN-110 failure
+ wd_cli --inform DEAD -N 'RN-110' -p 9001 -m 'Pgpool node with name RN-110 is not reachable'
+ </programlisting>
+ <programlisting>
+ #inform Pgpool-II about node-id 10 failure
+ wd_cli --inform DEAD -n 10 -m 'Pgpool node with ID 10 is not responding'
+ </programlisting>
+<!--
+ Similarly to inform Pgpool-II about the node is alive again.
+-->
+同様にノードが再び復帰したことをPgpool-IIに知らせます。
+ <programlisting>
+ #inform Pgpool-II about node-id 10 re-joining
+ wd_cli --inform ALIVE -n 10 -m 'Pgpool node with ID 10 is reachable again'
+ </programlisting>
+
+<!--
+ wd_cli can also be used to get the current status of cluster nodes.
+-->
+また、wd_cliはノードの現在の状態を取得するために使用することができます。
+ <programlisting>
+ wd_cli -f simple_conf/watchdog/pgpool_wd1.conf --info -v --all
+
+ Total Watchdog nodes configured for lifecheck: 2
+ *****************
+ Node ID: 0
+ Node Status code 4
+ Node Status: MASTER
+ Node Name: localhost:9991 Linux localhost.localdomain
+ Node Host: localhost
+ Node WD Port: 9001
+ Node Pgpool Port: 9991
+
+ Node ID: 1
+ Node Status code 7
+ Node Status: STANDBY
+ Node Name: localhost:9992 Linux localhost.localdomain
+ Node Host: localhost
+ Node WD Port: 9002
+ Node Pgpool Port: 9992
+ </programlisting>
+ </para>
+ </refsect1>
+
+</refentry>
diff --git a/doc.ja/src/sgml/reference.sgml b/doc.ja/src/sgml/reference.sgml
index 65da5f18f..b7c7daa83 100644
--- a/doc.ja/src/sgml/reference.sgml
+++ b/doc.ja/src/sgml/reference.sgml
@@ -180,6 +180,7 @@
&pgproto;
&pgpoolSetup;
&watchdoglSetup;
+ &wdCli;
</reference>
[parent: 904d6facbfd4]