Mention the need for enough file descriptors in the release notes chapter o...

Mark Craig

12.19.2012 50ee0b45af74b828b6e79ec987c0cd363b2b908b

Mention the need for enough file descriptors in the release notes chapter on overall prerequisites, rather than the CLI install procedure. The default settings on recent CentOS and Ubuntu systems seem to be 1024/user, which is not enough for OpenDJ in production.

It makes sense to call attention to this as an overall requirement because the admin needs root or sudoer access to edit /etc/security/limits.conf, and the rest of the CLI install can be done by a normal user. Also, if for some reason production installs are done with the GUI, then the information could be missed if only in the CLI install procedure.

 opendj3/src/main/docbkx/install-guide/chap-install-cli.xml

@@ -81,20 +81,6 @@
   </variablelist>
  </step>

  <step xml:id="enough-file-descriptors">
   <indexterm><primary>File descriptor requirements</primary></indexterm>
   
   <para>Allow OpenDJ software to use at least 64K (65536) file descriptors
   to operate properly.</para>

   <para>How you set the maximum number of file descriptors per process
   depends on your system. Read your system documentation for
   instructions.</para>

   <para>Typically you use the <command>ulimit -a</command> command to list
   current settings.</para>
  </step>

  <step xml:id="app-server-needed-for-dsml">
   <indexterm><primary>DSML gateway</primary></indexterm>
   

 opendj3/src/main/docbkx/release-notes/chap-before-you-install.xml

@@ -60,6 +60,34 @@
  corresponding Java SDK.</para>
 </section>

 <section xml:id="prerequisites-file-descriptors">
  <title>Maximum Open Files</title>
  <indexterm>
   <primary>File descriptors</primary>
   <secondary>Requirements</secondary>
  </indexterm>

  <para>OpenDJ needs to be able to open many files, especially when handling
  many client connections. Linux systems in particular often set a limit of
  1024 per user, which is too low for OpenDJ.</para>

  <para>When setting up OpenDJ for production use, make sure OpenDJ can use
  at least use at least 64K (65536) file descriptors. For example when running
  OpenDJ as user <literal>opendj</literal> on a Linux system that uses
  <filename>/etc/security/limits.conf</filename> to set user level limits,
  you can set soft and hard limits by adding these lines to the file.</para>

  <programlisting language="none">opendj soft nofile 65536
opendj hard nofile 131072</programlisting>

  <para>The example above assumes the system has enough file descriptors
  available overall. You can check the Linux system overall maximum as
  follows.</para>

  <screen>$ cat /proc/sys/fs/file-max
204252</screen>
 </section>

 <section xml:id="prerequisites-operating-systems">
  <title>Operating System</title>
  <indexterm>