Adding upstream version 2:4.17.12+dfsg.upstream/2%4.17.12+dfsgupstream

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

1 files changed, 240 insertions, 0 deletions

diff --git a/ctdb/doc/ctdb.sysconfig.5.xml b/ctdb/doc/ctdb.sysconfig.5.xml
new file mode 100644
index 0000000..2618934
--- /dev/null
+++ b/ctdb/doc/ctdb.sysconfig.5.xml
@@ -0,0 +1,240 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE refentry
+	PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
+	"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
+
+<refentry id="ctdb.sysconfig.5">
+
+  <refmeta>
+    <refentrytitle>ctdb.sysconfig</refentrytitle>
+    <manvolnum>5</manvolnum>
+    <refmiscinfo class="source">ctdb</refmiscinfo>
+    <refmiscinfo class="manual">CTDB - clustered TDB database</refmiscinfo>
+  </refmeta>
+
+  <refnamediv>
+    <refname>ctdb.sysconfig</refname>
+    <refpurpose>CTDB daemon configuration file</refpurpose>
+  </refnamediv>
+
+  <refsect1>
+    <title>DESCRIPTION</title>
+
+    <para>
+      This file contains configuration that affects the operation of
+      CTDB.  This is a distribution-specific service configuration
+      file such as <filename>/etc/sysconfig/ctdb</filename> (Red Hat)
+      or <filename>/etc/default/ctdb</filename> (Debian) and is a
+      shell script (see
+      <citerefentry><refentrytitle>sh</refentrytitle>
+      <manvolnum>1</manvolnum></citerefentry>).
+    </para>
+
+  </refsect1>
+
+  <refsect1>
+    <title>
+      GLOBAL CONFIGURATION
+    </title>
+
+    <variablelist>
+
+      <varlistentry>
+	<term>CTDB_INIT_STYLE=debian|redhat|suse</term>
+	<listitem>
+	  <para>
+	    This is the init style used by the Linux distribution (or
+	    other operating system) being used.  This is usually
+	    determined dynamically by checking the system.  This
+	    variable is used by the initscript to determine which init
+	    system primitives to use.  It is also used by some
+	    eventscripts to choose the name of initscripts for certain
+	    services, since these can vary between distributions.
+	  </para>
+	  <para>
+	    If using CTDB's event scripts are unable to determine an
+	    appropriate default then this option can also be placed in
+	    a relevant
+	    <citerefentry><refentrytitle>ctdb-script.options</refentrytitle>
+	    <manvolnum>5</manvolnum></citerefentry> file.
+	  </para>
+	  <para>
+	    Default: NONE.  Guessed, based on features of
+	    distribution.
+	  </para>
+	</listitem>
+      </varlistentry>
+
+    </variablelist>
+  </refsect1>
+
+  <refsect1>
+    <title>
+      RESOURCE LIMITS
+    </title>
+
+    <refsect2>
+      <title>
+	Maximum number of open files
+      </title>
+
+      <para>
+	CTDB can use a lot of file descriptors, especially when used
+	with Samba.  If there are thousands of smbd processes
+	connected to CTDB when this can mean that thousands of file
+	descriptors are used.  For CTDB, it is often necessary to
+	increase limit on the maximum number of open files.
+      </para>
+
+      <para>
+	The maximum number of open files should be configured using an
+	operating system mechanism.
+      </para>
+
+      <variablelist>
+
+	<varlistentry>
+	  <term>
+	    systemd
+	  </term>
+	  <listitem>
+	    <para>
+	      The
+	      <literal>LimitNOFILE=<option>LIMIT</option></literal>
+	      option can be used in a unit/service file increase the
+	      maximum number of open files.  See
+	      <citerefentry><refentrytitle>systemd.exec</refentrytitle>
+	      <manvolnum>5</manvolnum></citerefentry> for details.
+	    </para>
+	  </listitem>
+	</varlistentry>
+
+	<varlistentry>
+	  <term>
+	    SYSV init
+	  </term>
+	  <listitem>
+	    <para>
+	      Use a command like <command>ulimit -n
+	      <option>LIMIT</option></command> to increase the maximum
+	      number of open files.  This command can be put in the
+	      relevant distribution-specific service configuration file.
+	    </para>
+	  </listitem>
+	</varlistentry>
+
+      </variablelist>
+
+    </refsect2>
+
+    <refsect2>
+      <title>
+	Allowing core dumps
+      </title>
+
+      <para>
+	Many distributions do not allow core dump files to be
+	generated by default.  To assist with debugging, core files
+	can be enabled.  This should be configured using an operating
+	system mechanism.
+      </para>
+
+      <variablelist>
+
+	<varlistentry>
+	  <term>
+	    systemd
+	  </term>
+	  <listitem>
+	    <para>
+	      The <literal>LimitCORE=0|unlimited</literal> option can
+	      be used in a unit/service file.  <literal>0</literal>
+	      disallows core files, <literal>unlimited</literal>
+	      allows them.  maximum number of open files.  See
+	      <citerefentry><refentrytitle>systemd.exec</refentrytitle>
+	      <manvolnum>5</manvolnum></citerefentry> for details.
+	    </para>
+	  </listitem>
+	</varlistentry>
+
+	<varlistentry>
+	  <term>
+	    SYSV init
+	  </term>
+	  <listitem>
+	    <para>
+	      Use a command like <command>ulimit -c 0|unlimited</command>
+	      to disable or enable core files as required.  This
+	      command can be put in the relevant distribution-specific
+	      service configuration file.
+	    </para>
+	  </listitem>
+	</varlistentry>
+
+      </variablelist>
+
+    </refsect2>
+
+  </refsect1>
+
+  <refsect1>
+    <title>FILES</title>
+
+    <simplelist>
+      <member><filename>/etc/sysconfig/ctdb</filename></member>
+      <member><filename>/etc/default/ctdb</filename></member>
+      <member><filename>/usr/local/etc/ctdb/script.options</filename></member>
+    </simplelist>
+  </refsect1>
+
+  <refsect1>
+    <title>SEE ALSO</title>
+    <para>
+      <citerefentry><refentrytitle>ctdbd</refentrytitle>
+      <manvolnum>1</manvolnum></citerefentry>,
+
+      <citerefentry><refentrytitle>ctdb-script.options</refentrytitle>
+      <manvolnum>5</manvolnum></citerefentry>,
+
+      <citerefentry><refentrytitle>ctdb</refentrytitle>
+      <manvolnum>7</manvolnum></citerefentry>,
+
+      <ulink url="http://ctdb.samba.org/"/>
+    </para>
+  </refsect1>
+
+  <refentryinfo>
+    <author>
+      <contrib>
+	This documentation was written by
+	Martin Schwenke
+      </contrib>
+    </author>
+
+    <copyright>
+      <year>2007</year>
+      <holder>Andrew Tridgell</holder>
+      <holder>Ronnie Sahlberg</holder>
+    </copyright>
+    <legalnotice>
+      <para>
+	This program is free software; you can redistribute it and/or
+	modify it under the terms of the GNU General Public License as
+	published by the Free Software Foundation; either version 3 of
+	the License, or (at your option) any later version.
+      </para>
+      <para>
+	This program is distributed in the hope that it will be
+	useful, but WITHOUT ANY WARRANTY; without even the implied
+	warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
+	PURPOSE.  See the GNU General Public License for more details.
+      </para>
+      <para>
+	You should have received a copy of the GNU General Public
+	License along with this program; if not, see
+	<ulink url="http://www.gnu.org/licenses"/>.
+      </para>
+    </legalnotice>
+  </refentryinfo>
+
+</refentry>