ctdb/doc/ctdb.sysconfig.5.xml

   1 <?xml version="1.0" encoding="iso-8859-1"?>
   2 <!DOCTYPE refentry
   3         PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   4         "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
   5
   6 <refentry id="ctdb.sysconfig.5">
   7
   8   <refmeta>
   9     <refentrytitle>ctdb.sysconfig</refentrytitle>
  10     <manvolnum>5</manvolnum>
  11     <refmiscinfo class="source">ctdb</refmiscinfo>
  12     <refmiscinfo class="manual">CTDB - clustered TDB database</refmiscinfo>
  13   </refmeta>
  14
  15   <refnamediv>
  16     <refname>ctdb.sysconfig</refname>
  17     <refpurpose>CTDB daemon configuration file</refpurpose>
  18   </refnamediv>
  19
  20   <refsect1>
  21     <title>DESCRIPTION</title>
  22
  23     <para>
  24       This file contains configuration that affects the operation of
  25       CTDB.  This is a distribution-specific service configuration
  26       file such as <filename>/etc/sysconfig/ctdb</filename> (Red Hat)
  27       or <filename>/etc/default/ctdb</filename> (Debian) and is a
  28       shell script (see
  29       <citerefentry><refentrytitle>sh</refentrytitle>
  30       <manvolnum>1</manvolnum></citerefentry>).
  31     </para>
  32
  33   </refsect1>
  34
  35   <refsect1>
  36     <title>
  37       GLOBAL CONFIGURATION
  38     </title>
  39
  40     <variablelist>
  41
  42       <varlistentry>
  43         <term>CTDB_INIT_STYLE=debian|redhat|suse</term>
  44         <listitem>
  45           <para>
  46             This is the init style used by the Linux distribution (or
  47             other operating system) being used.  This is usually
  48             determined dynamically by checking the system.  This
  49             variable is used by the initscript to determine which init
  50             system primitives to use.  It is also used by some
  51             eventscripts to choose the name of initscripts for certain
  52             services, since these can vary between distributions.
  53           </para>
  54           <para>
  55             If using CTDB's event scripts are unable to determine an
  56             appropriate default then this option can also be placed in
  57             a relevant
  58             <citerefentry><refentrytitle>ctdb-script.options</refentrytitle>
  59             <manvolnum>5</manvolnum></citerefentry> file.
  60           </para>
  61           <para>
  62             Default: NONE.  Guessed, based on features of
  63             distribution.
  64           </para>
  65         </listitem>
  66       </varlistentry>
  67
  68       <varlistentry>
  69         <term>CTDB_STARTUP_TIMEOUT=<parameter>NUM</parameter></term>
  70         <listitem>
  71           <para>
  72             NUM is the number of seconds to wait for
  73             <citerefentry><refentrytitle>ctdbd</refentrytitle>
  74             <manvolnum>1</manvolnum></citerefentry> complete early
  75             initialisation up to a point where it is unlikely to
  76             abort.  If <command>ctdbd</command> doesn't complete the
  77             "setup" event before this timeout then it is killed.
  78           </para>
  79
  80           <para>
  81             Defaults: 10
  82           </para>
  83         </listitem>
  84       </varlistentry>
  85
  86     </variablelist>
  87   </refsect1>
  88
  89   <refsect1>
  90     <title>
  91       RESOURCE LIMITS
  92     </title>
  93
  94     <refsect2>
  95       <title>
  96         Maximum number of open files
  97       </title>
  98
  99       <para>
 100         CTDB can use a lot of file descriptors, especially when used
 101         with Samba.  If there are thousands of smbd processes
 102         connected to CTDB when this can mean that thousands of file
 103         descriptors are used.  For CTDB, it is often necessary to
 104         increase limit on the maximum number of open files.
 105       </para>
 106
 107       <para>
 108         The maximum number of open files should be configured using an
 109         operating system mechanism.
 110       </para>
 111
 112       <variablelist>
 113
 114         <varlistentry>
 115           <term>
 116             systemd
 117           </term>
 118           <listitem>
 119             <para>
 120               The
 121               <literal>LimitNOFILE=<option>LIMIT</option></literal>
 122               option can be used in a unit/service file increase the
 123               maximum number of open files.  See
 124               <citerefentry><refentrytitle>systemd.exec</refentrytitle>
 125               <manvolnum>5</manvolnum></citerefentry> for details.
 126             </para>
 127           </listitem>
 128         </varlistentry>
 129
 130         <varlistentry>
 131           <term>
 132             SYSV init
 133           </term>
 134           <listitem>
 135             <para>
 136               Use a command like <command>ulimit -n
 137               <option>LIMIT</option></command> to increase the maximum
 138               number of open files.  This command can be put in the
 139               relevant distribution-specific service configuration file.
 140             </para>
 141           </listitem>
 142         </varlistentry>
 143
 144       </variablelist>
 145
 146     </refsect2>
 147
 148     <refsect2>
 149       <title>
 150         Allowing core dumps
 151       </title>
 152
 153       <para>
 154         Many distributions do not allow core dump files to be
 155         generated by default.  To assist with debugging, core files
 156         can be enabled.  This should be configured using an operating
 157         system mechanism.
 158       </para>
 159
 160       <variablelist>
 161
 162         <varlistentry>
 163           <term>
 164             systemd
 165           </term>
 166           <listitem>
 167             <para>
 168               The <literal>LimitCORE=0|unlimited</literal> option can
 169               be used in a unit/service file.  <literal>0</literal>
 170               disallows core files, <literal>unlimited</literal>
 171               allows them.  maximum number of open files.  See
 172               <citerefentry><refentrytitle>systemd.exec</refentrytitle>
 173               <manvolnum>5</manvolnum></citerefentry> for details.
 174             </para>
 175           </listitem>
 176         </varlistentry>
 177
 178         <varlistentry>
 179           <term>
 180             SYSV init
 181           </term>
 182           <listitem>
 183             <para>
 184               Use a command like <command>ulimit -c 0|unlimited</command>
 185               to disable or enable core files as required.  This
 186               command can be put in the relevant distribution-specific
 187               service configuration file.
 188             </para>
 189           </listitem>
 190         </varlistentry>
 191
 192       </variablelist>
 193
 194     </refsect2>
 195
 196   </refsect1>
 197
 198   <refsect1>
 199     <title>FILES</title>
 200
 201     <simplelist>
 202       <member><filename>/etc/sysconfig/ctdb</filename></member>
 203       <member><filename>/etc/default/ctdb</filename></member>
 204       <member><filename>/usr/local/etc/ctdb/script.options</filename></member>
 205     </simplelist>
 206   </refsect1>
 207
 208   <refsect1>
 209     <title>SEE ALSO</title>
 210     <para>
 211       <citerefentry><refentrytitle>ctdbd</refentrytitle>
 212       <manvolnum>1</manvolnum></citerefentry>,
 213
 214       <citerefentry><refentrytitle>ctdb-script.options</refentrytitle>
 215       <manvolnum>5</manvolnum></citerefentry>,
 216
 217       <citerefentry><refentrytitle>ctdb</refentrytitle>
 218       <manvolnum>7</manvolnum></citerefentry>,
 219
 220       <ulink url="http://ctdb.samba.org/"/>
 221     </para>
 222   </refsect1>
 223
 224   <refentryinfo>
 225     <author>
 226       <contrib>
 227         This documentation was written by
 228         Martin Schwenke
 229       </contrib>
 230     </author>
 231
 232     <copyright>
 233       <year>2007</year>
 234       <holder>Andrew Tridgell</holder>
 235       <holder>Ronnie Sahlberg</holder>
 236     </copyright>
 237     <legalnotice>
 238       <para>
 239         This program is free software; you can redistribute it and/or
 240         modify it under the terms of the GNU General Public License as
 241         published by the Free Software Foundation; either version 3 of
 242         the License, or (at your option) any later version.
 243       </para>
 244       <para>
 245         This program is distributed in the hope that it will be
 246         useful, but WITHOUT ANY WARRANTY; without even the implied
 247         warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
 248         PURPOSE.  See the GNU General Public License for more details.
 249       </para>
 250       <para>
 251         You should have received a copy of the GNU General Public
 252         License along with this program; if not, see
 253         <ulink url="http://www.gnu.org/licenses"/>.
 254       </para>
 255     </legalnotice>
 256   </refentryinfo>
 257
 258 </refentry>