From: Tatsuo Ishii <ishii@postgresql.org>
Date: Sun, 8 Jun 2025 06:32:00 +0000 (+0900)
Subject: Doc: add section of kernel resources.
X-Git-Url: http://git.postgresql.org/gitweb/?a=commitdiff_plain;h=a691bcf4dc12a05937310b85abc8b471c4671e8c;p=pgpool2.git

Doc: add section of kernel resources.

Pgpool-II uses System V shared memory and semaphores. It's better to
describe the requirements in the docs.

Backpatch-through: v4.2
---

diff --git a/doc.ja/src/sgml/runtime.sgml b/doc.ja/src/sgml/runtime.sgml
index 0f40994e1..7bc450b4e 100644
--- a/doc.ja/src/sgml/runtime.sgml
+++ b/doc.ja/src/sgml/runtime.sgml
@@ -14,6 +14,31 @@
   本章では、<productname>Pgpool-II</>サーバの設定と実行方法、そしてオペレーティングシステムとの相互作用について説明します。 
  </para>
 
+ <sect1 id="kernel-resource">
+  <title>カーネルリソースの管理</title>
+
+  <indexterm>
+   <primary>カーネルリソース</primary>
+  </indexterm>
+
+  <para>
+   <productname>Pgpool-II</productname>を動かすためには、System V共有メモリとSystem Vセマフォが必要です。
+   どちらもLinuxでは十分な量が提供されますが、他のプラットフォームではカーネルパラメータの調整が必要かも知れません。
+  </para>
+  <para>
+   System V共有メモリは、最低でも約140MB必要です。
+   デフォルトの64MBより多い<link linkend="runtime-in-memory-query-cache">クエリキャッシュ</link>を使用する場合は、更に追加が必要になるかもしません。
+   共有メモリの必要セグメント数は3です。
+   通常カーネルは十分な共有メモリセグメント数があるはずです。
+  </para>
+  
+  <para>
+   System Vセマフォは、約10個ほど使用します。
+   必要セット数は1です。
+   通常カーネルには十分なSystem Vセマフォ数があるはずです。
+  </para>
+ </sect1>
+
  <sect1 id="pgpool-II-user">
   <!--
   <title>The <productname>Pgpool-II</productname> User Account</title>
diff --git a/doc/src/sgml/runtime.sgml b/doc/src/sgml/runtime.sgml
index e923ce382..0fe7ecabc 100644
--- a/doc/src/sgml/runtime.sgml
+++ b/doc/src/sgml/runtime.sgml
@@ -8,6 +8,35 @@
   and its interactions with the operating system.
  </para>
 
+ <sect1 id="kernel-resource">
+  <title>Managing kernel resouces</title>
+
+  <indexterm>
+   <primary>kernel resouces</primary>
+  </indexterm>
+
+  <para>
+   To run <productname>Pgpool-II</productname> System V shared memory
+   and System V semaphore are necessary. Although on linux enough
+   amount of both resources are provided, other platforms may need to
+   configure the kernel parameters.
+  </para>
+  <para>
+   The minimum requirement of System V shared memory is around 140 MB.
+   If you plan to use more than default 64MB
+   of <link linkend="runtime-in-memory-query-cache">query
+   cache</link>, you may need more shared memory.  Number of necessary
+   shared memory segments is 3.  Usually the kernel provides enough
+   shared memory segments.
+  </para>
+  
+  <para>
+   The minimum requirement of System V semaphore is around 10.  Number
+   of necessary semaphore sets is 3.  Usually the kernel provides
+   enough semaphore sets.
+  </para>
+ </sect1>
+
  <sect1 id="pgpool-II-user">
   <title>The <productname>Pgpool-II</productname> User Account</title>