1CTDB.CONF(5) CTDB - clustered TDB database CTDB.CONF(5)
2
6 ctdb.conf - CTDB configuration file
7
9 This file contains CTDB configuration options that affect the operation
10 of CTDB daemons and command-line tools. The default location of this
11 file is /etc/ctdb/ctdb.conf.
12 Note that this is a Samba-style configuration file, so it has a very
14 different syntax to previous CTDB configuration files.
15 For event script options please see ctdb-script.options(5).
17 Configuration options are grouped into several sections below. There
19 are only a few options in each section, allowing them to be ordered
20 (approximately) in decreasing order of importance.
21
23 Options in this section control CTDB's logging. They are valid within
24 the logging section of file, indicated by [logging].
25 log level = LOGLEVEL
27 LOGLEVEL is a string that controls the verbosity of ctdbd's
28 logging. See the LOG LEVELS section in ctdb(7) for more details.
29 Default: NOTICE
31 location = STRING
33 STRING specifies where ctdbd will write its log.
34 Valid values are:
36 file:FILENAME
38 FILENAME where ctdbd will write its log. This is usually
39 /var/log/log.ctdb.
40 syslog[:METHOD]
42 CTDB will log to syslog. By default this will use the syslog(3)
43 API.
44 If METHOD is specified then it specifies an extension that
46 causes logging to be done in a non-blocking fashion. This can
47 be useful under heavy loads that might cause the syslog daemon
48 to dequeue messages too slowly, which would otherwise cause
49 CTDB to block when logging. METHOD must be one of:
50 nonblocking
52 CTDB will log to syslog via /dev/log in non-blocking mode.
53 udp
55 CTDB will log to syslog via UDP to localhost:514. The
56 syslog daemon must be configured to listen on (at least)
57 localhost:514. Most implementations will log the messages
58 against hostname "localhost" - this is a limit of the
59 implementation for compatibility with more syslog daemon
60 implementations.
61 udp-rfc5424
63 As with "udp" but messages are sent in RFC5424 format. This
64 method will log the correct hostname but is not as widely
65 implemented in syslog daemons.
66 Default: file:/var/log/log.ctdb
68
70 Options in this section affect the CTDB cluster setup. They are valid
71 within the cluster section of file, indicated by [cluster].
72 cluster lock = LOCK
74 LOCK specifies the cluster-wide mutex used to detect and prevent a
75 partitioned cluster (or "split brain").
76 For information about the cluster lock please see the CLUSTER LOCK
78 section in ctdb(7).
79 Default: NONE. However, uses of a cluster lock is strongly
81 recommended.
82 leader capability = true|false
84 Indicates whether a node can become the leader for the cluster. If
85 this is set to false then the node will not be able to become the
86 leader for the cluster. This feature is primarily used for making a
87 cluster span across a WAN link and use CTDB as a WAN-accelerator.
88 Please see the REMOTE CLUSTER NODES section in ctdb(7) for more
90 information.
91 Default: true
93 leader timeout = SECONDS
95 Number of SECONDS without a leader broadcast before a node triggers
96 an election.
97 Default: 5
99 node address = IPADDR
101 IPADDR is the private IP address that ctdbd will bind to.
102 This option is only required when automatic address detection can
104 not be used. This can be the case when running multiple ctdbd
105 daemons/nodes on the same physical host (usually for testing),
106 using InfiniBand for the private network or on Linux when sysctl
107 net.ipv4.ip_nonlocal_bind=1.
108 Default: CTDB selects the first address from the nodes list that it
110 can bind to. See also the PRIVATE ADDRESS section in ctdb(7).
111 transport = tcp|ib
113 This option specifies which transport to use for ctdbd internode
114 communications on the private network.
115 ib means InfiniBand. The InfiniBand support is not regularly
117 tested. If it is known to be broken then it may be disabled so that
118 a value of ib is considered invalid.
119 Default: tcp
121
123 Options in this section affect the CTDB database setup. They are valid
124 within the database section of file, indicated by [database].
125 volatile database directory = DIRECTORY
127 DIRECTORY on local storage where CTDB keeps a local copy of
128 volatile TDB databases. This directory is local for each node and
129 should not be stored on the shared cluster filesystem.
130 Mounting a tmpfs (or similar memory filesystem) on this directory
132 can provide a significant performance improvement when there is I/O
133 contention on the local disk.
134 Default: /var/lib/ctdb/volatile
136 persistent database directory=DIRECTORY
138 DIRECTORY on local storage where CTDB keeps a local copy of
139 persistent TDB databases. This directory is local for each node and
140 should not be stored on the shared cluster filesystem.
141 Default: /var/lib/ctdb/persistent
143 state database directory = DIRECTORY
145 DIRECTORY on local storage where CTDB keeps a local copy of
146 internal state TDB databases. This directory is local for each node
147 and should not be stored on the shared cluster filesystem.
148 Default: /var/lib/ctdb/state
150 tdb mutexes = true|false
152 This parameter enables TDB_MUTEX_LOCKING feature on volatile
153 databases if the robust mutexes are supported. This optimizes the
154 record locking using robust mutexes and is much more efficient that
155 using posix locks.
156 If robust mutexes are unreliable on the platform being used then
158 they can be disabled by setting this to false.
159 lock debug script = FILENAME
161 FILENAME is a script used by CTDB's database locking code to
162 attempt to provide debugging information when CTDB is unable to
163 lock an entire database or a record.
164 This script should be a bare filename relative to the CTDB
166 configuration directory (/etc/ctdb/). Any directory prefix is
167 ignored and the path is calculated relative to this directory.
168 CTDB provides a lock debugging script and installs it as
170 /etc/ctdb/debug_locks.sh.
171 Default: NONE
173
175 Options in this section affect CTDB event handling. They are valid
176 within the event section of file, indicated by [event].
177 debug script = FILENAME
179 FILENAME is a script used by CTDB's event handling code to attempt
180 to provide debugging information when an event times out.
181 This script should be a bare filename relative to the CTDB
183 configuration directory (/etc/ctdb/). Any directory prefix is
184 ignored and the path is calculated relative to this directory.
185 CTDB provides a script for debugging timed out event scripts and
187 installs it as /etc/ctdb/debug-hung-script.sh.
188 Default: NONE
190
192 Options in this section affect CTDB failover. They are valid within the
193 failover section of file, indicated by [failover].
194 disabled = true|false
196 If set to true then public IP failover is disabled.
197 Default: false
199
201 Options in this section affect legacy CTDB setup. They are valid within
202 the legacy section of file, indicated by [legacy].
203 ctdb start as stopped = true|false
205 If set to true CTDB starts in the STOPPED state.
206 To allow the node to take part in the cluster it must be manually
208 continued with the ctdb continue command.
209 Please see the NODE STATES section in ctdb(7) for more information
211 about the STOPPED state.
212 Default: false
214 start as disabled = true|false
216 If set to true CTDB starts in the DISABLED state.
217 To allow the node to host public IP addresses and services, it must
219 be manually enabled using the ctdb enable command.
220 Please see the NODE STATES section in ctdb(7) for more information
222 about the DISABLED state.
223 Default: false
225 realtime scheduling = true|false
227 Usually CTDB runs with real-time priority. This helps it to perform
228 effectively on a busy system, such as when there are thousands of
229 Samba clients. If you are running CTDB on a platform that does not
230 support real-time priority, you can set this to false.
231 Default: true
233 lmaster capability = true|false
235 Indicates whether a node can become a location master for records
236 in a database. If this is set to false then the node will not be
237 part of the vnnmap. This feature is primarily used for making a
238 cluster span across a WAN link and use CTDB as a WAN-accelerator.
239 Please see the REMOTE CLUSTER NODES section in ctdb(7) for more
241 information.
242 Default: true
244 script log level = LOGLEVEL
246 This option sets the debug level of event script output to
247 LOGLEVEL.
248 See the DEBUG LEVELS section in ctdb(7) for more information.
250 Default: ERROR
252
254 /etc/ctdb/ctdb.conf
255
257 ctdbd(1), onnode(1), ctdb.sysconfig(5), ctdb-script.options(5),
258 ctdb(7), ctdb-tunables(7), http://ctdb.samba.org/
259
261 This documentation was written by Amitay Isaacs, Martin Schwenke
262
264 Copyright © 2007 Andrew Tridgell, Ronnie Sahlberg
265 This program is free software; you can redistribute it and/or modify it
267 under the terms of the GNU General Public License as published by the
268 Free Software Foundation; either version 3 of the License, or (at your
269 option) any later version.
270 This program is distributed in the hope that it will be useful, but
272 WITHOUT ANY WARRANTY; without even the implied warranty of
273 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
274 General Public License for more details.
275 You should have received a copy of the GNU General Public License along
277 with this program; if not, see http://www.gnu.org/licenses.
278ctdb 11/30/2023 CTDB.CONF(5)