pgpool2.git / summary / log / commit / refs

commit    b69e94e97ed4226e335e85f01bfc373c8e11db8f
Author:   Takuma Hoshiai <hoshiai@sraoss.co.jp>
Date:     Fri Mar 22 04:30:30 2019 +0000

    Doc: update chapters that 'Watchdog' of 'Tutorial' and some sections of 'Server Administration'
    
    reviewed by Tatsu Ishii and Bo Peng.


doc.ja/src/sgml/advanced.sgml | 17 +++-- doc.ja/src/sgml/installation-rpm.sgml | 40 ++++++----- doc.ja/src/sgml/installation-tips.sgml | 12 ++++ doc.ja/src/sgml/installation.sgml | 123 ++++++++------------------------- doc.ja/src/sgml/runtime.sgml | 121 ++++++++++++++++++++++++-------- doc/src/sgml/advanced.sgml | 9 ++- doc/src/sgml/installation-rpm.sgml | 28 ++++---- doc/src/sgml/installation-tips.sgml | 11 +++ doc/src/sgml/installation.sgml | 79 ++++++--------------- doc/src/sgml/runtime.sgml | 74 +++++++++++++++----- 10 files changed, 275 insertions(+), 239 deletions(-) diff --git a/doc.ja/src/sgml/advanced.sgml b/doc.ja/src/sgml/advanced.sgml index 769162374..66313461d 100644 --- a/doc.ja/src/sgml/advanced.sgml +++ b/doc.ja/src/sgml/advanced.sgml @@ -122,7 +122,7 @@ watchdog死活監視は、高可用性のために、watchdogクラスタに所 exchange between <productname>Pgpool-II</productname> nodes. This is the default and recommended mode to be used for health checking. --> -<literal>heartbeat</literal>モードでは、watchdogは他の<productname>Pgpool-II</productname>プロセスを<literal>heartbeat</literal>信号で監視します。 +<literal>heartbeat</literal>モードでは、watchdogは他の<productname>Pgpool-II</productname>プロセスをハートビート信号で監視します。 watchdogは、定期的に他の<productname>Pgpool-II</productname>から送られたハートビート信号を受信します。 一定期間信号が受信されなければ、watchdogはその<productname>Pgpool-II</productname>に障害が起こったとみなします。 冗長性のために<productname>Pgpool-II</productname>ノード間で取り交わされるハートビート通信のためのネットワーク接続を複数使うことができます。 @@ -224,7 +224,7 @@ watchdogは、定期的に他の<productname>Pgpool-II</productname>から送ら <productname>Pgpool-II</productname> to work using the same IP address even when servers are switched. --> -スタンバイ<productname>Pgpool-II</productname>サーバが昇格すると、新しいアクティブサーバは仮想IPインターフェスを立ち上げます。 +スタンバイ<productname>Pgpool-II</productname>サーバが昇格すると、新しいアクティブサーバは仮想IPインターフェイスを立ち上げます。 一方、以前のアクティブサーバは、仮想IPインターフェイスを停止します。 これにより、サーバが切り替わっても<productname>Pgpool-II</productname>は同じIPアドレスを使うことができます。 </para> @@ -272,7 +272,7 @@ watchdogは、定期的に他の<productname>Pgpool-II</productname>から送ら the watchdog for bringing up and bringing down the VIP require the root privileges. <productname>Pgpool-II</productname> requires the user running <productname>Pgpool-II</productname> to have root - privileges when the watchdog is enabled along with delegate IP. + privileges when the watchdog is enabled along with virtual IP. This is however not good security practice to run the <productname>Pgpool-II</productname> as root user, the alternative and preferred way is to run the <productname>Pgpool-II</productname> @@ -298,7 +298,7 @@ watchdogは、<productname>Pgpool-II</productname>の下位プロセスとして <para> watchdogは仮想IPインターフェイスを制御します。 VIPを起動、停止するために実行されるコマンドにはroot権限が必要です。 -watchdogが委任IPを伴って起動される際には、<productname>Pgpool-II</productname>は、<productname>Pgpool-II</productname>を実行しているユーザがroot権限を持つことを要求します。 +watchdogが仮想IPを伴って起動される際には、<productname>Pgpool-II</productname>は、<productname>Pgpool-II</productname>を実行しているユーザがroot権限を持つことを要求します。 しかし、<productname>Pgpool-II</productname>をrootユーザで実行するのは良いセキュリティの実践とは言えません。 別の推奨する方法は、<productname>Pgpool-II</productname>を通常のユーザとして起動し、<command>sudo</command>を使って<xref linkend="guc-if-up-cmd">、<xref linkend="guc-if-down-cmd">、<xref linkend="guc-arping-cmd">にカスタムコマンドを設定するか、<literal>if_*</literal>コマンドに<command>setuid</command>("set user ID upon execution")することです。 </para> @@ -1065,11 +1065,11 @@ IPCソケットは、watchdogと通信する外部/サードパーティシス <!-- Watchdog lifecheck is the sub-component of watchdog that monitors the health of <productname>Pgpool-II</productname> nodes participating in the watchdog - cluster. <productname>Pgpool-II</productname> watchdog provides two built-in - methods of remote node health checking, "heartbeat" and "query" mode. + cluster. <productname>Pgpool-II</productname> watchdog provides three built-in + methods of remote node health checking, "heartbeat", "query" and "external" mode. --> Watchdogにおける死活監視は、watchdogクラスタに参加している<productname>Pgpool-II</productname>ノードの健全性を監視するwatchdogの下位コンポーネントです。 -<productname>Pgpool-II</productname> watchdogは、リモートノードの健全性をチェックする2つの方法、"heartbeat"と"query"モードを提供します。 +<productname>Pgpool-II</productname> watchdogは、リモートノードの健全性をチェックする3つの方法、"heartbeat"と"query"とexternal"モードを提供します。 </para> <para> <!-- @@ -1081,6 +1081,8 @@ Watchdogにおける死活監視は、watchdogクラスタに参加している< interface for querying the remote <productname>Pgpool-II</productname>. And in this mode the lifecheck process creates a new thread for each health check query which gets destroyed as soon as the query finishes. + While in "external" mode, this mode disables the built in lifecheck of + <productname>Pgpool-II</productname>, and expects that the external system will monitor local and remote node instead. --> "heartbeat"モードでは、死活監視プロセスは<acronym>UDP</acronym>を使ってリモートノードにアクセスできるかどうか確認します。 各ノード毎に死活監視の親プロセスは2つの子プロセスを起動します。 @@ -1088,6 +1090,7 @@ Watchdogにおける死活監視は、watchdogクラスタに参加している< "query"モードでは、死活監視プロセスはPostgreSQLのlibpqインターフェイスを使ってリモートの<productname>Pgpool-II</productname>に問い合わせを送ります。 このモードでは、各死活監視プロセスは、死活監視のために新しくスレッドを作成します。 クエリが終了すると、直ちにそのスレッドは破棄されます。 +"external"モードでは、<productname>Pgpool-II</productname>の死活監視は無効になり、代わりに外部システムがローカルノードとリモートノードを監視することを期待します。 </para> <para> <!-- diff --git a/doc.ja/src/sgml/installation-rpm.sgml b/doc.ja/src/sgml/installation-rpm.sgml index 58a5d36d2..4d2effe37 100644 --- a/doc.ja/src/sgml/installation-rpm.sgml +++ b/doc.ja/src/sgml/installation-rpm.sgml @@ -36,19 +36,19 @@ --> RHELとその派生ディストリビューションでは、以下を一度行ってください。 <programlisting> -yum install http://www.pgpool.net/yum/rpms/3.6/redhat/rhel-7-x86_64/pgpool-II-release-3.6-1.noarch.rpm +yum install http://www.pgpool.net/yum/rpms/4.0/redhat/rhel-7-x86_64/pgpool-II-release-4.0-1.noarch.rpm </programlisting> <!-- Then: --> そして以下を実施してください。 <programlisting> -yum install pgpool-II-pg96 +yum install pgpool-II-pg11 </programlisting> <!-- - <literal>pg96</literal> means <literal>PostgreSQL - 9.6</literal>. <productname>Pgpool-II</productname> + <literal>pg11</literal> means <literal>PostgreSQL + 11</literal>. <productname>Pgpool-II</productname> needs <productname>PostgreSQL</productname>'s library and extensions directory. Since the directory paths are different in the particular <productname>PostgreSQL</productname> versions, @@ -60,12 +60,12 @@ yum install pgpool-II-pg96 Optionally you can install: --> -<literal>pg96</literal>は、<literal>PostgreSQL 9.6</literal>を意味しています。 +<literal>pg11</literal>は、<literal>PostgreSQL 11</literal>を意味しています。 <productname>Pgpool-II</productname>は<productname>PostgreSQL</productname>のライブラリと拡張のディレクトリが必要です。 そのディレクトリへのパスは<productname>PostgreSQL</productname>のバージョンごとに異なっているので、<productname>PostgreSQL</productname>に対応するRPMを選んでください。 またRPMは、<ulink url="https://www.postgresql.org/download/linux/redhat/"><productname>PostgreSQL</productname>コミュニティRPM</ulink>を使用することを前提としています。 <programlisting> -yum install pgpool-II-pg96-debuginfo +yum install pgpool-II-pg11-debuginfo </programlisting> <!-- which makes it easier to retrieve debugging symbols from the core @@ -77,7 +77,7 @@ yum install pgpool-II-pg96-debuginfo インストールすることを推奨します。 開発向けのオプションパッケージがあります。 <programlisting> -yum install pgpool-II-pg96-devel +yum install pgpool-II-pg11-devel </programlisting> <!-- This installs header files which developers are interested in @@ -92,7 +92,7 @@ yum install pgpool-II-pg96-devel --> すべての<productname>PostgreSQL</productname>サーバに、以下をインストールしてください。 <programlisting> -yum install pgpool-II-pg96-extensions +yum install pgpool-II-pg11-extensions </programlisting> </para> @@ -107,11 +107,11 @@ yum install pgpool-II-pg96-extensions <!-- All the <productname>Pgpool-II</productname> configuration files live in <filename>/etc/pgpool-II</filename>. Please refer - to <xref linkend="setting-up-pgpool-conf"> to see how to set up + to <xref linkend="configuring-pgpool"> to see how to set up configuration files. --> すべての<productname>Pgpool-II</productname>設定ファイルは<filename>/etc/pgpool-II</filename>にあります。 -設定方法については<xref linkend="setting-up-pgpool-conf">を参照ください。 +設定方法については<xref linkend="configuring-pgpool">を参照ください。 </para> </sect2> @@ -124,28 +124,30 @@ yum install pgpool-II-pg96-extensions <!-- RHEL7/CentOS 7では、以下を一度行ってください。 --> - +<!-- + Do this once, if set the automatic startup of <productname>Pgpool-II</productname>. +--> +<productname>Pgpool-II</productname>の自動起動を設定する場合、以下を実行してください。 <programlisting> systemctl enable pgpool.service </programlisting> <!-- - After this, restart the whole system or: + After this, restart the whole system or do this. Please note that + <productname>PostgreSQL</productname> servers must have been started + before this. --> この後システム全体を再起動するか、以下を実行してください。 - +<productname>PostgreSQL</productname>サーバは、これよりも前に起動済みでなければならないことに注意してください。 <programlisting> systemctl start pgpool.service </programlisting> <!-- - Please note that <productname>PostgreSQL</productname> servers - must have been started before this. - - To stop <productname>Pgpool-II</productname>: + To stop <productname>Pgpool-II</productname>, do this once. + <productname>Pgpool-II</productname> must need to stop, before <productname>PostgreSQL</productname> is stopped. --> -<productname>PostgreSQL</productname>サーバは、これよりも前に起動済みでなければならないことに注意してください。 - +<productname>Pgpool-II</productname>を停止するには、以下を実行してください。<productname>PostgreSQL</productname>を停止する場合、<productname>Pgpool-II</productname>を先に停止する必要があります。 <programlisting> systemctl stop pgpool.service </programlisting> diff --git a/doc.ja/src/sgml/installation-tips.sgml b/doc.ja/src/sgml/installation-tips.sgml index 6ff75d933..dea4e5c49 100644 --- a/doc.ja/src/sgml/installation-tips.sgml +++ b/doc.ja/src/sgml/installation-tips.sgml @@ -27,6 +27,18 @@ <productname>Pgpool-II</productname>が他の<productname>Pgpool-II</productname>サーバや<productname>PostgreSQL</productname>サーバに接続する際には、ファイアーウォールの管理ソフトによって目的のポートが開けられていなければなりません。 </para> + <para> +<!-- + First, allow to access port that <productname>Pgpool-II</productname> use. +--> +まず、<productname>Pgpool-II</productname>の使用するポートを開放します。 + + <programlisting> +firewall-cmd --permanent --zone=public --add-port=9999/tcp --add-port=9898/tcp --add-port=9000/tcp --add-port=9694/tcp +firewall-cmd --permanent --zone=public --add-port=9999/udp --add-port=9898/udp --add-port=9000/udp --add-port=9694/udp +firewall-cmd --reload + </programlisting> + </para> <para> <!-- Here is an example for CentOS/RHEL7 when access diff --git a/doc.ja/src/sgml/installation.sgml b/doc.ja/src/sgml/installation.sgml index 4c04a0c80..0be4562c9 100644 --- a/doc.ja/src/sgml/installation.sgml +++ b/doc.ja/src/sgml/installation.sgml @@ -99,6 +99,18 @@ Windows はサポートされてません。 </para> </listitem> + <listitem> + <para> +<!-- + Several packages of <productname>PostgreSQL</productname> are required to + install <productname>Pgpool-II</productname>. You install postgresql-libs + and postgresql-devel packages from rpm. +--> +<productname>Pgpool-II</productname>をインストールするためには<productname>PostgreSQL</productname>のいくつかのパッケージが必要となります。 +<productname>PostgreSQL</productname>をソースコードからインストールする、もしくは<application>postgresql-libs</application>,<application>postgresql-devel</application>のパッケージをインストールしてください。 + </para> + </listitem> + </itemizedlist> </para> @@ -366,6 +378,21 @@ make install <title>Installing pgpool_recovery</title> --> <title>pgpool_recoveryのインストール</title> + <para> +<!-- + <productname>Pgpool-II</productname> need function of <function>pgpool_recovery</function>, + <function>pgpool_remote_start</function> and <function>pgpool_switch_xlog</function>, + when you use the online recovery that discribes latter. + Also pgpoolAdmin of management tool, stop, restart or reload a + <productname>PostgreSQL </prodcutname> on the screen by use <function>pgpool_pgctl<function>. + It is enough, if these function installed in template1 fisrt. These + function do not needed that install in all databases. +--> +後述の オンラインリカバリ の機能を使う場合には、 pgpool_recovery, pgpool_remote_start, pgpool_switch_xlog という関数が必要です。 +また管理ツールである pgpoolAdmin の画面上から、バックエンドノードの PostgreSQL を停止・再起動・設定再読み込みを行なうことができますが、これには pgpool_pgctl という関数が使われます。 +これらの関数は、すべてのデータベースにインストールされている必要はなく、template1 にだけで 構いません。 + </para> + <para> <!-- This is required in all <productname>Pgpool-II</productname> @@ -373,7 +400,7 @@ make install --> これは全ての<productname>Pgpool-II</productname>のインストールで必要です。 <programlisting> -$ cd pgpool-II-x.x.x/src/sql/pgpool-recovery +$ cd pgpool-II-&version/src/sql/pgpool-recovery $ make $ make install </programlisting> @@ -461,7 +488,7 @@ $ pg_ctl reload -D /usr/local/pgsql/data <para> <programlisting> -$ cd pgpool-II-x.x.x/src/sql/pgpool-regclass +$ cd pgpool-II-&version/src/sql/pgpool-regclass $ make $ make install </programlisting> @@ -534,7 +561,7 @@ $ psql -f pgpool-regclass.sql template1 このテーブルに対するロックは、<command>VACUUM</command>と競合するため、<command>INSERT</command>処理が長時間待たされ続ける可能性があります。 <programlisting> - $ cd pgpool-II-x.x.x/src/sql + $ cd pgpool-II-&version/src/sql $ psql -f insert_lock.sql template1 </programlisting> @@ -554,96 +581,6 @@ $ psql -f pgpool-regclass.sql template1 </para> </sect1> - <sect1 id="setting-up-pgpool-conf"> -<!-- - <title>Setting up pgpool.conf</title> ---> - <title>pgpool.confの設定</title> - - <para> -<!-- - For each <productname>Pgpool-II</productname> operation mode, - there are sample configurations. ---> -各<productname>Pgpool-II</productname>の動作モードについて設定のサンプルがあります。 - - </para> - - <table id="pgpool-conf-samples-table"> -<!-- - <title>pgpool.conf samples</title> ---> - <title>pgpool.confのサンプル</title> - - <tgroup cols="2"> - <thead> - <row> -<!-- - <entry>Operation mode</entry> - <entry>Configuration file name</entry> ---> - <entry>動作モード</entry> - <entry>設定ファイル名</entry> - </row> - </thead> - - <tbody> - <row> -<!-- - <entry>Streaming replication mode</entry> ---> - <entry>ストリーミングレプリケーションモード</entry> - <entry><literal>pgpool.conf.sample-stream</literal></entry> - </row> - <row> -<!-- - <entry>Replication mode</entry> ---> - <entry>ネイティブレプリケーションモード</entry> - <entry><literal>pgpool.conf.sample-replication</literal></entry> - </row> - <row> -<!-- - <entry>Master slave mode</entry> ---> - <entry>マスタースレーブモード</entry> - <entry><literal>pgpool.conf.sample-master-slave</literal></entry> - </row> - <row> -<!-- - <entry>Raw mode</entry> ---> - <entry>Rawモード</entry> - <entry><literal>pgpool.conf.sample</literal> </entry> - </row> - <row> -<!-- - <entry>Logical replication mode</entry> ---> - <entry>ロジカルレプリケーションモード</entry> - <entry><literal>pgpool.conf.sample-logical</literal> </entry> - </row> - </tbody> - </tgroup> - </table> - - <para> -<!-- - These configuration files are located at /usr/local/etc with - default installation from source code. - You can copy one of them as <filename>pgpool.conf</filename>. - (probably you need root privilege for this) ---> -これらの設定ファイルはデフォルトのソースコードからのインストールでは/usr/local/etcに配置されています。 -これらを<filename>pgpool.conf</filename>としてコピーして使うことが可能です。 -(もしかするとそのためにはroot権限が必要かもしれません。) - <programlisting> -# cd /usr/local/etc -# cp pgpool.conf.sample-stream pgpool.conf - </programlisting> - </para> - </sect1> - <sect1 id="install-docs"> <!-- <title>Compiling and installing documents</title> diff --git a/doc.ja/src/sgml/runtime.sgml b/doc.ja/src/sgml/runtime.sgml index bcb86896f..83ccc1a56 100644 --- a/doc.ja/src/sgml/runtime.sgml +++ b/doc.ja/src/sgml/runtime.sgml @@ -167,11 +167,95 @@ password: <userinput>your_password</userinput> starting <productname>Pgpool-II</productname> using <option>-f</option> option. <filename>pgpool.conf</filename> is located - at <filename>$prefix/etc/pgpool.conf</filename> by default. + at <filename>$prefix/etc/pgpool.conf</filename> by default, + if it installed from source code. --> <filename>pgpool.conf</filename>は<productname>Pgpool-II</productname>のメインの設定ファイルです。 <productname>Pgpool-II</productname>の起動時には<option>-f</option>オプションでこのファイルのパスを指定する必要があります。 -デフォルトでは<filename>pgpool.conf</filename>は<filename>$prefix/etc/pgpool.conf</filename>に配置されます。 +ソースコードからインストールした場合、デフォルトでは<filename>pgpool.conf</filename>は<filename>$prefix/etc/pgpool.conf</filename>に配置されます。 + </para> + + <para> +<!-- + For each <productname>Pgpool-II</productname> operation mode, + there are sample configurations. +--> +各<productname>Pgpool-II</productname>の動作モードについて設定のサンプルがあります。 + + </para> + + <table id="pgpool-conf-samples-table"> +<!-- + <title>pgpool.conf samples</title> +--> + <title>pgpool.confのサンプル</title> + + <tgroup cols="2"> + <thead> + <row> +<!-- + <entry>Operation mode</entry> + <entry>Configuration file name</entry> +--> + <entry>動作モード</entry> + <entry>設定ファイル名</entry> + </row> + </thead> + + <tbody> + <row> +<!-- + <entry>Streaming replication mode</entry> +--> + <entry>ストリーミングレプリケーションモード</entry> + <entry><literal>pgpool.conf.sample-stream</literal></entry> + </row> + <row> +<!-- + <entry>Replication mode</entry> +--> + <entry>ネイティブレプリケーションモード</entry> + <entry><literal>pgpool.conf.sample-replication</literal></entry> + </row> + <row> +<!-- + <entry>Master slave mode</entry> +--> + <entry>マスタースレーブモード</entry> + <entry><literal>pgpool.conf.sample-master-slave</literal></entry> + </row> + <row> +<!-- + <entry>Raw mode</entry> +--> + <entry>Rawモード</entry> + <entry><literal>pgpool.conf.sample</literal> </entry> + </row> + <row> +<!-- + <entry>Logical replication mode</entry> +--> + <entry>ロジカルレプリケーションモード</entry> + <entry><literal>pgpool.conf.sample-logical</literal> </entry> + </row> + </tbody> + </tgroup> + </table> + + <para> +<!-- + These configuration files are located at /usr/local/etc with + default installation from source code. + You can copy one of them as <filename>pgpool.conf</filename>. + (probably you need root privilege for this) +--> +これらの設定ファイルはデフォルトのソースコードからのインストールでは/usr/local/etcに配置されています。 +これらを<filename>pgpool.conf</filename>としてコピーして使うことが可能です。 +(もしかするとそのためにはroot権限が必要かもしれません。) + <programlisting> +# cd /usr/local/etc +# cp pgpool.conf.sample-stream pgpool.conf + </programlisting> </para> </sect2> @@ -213,15 +297,10 @@ password: <userinput>your_password</userinput> There are four different running modes in <productname>Pgpool-II</>: streaming replication mode, master slave mode, native replication mode and raw mode. In any mode, <productname>Pgpool-II</> provides connection pooling, - automatic fail over and online recovery. The sample configuration - files for each mode are provied. They are located - under <filename>$prefix/etc</filename>. You can copy one of them - to <filename>$prefix/etc/pgpool.conf</filename>. + automatic fail over and online recovery. --> <productname>Pgpool-II</>にはストリーミングレプリケーションモード、ロジカルレプリケーションモード、マスタースレーブモード(slonyモード)、ネイティブレプリケーションモード、rawモードの5つの動作モードがあります。 いずれのモードにおいても、<productname>Pgpool-II</>はコネクションプーリング、自動フェイルオーバ、オンラインリカバリの機能を提供します。 -各モードのためのサンプルの設定ファイルが提供されています。 -これらは<filename>$prefix/etc/</filename>以下に配置されており、<filename>$prefix/etc/pgpool.conf</filename>としてコピーして使用することができます。 </para> <para> @@ -242,14 +321,12 @@ password: <userinput>your_password</userinput> operating streaming replication. In this mode, <productname>PostgreSQL</> is responsible for synchronizing databases. This mode is widely used and most recommended way to use <productname>Pgpool-II</>. Load balancing is - possible in the mode. The sample configuration file - is <filename>$prefix/etc/pgpool.conf.sample-stream</filename>. + possible in the mode. --> <firstterm>ストリーミングレプリケーションモード</firstterm>はストリーミングレプリケーションを使用する<productname>PostgreSQL</>サーバと一緒に使うことができます。 このモードでは、<productname>PostgreSQL</>がデータベースを同期する責任を持ちます。 このモードは広く使われており、最も推奨される<productname>Pgpool-II</>の使用法です。 このモードでは負荷分散が可能です。 -サンプルの設定ファイルは<filename>$prefix/etc/pgpool.conf.sample-stream</filename>です。 </para> <para> @@ -263,8 +340,7 @@ password: <userinput>your_password</userinput> could be load balanced. <productname>Pgpool-II</> load balaces all tables. This means that if a table is not replicated, <productname>Pgpool-II</> may lookup outdated tables - in the subscriber side. The sample configuration file - is <filename>$prefix/etc/pgpool.conf.sample-logical</filename>. + in the subscriber side. --> <firstterm>ロジカルレプリケーションモード</firstterm>はロジカルレプリケーションを使用する<productname>PostgreSQL</>サーバと一緒に使うことができます。 このモードでは、<productname>PostgreSQL</>がテーブルを同期する責任を持ちます。 @@ -272,7 +348,6 @@ password: <userinput>your_password</userinput> ロジカルレプリケーションは必ずしもすべてのテーブルをレプリケーションしないので、負荷分散させるテーブルがレプリケーションされるようにするのはユーザの責任です。 <productname>Pgpool-II</>はすべてのテーブルをロードバランスします。 このことは、テーブルがレプリケーションされていない場合には、<productname>Pgpool-II</>がサブスクライバー側の更新されていない古いテーブルを見てしまうかもしれないことを意味します。 -サンプルの設定ファイルは<filename>$prefix/etc/pgpool.conf.sample-logical</filename>です。 </para> <para> @@ -286,14 +361,12 @@ password: <userinput>your_password</userinput> streaming replication, we do not recommend to use this mode unless you have specific reason to use <productname>Slony</>. Load balancing is possible in the - mode. The sample configuration file - is <filename>$prefix/etc/pgpool.conf.sample-master-slave</filename>. + mode. --> <firstterm>マスタスレーブモード</firstterm>(slonyモード)は<productname>Slony-I</>を使用する<productname>PostgreSQL</>サーバと一緒に使うことができます。 このモードでは、<productname>Slony</>/<productname>PostgreSQL</>がデータベースを同期する責任を持ちます。 <productname>Slony</>はストリーミングレプリケーションの登場により廃れつつあるため、<productname>Slony</>を使う特別な理由が無い限りこのモードの使用を推奨しません。 このモードでは負荷分散が可能です。 -サンプルの設定ファイルは<filename>$prefix/etc/pgpool.conf.sample-master-slave</filename>です。 </para> <para> @@ -320,8 +393,7 @@ password: <userinput>your_password</userinput> mode with <literal>synchronous_commit = remote_apply</literal>. </para> <para> - Load balancing is possible in the mode. The sample configuration - file <filename>$prefix/etc/pgpool.conf.sample-replication</filename>. + Load balancing is possible in the mode. </para> <para> @@ -329,9 +401,7 @@ password: <userinput>your_password</userinput> mode</firstterm>, <productname>Pgpool-II</> does not care about the database synchronization. It's user's responsibility to make the whole system does a meaningfull thing. Load balancing - is <emphasis>not</emphasis> possible in the mode. The sample - configuration - file <filename>$prefix/etc/pgpool.conf.sample</filename>. + is <emphasis>not</emphasis> possible in the mode. --> <firstterm>ネイティブレプリケーションモード</firstterm>では、<productname>Pgpool-II</>がデータベースを同期する責任を持ちます。 このモードの利点は同期が同期的に行われることです。 @@ -345,7 +415,6 @@ password: <userinput>your_password</userinput> </para> <para> このモードでは負荷分散が可能です。 -サンプルの設定ファイルは<filename>$prefix/etc/pgpool.conf.sample-replication</filename>です。 </para> <para> @@ -353,15 +422,11 @@ password: <userinput>your_password</userinput> In the raw mode, <productname>Pgpool-II</> does not care about the database synchronization. It's user's responsibility to make the whole system does a meaningfull thing. Load balancing - is <emphasis>not</emphasis> possible in the mode. The sample - configuration - file <filename>$prefix/etc/pgpool.conf.sample</filename>. + is <emphasis>not</emphasis> possible in the mode. --> <firstterm>rawモード</firstterm>では、<productname>Pgpool-II</>はデータベースの同期に関しては関与しません。 システム全体に意味の有る動作をさせるのはユーザの責任となります。 このモードでは負荷分散は<emphasis>できません</emphasis>。 -サンプルの設定ファイルは<filename>$prefix/etc/pgpool.conf.sample</filename>です。 - </para> </sect2> </sect1> diff --git a/doc/src/sgml/advanced.sgml b/doc/src/sgml/advanced.sgml index c6d9618b2..199774d55 100644 --- a/doc/src/sgml/advanced.sgml +++ b/doc/src/sgml/advanced.sgml @@ -181,7 +181,7 @@ the watchdog for bringing up and bringing down the VIP require the root privileges. <productname>Pgpool-II</productname> requires the user running <productname>Pgpool-II</productname> to have root - privileges when the watchdog is enabled along with delegate IP. + privileges when the watchdog is enabled along with virtual IP. This is however not good security practice to run the <productname>Pgpool-II</productname> as root user, the alternative and preferred way is to run the <productname>Pgpool-II</productname> @@ -705,8 +705,8 @@ <para> Watchdog lifecheck is the sub-component of watchdog that monitors the health of <productname>Pgpool-II</productname> nodes participating in the watchdog - cluster. <productname>Pgpool-II</productname> watchdog provides two built-in - methods of remote node health checking, "heartbeat" and "query" mode. + cluster. <productname>Pgpool-II</productname> watchdog provides three built-in + methods of remote node health checking, "heartbeat", "query" and "external" mode. </para> <para> In "heartbeat" mode, The lifecheck process sends and receives the data over @@ -717,6 +717,9 @@ interface for querying the remote <productname>Pgpool-II</productname>. And in this mode the lifecheck process creates a new thread for each health check query which gets destroyed as soon as the query finishes. + While in "external" mode, this mode disables the built in lifecheck of + <productname>Pgpool-II</productname>, and expects that the external system + will monitor local and remote node instead. </para> <para> Apart from remote node health checking watchdog lifecheck can also check the diff --git a/doc/src/sgml/installation-rpm.sgml b/doc/src/sgml/installation-rpm.sgml index 763f5fa08..b46ff2444 100644 --- a/doc/src/sgml/installation-rpm.sgml +++ b/doc/src/sgml/installation-rpm.sgml @@ -20,15 +20,15 @@ <para> For RHEL and its derivatives do following once: <programlisting> -yum install http://www.pgpool.net/yum/rpms/3.6/redhat/rhel-7-x86_64/pgpool-II-release-3.6-1.noarch.rpm +yum install http://www.pgpool.net/yum/rpms/4.0/redhat/rhel-7-x86_64/pgpool-II-release-4.0-1.noarch.rpm </programlisting> Then: <programlisting> -yum install pgpool-II-pg96 +yum install pgpool-II-pg11 </programlisting> - <literal>pg96</literal> means <literal>PostgreSQL - 9.5</literal>. <productname>Pgpool-II</productname> + <literal>pg11</literal> means <literal>PostgreSQL + 11</literal>. <productname>Pgpool-II</productname> needs <productname>PostgreSQL</productname>'s library and extensions directory. Since the directory paths are different in the particular <productname>PostgreSQL</productname> versions, @@ -40,14 +40,14 @@ yum install pgpool-II-pg96 Optionally you can install: <programlisting> -yum install pgpool-II-pg96-debuginfo +yum install pgpool-II-pg11-debuginfo </programlisting> which makes it easier to retrieve debugging symbols from the core or the backtrace. We recommend to install it. There is an optional package for developers. <programlisting> -yum install pgpool-II-pg96-devel +yum install pgpool-II-pg11-devel </programlisting> This installs header files which developers are interested in </para> @@ -56,7 +56,7 @@ yum install pgpool-II-pg96-devel On all the <productname>PostgreSQL</productname> servers you need to install: <programlisting> -yum install pgpool-II-pg96-extensions +yum install pgpool-II-pg11-extensions </programlisting> </para> @@ -67,7 +67,7 @@ yum install pgpool-II-pg96-extensions <para> All the <productname>Pgpool-II</productname> configuration files live in <filename>/etc/pgpool-II</filename>. Please refer - to <xref linkend="setting-up-pgpool-conf"> to see how to set up + to <xref linkend="configuring-pgpool"> to see how to set up configuration files. </para> </sect2> @@ -76,21 +76,21 @@ yum install pgpool-II-pg96-extensions <title>Starting/stopping Pgpool-II</title> <para> On RHEL7/CentOS 7, do this once. - + Do this once, if set the automatic startup of <productname>Pgpool-II</productname>. <programlisting> systemctl enable pgpool.service </programlisting> - After this, restart the whole system or: + After this, restart the whole system or do this. Please note that + <productname>PostgreSQL</productname> servers must have been started + before this. <programlisting> systemctl start pgpool.service </programlisting> - Please note that <productname>PostgreSQL</productname> servers - must have been started before this. - - To stop <productname>Pgpool-II</productname>: + To stop <productname>Pgpool-II</productname>, do this once. + <productname>Pgpool-II</productname> must need to stop, before <productname>PostgreSQL</productname> is stopped. <programlisting> systemctl stop pgpool.service </programlisting> diff --git a/doc/src/sgml/installation-tips.sgml b/doc/src/sgml/installation-tips.sgml index 43d504ebc..e8d43f604 100644 --- a/doc/src/sgml/installation-tips.sgml +++ b/doc/src/sgml/installation-tips.sgml @@ -15,9 +15,20 @@ must be accessible by enabling firewall management softwares. </para> + <para> + First, allow to access port that <productname>Pgpool-II</productname> use. + + <programlisting> +firewall-cmd --permanent --zone=public --add-port=9999/tcp --add-port=9898/tcp --add-port=9000/tcp --add-port=9694/tcp +firewall-cmd --permanent --zone=public --add-port=9999/udp --add-port=9898/udp --add-port=9000/udp --add-port=9694/udp +firewall-cmd --reload + </programlisting> + </para> + <para> Here is an example for CentOS/RHEL7 when access to <productname>PostgreSQL</productname> is required. + <programlisting> firewall-cmd --permanent --zone=public --add-service=postgresql firewall-cmd --reload diff --git a/doc/src/sgml/installation.sgml b/doc/src/sgml/installation.sgml index ecf952abb..46f6ae4d6 100644 --- a/doc/src/sgml/installation.sgml +++ b/doc/src/sgml/installation.sgml @@ -64,6 +64,13 @@ </para> </listitem> + <listitem> + <para> + Several packages of <productname>PostgreSQL</productname> are required to + install <productname>Pgpool-II</productname>. You install postgresql-libs + and postgresql-devel packages from rpm. + </para> + </listitem> </itemizedlist> </para> @@ -255,11 +262,21 @@ make install <sect1 id="install-pgpool-recovery"> <title>Installing pgpool_recovery</title> + <para> + <productname>Pgpool-II</productname> need function of <function>pgpool_recovery</function>, + <function>pgpool_remote_start</function> and <function>pgpool_switch_xlog</function>, + when you use the online recovery that discribes latter. + Also pgpoolAdmin of management tool, stop, restart or reload a + <productname>PostgreSQL</productname> on the screen by use <function>pgpool_pgctl</function>. + It is enough, if these function installed in template1 fisrt. These + function do not needed that install in all databases. + </para> + <para> This is required in all <productname>Pgpool-II</productname> installation. <programlisting> -$ cd pgpool-II-x.x.x/src/sql/pgpool-recovery +$ cd pgpool-II-&version/src/sql/pgpool-recovery $ make $ make install </programlisting> @@ -319,7 +336,7 @@ $ pg_ctl reload -D /usr/local/pgsql/data <para> <programlisting> -$ cd pgpool-II-x.x.x/src/sql/pgpool-regclass +$ cd pgpool-II-&version/src/sql/pgpool-regclass $ make $ make install </programlisting> @@ -366,7 +383,7 @@ $ psql -f pgpool-regclass.sql template1 processing may be thereby kept waiting for a long time. <programlisting> - $ cd pgpool-II-x.x.x/src/sql + $ cd pgpool-II-&version/src/sql $ psql -f insert_lock.sql template1 </programlisting> @@ -382,62 +399,6 @@ $ psql -f pgpool-regclass.sql template1 </para> </sect1> - <sect1 id="setting-up-pgpool-conf"> - <title>Setting up pgpool.conf</title> - - <para> - For each <productname>Pgpool-II</productname> operation mode, - there are sample configurations. - </para> - - <table id="pgpool-conf-samples-table"> - <title>pgpool.conf samples</title> - - <tgroup cols="2"> - <thead> - <row> - <entry>Operation mode</entry> - <entry>Configuration file name</entry> - </row> - </thead> - - <tbody> - <row> - <entry>Streaming replication mode</entry> - <entry><literal>pgpool.conf.sample-stream</literal></entry> - </row> - <row> - <entry>Replication mode</entry> - <entry><literal>pgpool.conf.sample-replication</literal></entry> - </row> - <row> - <entry>Master slave mode</entry> - <entry><literal>pgpool.conf.sample-master-slave</literal></entry> - </row> - <row> - <entry>Raw mode</entry> - <entry><literal>pgpool.conf.sample</literal> </entry> - </row> - <row> - <entry>Logical replication mode</entry> - <entry><literal>pgpool.conf.sample-logical</literal> </entry> - </row> - </tbody> - </tgroup> - </table> - - <para> - These configuration files are located at /usr/local/etc with - default installation from source code. - You can copy one of them as <filename>pgpool.conf</filename>. - (probably you need root privilege for this) - <programlisting> -# cd /usr/local/etc -# cp pgpool.conf.sample-stream pgpool.conf - </programlisting> - </para> - </sect1> - <sect1 id="install-docs"> <title>Compiling and installing documents</title> diff --git a/doc/src/sgml/runtime.sgml b/doc/src/sgml/runtime.sgml index 4eca8e86d..c7cab3ce8 100644 --- a/doc/src/sgml/runtime.sgml +++ b/doc/src/sgml/runtime.sgml @@ -104,7 +104,58 @@ password: <userinput>your_password</userinput> starting <productname>Pgpool-II</productname> using <option>-f</option> option. <filename>pgpool.conf</filename> is located - at <filename>$prefix/etc/pgpool.conf</filename> by default. + at <filename>$prefix/etc/pgpool.conf</filename> by default, + if it installed from source code. + </para> + + <para> + For each <productname>Pgpool-II</productname> operation mode, + there are sample configurations. + </para> + + <table id="pgpool-conf-samples-table"> + <title>pgpool.conf samples</title> + + <tgroup cols="2"> + <thead> + <row> + <entry>Operation mode</entry> + <entry>Configuration file name</entry> + </row> + </thead> + + <tbody> + <row> + <entry>Streaming replication mode</entry> + </row> + <row> + <entry>Replication mode</entry> + <entry><literal>pgpool.conf.sample-replication</literal></entry> + </row> + <row> + <entry>Master slave mode</entry> + </row> + <row> + <entry>Raw mode</entry> + <entry><literal>pgpool.conf.sample</literal> </entry> + </row> + <row> + <entry>Logical replication mode</entry> + <entry><literal>pgpool.conf.sample-logical</literal> </entry> + </row> + </tbody> + </tgroup> + </table> + + <para> + These configuration files are located at /usr/local/etc with + default installation from source code. + You can copy one of them as <filename>pgpool.conf</filename>. + (probably you need root privilege for this) + <programlisting> +# cd /usr/local/etc +# cp pgpool.conf.sample-stream pgpool.conf + </programlisting> </para> </sect2> @@ -133,10 +184,7 @@ password: <userinput>your_password</userinput> logical replication mode, master slave mode (slony mode), native replication mode and raw mode. In any mode, <productname>Pgpool-II</> provides connection pooling, - automatic fail over and online recovery. The sample - configuration files for each mode are provied. They are located - under <filename>$prefix/etc</filename>. You can copy one of them - to <filename>$prefix/etc/pgpool.conf</filename>. + automatic fail over and online recovery. </para> <para> @@ -153,8 +201,7 @@ password: <userinput>your_password</userinput> responsible for synchronizing databases. This mode is widely used and most recommended way to use <productname>Pgpool-II</>. Load balancing is possible in the - mode. The sample configuration file - is <filename>$prefix/etc/pgpool.conf.sample-stream</filename>. + mode. </para> <para> @@ -167,8 +214,7 @@ password: <userinput>your_password</userinput> could be load balanced. <productname>Pgpool-II</> load balaces all tables. This means that if a table is not replicated, <productname>Pgpool-II</> may lookup outdated tables - in the subscriber side. The sample configuration file - is <filename>$prefix/etc/pgpool.conf.sample-logical</filename>. + in the subscriber side. </para> <para> @@ -181,8 +227,7 @@ password: <userinput>your_password</userinput> streaming replication, we do not recommend to use this mode unless you have specific reason to use <productname>Slony</>. Load balancing is possible in the - mode. The sample configuration file - is <filename>$prefix/etc/pgpool.conf.sample-master-slave</filename>. + mode. </para> <para> @@ -208,8 +253,7 @@ password: <userinput>your_password</userinput> mode with <literal>synchronous_commit = remote_apply</literal>. </para> <para> - Load balancing is possible in the mode. The sample configuration - file <filename>$prefix/etc/pgpool.conf.sample-replication</filename>. + Load balancing is possible in the mode. </para> <para> @@ -217,9 +261,7 @@ password: <userinput>your_password</userinput> mode</firstterm>, <productname>Pgpool-II</> does not care about the database synchronization. It's user's responsibility to make the whole system does a meaningfull thing. Load balancing - is <emphasis>not</emphasis> possible in the mode. The sample - configuration - file <filename>$prefix/etc/pgpool.conf.sample</filename>. + is <emphasis>not</emphasis> possible in the mode. </para> </sect2> </sect1> [parent: 5abb77f1eaa8]