Doc: add section of kernel resources.
authorTatsuo Ishii <ishii@postgresql.org>
Sun, 8 Jun 2025 06:32:00 +0000 (15:32 +0900)
committerTatsuo Ishii <ishii@postgresql.org>
Sun, 8 Jun 2025 06:32:00 +0000 (15:32 +0900)
Pgpool-II uses System V shared memory and semaphores. It's better to
describe the requirements in the docs.

Backpatch-through: v4.2

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

index 0f40994e15361c52b7fb9c502953e296a168c9f2..7bc450b4e9ddb8278f19329bd669536ea0eb082f 100644 (file)
   ๆœฌ็ซ ใงใฏใ€<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>
index e923ce3828d126949c57d294d7c924c85d0ce2cb..0fe7ecabc283f1e968f0a5eb55d564411438e741 100644 (file)
@@ -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>