idmap_ad: Fix retrieving credentials from clustered secrets.tdb
[Samba.git] / ctdb / doc / ctdb-tunables.7.xml
blob088e8227620ac48f4a1d8fce1224499e85e1b613
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">
6 <refentry id="ctdb-tunables.7">
8   <refmeta>
9     <refentrytitle>ctdb-tunables</refentrytitle>
10     <manvolnum>7</manvolnum>
11     <refmiscinfo class="source">ctdb</refmiscinfo>
12     <refmiscinfo class="manual">CTDB - clustered TDB database</refmiscinfo>
13   </refmeta>
15   <refnamediv>
16     <refname>ctdb-tunables</refname>
17     <refpurpose>CTDB tunable configuration variables</refpurpose>
18   </refnamediv>
20   <refsect1>
21     <title>DESCRIPTION</title>
23     <para>
24       CTDB's behaviour can be configured by setting run-time tunable
25       variables.  This lists and describes all tunables.  See the
26       <citerefentry><refentrytitle>ctdb</refentrytitle>
27       <manvolnum>1</manvolnum></citerefentry>
28       <command>listvars</command>, <command>setvar</command> and
29       <command>getvar</command> commands for more details.
30     </para>
32     <para>
33       The tunable variables are listed alphabetically.
34     </para>
36     <refsect2>
37       <title>AllowClientDBAttach</title>
38       <para>Default: 1</para>
39       <para>
40         When set to 0, clients are not allowed to attach to any databases.
41         This can be used to temporarily block any new processes from
42         attaching to and accessing the databases.  This is mainly used
43         for detaching a volatile database using 'ctdb detach'.
44       </para>
45     </refsect2>
47     <refsect2>
48       <title>AllowUnhealthyDBRead</title>
49       <para>Default: 0</para>
50       <para>
51         When set to 1, ctdb allows database traverses to read unhealthy
52         databases.  By default, ctdb does not allow reading records from
53         unhealthy databases.
54       </para>
55     </refsect2>
57     <refsect2>
58       <title>ControlTimeout</title>
59       <para>Default: 60</para>
60       <para>
61         This is the default setting for timeout for when sending a
62         control message to either the local or a remote ctdb daemon.
63       </para>
64     </refsect2>
66     <refsect2>
67       <title>DatabaseHashSize</title>
68       <para>Default: 100001</para>
69       <para>
70         Number of the hash chains for the local store of the tdbs that
71         ctdb manages.
72       </para>
73     </refsect2>
75     <refsect2>
76       <title>DatabaseMaxDead</title>
77       <para>Default: 5</para>
78       <para>
79         Maximum number of dead records per hash chain for the tdb databses
80         managed by ctdb.
81       </para>
82     </refsect2>
84     <refsect2>
85       <title>DBRecordCountWarn</title>
86       <para>Default: 100000</para>
87       <para>
88         When set to non-zero, ctdb will log a warning during recovery if
89         a database has more than this many records. This will produce a
90         warning if a database grows uncontrollably with orphaned records.
91       </para>
92     </refsect2>
94     <refsect2>
95       <title>DBRecordSizeWarn</title>
96       <para>Default: 10000000</para>
97       <para>
98         When set to non-zero, ctdb will log a warning during recovery
99         if a single record is bigger than this size. This will produce
100         a warning if a database record grows uncontrollably.
101       </para>
102     </refsect2>
104     <refsect2>
105       <title>DBSizeWarn</title>
106       <para>Default: 1000000000</para>
107       <para>
108         When set to non-zero, ctdb will log a warning during recovery if
109         a database size is bigger than this. This will produce a warning
110         if a database grows uncontrollably.
111       </para>
112     </refsect2>
114     <refsect2>
115       <title>DeferredAttachTO</title>
116       <para>Default: 120</para>
117       <para>
118         When databases are frozen we do not allow clients to attach to
119         the databases. Instead of returning an error immediately to the
120         client, the attach request from the client is deferred until
121         the database becomes available again at which stage we respond
122         to the client.
123       </para>
124       <para>
125         This timeout controls how long we will defer the request from the
126         client before timing it out and returning an error to the client.
127       </para>
128     </refsect2>
130     <refsect2>
131       <title>DeterministicIPs</title>
132       <para>Default: 0</para>
133       <para>
134         When set to 1, ctdb will try to keep public IP addresses locked
135         to specific nodes as far as possible. This makes it easier
136         for debugging since you can know that as long as all nodes are
137         healthy public IP X will always be hosted by node Y.
138       </para>
139       <para>
140         The cost of using deterministic IP address assignment is that it
141         disables part of the logic where ctdb tries to reduce the number
142         of public IP assignment changes in the cluster. This tunable may
143         increase the number of IP failover/failbacks that are performed
144         on the cluster by a small margin.
145       </para>
146     </refsect2>
148     <refsect2>
149       <title>DisableIPFailover</title>
150       <para>Default: 0</para>
151       <para>
152         When set to non-zero, ctdb will not perform failover or
153         failback. Even if a node fails while holding public IPs, ctdb
154         will not recover the IPs or assign them to another node.
155       </para>
156       <para>
157         When this tunable is enabled, ctdb will no longer attempt
158         to recover the cluster by failing IP addresses over to other
159         nodes. This leads to a service outage until the administrator
160         has manually performed IP failover to replacement nodes using the
161         'ctdb moveip' command.
162       </para>
163     </refsect2>
165     <refsect2>
166       <title>ElectionTimeout</title>
167       <para>Default: 3</para>
168       <para>
169         The number of seconds to wait for the election of recovery
170         master to complete. If the election is not completed during this
171         interval, then that round of election fails and ctdb starts a
172         new election.
173       </para>
174     </refsect2>
176     <refsect2>
177       <title>EnableBans</title>
178       <para>Default: 1</para>
179       <para>
180         This parameter allows ctdb to ban a node if the node is misbehaving.
181       </para>
182       <para>
183         When set to 0, this disables banning completely in the cluster
184         and thus nodes can not get banned, even it they break. Don't
185         set to 0 unless you know what you are doing.  You should set
186         this to the same value on all nodes to avoid unexpected behaviour.
187       </para>
188     </refsect2>
190     <refsect2>
191       <title>EventScriptTimeout</title>
192       <para>Default: 30</para>
193       <para>
194         Maximum time in seconds to allow an event to run before timing
195         out.  This is the total time for all enabled scripts that are
196         run for an event, not just a single event script.
197       </para>
198       <para>
199         Note that timeouts are ignored for some events ("takeip",
200         "releaseip", "startrecovery", "recovered") and converted to
201         success.  The logic here is that the callers of these events
202         implement their own additional timeout.
203       </para>
204     </refsect2>
206     <refsect2>
207       <title>FetchCollapse</title>
208       <para>Default: 1</para>
209       <para>
210        This parameter is used to avoid multiple migration requests for
211        the same record from a single node. All the record requests for
212        the same record are queued up and processed when the record is
213        migrated to the current node.
214       </para>
215       <para>
216         When many clients across many nodes try to access the same record
217         at the same time this can lead to a fetch storm where the record
218         becomes very active and bounces between nodes very fast. This
219         leads to high CPU utilization of the ctdbd daemon, trying to
220         bounce that record around very fast, and poor performance.
221         This can improve performance and reduce CPU utilization for
222         certain workloads.
223       </para>
224     </refsect2>
226     <refsect2>
227       <title>HopcountMakeSticky</title>
228       <para>Default: 50</para>
229       <para>
230         For database(s) marked STICKY (using 'ctdb setdbsticky'),
231         any record that is migrating so fast that hopcount
232         exceeds this limit is marked as STICKY record for
233         <varname>StickyDuration</varname> seconds. This means that
234         after each migration the sticky record will be kept on the node
235         <varname>StickyPindown</varname>milliseconds and prevented from
236         being migrated off the node.
237        </para>
238        <para>
239         This will improve performance for certain workloads, such as
240         locking.tdb if many clients are opening/closing the same file
241         concurrently.
242       </para>
243     </refsect2>
245     <refsect2>
246       <title>KeepaliveInterval</title>
247       <para>Default: 5</para>
248       <para>
249         How often in seconds should the nodes send keep-alive packets to
250         each other.
251       </para>
252     </refsect2>
254     <refsect2>
255       <title>KeepaliveLimit</title>
256       <para>Default: 5</para>
257       <para>
258         After how many keepalive intervals without any traffic should
259         a node wait until marking the peer as DISCONNECTED.
260        </para>
261        <para>
262         If a node has hung, it can take
263         <varname>KeepaliveInterval</varname> *
264         (<varname>KeepaliveLimit</varname> + 1) seconds before
265         ctdb determines that the node is DISCONNECTED and performs
266         a recovery. This limit should not be set too high to enable
267         early detection and avoid any application timeouts (e.g. SMB1)
268         to kick in before the fail over is completed.
269       </para>
270     </refsect2>
272     <refsect2>
273       <title>LCP2PublicIPs</title>
274       <para>Default: 1</para>
275       <para>
276         When set to 1, ctdb uses the LCP2 ip allocation algorithm.
277       </para>
278     </refsect2>
280     <refsect2>
281       <title>LockProcessesPerDB</title>
282       <para>Default: 200</para>
283       <para>
284         This is the maximum number of lock helper processes ctdb will
285         create for obtaining record locks.  When ctdb cannot get a record
286         lock without blocking, it creates a helper process that waits
287         for the lock to be obtained.
288       </para>
289     </refsect2>
291     <refsect2>
292       <title>LogLatencyMs</title>
293       <para>Default: 0</para>
294       <para>
295         When set to non-zero, ctdb will log if certains operations
296         take longer than this value, in milliseconds, to complete.
297         These operations include "process a record request from client",
298         "take a record or database lock", "update a persistent database
299         record" and "vaccum a database".
300       </para>
301     </refsect2>
303     <refsect2>
304       <title>MaxQueueDropMsg</title>
305       <para>Default: 1000000</para>
306       <para>
307         This is the maximum number of messages to be queued up for
308         a client before ctdb will treat the client as hung and will
309         terminate the client connection.
310       </para>
311     </refsect2>
313     <refsect2>
314       <title>MonitorInterval</title>
315       <para>Default: 15</para>
316       <para>
317         How often should ctdb run the 'monitor' event in seconds to check
318         for a node's health.
319       </para>
320     </refsect2>
322     <refsect2>
323       <title>MonitorTimeoutCount</title>
324       <para>Default: 20</para>
325       <para>
326         How many 'monitor' events in a row need to timeout before a node
327         is flagged as UNHEALTHY.  This setting is useful if scripts can
328         not be written so that they do not hang for benign reasons.
329       </para>
330     </refsect2>
332     <refsect2>
333       <title>NoIPFailback</title>
334       <para>Default: 0</para>
335       <para>
336         When set to 1, ctdb will not perform failback of IP addresses
337         when a node becomes healthy. When a node becomes UNHEALTHY,
338         ctdb WILL perform failover of public IP addresses, but when the
339         node becomes HEALTHY again, ctdb will not fail the addresses back.
340       </para>
341       <para>
342         Use with caution! Normally when a node becomes available to the
343         cluster ctdb will try to reassign public IP addresses onto the
344         new node as a way to distribute the workload evenly across the
345         clusternode. Ctdb tries to make sure that all running nodes have
346         approximately the same number of public addresses it hosts.
347       </para>
348       <para>
349         When you enable this tunable, ctdb will no longer attempt to
350         rebalance the cluster by failing IP addresses back to the new
351         nodes. An unbalanced cluster will therefore remain unbalanced
352         until there is manual intervention from the administrator. When
353         this parameter is set, you can manually fail public IP addresses
354         over to the new node(s) using the 'ctdb moveip' command.
355       </para>
356     </refsect2>
358     <refsect2>
359       <title>NoIPHostOnAllDisabled</title>
360       <para>Default: 0</para>
361       <para>
362         If no nodes are HEALTHY then by default ctdb will happily host
363         public IPs on disabled (unhealthy or administratively disabled)
364         nodes.  This can cause problems, for example if the underlying
365         cluster filesystem is not mounted.  When set to 1 on a node and
366         that node is disabled, any IPs hosted by this node will be
367         released and the node will not takeover any IPs until it is no
368         longer disabled.
369       </para>
370     </refsect2>
372     <refsect2>
373       <title>NoIPTakeover</title>
374       <para>Default: 0</para>
375       <para>
376         When set to 1, ctdb will not allow IP addresses to be failed
377         over onto this node. Any IP addresses that the node currently
378         hosts will remain on the node but no new IP addresses can be
379         failed over to the node.
380       </para>
381     </refsect2>
383     <refsect2>
384       <title>PullDBPreallocation</title>
385       <para>Default: 10*1024*1024</para>
386       <para>
387         This is the size of a record buffer to pre-allocate for sending
388         reply to PULLDB control. Usually record buffer starts with size
389         of the first record and gets reallocated every time a new record
390         is added to the record buffer. For a large number of records,
391         this can be very inefficient to grow the record buffer one record
392         at a time.
393       </para>
394     </refsect2>
396     <refsect2>
397       <title>QueueBufferSize</title>
398       <para>Default: 1024</para>
399       <para>
400         This is the maximum amount of data (in bytes) ctdb will read
401         from a socket at a time.
402       </para>
403       <para>
404         For a busy setup, if ctdb is not able to process the TCP sockets
405         fast enough (large amount of data in Recv-Q for tcp sockets),
406         then this tunable value should be increased.  However, large
407         values can keep ctdb busy processing packets and prevent ctdb
408         from handling other events.
409       </para>
410     </refsect2>
412     <refsect2>
413       <title>RecBufferSizeLimit</title>
414       <para>Default: 1000000</para>
415       <para>
416         This is the limit on the size of the record buffer to be sent
417         in various controls.  This limit is used by new controls used
418         for recovery and controls used in vacuuming.
419       </para>
420     </refsect2>
422     <refsect2>
423       <title>RecdFailCount</title>
424       <para>Default: 10</para>
425       <para>
426         If the recovery daemon has failed to ping the main dameon for
427         this many consecutive intervals, the main daemon will consider
428         the recovery daemon as hung and will try to restart it to recover.
429       </para>
430     </refsect2>
432     <refsect2>
433       <title>RecdPingTimeout</title>
434       <para>Default: 60</para>
435       <para>
436         If the main dameon has not heard a "ping" from the recovery dameon
437         for this many seconds, the main dameon will log a message that
438         the recovery daemon is potentially hung.  This also increments a
439         counter which is checked against <varname>RecdFailCount</varname>
440         for detection of hung recovery daemon.
441       </para>
442     </refsect2>
444     <refsect2>
445       <title>RecLockLatencyMs</title>
446       <para>Default: 1000</para>
447       <para>
448         When using a reclock file for split brain prevention, if set
449         to non-zero this tunable will make the recovery dameon log a
450         message if the fcntl() call to lock/testlock the recovery file
451         takes longer than this number of milliseconds.
452       </para>
453     </refsect2>
455     <refsect2>
456       <title>RecoverInterval</title>
457       <para>Default: 1</para>
458       <para>
459         How frequently in seconds should the recovery daemon perform the
460         consistency checks to determine if it should perform a recovery.
461       </para>
462     </refsect2>
464     <refsect2>
465       <title>RecoverPDBBySeqNum</title>
466       <para>Default: 1</para>
467       <para>
468         When set to zero, database recovery for persistent databases is
469         record-by-record and recovery process simply collects the most
470         recent version of every individual record.
471       </para>
472       <para>
473         When set to non-zero, persistent databases will instead be
474         recovered as a whole db and not by individual records. The
475         node that contains the highest value stored in the record
476         "__db_sequence_number__" is selected and the copy of that nodes
477         database is used as the recovered database.
478       </para>
479       <para>
480         By default, recovery of persistent databses is done using
481         __db_sequence_number__ record.
482       </para>
483     </refsect2>
485     <refsect2>
486       <title>RecoverTimeout</title>
487       <para>Default: 120</para>
488       <para>
489         This is the default setting for timeouts for controls when sent
490         from the recovery daemon. We allow longer control timeouts from
491         the recovery daemon than from normal use since the recovery
492         dameon often use controls that can take a lot longer than normal
493         controls.
494       </para>
495     </refsect2>
497     <refsect2>
498       <title>RecoveryBanPeriod</title>
499       <para>Default: 300</para>
500       <para>
501        The duration in seconds for which a node is banned if the node
502        fails during recovery.  After this time has elapsed the node will
503        automatically get unbanned and will attempt to rejoin the cluster.
504       </para>
505       <para>
506        A node usually gets banned due to real problems with the node.
507        Don't set this value too small.  Otherwise, a problematic node
508        will try to re-join cluster too soon causing unnecessary recoveries.
509       </para>
510     </refsect2>
512     <refsect2>
513       <title>RecoveryDropAllIPs</title>
514       <para>Default: 120</para>
515       <para>
516         If a node is stuck in recovery, or stopped, or banned, for this
517         many seconds, then ctdb will release all public addresses on
518         that node.
519       </para>
520     </refsect2>
522     <refsect2>
523       <title>RecoveryGracePeriod</title>
524       <para>Default: 120</para>
525       <para>
526        During recoveries, if a node has not caused recovery failures
527        during the last grace period in seconds, any records of
528        transgressions that the node has caused recovery failures will be
529        forgiven. This resets the ban-counter back to zero for that node.
530       </para>
531     </refsect2>
533     <refsect2>
534       <title>RepackLimit</title>
535       <para>Default: 10000</para>
536       <para>
537         During vacuuming, if the number of freelist records are more than
538         <varname>RepackLimit</varname>, then the database is repacked
539         to get rid of the freelist records to avoid fragmentation.
540       </para>
541       <para>
542         Databases are repacked only if both <varname>RepackLimit</varname>
543         and <varname>VacuumLimit</varname> are exceeded.
544       </para>
545     </refsect2>
547     <refsect2>
548       <title>RerecoveryTimeout</title>
549       <para>Default: 10</para>
550       <para>
551         Once a recovery has completed, no additional recoveries are
552         permitted until this timeout in seconds has expired.
553       </para>
554     </refsect2>
556     <refsect2>
557       <title>SeqnumInterval</title>
558       <para>Default: 1000</para>
559       <para>
560         Some databases have seqnum tracking enabled, so that samba will
561         be able to detect asynchronously when there has been updates
562         to the database.  Everytime a database is updated its sequence
563         number is increased.
564       </para>
565       <para>
566         This tunable is used to specify in milliseconds how frequently
567         ctdb will send out updates to remote nodes to inform them that
568         the sequence number is increased.
569       </para>
570     </refsect2>
572     <refsect2>
573       <title>StatHistoryInterval</title>
574       <para>Default: 1</para>
575       <para>
576         Granularity of the statistics collected in the statistics
577         history. This is reported by 'ctdb stats' command.
578       </para>
579     </refsect2>
581     <refsect2>
582       <title>StickyDuration</title>
583       <para>Default: 600</para>
584       <para>
585         Once a record has been marked STICKY, this is the duration in
586         seconds, the record will be flagged as a STICKY record.
587       </para>
588     </refsect2>
590     <refsect2>
591       <title>StickyPindown</title>
592       <para>Default: 200</para>
593       <para>
594         Once a STICKY record has been migrated onto a node, it will be
595         pinned down on that node for this number of milliseconds. Any
596         request from other nodes to migrate the record off the node will
597         be deferred.
598       </para>
599     </refsect2>
601     <refsect2>
602       <title>TakeoverTimeout</title>
603       <para>Default: 9</para>
604       <para>
605         This is the duration in seconds in which ctdb tries to complete IP
606         failover.
607       </para>
608     </refsect2>
610     <refsect2>
611       <title>TDBMutexEnabled</title>
612       <para>Default: 0</para>
613       <para>
614         This paramter enables TDB_MUTEX_LOCKING feature on volatile
615         databases if the robust mutexes are supported. This optimizes the
616         record locking using robust mutexes and is much more efficient
617         that using posix locks.
618       </para>
619     </refsect2>
621     <refsect2>
622       <title>TickleUpdateInterval</title>
623       <para>Default: 20</para>
624       <para>
625         Every <varname>TickleUpdateInterval</varname> seconds, ctdb
626         synchronizes the client connection information across nodes.
627       </para>
628     </refsect2>
630     <refsect2>
631       <title>TraverseTimeout</title>
632       <para>Default: 20</para>
633       <para>
634         This is the duration in seconds for which a database traverse
635         is allowed to run.  If the traverse does not complete during
636         this interval, ctdb will abort the traverse.
637       </para>
638     </refsect2>
640     <refsect2>
641       <title>VacuumFastPathCount</title>
642       <para>Default: 60</para>
643       <para>
644        During a vacuuming run, ctdb usually processes only the records
645        marked for deletion also called the fast path vacuuming. After
646        finishing <varname>VacuumFastPathCount</varname> number of fast
647        path vacuuming runs, ctdb will trigger a scan of complete database
648        for any empty records that need to be deleted.
649       </para>
650     </refsect2>
652     <refsect2>
653       <title>VacuumInterval</title>
654       <para>Default: 10</para>
655       <para>
656         Periodic interval in seconds when vacuuming is triggered for
657         volatile databases.
658       </para>
659     </refsect2>
661     <refsect2>
662       <title>VacuumLimit</title>
663       <para>Default: 5000</para>
664       <para>
665         During vacuuming, if the number of deleted records are more than
666         <varname>VacuumLimit</varname>, then databases are repacked to
667         avoid fragmentation.
668       </para>
669       <para>
670         Databases are repacked only if both <varname>RepackLimit</varname>
671         and <varname>VacuumLimit</varname> are exceeded.
672       </para>
673     </refsect2>
675     <refsect2>
676       <title>VacuumMaxRunTime</title>
677       <para>Default: 120</para>
678       <para>
679         The maximum time in seconds for which the vacuuming process is
680         allowed to run.  If vacuuming process takes longer than this
681         value, then the vacuuming process is terminated.
682       </para>
683     </refsect2>
685     <refsect2>
686       <title>VerboseMemoryNames</title>
687       <para>Default: 0</para>
688       <para>
689         When set to non-zero, ctdb assigns verbose names for some of
690         the talloc allocated memory objects.  These names are visible
691         in the talloc memory report generated by 'ctdb dumpmemory'.
692       </para>
693     </refsect2>
695   </refsect1>
697   <refsect1>
698     <title>SEE ALSO</title>
699     <para>
700       <citerefentry><refentrytitle>ctdb</refentrytitle>
701       <manvolnum>1</manvolnum></citerefentry>,
703       <citerefentry><refentrytitle>ctdbd</refentrytitle>
704       <manvolnum>1</manvolnum></citerefentry>,
706       <citerefentry><refentrytitle>ctdbd.conf</refentrytitle>
707       <manvolnum>5</manvolnum></citerefentry>,
709       <citerefentry><refentrytitle>ctdb</refentrytitle>
710       <manvolnum>7</manvolnum></citerefentry>,
712       <ulink url="http://ctdb.samba.org/"/>
713     </para>
714   </refsect1>
716   <refentryinfo>
717     <author>
718       <contrib>
719         This documentation was written by
720         Ronnie Sahlberg,
721         Amitay Isaacs,
722         Martin Schwenke
723       </contrib>
724     </author>
726     <copyright>
727       <year>2007</year>
728       <holder>Andrew Tridgell</holder>
729       <holder>Ronnie Sahlberg</holder>
730     </copyright>
731     <legalnotice>
732       <para>
733         This program is free software; you can redistribute it and/or
734         modify it under the terms of the GNU General Public License as
735         published by the Free Software Foundation; either version 3 of
736         the License, or (at your option) any later version.
737       </para>
738       <para>
739         This program is distributed in the hope that it will be
740         useful, but WITHOUT ANY WARRANTY; without even the implied
741         warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
742         PURPOSE.  See the GNU General Public License for more details.
743       </para>
744       <para>
745         You should have received a copy of the GNU General Public
746         License along with this program; if not, see
747         <ulink url="http://www.gnu.org/licenses"/>.
748       </para>
749     </legalnotice>
750   </refentryinfo>
752 </refentry>