ctdb/doc/ctdb.sysconfig.5.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   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     </variablelist>
  69   </refsect1>
  70
  71   <refsect1>
  72     <title>
  73       RESOURCE LIMITS
  74     </title>
  75
  76     <refsect2>
  77       <title>
  78         Maximum number of open files
  79       </title>
  80
  81       <para>
  82         CTDB can use a lot of file descriptors, especially when used
  83         with Samba.  If there are thousands of smbd processes
  84         connected to CTDB when this can mean that thousands of file
  85         descriptors are used.  For CTDB, it is often necessary to
  86         increase limit on the maximum number of open files.
  87       </para>
  88
  89       <para>
  90         The maximum number of open files should be configured using an
  91         operating system mechanism.
  92       </para>
  93
  94       <variablelist>
  95
  96         <varlistentry>
  97           <term>
  98             systemd
  99           </term>
 100           <listitem>
 101             <para>
 102               The
 103               <literal>LimitNOFILE=<option>LIMIT</option></literal>
 104               option can be used in a unit/service file increase the
 105               maximum number of open files.  See
 106               <citerefentry><refentrytitle>systemd.exec</refentrytitle>
 107               <manvolnum>5</manvolnum></citerefentry> for details.
 108             </para>
 109           </listitem>
 110         </varlistentry>
 111
 112         <varlistentry>
 113           <term>
 114             SYSV init
 115           </term>
 116           <listitem>
 117             <para>
 118               Use a command like <command>ulimit -n
 119               <option>LIMIT</option></command> to increase the maximum
 120               number of open files.  This command can be put in the
 121               relevant distribution-specific service configuration file.
 122             </para>
 123           </listitem>
 124         </varlistentry>
 125
 126       </variablelist>
 127
 128     </refsect2>
 129
 130     <refsect2>
 131       <title>
 132         Allowing core dumps
 133       </title>
 134
 135       <para>
 136         Many distributions do not allow core dump files to be
 137         generated by default.  To assist with debugging, core files
 138         can be enabled.  This should be configured using an operating
 139         system mechanism.
 140       </para>
 141
 142       <variablelist>
 143
 144         <varlistentry>
 145           <term>
 146             systemd
 147           </term>
 148           <listitem>
 149             <para>
 150               The <literal>LimitCORE=0|unlimited</literal> option can
 151               be used in a unit/service file.  <literal>0</literal>
 152               disallows core files, <literal>unlimited</literal>
 153               allows them.  maximum number of open files.  See
 154               <citerefentry><refentrytitle>systemd.exec</refentrytitle>
 155               <manvolnum>5</manvolnum></citerefentry> for details.
 156             </para>
 157           </listitem>
 158         </varlistentry>
 159
 160         <varlistentry>
 161           <term>
 162             SYSV init
 163           </term>
 164           <listitem>
 165             <para>
 166               Use a command like <command>ulimit -c 0|unlimited</command>
 167               to disable or enable core files as required.  This
 168               command can be put in the relevant distribution-specific
 169               service configuration file.
 170             </para>
 171           </listitem>
 172         </varlistentry>
 173
 174       </variablelist>
 175
 176     </refsect2>
 177
 178   </refsect1>
 179
 180   <refsect1>
 181     <title>FILES</title>
 182
 183     <simplelist>
 184       <member><filename>/etc/sysconfig/ctdb</filename></member>
 185       <member><filename>/etc/default/ctdb</filename></member>
 186       <member><filename>/usr/local/etc/ctdb/script.options</filename></member>
 187     </simplelist>
 188   </refsect1>
 189
 190   <refsect1>
 191     <title>SEE ALSO</title>
 192     <para>
 193       <citerefentry><refentrytitle>ctdbd</refentrytitle>
 194       <manvolnum>1</manvolnum></citerefentry>,
 195
 196       <citerefentry><refentrytitle>ctdb-script.options</refentrytitle>
 197       <manvolnum>5</manvolnum></citerefentry>,
 198
 199       <citerefentry><refentrytitle>ctdb</refentrytitle>
 200       <manvolnum>7</manvolnum></citerefentry>,
 201
 202       <ulink url="http://ctdb.samba.org/"/>
 203     </para>
 204   </refsect1>
 205
 206   <refentryinfo>
 207     <author>
 208       <contrib>
 209         This documentation was written by
 210         Martin Schwenke
 211       </contrib>
 212     </author>
 213
 214     <copyright>
 215       <year>2007</year>
 216       <holder>Andrew Tridgell</holder>
 217       <holder>Ronnie Sahlberg</holder>
 218     </copyright>
 219     <legalnotice>
 220       <para>
 221         This program is free software; you can redistribute it and/or
 222         modify it under the terms of the GNU General Public License as
 223         published by the Free Software Foundation; either version 3 of
 224         the License, or (at your option) any later version.
 225       </para>
 226       <para>
 227         This program is distributed in the hope that it will be
 228         useful, but WITHOUT ANY WARRANTY; without even the implied
 229         warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
 230         PURPOSE.  See the GNU General Public License for more details.
 231       </para>
 232       <para>
 233         You should have received a copy of the GNU General Public
 234         License along with this program; if not, see
 235         <ulink url="http://www.gnu.org/licenses"/>.
 236       </para>
 237     </legalnotice>
 238   </refentryinfo>
 239
 240 </refentry>