sin/samba-mirror
1
0
Fork 0
mirror of https://github.com/samba-team/samba.git synced 2024-12-23 17:34:34 +03:00
Code

doc: Do not keep the built version of manpages in version control

Browse Source 
Generated docs will be bundled with release tarballs. No need to keep
them in git. This avoids the need to commit the generated doc version
if source xml is modified.

Signed-off-by: Amitay Isaacs <amitay@gmail.com>

(This used to be ctdb commit f3888712298f1de7cc7eb51f50c22080fa64e3c0)
This commit is contained in:
Amitay Isaacs 2012-10-22 17:43:32 +11:00
parent 231898db1f
commit 56e1d523a5
10 changed files with 0 additions and 4834 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1053
ctdb/doc/ctdb.1
View File

File diff suppressed because it is too large Load Diff

812
ctdb/doc/ctdb.1.html
View File

@ -1,812 +0,0 @@
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>ctdb</title><meta name="generator" content="DocBook XSL Stylesheets V1.76.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" title="ctdb"><a name="ctdb.1"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>ctdb &#8212; clustered tdb database management utility</p></div><div class="refsynopsisdiv" title="Synopsis"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">ctdb [ OPTIONS ] COMMAND ...</code> </p></div><div class="cmdsynopsis"><p><code class="command">ctdb</code> [-n &lt;node&gt;] [-Y] [-t &lt;timeout&gt;] [-T &lt;timelimit&gt;] [-? --help] [--usage] [-d --debug=&lt;INTEGER&gt;] [--socket=&lt;filename&gt;] [--print-emptyrecords] [--print-datasize] [--print-lmaster] [--print-hash] [--print-recordflags]</p></div></div><div class="refsect1" title="DESCRIPTION"><a name="idp200144"></a><h2>DESCRIPTION</h2><p>
ctdb is a utility to view and manage a ctdb cluster.
</p></div><div class="refsect1" title="OPTIONS"><a name="idp200792"></a><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">-n &lt;pnn&gt;</span></dt><dd><p>
This specifies the physical node number on which to execute the
command. Default is to run the command on the daemon running on
the local host.
</p><p>
The physical node number is an integer that describes the node in the
cluster. The first node has physical node number 0.
</p></dd><dt><span class="term">-Y</span></dt><dd><p>
Produce output in machine readable form for easier parsing by scripts. Not all commands support this option.
</p></dd><dt><span class="term">-t &lt;timeout&gt;</span></dt><dd><p>
How long should ctdb wait for the local ctdb daemon to respond to a command before timing out. Default is 3 seconds.
</p></dd><dt><span class="term">-T &lt;timelimit&gt;</span></dt><dd><p>
A limit on how long the ctdb command will run for before it will
be aborted. When this timelimit has been exceeded the ctdb command will
terminate.
</p></dd><dt><span class="term">-? --help</span></dt><dd><p>
Print some help text to the screen.
</p></dd><dt><span class="term">--usage</span></dt><dd><p>
Print useage information to the screen.
</p></dd><dt><span class="term">-d --debug=&lt;debuglevel&gt;</span></dt><dd><p>
Change the debug level for the command. Default is 0.
</p></dd><dt><span class="term">--socket=&lt;filename&gt;</span></dt><dd><p>
Specify the socketname to use when connecting to the local ctdb
daemon. The default is /tmp/ctdb.socket .
</p><p>
You only need to specify this parameter if you run multiple ctdb
daemons on the same physical host and thus can not use the default
name for the domain socket.
</p></dd><dt><span class="term">--print-emptyrecords</span></dt><dd><p>
This enables printing of empty records when dumping databases
with the catdb, cattbd and dumpdbbackup commands. Records with
empty data segment are considered deleted by ctdb and cleaned
by the vacuuming mechanism, so this switch can come in handy for
debugging the vacuuming behaviour.
</p></dd><dt><span class="term">--print-datasize</span></dt><dd><p>
This lets database dumps (catdb, cattdb, dumpdbbackup) print the
size of the record data instead of dumping the data contents.
</p></dd><dt><span class="term">--print-lmaster</span></dt><dd><p>
This lets catdb print the lmaster for each record.
</p></dd><dt><span class="term">--print-hash</span></dt><dd><p>
This lets database dumps (catdb, cattdb, dumpdbbackup) print the
hash for each record.
</p></dd><dt><span class="term">--print-recordflags</span></dt><dd><p>
This lets catdb and dumpdbbackup print the
record flags for each record. Note that cattdb always
prints the flags.
</p></dd></dl></div></div><div class="refsect1" title="Administrative Commands"><a name="idp70096"></a><h2>Administrative Commands</h2><p>
These are commands used to monitor and administrate a CTDB cluster.
</p><div class="refsect2" title="pnn"><a name="idp70632"></a><h3>pnn</h3><p>
This command displays the pnn of the current node.
</p></div><div class="refsect2" title="status"><a name="idp71216"></a><h3>status</h3><p>
This command shows the current status of the ctdb node.
</p><div class="refsect3" title="node status"><a name="idp71760"></a><h4>node status</h4><p>
Node status reflects the current status of the node. There are five possible states:
</p><p>
OK - This node is fully functional.
</p><p>
DISCONNECTED - This node could not be connected through the network and is currently not participating in the cluster. If there is a public IP address associated with this node it should have been taken over by a different node. No services are running on this node.
</p><p>
DISABLED - This node has been administratively disabled. This node is still functional and participates in the CTDB cluster but its IP addresses have been taken over by a different node and no services are currently being hosted.
</p><p>
UNHEALTHY - A service provided by this node is malfunctioning and should be investigated. The CTDB daemon itself is operational and participates in the cluster. Its public IP address has been taken over by a different node and no services are currnetly being hosted. All unhealthy nodes should be investigated and require an administrative action to rectify.
</p><p>
BANNED - This node failed too many recovery attempts and has been banned from participating in the cluster for a period of RecoveryBanPeriod seconds. Any public IP address has been taken over by other nodes. This node does not provide any services. All banned nodes should be investigated and require an administrative action to rectify. This node does not perticipate in the CTDB cluster but can still be communicated with. I.e. ctdb commands can be sent to it.
</p><p>
STOPPED - A node that is stopped does not host any public ip addresses,
nor is it part of the VNNMAP. A stopped node can not become LVSMASTER,
RECMASTER or NATGW.
This node does not perticipate in the CTDB cluster but can still be
communicated with. I.e. ctdb commands can be sent to it.
</p><p>
PARTIALLYONLINE - A node that is partially online participates
in a cluster like a node that is ok. Some interfaces to serve
public ip addresses are down, but at least one interface is up.
See also "ctdb ifaces".
</p></div><div class="refsect3" title="generation"><a name="idp75800"></a><h4>generation</h4><p>
The generation id is a number that indicates the current generation
of a cluster instance. Each time a cluster goes through a
reconfiguration or a recovery its generation id will be changed.
</p><p>
This number does not have any particular meaning other than to keep
track of when a cluster has gone through a recovery. It is a random
number that represents the current instance of a ctdb cluster
and its databases.
CTDBD uses this number internally to be able to tell when commands
to operate on the cluster and the databases was issued in a different
generation of the cluster, to ensure that commands that operate
on the databases will not survive across a cluster database recovery.
After a recovery, all old outstanding commands will automatically
become invalid.
</p><p>
Sometimes this number will be shown as "INVALID". This only means that
the ctdbd daemon has started but it has not yet merged with the cluster through a recovery.
All nodes start with generation "INVALID" and are not assigned a real
generation id until they have successfully been merged with a cluster
through a recovery.
</p></div><div class="refsect3" title="VNNMAP"><a name="idp77912"></a><h4>VNNMAP</h4><p>
The list of Virtual Node Numbers. This is a list of all nodes that actively participates in the cluster and that share the workload of hosting the Clustered TDB database records.
Only nodes that are participating in the vnnmap can become lmaster or dmaster for a database record.
</p></div><div class="refsect3" title="Recovery mode"><a name="idp78760"></a><h4>Recovery mode</h4><p>
This is the current recovery mode of the cluster. There are two possible modes:
</p><p>
NORMAL - The cluster is fully operational.
</p><p>
RECOVERY - The cluster databases have all been frozen, pausing all services while the cluster awaits a recovery process to complete. A recovery process should finish within seconds. If a cluster is stuck in the RECOVERY state this would indicate a cluster malfunction which needs to be investigated.
</p><p>
Once the recovery master detects an inconsistency, for example a node
becomes disconnected/connected, the recovery daemon will trigger a
cluster recovery process, where all databases are remerged across the
cluster. When this process starts, the recovery master will first
"freeze" all databases to prevent applications such as samba from
accessing the databases and it will also mark the recovery mode as
RECOVERY.
</p><p>
When CTDBD starts up, it will start in RECOVERY mode.
Once the node has been merged into a cluster and all databases
have been recovered, the node mode will change into NORMAL mode
and the databases will be "thawed", allowing samba to access the
databases again.
</p></div><div class="refsect3" title="Recovery master"><a name="idp81288"></a><h4>Recovery master</h4><p>
This is the cluster node that is currently designated as the recovery master. This node is responsible of monitoring the consistency of the cluster and to perform the actual recovery process when reqired.
</p><p>
Only one node at a time can be the designated recovery master. Which
node is designated the recovery master is decided by an election
process in the recovery daemons running on each node.
</p></div><p>
Example: ctdb status
</p><p>Example output:</p><pre class="screen">
Number of nodes:4
pnn:0 11.1.2.200 OK (THIS NODE)
pnn:1 11.1.2.201 OK
pnn:2 11.1.2.202 OK
pnn:3 11.1.2.203 OK
Generation:1362079228
Size:4
hash:0 lmaster:0
hash:1 lmaster:1
hash:2 lmaster:2
hash:3 lmaster:3
Recovery mode:NORMAL (0)
Recovery master:0
</pre></div><div class="refsect2" title="recmaster"><a name="idp83552"></a><h3>recmaster</h3><p>
This command shows the pnn of the node which is currently the recmaster.
</p></div><div class="refsect2" title="uptime"><a name="idp84176"></a><h3>uptime</h3><p>
This command shows the uptime for the ctdb daemon. When the last recovery or ip-failover completed and how long it took. If the "duration" is shown as a negative number, this indicates that there is a recovery/failover in progress and it started that many seconds ago.
</p><p>
Example: ctdb uptime
</p><p>Example output:</p><pre class="screen">
Current time of node : Thu Oct 29 10:38:54 2009
Ctdbd start time : (000 16:54:28) Wed Oct 28 17:44:26 2009
Time of last recovery/failover: (000 16:53:31) Wed Oct 28 17:45:23 2009
Duration of last recovery/failover: 2.248552 seconds
</pre></div><div class="refsect2" title="listnodes"><a name="idp86032"></a><h3>listnodes</h3><p>
This command shows lists the ip addresses of all the nodes in the cluster.
</p><p>
Example: ctdb listnodes
</p><p>Example output:</p><pre class="screen">
10.0.0.71
10.0.0.72
10.0.0.73
10.0.0.74
</pre></div><div class="refsect2" title="ping"><a name="idp87456"></a><h3>ping</h3><p>
This command will "ping" all CTDB daemons in the cluster to verify that they are processing commands correctly.
</p><p>
Example: ctdb ping
</p><p>
Example output:
</p><pre class="screen">
response from 0 time=0.000054 sec (3 clients)
response from 1 time=0.000144 sec (2 clients)
response from 2 time=0.000105 sec (2 clients)
response from 3 time=0.000114 sec (2 clients)
</pre></div><div class="refsect2" title="ifaces"><a name="idp89040"></a><h3>ifaces</h3><p>
This command will display the list of network interfaces, which could
host public addresses, along with their status.
</p><p>
Example: ctdb ifaces
</p><p>
Example output:
</p><pre class="screen">
Interfaces on node 0
name:eth5 link:up references:2
name:eth4 link:down references:0
name:eth3 link:up references:1
name:eth2 link:up references:1
</pre><p>
Example: ctdb ifaces -Y
</p><p>
Example output:
</p><pre class="screen">
:Name:LinkStatus:References:
:eth5:1:2
:eth4:0:0
:eth3:1:1
:eth2:1:1
</pre></div><div class="refsect2" title="setifacelink &lt;iface&gt; &lt;status&gt;"><a name="idp91392"></a><h3>setifacelink &lt;iface&gt; &lt;status&gt;</h3><p>
This command will set the status of a network interface.
The status needs to be "up" or "down". This is typically
used in the 10.interfaces script in the "monitor" event.
</p><p>
Example: ctdb setifacelink eth0 up
</p></div><div class="refsect2" title="ip"><a name="idp92376"></a><h3>ip</h3><p>
This command will display the list of public addresses that are provided by the cluster and which physical node is currently serving this ip. By default this command will ONLY show those public addresses that are known to the node itself. To see the full list of all public ips across the cluster you must use "ctdb ip -n all".
</p><p>
Example: ctdb ip
</p><p>
Example output:
</p><pre class="screen">
Public IPs on node 0
172.31.91.82 node[1] active[] available[eth2,eth3] configured[eth2,eth3]
172.31.91.83 node[0] active[eth3] available[eth2,eth3] configured[eth2,eth3]
172.31.91.84 node[1] active[] available[eth2,eth3] configured[eth2,eth3]
172.31.91.85 node[0] active[eth2] available[eth2,eth3] configured[eth2,eth3]
172.31.92.82 node[1] active[] available[eth5] configured[eth4,eth5]
172.31.92.83 node[0] active[eth5] available[eth5] configured[eth4,eth5]
172.31.92.84 node[1] active[] available[eth5] configured[eth4,eth5]
172.31.92.85 node[0] active[eth5] available[eth5] configured[eth4,eth5]
</pre><p>
Example: ctdb ip -Y
</p><p>
Example output:
</p><pre class="screen">
:Public IP:Node:ActiveInterface:AvailableInterfaces:ConfiguredInterfaces:
:172.31.91.82:1::eth2,eth3:eth2,eth3:
:172.31.91.83:0:eth3:eth2,eth3:eth2,eth3:
:172.31.91.84:1::eth2,eth3:eth2,eth3:
:172.31.91.85:0:eth2:eth2,eth3:eth2,eth3:
:172.31.92.82:1::eth5:eth4,eth5:
:172.31.92.83:0:eth5:eth5:eth4,eth5:
:172.31.92.84:1::eth5:eth4,eth5:
:172.31.92.85:0:eth5:eth5:eth4,eth5:
</pre></div><div class="refsect2" title="ipinfo &lt;ip&gt;"><a name="idp96320"></a><h3>ipinfo &lt;ip&gt;</h3><p>
This command will display details about the specified public addresses.
</p><p>
Example: ctdb ipinfo 172.31.92.85
</p><p>
Example output:
</p><pre class="screen">
Public IP[172.31.92.85] info on node 0
IP:172.31.92.85
CurrentNode:0
NumInterfaces:2
Interface[1]: Name:eth4 Link:down References:0
Interface[2]: Name:eth5 Link:up References:2 (active)
</pre></div><div class="refsect2" title="scriptstatus"><a name="idp97920"></a><h3>scriptstatus</h3><p>
This command displays which scripts where run in the previous monitoring cycle and the result of each script. If a script failed with an error, causing the node to become unhealthy, the output from that script is also shown.
</p><p>
Example: ctdb scriptstatus
</p><p>
Example output:
</p><pre class="screen">
7 scripts were executed last monitoring cycle
00.ctdb Status:OK Duration:0.056 Tue Mar 24 18:56:57 2009
10.interface Status:OK Duration:0.077 Tue Mar 24 18:56:57 2009
11.natgw Status:OK Duration:0.039 Tue Mar 24 18:56:57 2009
20.multipathd Status:OK Duration:0.038 Tue Mar 24 18:56:57 2009
31.clamd Status:DISABLED
40.vsftpd Status:OK Duration:0.045 Tue Mar 24 18:56:57 2009
41.httpd Status:OK Duration:0.039 Tue Mar 24 18:56:57 2009
50.samba Status:ERROR Duration:0.082 Tue Mar 24 18:56:57 2009
OUTPUT:ERROR: Samba tcp port 445 is not responding
</pre></div><div class="refsect2" title="disablescript &lt;script&gt;"><a name="idp100136"></a><h3>disablescript &lt;script&gt;</h3><p>
This command is used to disable an eventscript.
</p><p>
This will take effect the next time the eventscripts are being executed so it can take a short while until this is reflected in 'scriptstatus'.
</p></div><div class="refsect2" title="enablescript &lt;script&gt;"><a name="idp101104"></a><h3>enablescript &lt;script&gt;</h3><p>
This command is used to enable an eventscript.
</p><p>
This will take effect the next time the eventscripts are being executed so it can take a short while until this is reflected in 'scriptstatus'.
</p></div><div class="refsect2" title="getvar &lt;name&gt;"><a name="idp102072"></a><h3>getvar &lt;name&gt;</h3><p>
Get the runtime value of a tuneable variable.
</p><p>
Example: ctdb getvar MaxRedirectCount
</p><p>
Example output:
</p><pre class="screen">
MaxRedirectCount = 3
</pre></div><div class="refsect2" title="setvar &lt;name&gt; &lt;value&gt;"><a name="idp103496"></a><h3>setvar &lt;name&gt; &lt;value&gt;</h3><p>
Set the runtime value of a tuneable variable.
</p><p>
Example: ctdb setvar MaxRedirectCount 5
</p></div><div class="refsect2" title="listvars"><a name="idp104384"></a><h3>listvars</h3><p>
List all tuneable variables, except the values of the obsolete tunables
like VacuumMinInterval. The obsolete tunables can be retrieved only
explicitly with the "ctdb getvar" command.
</p><p>
Example: ctdb listvars
</p><p>
Example output:
</p><pre class="screen">
MaxRedirectCount = 3
SeqnumInterval = 1000
ControlTimeout = 60
TraverseTimeout = 20
KeepaliveInterval = 5
KeepaliveLimit = 5
RecoverTimeout = 20
RecoverInterval = 1
ElectionTimeout = 3
TakeoverTimeout = 9
MonitorInterval = 15
TickleUpdateInterval = 20
EventScriptTimeout = 30
EventScriptTimeoutCount = 1
RecoveryGracePeriod = 120
RecoveryBanPeriod = 300
DatabaseHashSize = 100001
DatabaseMaxDead = 5
RerecoveryTimeout = 10
EnableBans = 1
DeterministicIPs = 0
LCP2PublicIPs = 1
ReclockPingPeriod = 60
NoIPFailback = 0
DisableIPFailover = 0
VerboseMemoryNames = 0
RecdPingTimeout = 60
RecdFailCount = 10
LogLatencyMs = 0
RecLockLatencyMs = 1000
RecoveryDropAllIPs = 120
VerifyRecoveryLock = 1
VacuumInterval = 10
VacuumMaxRunTime = 30
RepackLimit = 10000
VacuumLimit = 5000
VacuumFastPathCount = 60
MaxQueueDropMsg = 1000000
UseStatusEvents = 0
AllowUnhealthyDBRead = 0
StatHistoryInterval = 1
DeferredAttachTO = 120
AllowClientDBAttach = 1
RecoverPDBBySeqNum = 0
</pre></div><div class="refsect2" title="lvsmaster"><a name="idp107184"></a><h3>lvsmaster</h3><p>
This command shows which node is currently the LVSMASTER. The
LVSMASTER is the node in the cluster which drives the LVS system and
which receives all incoming traffic from clients.
</p><p>
LVS is the mode where the entire CTDB/Samba cluster uses a single
ip address for the entire cluster. In this mode all clients connect to
one specific node which will then multiplex/loadbalance the clients
evenly onto the other nodes in the cluster. This is an alternative to using
public ip addresses. See the manpage for ctdbd for more information
about LVS.
</p></div><div class="refsect2" title="lvs"><a name="idp108528"></a><h3>lvs</h3><p>
This command shows which nodes in the cluster are currently active in the
LVS configuration. I.e. which nodes we are currently loadbalancing
the single ip address across.
</p><p>
LVS will by default only loadbalance across those nodes that are both
LVS capable and also HEALTHY. Except if all nodes are UNHEALTHY in which
case LVS will loadbalance across all UNHEALTHY nodes as well.
LVS will never use nodes that are DISCONNECTED, STOPPED, BANNED or
DISABLED.
</p><p>
Example output:
</p><pre class="screen">
2:10.0.0.13
3:10.0.0.14
</pre></div><div class="refsect2" title="getcapabilities"><a name="idp110384"></a><h3>getcapabilities</h3><p>
This command shows the capabilities of the current node.
Please see manpage for ctdbd for a full list of all capabilities and
more detailed description.
</p><p>
RECMASTER and LMASTER capabilities are primarily used when CTDBD
is used to create a cluster spanning across WAN links. In which case
ctdbd acts as a WAN accelerator.
</p><p>
LVS capabile means that the node is participating in LVS, a mode
where the entire CTDB cluster uses one single ip address for the
entire cluster instead of using public ip address failover.
This is an alternative to using a loadbalancing layer-4 switch.
</p><p>
Example output:
</p><pre class="screen">
RECMASTER: YES
LMASTER: YES
LVS: NO
</pre></div><div class="refsect2" title="statistics"><a name="idp112560"></a><h3>statistics</h3><p>
Collect statistics from the CTDB daemon about how many calls it has served.
</p><p>
Example: ctdb statistics
</p><p>
Example output:
</p><pre class="screen">
CTDB version 1
num_clients 3
frozen 0
recovering 0
client_packets_sent 360489
client_packets_recv 360466
node_packets_sent 480931
node_packets_recv 240120
keepalive_packets_sent 4
keepalive_packets_recv 3
node
req_call 2
reply_call 2
req_dmaster 0
reply_dmaster 0
reply_error 0
req_message 42
req_control 120408
reply_control 360439
client
req_call 2
req_message 24
req_control 360440
timeouts
call 0
control 0
traverse 0
total_calls 2
pending_calls 0
lockwait_calls 0
pending_lockwait_calls 0
memory_used 5040
max_hop_count 0
max_call_latency 4.948321 sec
max_lockwait_latency 0.000000 sec
</pre></div><div class="refsect2" title="statisticsreset"><a name="idp115200"></a><h3>statisticsreset</h3><p>
This command is used to clear all statistics counters in a node.
</p><p>
Example: ctdb statisticsreset
</p></div><div class="refsect2" title="getreclock"><a name="idp116064"></a><h3>getreclock</h3><p>
This command is used to show the filename of the reclock file that is used.
</p><p>
Example output:
</p><pre class="screen">
Reclock file:/gpfs/.ctdb/shared
</pre></div><div class="refsect2" title="setreclock [filename]"><a name="idp117264"></a><h3>setreclock [filename]</h3><p>
This command is used to modify, or clear, the file that is used as the reclock file at runtime. When this command is used, the reclock file checks are disabled. To re-enable the checks the administrator needs to activate the "VerifyRecoveryLock" tunable using "ctdb setvar".
</p><p>
If run with no parameter this will remove the reclock file completely. If run with a parameter the parameter specifies the new filename to use for the recovery lock.
</p><p>
This command only affects the runtime settings of a ctdb node and will be lost when ctdb is restarted. For persistent changes to the reclock file setting you must edit /etc/sysconfig/ctdb.
</p></div><div class="refsect2" title="getdebug"><a name="idp118840"></a><h3>getdebug</h3><p>
Get the current debug level for the node. the debug level controls what information is written to the log file.
</p><p>
The debug levels are mapped to the corresponding syslog levels.
When a debug level is set, only those messages at that level and higher
levels will be printed.
</p><p>
The list of debug levels from highest to lowest are :
</p><p>
EMERG ALERT CRIT ERR WARNING NOTICE INFO DEBUG
</p></div><div class="refsect2" title="setdebug &lt;debuglevel&gt;"><a name="idp120392"></a><h3>setdebug &lt;debuglevel&gt;</h3><p>
Set the debug level of a node. This controls what information will be logged.
</p><p>
The debuglevel is one of EMERG ALERT CRIT ERR WARNING NOTICE INFO DEBUG
</p></div><div class="refsect2" title="getpid"><a name="idp121320"></a><h3>getpid</h3><p>
This command will return the process id of the ctdb daemon.
</p></div><div class="refsect2" title="disable"><a name="idp121928"></a><h3>disable</h3><p>
This command is used to administratively disable a node in the cluster.
A disabled node will still participate in the cluster and host
clustered TDB records but its public ip address has been taken over by
a different node and it no longer hosts any services.
</p></div><div class="refsect2" title="enable"><a name="idp122760"></a><h3>enable</h3><p>
Re-enable a node that has been administratively disabled.
</p></div><div class="refsect2" title="stop"><a name="idp123368"></a><h3>stop</h3><p>
This command is used to administratively STOP a node in the cluster.
A STOPPED node is connected to the cluster but will not host any
public ip addresse, nor does it participate in the VNNMAP.
The difference between a DISABLED node and a STOPPED node is that
a STOPPED node does not host any parts of the database which means
that a recovery is required to stop/continue nodes.
</p></div><div class="refsect2" title="continue"><a name="idp124312"></a><h3>continue</h3><p>
Re-start a node that has been administratively stopped.
</p></div><div class="refsect2" title="addip &lt;public_ip/mask&gt; &lt;iface&gt;"><a name="idp124920"></a><h3>addip &lt;public_ip/mask&gt; &lt;iface&gt;</h3><p>
This command is used to add a new public ip to a node during runtime.
This allows public addresses to be added to a cluster without having
to restart the ctdb daemons.
</p><p>
Note that this only updates the runtime instance of ctdb. Any changes will be lost next time ctdb is restarted and the public addresses file is re-read.
If you want this change to be permanent you must also update the public addresses file manually.
</p></div><div class="refsect2" title="delip &lt;public_ip&gt;"><a name="idp126136"></a><h3>delip &lt;public_ip&gt;</h3><p>
This command is used to remove a public ip from a node during runtime.
If this public ip is currently hosted by the node it being removed from, the ip will first be failed over to another node, if possible, before it is removed.
</p><p>
Note that this only updates the runtime instance of ctdb. Any changes will be lost next time ctdb is restarted and the public addresses file is re-read.
If you want this change to be permanent you must also update the public addresses file manually.
</p></div><div class="refsect2" title="moveip &lt;public_ip&gt; &lt;node&gt;"><a name="idp127408"></a><h3>moveip &lt;public_ip&gt; &lt;node&gt;</h3><p>
This command can be used to manually fail a public ip address to a
specific node.
</p><p>
In order to manually override the "automatic" distribution of public
ip addresses that ctdb normally provides, this command only works
when you have changed the tunables for the daemon to:
</p><p>
DeterministicIPs = 0
</p><p>
NoIPFailback = 1
</p></div><div class="refsect2" title="shutdown"><a name="idp128960"></a><h3>shutdown</h3><p>
This command will shutdown a specific CTDB daemon.
</p></div><div class="refsect2" title="recover"><a name="idp129560"></a><h3>recover</h3><p>
This command will trigger the recovery daemon to do a cluster
recovery.
</p></div><div class="refsect2" title="ipreallocate"><a name="idp130192"></a><h3>ipreallocate</h3><p>
This command will force the recovery master to perform a full ip reallocation process and redistribute all ip addresses. This is useful to "reset" the allocations back to its default state if they have been changed using the "moveip" command. While a "recover" will also perform this reallocation, a recovery is much more hevyweight since it will also rebuild all the databases.
</p></div><div class="refsect2" title="setlmasterrole &lt;on|off&gt;"><a name="idp131128"></a><h3>setlmasterrole &lt;on|off&gt;</h3><p>
This command is used ot enable/disable the LMASTER capability for a node at runtime. This capability determines whether or not a node can be used as an LMASTER for records in the database. A node that does not have the LMASTER capability will not show up in the vnnmap.
</p><p>
Nodes will by default have this capability, but it can be stripped off nodes by the setting in the sysconfig file or by using this command.
</p><p>
Once this setting has been enabled/disabled, you need to perform a recovery for it to take effect.
</p><p>
See also "ctdb getcapabilities"
</p></div><div class="refsect2" title="setrecmasterrole &lt;on|off&gt;"><a name="idp132864"></a><h3>setrecmasterrole &lt;on|off&gt;</h3><p>
This command is used ot enable/disable the RECMASTER capability for a node at runtime. This capability determines whether or not a node can be used as an RECMASTER for the cluster. A node that does not have the RECMASTER capability can not win a recmaster election. A node that already is the recmaster for the cluster when the capability is stripped off the node will remain the recmaster until the next cluster election.
</p><p>
Nodes will by default have this capability, but it can be stripped off nodes by the setting in the sysconfig file or by using this command.
</p><p>
See also "ctdb getcapabilities"
</p></div><div class="refsect2" title="killtcp &lt;srcip:port&gt; &lt;dstip:port&gt;"><a name="idp134456"></a><h3>killtcp &lt;srcip:port&gt; &lt;dstip:port&gt;</h3><p>
This command will kill the specified TCP connection by issuing a
TCP RST to the srcip:port endpoint. This is a command used by the
ctdb eventscripts.
</p></div><div class="refsect2" title="gratiousarp &lt;ip&gt; &lt;interface&gt;"><a name="idp135200"></a><h3>gratiousarp &lt;ip&gt; &lt;interface&gt;</h3><p>
This command will send out a gratious arp for the specified interface
through the specified interface. This command is mainly used by the
ctdb eventscripts.
</p></div><div class="refsect2" title="reloadnodes"><a name="idp135952"></a><h3>reloadnodes</h3><p>
This command is used when adding new nodes, or removing existing nodes from an existing cluster.
</p><p>
Procedure to add a node:
</p><p>
1, To expand an existing cluster, first ensure with 'ctdb status' that
all nodes are up and running and that they are all healthy.
Do not try to expand a cluster unless it is completely healthy!
</p><p>
2, On all nodes, edit /etc/ctdb/nodes and add the new node as the last
entry to the file. The new node MUST be added to the end of this file!
</p><p>
3, Verify that all the nodes have identical /etc/ctdb/nodes files after you edited them and added the new node!
</p><p>
4, Run 'ctdb reloadnodes' to force all nodes to reload the nodesfile.
</p><p>
5, Use 'ctdb status' on all nodes and verify that they now show the additional node.
</p><p>
6, Install and configure the new node and bring it online.
</p><p>
Procedure to remove a node:
</p><p>
1, To remove a node from an existing cluster, first ensure with 'ctdb status' that
all nodes, except the node to be deleted, are up and running and that they are all healthy.
Do not try to remove a node from a cluster unless the cluster is completely healthy!
</p><p>
2, Shutdown and poweroff the node to be removed.
</p><p>
3, On all other nodes, edit the /etc/ctdb/nodes file and comment out the node to be removed. Do not delete the line for that node, just comment it out by adding a '#' at the beginning of the line.
</p><p>
4, Run 'ctdb reloadnodes' to force all nodes to reload the nodesfile.
</p><p>
5, Use 'ctdb status' on all nodes and verify that the deleted node no longer shows up in the list..
</p><p>
</p></div><div class="refsect2" title="reloadips"><a name="idp141008"></a><h3>reloadips</h3><p>
This command is used to reload the public addresses file and update the
ip configuration of the running daemon.
</p><p>
Procedure to update the public address configuration on a single node:
</p><p>
1, Update the /etc/ctdb/public_addresses file on the node
</p><p>
2, Run 'ctdb reloadips' on the node.
</p><p>
The file will then be reloaded on the node and addresses will be added
or removed as required to match the newly loaded file. When updating
a single node it may take a little while before any newly added
addresses are failed onto the node.
</p><p>
</p><p>
Procedure to update the public address configuration on whole cluster:
</p><p>
1, Update the /etc/ctdb/public_addresses file on all nodes
</p><p>
2, Run 'ctdb reloadips -n all'.
</p><p>
This command will then force all nodes to reload and update the
addresses. This process is controlled and synchronized by the recovery
master to ensure that all addresses are added to all nodes as one
single operation, after which any required ip node rebalancing may
may take place.
</p></div><div class="refsect2" title="tickle &lt;srcip:port&gt; &lt;dstip:port&gt;"><a name="idp3295016"></a><h3>tickle &lt;srcip:port&gt; &lt;dstip:port&gt;</h3><p>
This command will will send a TCP tickle to the source host for the
specified TCP connection.
A TCP tickle is a TCP ACK packet with an invalid sequence and
acknowledge number and will when received by the source host result
in it sending an immediate correct ACK back to the other end.
</p><p>
TCP tickles are useful to "tickle" clients after a IP failover has
occured since this will make the client immediately recognize the
TCP connection has been disrupted and that the client will need
to reestablish. This greatly speeds up the time it takes for a client
to detect and reestablish after an IP failover in the ctdb cluster.
</p></div><div class="refsect2" title="gettickles &lt;ip&gt;"><a name="idp3296504"></a><h3>gettickles &lt;ip&gt;</h3><p>
This command is used to show which TCP connections are registered with
CTDB to be "tickled" if there is a failover.
</p></div><div class="refsect2" title="repack [max_freelist]"><a name="idp3297152"></a><h3>repack [max_freelist]</h3><p>
Over time, when records are created and deleted in a TDB, the TDB list of free space will become fragmented. This can lead to a slowdown in accessing TDB records.
This command is used to defragment a TDB database and pruning the freelist.
</p><p>
If [max_freelist] is specified, then a database will only be repacked if it has more than this number of entries in the freelist.
</p><p>
During repacking of the database, the entire TDB database will be locked to prevent writes. If samba tries to write to a record in the database during a repack operation, samba will block until the repacking has completed.
</p><p>
This command can be disruptive and can cause samba to block for the duration of the repack operation. In general, a repack operation will take less than one second to complete.
</p><p>
A repack operation will only defragment the local TDB copy of the CTDB database. You need to run this command on all of the nodes to repack a CTDB database completely.
</p><p>
Example: ctdb repack 1000
</p><p>
By default, this operation is issued from the 00.ctdb event script every 5 minutes.
</p></div><div class="refsect2" title="vacuum [max_records]"><a name="idp3299928"></a><h3>vacuum [max_records]</h3><p>
Over time CTDB databases will fill up with empty deleted records which will lead to a progressive slow down of CTDB database access.
This command is used to prune all databases and delete all empty records from the cluster.
</p><p>
By default, vacuum will delete all empty records from all databases.
If [max_records] is specified, the command will only delete the first
[max_records] empty records for each database.
</p><p>
Vacuum only deletes records where the local node is the lmaster.
To delete all records from the entire cluster you need to run a vacuum from each node.
This command is not disruptive. Samba is unaffected and will still be able to read/write records normally while the database is being vacuumed.
</p><p>
Example: ctdb vacuum
</p><p>
By default, this operation is issued from the 00.ctdb event script every 5 minutes.
</p></div><div class="refsect2" title="backupdb &lt;dbname&gt; &lt;file&gt;"><a name="idp3302120"></a><h3>backupdb &lt;dbname&gt; &lt;file&gt;</h3><p>
This command can be used to copy the entire content of a database out to a file. This file can later be read back into ctdb using the restoredb command.
This is mainly useful for backing up persistent databases such as secrets.tdb and similar.
</p></div><div class="refsect2" title="restoredb &lt;file&gt; [&lt;dbname&gt;]"><a name="idp3302952"></a><h3>restoredb &lt;file&gt; [&lt;dbname&gt;]</h3><p>
This command restores a persistent database that was previously backed up using backupdb.
By default the data will be restored back into the same database as
it was created from. By specifying dbname you can restore the data
into a different database.
</p></div><div class="refsect2" title="wipedb &lt;dbname&gt;"><a name="idp3303808"></a><h3>wipedb &lt;dbname&gt;</h3><p>
This command can be used to remove all content of a database.
</p></div></div><div class="refsect2" title="getlog [&lt;level&gt;] [recoverd]"><a name="idp3304472"></a><h3>getlog [&lt;level&gt;] [recoverd]</h3><p>
In addition to the normal logging to a log file,
CTDBD also keeps a in-memory ringbuffer containing the most recent
log entries for all log levels (except DEBUG).
</p><p>
This is useful since it allows for keeping continuous logs to a file
at a reasonable non-verbose level, but shortly after an incident has
occured, a much more detailed log can be pulled from memory. This
can allow you to avoid having to reproduce an issue due to the
on-disk logs being of insufficient detail.
</p><p>
This command extracts all messages of level or lower log level
from memory and prints it to the screen. The level is not
specified it defaults to NOTICE.
</p><p>
By default, logs are extracted from the main CTDB daemon. If
the recoverd option is given then logs are extracted from the
recovery daemon.
</p></div><div class="refsect2" title="clearlog [recoverd]"><a name="idp3306480"></a><h3>clearlog [recoverd]</h3><p>
This command clears the in-memory logging ringbuffer.
</p><p>
By default, logs are cleared in the main CTDB daemon. If the
recoverd option is given then logs are cleared in the recovery
daemon.
</p></div><div class="refsect2" title="setdbreadonly &lt;dbname|hash&gt;"><a name="idp3307408"></a><h3>setdbreadonly &lt;dbname|hash&gt;</h3><p>
This command will enable the ReadOnly record support for a database.
This is an experimental feature to improve performance for contended
records primarily in locking.tdb and brlock.tdb.
When enabling this feature you must set it on all nodes in the cluster.
For now, this feature requires a special patch to samba in order to
use it.
</p></div><div class="refsect1" title="Debugging Commands"><a name="idp3308328"></a><h2>Debugging Commands</h2><p>
These commands are primarily used for CTDB development and testing and
should not be used for normal administration.
</p><div class="refsect2" title="process-exists &lt;pid&gt;"><a name="idp3308920"></a><h3>process-exists &lt;pid&gt;</h3><p>
This command checks if a specific process exists on the CTDB host. This is mainly used by Samba to check if remote instances of samba are still running or not.
</p></div><div class="refsect2" title="getdbmap"><a name="idp3309656"></a><h3>getdbmap</h3><p>
This command lists all clustered TDB databases that the CTDB daemon has attached to. Some databases are flagged as PERSISTENT, this means that the database stores data persistently and the data will remain across reboots. One example of such a database is secrets.tdb where information about how the cluster was joined to the domain is stored.
</p><p>
If a PERSISTENT database is not in a healthy state the database is
flagged as UNHEALTHY. If there's at least one completely healthy node running in
the cluster, it's possible that the content is restored by a recovery
run automaticly. Otherwise an administrator needs to analyze the
problem.
</p><p>
See also "ctdb getdbstatus", "ctdb backupdb", "ctdb restoredb",
"ctdb dumpbackup", "ctdb wipedb", "ctdb setvar AllowUnhealthyDBRead 1"
and (if samba or tdb-utils are installed) "tdbtool check".
</p><p>
Most databases are not persistent and only store the state information that the currently running samba daemons need. These databases are always wiped when ctdb/samba starts and when a node is rebooted.
</p><p>
Example: ctdb getdbmap
</p><p>
Example output:
</p><pre class="screen">
Number of databases:10
dbid:0x435d3410 name:notify.tdb path:/var/ctdb/notify.tdb.0
dbid:0x42fe72c5 name:locking.tdb path:/var/ctdb/locking.tdb.0
dbid:0x1421fb78 name:brlock.tdb path:/var/ctdb/brlock.tdb.0
dbid:0x17055d90 name:connections.tdb path:/var/ctdb/connections.tdb.0
dbid:0xc0bdde6a name:sessionid.tdb path:/var/ctdb/sessionid.tdb.0
dbid:0x122224da name:test.tdb path:/var/ctdb/test.tdb.0
dbid:0x2672a57f name:idmap2.tdb path:/var/ctdb/persistent/idmap2.tdb.0 PERSISTENT
dbid:0xb775fff6 name:secrets.tdb path:/var/ctdb/persistent/secrets.tdb.0 PERSISTENT
dbid:0xe98e08b6 name:group_mapping.tdb path:/var/ctdb/persistent/group_mapping.tdb.0 PERSISTENT
dbid:0x7bbbd26c name:passdb.tdb path:/var/ctdb/persistent/passdb.tdb.0 PERSISTENT
</pre><p>
Example output for an unhealthy database:
</p><pre class="screen">
Number of databases:1
dbid:0xb775fff6 name:secrets.tdb path:/var/ctdb/persistent/secrets.tdb.0 PERSISTENT UNHEALTHY
</pre><p>
Example output for a healthy database as machinereadable output -Y:
</p><pre class="screen">
:ID:Name:Path:Persistent:Unhealthy:
:0x7bbbd26c:passdb.tdb:/var/ctdb/persistent/passdb.tdb.0:1:0:
</pre></div><div class="refsect2" title="getdbstatus &lt;dbname&gt;"><a name="idp3314736"></a><h3>getdbstatus &lt;dbname&gt;</h3><p>
This command displays more details about a database.
</p><p>
Example: ctdb getdbstatus test.tdb.0
</p><p>
Example output:
</p><pre class="screen">
dbid: 0x122224da
name: test.tdb
path: /var/ctdb/test.tdb.0
PERSISTENT: no
HEALTH: OK
</pre><p>
Example: ctdb getdbstatus registry.tdb (with a corrupted TDB)
</p><p>
Example output:
</p><pre class="screen">
dbid: 0xf2a58948
name: registry.tdb
path: /var/ctdb/persistent/registry.tdb.0
PERSISTENT: yes
HEALTH: NO-HEALTHY-NODES - ERROR - Backup of corrupted TDB in '/var/ctdb/persistent/registry.tdb.0.corrupted.20091208091949.0Z'
</pre></div><div class="refsect2" title="catdb &lt;dbname&gt;"><a name="idp3317192"></a><h3>catdb &lt;dbname&gt;</h3><p>
This command will dump a clustered TDB database to the screen. This is a debugging command.
</p></div><div class="refsect2" title="cattdb &lt;dbname&gt;"><a name="idp3317816"></a><h3>cattdb &lt;dbname&gt;</h3><p>
This command will dump the content of the local TDB database to the screen. This is a debugging command.
</p></div><div class="refsect2" title="dumpdbbackup &lt;backup-file&gt;"><a name="idp3318456"></a><h3>dumpdbbackup &lt;backup-file&gt;</h3><p>
This command will dump the content of database backup to the screen
(similar to ctdb catdb). This is a debugging command.
</p></div><div class="refsect2" title="getmonmode"><a name="idp3319144"></a><h3>getmonmode</h3><p>
This command returns the monutoring mode of a node. The monitoring mode is either ACTIVE or DISABLED. Normally a node will continuously monitor that all other nodes that are expected are in fact connected and that they respond to commands.
</p><p>
ACTIVE - This is the normal mode. The node is actively monitoring all other nodes, both that the transport is connected and also that the node responds to commands. If a node becomes unavailable, it will be marked as DISCONNECTED and a recovery is initiated to restore the cluster.
</p><p>
DISABLED - This node is not monitoring that other nodes are available. In this mode a node failure will not be detected and no recovery will be performed. This mode is useful when for debugging purposes one wants to attach GDB to a ctdb process but wants to prevent the rest of the cluster from marking this node as DISCONNECTED and do a recovery.
</p></div><div class="refsect2" title="setmonmode &lt;0|1&gt;"><a name="idp3320976"></a><h3>setmonmode &lt;0|1&gt;</h3><p>
This command can be used to explicitly disable/enable monitoring mode on a node. The main purpose is if one wants to attach GDB to a running ctdb daemon but wants to prevent the other nodes from marking it as DISCONNECTED and issuing a recovery. To do this, set monitoring mode to 0 on all nodes before attaching with GDB. Remember to set monitoring mode back to 1 afterwards.
</p></div><div class="refsect2" title="attach &lt;dbname&gt; [persistent]"><a name="idp3321888"></a><h3>attach &lt;dbname&gt; [persistent]</h3><p>
This is a debugging command. This command will make the CTDB daemon create a new CTDB database and attach to it.
</p></div><div class="refsect2" title="dumpmemory"><a name="idp3322608"></a><h3>dumpmemory</h3><p>
This is a debugging command. This command will make the ctdb
daemon to write a fill memory allocation map to standard output.
</p></div><div class="refsect2" title="rddumpmemory"><a name="idp3323280"></a><h3>rddumpmemory</h3><p>
This is a debugging command. This command will dump the talloc memory
allocation tree for the recovery daemon to standard output.
</p></div><div class="refsect2" title="thaw"><a name="idp3323944"></a><h3>thaw</h3><p>
Thaw a previously frozen node.
</p></div><div class="refsect2" title="eventscript &lt;arguments&gt;"><a name="idp3324512"></a><h3>eventscript &lt;arguments&gt;</h3><p>
This is a debugging command. This command can be used to manually
invoke and run the eventscritps with arbitrary arguments.
</p></div><div class="refsect2" title="ban &lt;bantime|0&gt;"><a name="idp3325176"></a><h3>ban &lt;bantime|0&gt;</h3><p>
Administratively ban a node for bantime seconds. A bantime of 0 means that the node should be permanently banned.
</p><p>
A banned node does not participate in the cluster and does not host any records for the clustered TDB. Its ip address has been taken over by another node and no services are hosted.
</p><p>
Nodes are automatically banned if they are the cause of too many
cluster recoveries.
</p><p>
This is primarily a testing command. Note that the recovery daemon controls the overall ban state and it may automatically unban nodes at will. Meaning that a node that has been banned by the administrator can and ofter are unbanned before the admin specifid timeout triggers. If wanting to "drop" a node out from the cluster for mainentance or other reasons, use the "stop" / "continue" commands instad of "ban" / "unban".
</p></div><div class="refsect2" title="unban"><a name="idp3327216"></a><h3>unban</h3><p>
This command is used to unban a node that has either been
administratively banned using the ban command or has been automatically
banned by the recovery daemon.
</p></div><div class="refsect2" title="check_srvids &lt;srvid&gt; ..."><a name="idp3327928"></a><h3>check_srvids &lt;srvid&gt; ...</h3><p>
This command checks whether a set of srvid message ports are registered on the
node or not. The command takes a list of values to check.
</p><p>
Example: ctdb check_srvids 1 2 3 14765
</p><p>
Example output:
</p><pre class="screen">
Server id 0:1 does not exist
Server id 0:2 does not exist
Server id 0:3 does not exist
Server id 0:14765 exists
</pre></div></div><div class="refsect1" title="SEE ALSO"><a name="idp3329576"></a><h2>SEE ALSO</h2><p>
ctdbd(1), onnode(1)
<a class="ulink" href="http://ctdb.samba.org/" target="_top">http://ctdb.samba.org/</a>
</p></div><div class="refsect1" title="COPYRIGHT/LICENSE"><a name="idp3330376"></a><h2>COPYRIGHT/LICENSE</h2><div class="literallayout"><p><br>
Copyright (C) Andrew Tridgell 2007<br>
Copyright (C) Ronnie sahlberg 2007<br>
<br>
This program is free software; you can redistribute it and/or modify<br>
it under the terms of the GNU General Public License as published by<br>
the Free Software Foundation; either version 3 of the License, or (at<br>
your option) any later version.<br>
<br>
This program is distributed in the hope that it will be useful, but<br>
WITHOUT ANY WARRANTY; without even the implied warranty of<br>
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU<br>
General Public License for more details.<br>
<br>
You should have received a copy of the GNU General Public License<br>
along with this program; if not, see http://www.gnu.org/licenses/.<br>
</p></div></div></div></body></html>

1117
ctdb/doc/ctdbd.1
View File

File diff suppressed because it is too large Load Diff

995
ctdb/doc/ctdbd.1.html
View File

@ -1,995 +0,0 @@
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>ctdbd</title><meta name="generator" content="DocBook XSL Stylesheets V1.76.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" title="ctdbd"><a name="ctdbd.1"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>ctdbd &#8212; The CTDB cluster daemon</p></div><div class="refsynopsisdiv" title="Synopsis"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">ctdbd</code> </p></div><div class="cmdsynopsis"><p><code class="command">ctdbd</code> [-? --help] [-d --debug=&lt;INTEGER&gt;] {--dbdir=&lt;directory&gt;} {--dbdir-persistent=&lt;directory&gt;} [--event-script-dir=&lt;directory&gt;] [-i --interactive] [--listen=&lt;address&gt;] [--logfile=&lt;filename&gt;] [--lvs] {--nlist=&lt;filename&gt;} [--no-lmaster] [--no-recmaster] [--nosetsched] {--notification-script=&lt;filename&gt;} [--public-addresses=&lt;filename&gt;] [--public-interface=&lt;interface&gt;] {--reclock=&lt;filename&gt;} [--single-public-ip=&lt;address&gt;] [--socket=&lt;filename&gt;] [--start-as-disabled] [--start-as-stopped] [--syslog] [--log-ringbuf-size=&lt;num-entries&gt;] [--torture] [--transport=&lt;STRING&gt;] [--usage]</p></div></div><div class="refsect1" title="DESCRIPTION"><a name="idp129984"></a><h2>DESCRIPTION</h2><p>
ctdbd is the main ctdb daemon.
</p><p>
ctdbd provides a clustered version of the TDB database with automatic rebuild/recovery of the databases upon nodefailures.
</p><p>
Combined with a cluster filesystem ctdbd provides a full HA environment for services such as clustered Samba and NFS as well as other services.
</p><p>
ctdbd provides monitoring of all nodes in the cluster and automatically reconfigures the cluster and recovers upon node failures.
</p><p>
ctdbd is the main component in clustered Samba that provides a high-availability load-sharing CIFS server cluster.
</p></div><div class="refsect1" title="OPTIONS"><a name="idp133296"></a><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">-? --help</span></dt><dd><p>
Print some help text to the screen.
</p></dd><dt><span class="term">-d --debug=&lt;DEBUGLEVEL&gt;</span></dt><dd><p>
This option sets the debuglevel on the ctdbd daemon which controls what will be written to the logfile. The default is 0 which will only log important events and errors. A larger number will provide additional logging.
</p></dd><dt><span class="term">--dbdir=&lt;directory&gt;</span></dt><dd><p>
This is the directory on local storage where ctdbd keeps the local
copy of the TDB databases. This directory is local for each node and should not be stored on the shared cluster filesystem.
</p><p>
This directory would usually be /var/ctdb .
</p></dd><dt><span class="term">--dbdir-persistent=&lt;directory&gt;</span></dt><dd><p>
This is the directory on local storage where ctdbd keeps the local
copy of the persistent TDB databases. This directory is local for each node and should not be stored on the shared cluster filesystem.
</p><p>
This directory would usually be /etc/ctdb/persistent .
</p></dd><dt><span class="term">--event-script-dir=&lt;directory&gt;</span></dt><dd><p>
This option is used to specify the directory where the CTDB event
scripts are stored.
</p><p>
This will normally be /etc/ctdb/events.d which is part of the ctdb distribution.
</p></dd><dt><span class="term">-i --interactive</span></dt><dd><p>
By default ctdbd will detach itself from the shell and run in
the background as a daemon. This option makes ctdbd to start in interactive mode.
</p></dd><dt><span class="term">--listen=&lt;address&gt;</span></dt><dd><p>
This specifies which ip address ctdb will bind to. By default ctdbd will bind to the first address it finds in the /etc/ctdb/nodes file and which is also present on the local system in which case you do not need to provide this option.
</p><p>
This option is only required when you want to run multiple ctdbd daemons/nodes on the same physical host in which case there would be multiple entries in /etc/ctdb/nodes what would match a local interface.
</p></dd><dt><span class="term">--logfile=&lt;filename&gt;</span></dt><dd><p>
This is the file where ctdbd will write its log. This is usually /var/log/log.ctdb .
</p></dd><dt><span class="term">--lvs</span></dt><dd><p>
This option is used to activate the LVS capability on a CTDB node.
Please see the LVS section.
</p></dd><dt><span class="term">--nlist=&lt;filename&gt;</span></dt><dd><p>
This file contains a list of the private ip addresses of every node in the cluster. There is one line/ip address for each node. This file must be the same for all nodes in the cluster.
</p><p>
This file is usually /etc/ctdb/nodes .
</p></dd><dt><span class="term">--no-lmaster</span></dt><dd><p>
This argument specifies that this node can NOT become an lmaster
for records in the database. This means that it will never show up
in the vnnmap. This feature is primarily used for making a cluster
span across a WAN link and use CTDB as a WAN-accelerator.
</p><p>
Please see the "remote cluster nodes" section for more information.
</p></dd><dt><span class="term">--no-recmaster</span></dt><dd><p>
This argument specifies that this node can NOT become a recmaster
for the database. This feature is primarily used for making a cluster
span across a WAN link and use CTDB as a WAN-accelerator.
</p><p>
Please see the "remote cluster nodes" section for more information.
</p></dd><dt><span class="term">--nosetsched</span></dt><dd><p>
This is a ctdbd debugging option. this option is only used when
debugging ctdbd.
</p><p>
Normally ctdb will change its scheduler to run as a real-time
process. This is the default mode for a normal ctdbd operation
to gurarantee that ctdbd always gets the cpu cycles that it needs.
</p><p>
This option is used to tell ctdbd to NOT run as a real-time process
and instead run ctdbd as a normal userspace process.
This is useful for debugging and when you want to run ctdbd under
valgrind or gdb. (You don't want to attach valgrind or gdb to a
real-time process.)
</p></dd><dt><span class="term">--notification-script=&lt;filename&gt;</span></dt><dd><p>
This specifies a script which will be invoked by ctdb when certain
state changes occur in ctdbd and when you may want to trigger this
to run certain scripts.
</p><p>
This file is usually /etc/ctdb/notify.sh .
</p><p>
See the NOTIFICATION SCRIPT section below for more information.
</p></dd><dt><span class="term">--public_addresses=&lt;filename&gt;</span></dt><dd><p>
When used with IP takeover this specifies a file containing the public ip addresses to use on the cluster. This file contains a list of ip addresses netmasks and interfaces. When ctdb is operational it will distribute these public ip addresses evenly across the available nodes.
</p><p>
This is usually the file /etc/ctdb/public_addresses
</p></dd><dt><span class="term">--public-interface=&lt;interface&gt;</span></dt><dd><p>
This option tells ctdb which interface to attach public-addresses
to and also where to attach the single-public-ip when used.
</p><p>
This is only required when using public ip addresses and only when
you don't specify the interface explicitly in /etc/ctdb/public_addresses or when you are using --single-public-ip.
</p><p>
If you omit this argument when using public addresses or single public ip, ctdb will not be able to send out Gratious ARPs correctly or be able to kill tcp connections correctly which will lead to application failures.
</p></dd><dt><span class="term">--reclock=&lt;filename&gt;</span></dt><dd><p>
This is the name of the lock file stored of the shared cluster filesystem that ctdbd uses to prevent split brains from occuring.
This file must be stored on shared storage.
</p><p>
It is possible to run CTDB without a reclock file, but then there
will be no protection against split brain if the network becomes
partitioned. Using CTDB without a reclock file is strongly
discouraged.
</p></dd><dt><span class="term">--socket=&lt;filename&gt;</span></dt><dd><p>
This specifies the name of the domain socket that ctdbd will create. This socket is used for local clients to attach to and communicate with the ctdbd daemon.
</p><p>
The default is /tmp/ctdb.socket . You only need to use this option if you plan to run multiple ctdbd daemons on the same physical host.
</p></dd><dt><span class="term">--start-as-disabled</span></dt><dd><p>
This makes the ctdb daemon to be DISABLED when it starts up.
</p><p>
As it is DISABLED it will not get any of the public ip addresses
allocated to it, and thus this allow you to start ctdb on a node
without causing any ip address to failover from other nodes onto
the new node.
</p><p>
When used, the administrator must keep track of when nodes start and
manually enable them again using the "ctdb enable" command, or else
the node will not host any services.
</p><p>
A node that is DISABLED will not host any services and will not be
reachable/used by any clients.
</p></dd><dt><span class="term">--start-as-stopped</span></dt><dd><p>
This makes the ctdb daemon to be STOPPED when it starts up.
</p><p>
A node that is STOPPED does not host any public addresses. It is not part of the VNNMAP so it does act as an LMASTER. It also has all databases locked in recovery mode until restarted.
</p><p>
To restart and activate a STOPPED node, the command "ctdb continue" is used.
</p><p>
A node that is STOPPED will not host any services and will not be
reachable/used by any clients.
</p></dd><dt><span class="term">--syslog</span></dt><dd><p>
Send all log messages to syslog instead of to the ctdb logfile.
</p></dd><dt><span class="term">--log-ringbuf-size=&lt;num-entries&gt;</span></dt><dd><p>
In addition to the normal loggign to a log file,
CTDBD also keeps a in-memory ringbuffer containing the most recent
log entries for all log levels (except DEBUG).
</p><p>
This is useful since it allows for keeping continuous logs to a file
at a reasonable non-verbose level, but shortly after an incident has
occured, a much more detailed log can be pulled from memory. This
can allow you to avoid having to reproduce an issue due to the
on-disk logs being of insufficient detail.
</p><p>
This in-memory ringbuffer contains a fixed number of the most recent
entries. This is settable at startup either through the
--log-ringbuf-size argument, or preferably by using
CTDB_LOG_RINGBUF_SIZE in the sysconfig file.
</p><p>
Use the "ctdb getlog" command to access this log.
</p></dd><dt><span class="term">--torture</span></dt><dd><p>
This option is only used for development and testing of ctdbd. It adds artificial errors and failures to the common codepaths in ctdbd to verify that ctdbd can recover correctly for failures.
</p><p>
You do NOT want to use this option unless you are developing and testing new functionality in ctdbd.
</p></dd><dt><span class="term">--transport=&lt;STRING&gt;</span></dt><dd><p>
This option specifies which transport to use for ctdbd internode communications. The default is "tcp".
</p><p>
Currently only "tcp" is supported but "infiniband" might be
implemented in the future.
</p></dd><dt><span class="term">--usage</span></dt><dd><p>
Print useage information to the screen.
</p></dd></dl></div></div><div class="refsect1" title="Private vs Public addresses"><a name="idp4952544"></a><h2>Private vs Public addresses</h2><p>
When used for ip takeover in a HA environment, each node in a ctdb
cluster has multiple ip addresses assigned to it. One private and one or more public.
</p><div class="refsect2" title="Private address"><a name="idp4953632"></a><h3>Private address</h3><p>
This is the physical ip address of the node which is configured in
linux and attached to a physical interface. This address uniquely
identifies a physical node in the cluster and is the ip addresses
that ctdbd will use to communicate with the ctdbd daemons on the
other nodes in the cluster.
</p><p>
The private addresses are configured in /etc/ctdb/nodes
(unless the --nlist option is used) and contain one line for each
node in the cluster. Each line contains the private ip address for one
node in the cluster. This file must be the same on all nodes in the
cluster.
</p><p>
Since the private addresses are only available to the network when the
corresponding node is up and running you should not use these addresses
for clients to connect to services provided by the cluster. Instead
client applications should only attach to the public addresses since
these are guaranteed to always be available.
</p><p>
When using ip takeover, it is strongly recommended that the private
addresses are configured on a private network physically separated
from the rest of the network and that this private network is dedicated
to CTDB traffic.
</p>
Example /etc/ctdb/nodes for a four node cluster:
<pre class="screen">
10.1.1.1
10.1.1.2
10.1.1.3
10.1.1.4
</pre></div><div class="refsect2" title="Public address"><a name="idp4957936"></a><h3>Public address</h3><p>
A public address on the other hand is not attached to an interface.
This address is managed by ctdbd itself and is attached/detached to
a physical node at runtime.
</p><p>
The ctdb cluster will assign/reassign these public addresses across the
available healthy nodes in the cluster. When one node fails, its public address
will be migrated to and taken over by a different node in the cluster
to ensure that all public addresses are always available to clients as
long as there are still nodes available capable of hosting this address.
</p><p>
These addresses are not physically attached to a specific node.
The 'ctdb ip' command can be used to view the current assignment of
public addresses and which physical node is currently serving it.
</p><p>
On each node this file contains a list of the public addresses that
this node is capable of hosting.
The list also contain the netmask and the
interface where this address should be attached for the case where you
may want to serve data out through multiple different interfaces.
</p>
Example /etc/ctdb/public_addresses for a node that can host 4 public addresses:
<pre class="screen">
11.1.1.1/24 eth0
11.1.1.2/24 eth0
11.1.2.1/24 eth1
11.1.2.2/24 eth1
</pre><p>
In most cases this file would be the same on all nodes in a cluster but
there are exceptions when one may want to use different files
on different nodes.
</p>
Example: 4 nodes partitioned into two subgroups :
<pre class="screen">
Node 0:/etc/ctdb/public_addresses
10.1.1.1/24 eth0
10.1.1.2/24 eth0
Node 1:/etc/ctdb/public_addresses
10.1.1.1/24 eth0
10.1.1.2/24 eth0
Node 2:/etc/ctdb/public_addresses
10.2.1.1/24 eth0
10.2.1.2/24 eth0
Node 3:/etc/ctdb/public_addresses
10.2.1.1/24 eth0
10.2.1.2/24 eth0
</pre><p>
In this example nodes 0 and 1 host two public addresses on the
10.1.1.x network while nodes 2 and 3 host two public addresses for the
10.2.1.x network.
</p><p>
Ip address 10.1.1.1 can be hosted by either of nodes 0 or 1 and will be
available to clients as long as at least one of these two nodes are
available.
If both nodes 0 and node 1 become unavailable 10.1.1.1 also becomes
unavailable. 10.1.1.1 can not be failed over to node 2 or node 3 since
these nodes do not have this ip address listed in their public
addresses file.
</p></div></div><div class="refsect1" title="Node status"><a name="idp4965136"></a><h2>Node status</h2><p>
The current status of each node in the cluster can be viewed by the
'ctdb status' command.
</p><p>
There are five possible states for a node.
</p><p>
OK - This node is fully functional.
</p><p>
DISCONNECTED - This node could not be connected through the network
and is currently not particpating in the cluster. If there is a
public IP address associated with this node it should have been taken
over by a different node. No services are running on this node.
</p><p>
DISABLED - This node has been administratively disabled. This node is
still functional and participates in the CTDB cluster but its IP
addresses have been taken over by a different node and no services are
currently being hosted.
</p><p>
UNHEALTHY - A service provided by this node is malfunctioning and should
be investigated. The CTDB daemon itself is operational and participates
in the cluster. Its public IP address has been taken over by a different
node and no services are currently being hosted. All unhealthy nodes
should be investigated and require an administrative action to rectify.
</p><p>
BANNED - This node failed too many recovery attempts and has been banned
from participating in the cluster for a period of RecoveryBanPeriod
seconds. Any public IP address has been taken over by other nodes. This
node does not provide any services. All banned nodes should be
investigated and require an administrative action to rectify. This node
does not perticipate in the CTDB cluster but can still be communicated
with. I.e. ctdb commands can be sent to it.
</p><p>
STOPPED - A node that is stopped does not host any public ip addresses,
nor is it part of the VNNMAP. A stopped node can not become LVSMASTER,
RECMASTER or NATGW.
This node does not perticipate in the CTDB cluster but can still be
communicated with. I.e. ctdb commands can be sent to it.
</p></div><div class="refsect1" title="PUBLIC TUNABLES"><a name="idp4970848"></a><h2>PUBLIC TUNABLES</h2><p>
These are the public tuneables that can be used to control how ctdb behaves.
</p><div class="refsect2" title="MaxRedirectCount"><a name="idp4971968"></a><h3>MaxRedirectCount</h3><p>Default: 3</p><p>
If we are not the DMASTER and need to fetch a record across the network
we first send the request to the LMASTER after which the record
is passed onto the current DMASTER. If the DMASTER changes before
the request has reached that node, the request will be passed onto the
"next" DMASTER. For very hot records that migrate rapidly across the
cluster this can cause a request to "chase" the record for many hops
before it catches up with the record.
this is how many hops we allow trying to chase the DMASTER before we
switch back to the LMASTER again to ask for new directions.
</p><p>
When chasing a record, this is how many hops we will chase the record
for before going back to the LMASTER to ask for new guidance.
</p></div><div class="refsect2" title="SeqnumInterval"><a name="idp4974560"></a><h3>SeqnumInterval</h3><p>Default: 1000</p><p>
Some databases have seqnum tracking enabled, so that samba will be able
to detect asynchronously when there has been updates to the database.
Everytime a database is updated its sequence number is increased.
</p><p>
This tunable is used to specify in 'ms' how frequently ctdb will
send out updates to remote nodes to inform them that the sequence
number is increased.
</p></div><div class="refsect2" title="ControlTimeout"><a name="idp4976784"></a><h3>ControlTimeout</h3><p>Default: 60</p><p>
This is the default
setting for timeout for when sending a control message to either the
local or a remote ctdb daemon.
</p></div><div class="refsect2" title="TraverseTimeout"><a name="idp4978352"></a><h3>TraverseTimeout</h3><p>Default: 20</p><p>
This setting controls how long we allow a traverse process to run.
After this timeout triggers, the main ctdb daemon will abort the
traverse if it has not yet finished.
</p></div><div class="refsect2" title="KeepaliveInterval"><a name="idp4979968"></a><h3>KeepaliveInterval</h3><p>Default: 5</p><p>
How often in seconds should the nodes send keepalives to eachother.
</p></div><div class="refsect2" title="KeepaliveLimit"><a name="idp4981472"></a><h3>KeepaliveLimit</h3><p>Default: 5</p><p>
After how many keepalive intervals without any traffic should a node
wait until marking the peer as DISCONNECTED.
</p><p>
If a node has hung, it can thus take KeepaliveInterval*(KeepaliveLimit+1)
seconds before we determine that the node is DISCONNECTED and that we
require a recovery. This limitshould not be set too high since we want
a hung node to be detectec, and expunged from the cluster well before
common CIFS timeouts (45-90 seconds) kick in.
</p></div><div class="refsect2" title="RecoverTimeout"><a name="idp4983776"></a><h3>RecoverTimeout</h3><p>Default: 20</p><p>
This is the default setting for timeouts for controls when sent from the
recovery daemon. We allow longer control timeouts from the recovery daemon
than from normal use since the recovery dameon often use controls that
can take a lot longer than normal controls.
</p></div><div class="refsect2" title="RecoverInterval"><a name="idp4985488"></a><h3>RecoverInterval</h3><p>Default: 1</p><p>
How frequently in seconds should the recovery daemon perform the
consistency checks that determine if we need to perform a recovery or not.
</p></div><div class="refsect2" title="ElectionTimeout"><a name="idp4987072"></a><h3>ElectionTimeout</h3><p>Default: 3</p><p>
When electing a new recovery master, this is how many seconds we allow
the election to take before we either deem the election finished
or we fail the election and start a new one.
</p></div><div class="refsect2" title="TakeoverTimeout"><a name="idp4988688"></a><h3>TakeoverTimeout</h3><p>Default: 9</p><p>
This is how many seconds we allow controls to take for IP failover events.
</p></div><div class="refsect2" title="MonitorInterval"><a name="idp4990192"></a><h3>MonitorInterval</h3><p>Default: 15</p><p>
How often should ctdb run the event scripts to check for a nodes health.
</p></div><div class="refsect2" title="TickleUpdateInterval"><a name="idp4991696"></a><h3>TickleUpdateInterval</h3><p>Default: 20</p><p>
How often will ctdb record and store the "tickle" information used to
kickstart stalled tcp connections after a recovery.
</p></div><div class="refsect2" title="EventScriptTimeout"><a name="idp4993248"></a><h3>EventScriptTimeout</h3><p>Default: 20</p><p>
How long should ctdb let an event script run before aborting it and
marking the node unhealthy.
</p></div><div class="refsect2" title="EventScriptTimeoutCount"><a name="idp4994784"></a><h3>EventScriptTimeoutCount</h3><p>Default: 1</p><p>
How many events in a row needs to timeout before we flag the node UNHEALTHY.
This setting is useful if your scripts can not be written so that they
do not hang for benign reasons.
</p></div><div class="refsect2" title="EventScriptUnhealthyOnTimeout"><a name="idp4996400"></a><h3>EventScriptUnhealthyOnTimeout</h3><p>Default: 0</p><p>
This setting can be be used to make ctdb never become UNHEALTHY if your
eventscripts keep hanging/timing out.
</p></div><div class="refsect2" title="RecoveryGracePeriod"><a name="idp4997952"></a><h3>RecoveryGracePeriod</h3><p>Default: 120</p><p>
During recoveries, if a node has not caused recovery failures during the
last grace period, any records of transgressions that the node has caused
recovery failures will be forgiven. This resets the ban-counter back to
zero for that node.
</p></div><div class="refsect2" title="RecoveryBanPeriod"><a name="idp4999632"></a><h3>RecoveryBanPeriod</h3><p>Default: 300</p><p>
If a node becomes banned causing repetitive recovery failures. The node will
eventually become banned from the cluster.
This controls how long the culprit node will be banned from the cluster
before it is allowed to try to join the cluster again.
Don't set to small. A node gets banned for a reason and it is usually due
to real problems with the node.
</p></div><div class="refsect2" title="DatabaseHashSize"><a name="idp5001824"></a><h3>DatabaseHashSize</h3><p>Default: 100001</p><p>
Size of the hash chains for the local store of the tdbs that ctdb manages.
</p></div><div class="refsect2" title="DatabaseMaxDead"><a name="idp5003328"></a><h3>DatabaseMaxDead</h3><p>Default: 5</p><p>
How many dead records per hashchain in the TDB database do we allow before
the freelist needs to be processed.
</p></div><div class="refsect2" title="RerecoveryTimeout"><a name="idp5004880"></a><h3>RerecoveryTimeout</h3><p>Default: 10</p><p>
Once a recovery has completed, no additional recoveries are permitted
until this timeout has expired.
</p></div><div class="refsect2" title="EnableBans"><a name="idp5006416"></a><h3>EnableBans</h3><p>Default: 1</p><p>
When set to 0, this disables BANNING completely in the cluster and thus
nodes can not get banned, even it they break. Don't set to 0 unless you
know what you are doing.
</p></div><div class="refsect2" title="DeterministicIPs"><a name="idp5008032"></a><h3>DeterministicIPs</h3><p>Default: 0</p><p>
When enabled, this tunable makes ctdb try to keep public IP addresses
locked to specific nodes as far as possible. This makes it easier for
debugging since you can know that as long as all nodes are healthy
public IP X will always be hosted by node Y.
</p><p>
The cost of using deterministic IP address assignment is that it
disables part of the logic where ctdb tries to reduce the number of
public IP assignment changes in the cluster. This tunable may increase
the number of IP failover/failbacks that are performed on the cluster
by a small margin.
</p></div><div class="refsect2" title="LCP2PublicIPs"><a name="idp5010448"></a><h3>LCP2PublicIPs</h3><p>Default: 1</p><p>
When enabled this switches ctdb to use the LCP2 ip allocation
algorithm.
</p></div><div class="refsect2" title="ReclockPingPeriod"><a name="idp5011952"></a><h3>ReclockPingPeriod</h3><p>Default: x</p><p>
Obsolete
</p></div><div class="refsect2" title="NoIPFailback"><a name="idp5013360"></a><h3>NoIPFailback</h3><p>Default: 0</p><p>
When set to 1, ctdb will not perform failback of IP addresses when a node
becomes healthy. Ctdb WILL perform failover of public IP addresses when a
node becomes UNHEALTHY, but when the node becomes HEALTHY again, ctdb
will not fail the addresses back.
</p><p>
Use with caution! Normally when a node becomes available to the cluster
ctdb will try to reassign public IP addresses onto the new node as a way
to distribute the workload evenly across the clusternode. Ctdb tries to
make sure that all running nodes have approximately the same number of
public addresses it hosts.
</p><p>
When you enable this tunable, CTDB will no longer attempt to rebalance
the cluster by failing IP addresses back to the new nodes. An unbalanced
cluster will therefore remain unbalanced until there is manual
intervention from the administrator. When this parameter is set, you can
manually fail public IP addresses over to the new node(s) using the
'ctdb moveip' command.
</p></div><div class="refsect2" title="DisableIPFailover"><a name="idp5016592"></a><h3>DisableIPFailover</h3><p>Default: 0</p><p>
When enabled, ctdb will not perform failover or failback. Even if a
node fails while holding public IPs, ctdb will not recover the IPs or
assign them to another node.
</p><p>
When you enable this tunable, CTDB will no longer attempt to recover
the cluster by failing IP addresses over to other nodes. This leads to
a service outage until the administrator has manually performed failover
to replacement nodes using the 'ctdb moveip' command.
</p></div><div class="refsect2" title="NoIPTakeover"><a name="idp5018896"></a><h3>NoIPTakeover</h3><p>Default: 0</p><p>
When set to 1, ctdb will allow ip addresses to be failed over onto this
node. Any ip addresses that the node currently hosts will remain on the
node but no new ip addresses can be failed over onto the node.
</p></div><div class="refsect2" title="NoIPTakeoverOnDisabled"><a name="idp5020544"></a><h3>NoIPTakeoverOnDisabled</h3><p>Default: 0</p><p>
If no nodes are healthy then by default ctdb will happily host
public IPs on disabled (unhealthy or administratively disabled)
nodes. This can cause problems, for example if the underlying
cluster filesystem is not mounted. When set to 1 this behaviour
is switched off and disabled nodes will not be able to takeover
IPs.
</p></div><div class="refsect2" title="DBRecordCountWarn"><a name="idp5022320"></a><h3>DBRecordCountWarn</h3><p>Default: 100000</p><p>
When set to non-zero, ctdb will log a warning when we try to recover a
database with more than this many records. This will produce a warning
if a database grows uncontrollably with orphaned records.
</p></div><div class="refsect2" title="DBRecordSizeWarn"><a name="idp5023968"></a><h3>DBRecordSizeWarn</h3><p>Default: 10000000</p><p>
When set to non-zero, ctdb will log a warning when we try to recover a
database where a single record is bigger than this. This will produce
a warning if a database record grows uncontrollably with orphaned
sub-records.
</p></div><div class="refsect2" title="DBSizeWarn"><a name="idp5025632"></a><h3>DBSizeWarn</h3><p>Default: 1000000000</p><p>
When set to non-zero, ctdb will log a warning when we try to recover a
database bigger than this. This will produce
a warning if a database grows uncontrollably.
</p></div><div class="refsect2" title="VerboseMemoryNames"><a name="idp5027232"></a><h3>VerboseMemoryNames</h3><p>Default: 0</p><p>
This feature consumes additional memory. when used the talloc library
will create more verbose names for all talloc allocated objects.
</p></div><div class="refsect2" title="RecdPingTimeout"><a name="idp5028800"></a><h3>RecdPingTimeout</h3><p>Default: 60</p><p>
If the main dameon has not heard a "ping" from the recovery dameon for
this many seconds, the main dameon will log a message that the recovery
daemon is potentially hung.
</p></div><div class="refsect2" title="RecdFailCount"><a name="idp5030416"></a><h3>RecdFailCount</h3><p>Default: 10</p><p>
If the recovery daemon has failed to ping the main dameon for this many
consecutive intervals, the main daemon will consider the recovery daemon
as hung and will try to restart it to recover.
</p></div><div class="refsect2" title="LogLatencyMs"><a name="idp5032048"></a><h3>LogLatencyMs</h3><p>Default: 0</p><p>
When set to non-zero, this will make the main daemon log any operation that
took longer than this value, in 'ms', to complete.
These include "how long time a lockwait child process needed",
"how long time to write to a persistent database" but also
"how long did it take to get a response to a CALL from a remote node".
</p></div><div class="refsect2" title="RecLockLatencyMs"><a name="idp5033824"></a><h3>RecLockLatencyMs</h3><p>Default: 1000</p><p>
When using a reclock file for split brain prevention, if set to non-zero
this tunable will make the recovery dameon log a message if the fcntl()
call to lock/testlock the recovery file takes longer than this number of
ms.
</p></div><div class="refsect2" title="RecoveryDropAllIPs"><a name="idp5035488"></a><h3>RecoveryDropAllIPs</h3><p>Default: 120</p><p>
If we have been stuck in recovery, or stopped, or banned, mode for
this many seconds we will force drop all held public addresses.
</p></div><div class="refsect2" title="verifyRecoveryLock"><a name="idp5037056"></a><h3>verifyRecoveryLock</h3><p>Default: 1</p><p>
Should we take a fcntl() lock on the reclock file to verify that we are the
sole recovery master node on the cluster or not.
</p></div><div class="refsect2" title="DeferredAttachTO"><a name="idp5038624"></a><h3>DeferredAttachTO</h3><p>Default: 120</p><p>
When databases are frozen we do not allow clients to attach to the
databases. Instead of returning an error immediately to the application
the attach request from the client is deferred until the database
becomes available again at which stage we respond to the client.
</p><p>
This timeout controls how long we will defer the request from the client
before timing it out and returning an error to the client.
</p></div><div class="refsect2" title="HopcountMakeSticky"><a name="idp5040880"></a><h3>HopcountMakeSticky</h3><p>Default: 50</p><p>
If the database is set to 'STICKY' mode, using the 'ctdb setdbsticky'
command, any record that is seen as very hot and migrating so fast that
hopcount surpasses 50 is set to become a STICKY record for StickyDuration
seconds. This means that after each migration the record will be kept on
the node and prevented from being migrated off the node.
</p><p>
This setting allows to try to identify such records and stop them from
migrating across the cluster so fast. This will improve performance for
certain workloads, such as locking.tdb if many clients are opening/closing
the same file concurrently.
</p></div><div class="refsect2" title="StickyDuration"><a name="idp5043344"></a><h3>StickyDuration</h3><p>Default: 600</p><p>
Once a record has been found to be fetch-lock hot and has been flagged to
become STICKY, this is for how long, in seconds, the record will be
flagged as a STICKY record.
</p></div><div class="refsect2" title="StickyPindown"><a name="idp5044960"></a><h3>StickyPindown</h3><p>Default: 200</p><p>
Once a STICKY record has been migrated onto a node, it will be pinned down
on that node for this number of ms. Any request from other nodes to migrate
the record off the node will be deferred until the pindown timer expires.
</p></div><div class="refsect2" title="MaxLACount"><a name="idp5046624"></a><h3>MaxLACount</h3><p>Default: 20</p><p>
When record content is fetched from a remote node, if it is only for
reading the record, pass back the content of the record but do not yet
migrate the record. Once MaxLACount identical requests from the
same remote node have been seen will the record be forcefully migrated
onto the requesting node. This reduces the amount of migration for a
database read-mostly workload at the expense of more frequent network
roundtrips.
</p></div><div class="refsect2" title="StatHistoryInterval"><a name="idp5048512"></a><h3>StatHistoryInterval</h3><p>Default: 1</p><p>
Granularity of the statistics collected in the statistics history.
</p></div><div class="refsect2" title="AllowClientDBAttach"><a name="idp5050016"></a><h3>AllowClientDBAttach</h3><p>Default: 1</p><p>
When set to 0, clients are not allowed to attach to any databases.
This can be used to temporarily block any new processes from attaching
to and accessing the databases.
</p></div><div class="refsect2" title="RecoverPDBBySeqNum"><a name="idp5051632"></a><h3>RecoverPDBBySeqNum</h3><p>Default: 0</p><p>
When set to non-zero, this will change how the recovery process for
persistent databases ar performed. By default, when performing a database
recovery, for normal as for persistent databases, recovery is
record-by-record and recovery process simply collects the most recent
version of every individual record.
</p><p>
When set to non-zero, persistent databases will instead be recovered as
a whole db and not by individual records. The node that contains the
highest value stored in the record "__db_sequence_number__" is selected
and the copy of that nodes database is used as the recovered database.
</p></div><div class="refsect2" title="FetchCollapse"><a name="idp5054096"></a><h3>FetchCollapse</h3><p>Default: 1</p><p>
When many clients across many nodes try to access the same record at the
same time this can lead to a fetch storm where the record becomes very
active and bounces between nodes very fast. This leads to high CPU
utilization of the ctdbd daemon, trying to bounce that record around
very fast, and poor performance.
</p><p>
This parameter is used to activate a fetch-collapse. A fetch-collapse
is when we track which records we have requests in flight so that we only
keep one request in flight from a certain node, even if multiple smbd
processes are attemtping to fetch the record at the same time. This
can improve performance and reduce CPU utilization for certain
workloads.
</p><p>
This timeout controls if we should collapse multiple fetch operations
of the same record into a single request and defer all duplicates or not.
</p></div><div class="refsect2" title="DeadlockTimeout"><a name="idp5057536"></a><h3>DeadlockTimeout</h3><p>Default: 60</p><p>
Number of seconds to determine if ctdb is in deadlock with samba.
</p><p>
When ctdb daemon is blocked waiting for a lock on a database which is
blocked by some other process, ctdb logs a warning every 10 seconds. Most
often this is caused by samba locking databases and waiting on ctdb and
result in a deadlock. If the lock is not obtained by ctdb before deadlock
timeout expires, ctdb will detect it as a deadlock and terminate the
blocking samba process. Setting this value to 0 disables deadlock
detection.
</p></div></div><div class="refsect1" title="LVS"><a name="idp5060032"></a><h2>LVS</h2><p>
LVS is a mode where CTDB presents one single IP address for the entire
cluster. This is an alternative to using public IP addresses and round-robin
DNS to loadbalance clients across the cluster.
</p><p>
This is similar to using a layer-4 loadbalancing switch but with some restrictions.
</p><p>
In this mode the cluster select a set of nodes in the cluster and loadbalance
all client access to the LVS address across this set of nodes. This set of nodes are all LVS capable nodes that are HEALTHY, or if no HEALTHY nodes exists
all LVS capable nodes regardless of health status.
LVS will however never loadbalance traffic to nodes that are BANNED,
STOPPED, DISABLED or DISCONNECTED. The "ctdb lvs" command is used to show
which nodes are currently load-balanced across.
</p><p>
One of the these nodes are elected as the LVSMASTER. This node receives all
traffic from clients coming in to the LVS address and multiplexes it
across the internal network to one of the nodes that LVS is using.
When responding to the client, that node will send the data back
directly to the client, bypassing the LVSMASTER node.
The command "ctdb lvsmaster" will show which node is the current
LVSMASTER.
</p><p>
The path used for a client i/o is thus :
</p><pre class="screen">
(1) Client sends request packet to LVSMASTER
(2) LVSMASTER passes the request on to one node across the internal network.
(3) Selected node processes the request.
(4) Node responds back to client.
</pre><p>
</p><p>
This means that all incoming traffic to the cluster will pass through
one physical node, which limits scalability. You can send more data to the
LVS address that one physical node can multiplex. This means that you
should not use LVS if your I/O pattern is write-intensive since you will be
limited in the available network bandwidth that node can handle.
LVS does work wery well for read-intensive workloads where only smallish
READ requests are going through the LVSMASTER bottleneck and the majority
of the traffic volume (the data in the read replies) goes straight from
the processing node back to the clients. For read-intensive i/o patterns you can acheive very high throughput rates in this mode.
</p><p>
Note: you can use LVS and public addresses at the same time.
</p><div class="refsect2" title="Configuration"><a name="idp5066256"></a><h3>Configuration</h3><p>
To activate LVS on a CTDB node you must specify CTDB_PUBLIC_INTERFACE and
CTDB_LVS_PUBLIC_ADDRESS in /etc/sysconfig/ctdb.
</p><p>
You must also specify the "--lvs" command line argument to ctdbd to activate LVS as a capability of the node. This should be done automatically for you by the /etc/init.d/ctdb script.
</p><p>
Example:
</p><pre class="screen">
CTDB_PUBLIC_INTERFACE=eth0
CTDB_LVS_PUBLIC_IP=10.0.0.237
</pre><p>
</p></div><p>
If you use LVS, you must still have a real/permanent address configured
for the public interface on each node. This address must be routable
and the cluster nodes must be configured so that all traffic back to client
hosts are routed through this interface. This is also required in order
to allow samba/winbind on the node to talk to the domain controller.
(we can not use the lvs IP address to initiate outgoing traffic)
</p><p>
I.e. make sure that you can "ping" both the domain controller and also
all of the clients from the node BEFORE you enable LVS. Also make sure
that when you ping these hosts that the traffic is routed out through the
eth0 interface.
</p></div><div class="refsect1" title="REMOTE CLUSTER NODES"><a name="idp5070736"></a><h2>REMOTE CLUSTER NODES</h2><p>
It is possible to have a CTDB cluster that spans across a WAN link.
For example where you have a CTDB cluster in your datacentre but you also
want to have one additional CTDB node located at a remote branch site.
This is similar to how a WAN accelerator works but with the difference
that while a WAN-accelerator often acts as a Proxy or a MitM, in
the ctdb remote cluster node configuration the Samba instance at the remote site
IS the genuine server, not a proxy and not a MitM, and thus provides 100%
correct CIFS semantics to clients.
</p><p>
See the cluster as one single multihomed samba server where one of
the NICs (the remote node) is very far away.
</p><p>
NOTE: This does require that the cluster filesystem you use can cope
with WAN-link latencies. Not all cluster filesystems can handle
WAN-link latencies! Whether this will provide very good WAN-accelerator
performance or it will perform very poorly depends entirely
on how optimized your cluster filesystem is in handling high latency
for data and metadata operations.
</p><p>
To activate a node as being a remote cluster node you need to set
the following two parameters in /etc/sysconfig/ctdb for the remote node:
</p><pre class="screen">
CTDB_CAPABILITY_LMASTER=no
CTDB_CAPABILITY_RECMASTER=no
</pre><p>
</p><p>
Verify with the command "ctdb getcapabilities" that that node no longer
has the recmaster or the lmaster capabilities.
</p></div><div class="refsect1" title="NAT-GW"><a name="idp5075392"></a><h2>NAT-GW</h2><p>
Sometimes it is desireable to run services on the CTDB node which will
need to originate outgoing traffic to external servers. This might
be contacting NIS servers, LDAP servers etc. etc.
</p><p>
This can sometimes be problematic since there are situations when a
node does not have any public ip addresses assigned. This could
be due to the nobe just being started up and no addresses have been
assigned yet or it could be that the node is UNHEALTHY in which
case all public addresses have been migrated off.
</p><p>
If then the service status of CTDB depends on such services being
able to always being able to originate traffic to external resources
this becomes extra troublesome. The node might be UNHEALTHY because
the service can not be reached, and the service can not be reached
because the node is UNHEALTHY.
</p><p>
There are two ways to solve this problem. The first is by assigning a
static ip address for one public interface on every node which will allow
every node to be able to route traffic to the public network even
if there are no public addresses assigned to the node.
This is the simplest way but it uses up a lot of ip addresses since you
have to assign both static and also public addresses to each node.
</p><div class="refsect2" title="NAT-GW"><a name="idp5078848"></a><h3>NAT-GW</h3><p>
A second way is to use the built in NAT-GW feature in CTDB.
With NAT-GW you assign one public NATGW address for each natgw group.
Each NATGW group is a set of nodes in the cluster that shares the same
NATGW address to talk to the outside world. Normally there would only be
one NATGW group spanning the entire cluster, but in situations where one
ctdb cluster spans multiple physical sites it is useful to have one
NATGW group for each of the two sites.
</p><p>
There can be multiple NATGW groups in one cluster but each node can only
be member of one NATGW group.
</p><p>
In each NATGW group, one of the nodes is designated the NAT Gateway
through which all traffic that is originated by nodes in this group
will be routed through if a public addresses are not available.
</p></div><div class="refsect2" title="Configuration"><a name="idp5081536"></a><h3>Configuration</h3><p>
NAT-GW is configured in /etc/sysconfig/ctdb by setting the following
variables:
</p><pre class="screen">
# NAT-GW configuration
# Some services running on nthe CTDB node may need to originate traffic to
# remote servers before the node is assigned any IP addresses,
# This is problematic since before the node has public addresses the node might
# not be able to route traffic to the public networks.
# One solution is to have static public addresses assigned with routing
# in addition to the public address interfaces, thus guaranteeing that
# a node always can route traffic to the external network.
# This is the most simple solution but it uses up a large number of
# additional ip addresses.
#
# A more complex solution is NAT-GW.
# In this mode we only need one additional ip address for the cluster from
# the exsternal public network.
# One of the nodes in the cluster is elected to be hosting this ip address
# so it can reach the external services. This node is also configured
# to use NAT MASQUERADING for all traffic from the internal private network
# to the external network. This node is the NAT-GW node.
#
# All other nodes are set up with a default rote with a metric of 10 to point
# to the nat-gw node.
#
# The effect of this is that only when a node does not have a public address
# and thus no proper routes to the external world it will instead
# route all packets through the nat-gw node.
#
# CTDB_NATGW_NODES is the list of nodes that belong to this natgw group.
# You can have multiple natgw groups in one cluster but each node
# can only belong to one single natgw group.
#
# CTDB_NATGW_PUBLIC_IP=10.0.0.227/24
# CTDB_NATGW_PUBLIC_IFACE=eth0
# CTDB_NATGW_DEFAULT_GATEWAY=10.0.0.1
# CTDB_NATGW_PRIVATE_NETWORK=10.1.1.0/24
# CTDB_NATGW_NODES=/etc/ctdb/natgw_nodes
#
# Normally any node in the natgw group can act as the natgw master.
# In some configurations you may have special nodes that is a part of the
# cluster/natgw group, but where the node lacks connectivity to the
# public network.
# For these cases, set this variable to make these nodes not able to
# become natgw master.
#
# CTDB_NATGW_SLAVE_ONLY=yes
</pre></div><div class="refsect2" title="CTDB_NATGW_PUBLIC_IP"><a name="idp5085360"></a><h3>CTDB_NATGW_PUBLIC_IP</h3><p>
This is an ip address in the public network that is used for all outgoing
traffic when the public addresses are not assigned.
This address will be assigned to one of the nodes in the cluster which
will masquerade all traffic for the other nodes.
</p><p>
Format of this parameter is IPADDRESS/NETMASK
</p></div><div class="refsect2" title="CTDB_NATGW_PUBLIC_IFACE"><a name="idp5087136"></a><h3>CTDB_NATGW_PUBLIC_IFACE</h3><p>
This is the physical interface where the CTDB_NATGW_PUBLIC_IP will be
assigned to. This should be an interface connected to the public network.
</p><p>
Format of this parameter is INTERFACE
</p></div><div class="refsect2" title="CTDB_NATGW_DEFAULT_GATEWAY"><a name="idp5088720"></a><h3>CTDB_NATGW_DEFAULT_GATEWAY</h3><p>
This is the default gateway to use on the node that is elected to host
the CTDB_NATGW_PUBLIC_IP. This is the default gateway on the public network.
</p><p>
Format of this parameter is IPADDRESS
</p></div><div class="refsect2" title="CTDB_NATGW_PRIVATE_NETWORK"><a name="idp5090304"></a><h3>CTDB_NATGW_PRIVATE_NETWORK</h3><p>
This is the network/netmask used for the interal private network.
</p><p>
Format of this parameter is IPADDRESS/NETMASK
</p></div><div class="refsect2" title="CTDB_NATGW_NODES"><a name="idp5091888"></a><h3>CTDB_NATGW_NODES</h3><p>
This is the list of all nodes that belong to the same NATGW group
as this node. The default is /etc/ctdb/natgw_nodes.
</p></div><div class="refsect2" title="Operation"><a name="idp5093056"></a><h3>Operation</h3><p>
When the NAT-GW functionality is used, one of the nodes is elected
to act as a NAT router for all the other nodes in the group when
they need to originate traffic to the external public network.
</p><p>
The NAT-GW node is assigned the CTDB_NATGW_PUBLIC_IP to the
specified interface and the provided default route. Given that
the NAT-GW mechanism acts as a last resort, its default route is
added with a metric of 10 so that it can coexist with other
configured static routes. The NAT-GW is configured to act as a
router and to masquerade all traffic it receives from the
internal private network and which is destined to the external
network(s).
</p><p>
All other nodes in the group are configured with a default route of
metric 10 pointing to the designated NAT GW node.
</p><p>
This is implemented in the 11.natgw eventscript. Please see the
eventscript for further information.
</p></div><div class="refsect2" title="Removing/Changing NATGW at runtime"><a name="idp5096256"></a><h3>Removing/Changing NATGW at runtime</h3><p>
The following are the procedures to change/remove a NATGW configuration
at runtime, without having to restart ctdbd.
</p><p>
If you want to remove NATGW completely from a node, use these steps:
</p><pre class="screen">
1, Run 'CTDB_BASE=/etc/ctdb /etc/ctdb/events.d/11.natgw removenatgw'
2, Then remove the configuration from /etc/sysconfig/ctdb
</pre><p>
If you want to change the NATGW configuration on a node :
</p><pre class="screen">
1, Run 'CTDB_BASE=/etc/ctdb /etc/ctdb/events.d/11.natgw removenatgw'
2, Then change the configuration in /etc/sysconfig/ctdb
3, Run 'CTDB_BASE=/etc/ctdb /etc/ctdb/events.d/11.natgw updatenatgw'
</pre></div></div><div class="refsect1" title="POLICY ROUTING"><a name="idp5100096"></a><h2>POLICY ROUTING</h2><p>
A node running CTDB may be a component of a complex network
topology. In particular, public addresses may be spread across
several different networks (or VLANs) and it may not be possible
to route packets from these public addresses via the system's
default route. Therefore, CTDB has support for policy routing
via the 13.per_ip_routing eventscript. This allows routing to
be specified for packets sourced from each public address. The
routes are added and removed as CTDB moves public addresses
between nodes.
</p><div class="refsect2" title="Configuration variables"><a name="idp5101712"></a><h3>Configuration variables</h3><p>
There are 4 configuration variables related to policy routing:
</p><div class="variablelist"><dl><dt><span class="term"><code class="varname">CTDB_PER_IP_ROUTING_CONF</code></span></dt><dd><p>
The name of a configuration file that specifies the
desired routes for each source address. The configuration
file format is discussed below. A recommended value is
<code class="filename">/etc/ctdb/policy_routing</code>.
</p><p>
The special value <code class="constant">__auto_link_local__</code>
indicates that no configuration file is provided and that
CTDB should generate reasonable link-local routes for each
public address.
</p></dd><dt><span class="term"><code class="varname">CTDB_PER_IP_ROUTING_RULE_PREF</code></span></dt><dd><p>
This sets the priority (or preference) for the routing
rules that are added by CTDB.
</p><p>
This should be (strictly) greater than 0 and (strictly)
less than 32766. A priority of 100 is recommended, unless
this conflicts with a priority already in use on the
system. See ip(8) for more details.
</p></dd><dt><span class="term">
<code class="varname">CTDB_PER_IP_ROUTING_TABLE_ID_LOW</code>,
<code class="varname">CTDB_PER_IP_ROUTING_TABLE_ID_HIGH</code>
</span></dt><dd><p>
CTDB determines a unique routing table number to use for
the routing related to each public address. These
variables indicate the minimum and maximum routing table
numbers that are used.
</p><p>
The ip command uses some reserved routing table numbers
below 255. Therefore, CTDB_PER_IP_ROUTING_TABLE_ID_LOW
should be (strictly) greater than 255. 1000 and 9000
are recommended values, unless this range conflicts with
routing tables numbers already in use on the system.
</p><p>
CTDB uses the standard file
<code class="filename">/etc/iproute2/rt_tables</code> to maintain
a mapping between the routing table numbers and labels.
The label for a public address &lt;addr;gt; will look
like ctdb.&lt;addr&gt;. This means that the associated
rules and routes are easy to read (and manipulate).
</p></dd></dl></div></div><div class="refsect2" title="Configuration file"><a name="idp5113856"></a><h3>Configuration file</h3><p>
The format of each line is:
</p><pre class="screen">
&lt;public_address&gt; &lt;network&gt; [ &lt;gateway&gt; ]
</pre><p>
Leading whitespace is ignored and arbitrary whitespace may be
used as a separator. Lines that have a "public address" item
that doesn't match an actual public address are ignored. This
means that comment lines can be added using a leading
character such as '#', since this will never match an IP
address.
</p><p>
A line without a gateway indicates a link local route.
</p><p>
For example, consider the configuration line:
</p><pre class="screen">
192.168.1.99 192.168.1.1/24
</pre><p>
If the corresponding public_addresses line is:
</p><pre class="screen">
192.168.1.99/24 eth2,eth3
</pre><p>
<code class="varname">CTDB_PER_IP_ROUTING_RULE_PREF</code> is 100, and
CTDB adds the address to eth2 then the following routing
information is added:
</p><pre class="screen">
ip rule add from 192.168.1.99 pref 100 table ctdb.192.168.1.99
ip route add 192.168.1.0/24 dev eth2 table ctdb.192.168.1.99
</pre><p>
This causes traffic from 192.168.1.1 to 192.168.1.0/24 go via
eth2.
</p><p>
The <span class="command"><strong>ip rule</strong></span> command will show (something
like - depending on other public addresses and other routes on
the system):
</p><pre class="screen">
0: from all lookup local
100: from 192.168.1.99 lookup ctdb.192.168.1.99
32766: from all lookup main
32767: from all lookup default
</pre><p>
<span class="command"><strong>ip route show table ctdb.192.168.1.99</strong></span> will show:
</p><pre class="screen">
192.168.1.0/24 dev eth2 scope link
</pre><p>
The usual use for a line containing a gateway is to add a
default route corresponding to a particular source address.
Consider this line of configuration:
</p><pre class="screen">
192.168.1.99 0.0.0.0/0 192.168.1.1
</pre><p>
In the situation described above this will cause an extra
routing command to be executed:
</p><pre class="screen">
ip route add 0.0.0.0/0 via 192.168.1.1 dev eth2 table ctdb.192.168.1.99
</pre><p>
With both configuration lines, <span class="command"><strong>ip route show table
ctdb.192.168.1.99</strong></span> will show:
</p><pre class="screen">
192.168.1.0/24 dev eth2 scope link
default via 192.168.1.1 dev eth2
</pre></div><div class="refsect2" title="Example configuration"><a name="idp5128656"></a><h3>Example configuration</h3><p>
Here is a more complete example configuration.
</p><pre class="screen">
/etc/ctdb/public_addresses:
192.168.1.98 eth2,eth3
192.168.1.99 eth2,eth3
/etc/ctdb/policy_routing:
192.168.1.98 192.168.1.0/24
192.168.1.98 192.168.200.0/24 192.168.1.254
192.168.1.98 0.0.0.0/0 192.168.1.1
192.168.1.99 192.168.1.0/24
192.168.1.99 192.168.200.0/24 192.168.1.254
192.168.1.99 0.0.0.0/0 192.168.1.1
</pre><p>
The routes local packets as expected, the default route is as
previously discussed, but packets to 192.168.200.0/24 are
routed via the alternate gateway 192.168.1.254.
</p></div></div><div class="refsect1" title="NOTIFICATION SCRIPT"><a name="idp5131488"></a><h2>NOTIFICATION SCRIPT</h2><p>
Notification scripts are used with ctdb to have a call-out from ctdb
to a user-specified script when certain state changes occur in ctdb.
This is commonly to set up either sending SNMP traps or emails
when a node becomes unhealthy and similar.
</p><p>
This is activated by setting CTDB_NOTIFY_SCRIPT=&lt;your script&gt; in the
sysconfig file, or by adding --notification-script=&lt;your script&gt;.
</p><p>
See /etc/ctdb/notify.sh for an example script.
</p><p>
CTDB currently generates notifications on these state changes:
</p><div class="refsect2" title="unhealthy"><a name="idp5134368"></a><h3>unhealthy</h3><p>
This call-out is triggered when the node changes to UNHEALTHY state.
</p></div><div class="refsect2" title="healthy"><a name="idp5135488"></a><h3>healthy</h3><p>
This call-out is triggered when the node changes to HEALTHY state.
</p></div><div class="refsect2" title="startup"><a name="idp5136608"></a><h3>startup</h3><p>
This call-out is triggered when ctdb has started up and all managed services are up and running.
</p></div></div><div class="refsect1" title="ClamAV Daemon"><a name="idp5137888"></a><h2>ClamAV Daemon</h2><p>
CTDB has support to manage the popular anti-virus daemon ClamAV.
This support is implemented through the
eventscript : /etc/ctdb/events.d/31.clamd.
</p><div class="refsect2" title="Configuration"><a name="idp5138944"></a><h3>Configuration</h3><p>
Start by configuring CLAMAV normally and test that it works. Once this is
done, copy the configuration files over to all the nodes so that all nodes
share identical CLAMAV configurations.
Once this is done you can proceed with the intructions below to activate
CTDB support for CLAMAV.
</p><p>
First, to activate CLAMAV support in CTDB, edit /etc/sysconfig/ctdb and add the two lines :
</p><pre class="screen">
CTDB_MANAGES_CLAMD=yes
CTDB_CLAMD_SOCKET="/path/to/clamd.socket"
</pre><p>
Second, activate the eventscript
</p><pre class="screen">
ctdb enablescript 31.clamd
</pre><p>
Third, CTDB will now be starting and stopping this service accordingly,
so make sure that the system is not configured to start/stop this service
automatically.
On RedHat systems you can disable the system starting/stopping CLAMAV automatically by running :
</p><pre class="screen">
chkconfig clamd off
</pre><p>
</p><p>
Once you have restarted CTDBD, use
</p><pre class="screen">
ctdb scriptstatus
</pre><p>
and verify that the 31.clamd eventscript is listed and that it was executed successfully.
</p></div></div><div class="refsect1" title="SEE ALSO"><a name="idp5145008"></a><h2>SEE ALSO</h2><p>
ctdb(1), onnode(1)
<a class="ulink" href="http://ctdb.samba.org/" target="_top">http://ctdb.samba.org/</a>
</p></div><div class="refsect1" title="COPYRIGHT/LICENSE"><a name="idp5146528"></a><h2>COPYRIGHT/LICENSE</h2><div class="literallayout"><p><br>
Copyright (C) Andrew Tridgell 2007<br>
Copyright (C) Ronnie sahlberg 2007<br>
<br>
This program is free software; you can redistribute it and/or modify<br>
it under the terms of the GNU General Public License as published by<br>
the Free Software Foundation; either version 3 of the License, or (at<br>
your option) any later version.<br>
<br>
This program is distributed in the hope that it will be useful, but<br>
WITHOUT ANY WARRANTY; without even the implied warranty of<br>
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU<br>
General Public License for more details.<br>
<br>
You should have received a copy of the GNU General Public License<br>
along with this program; if not, see http://www.gnu.org/licenses/.<br>
</p></div></div></div></body></html>

258
ctdb/doc/ltdbtool.1
View File

@ -1,258 +0,0 @@
'\" t
.\" Title: ltdbtool
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 05/04/2011
.\" Manual:
.\" Source:
.\" Language: English
.\"
.TH "LTDBTOOL" "1" "05/04/2011" "" ""
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
ltdbtool \- handle ctdb\*(Aqs local tdb copies
.SH "SYNOPSIS"
.HP \w'\fBltdbtool\ [OPTIONS]\ COMMAND\fR\ 'u
\fBltdbtool [OPTIONS] COMMAND\fR
.SH "DESCRIPTION"
.PP
ltdbtool is a utility to cope with ctdb\*(Aqs local tdb copies (LTDBs) without connecting to a ctdb daemon\&.
.PP
It can be used to
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
dump the contents of a LTDB, optionally printing the ctdb record header information,
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
convert between an LTDB and a non\-clustered tdb by adding or removing ctdb headers and
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
convert between 64 and 32 bit LTDBs where the ctdb record headers differ by 4 bytes of padding\&.
.RE
.sp
.SH "COMMANDS"
.PP
help
.RS 4
Print a help text\&.
.RE
.PP
dump <IDB>
.RS 4
Dump the contents of a LTDB file to standard output in a human\-readable format\&.
.RE
.PP
convert <IDB> <ODB>
.RS 4
Make a copy of a LTDB optionally adding or removing ctdb headers\&.
.RE
.SH "OPTIONS"
.PP
\-p
.RS 4
Dump with header information, similar to "ctdb catdb"\&.
.RE
.PP
\-s {0|32|64}
.RS 4
Specify how to determine the ctdb record header size for the input database:
.PP
0
.RS 4
no ctdb header
.RE
.PP
32
.RS 4
ctdb header size of a 32 bit system (20 bytes)
.RE
.PP
64
.RS 4
ctdb header size of a 64 bit system (24 bytes)
.RE
.sp
The default is 32 or 64 depending on the system architecture\&.
.RE
.PP
\-o {0|32|64}
.RS 4
Specify how to determine the ctdb record header size for the output database, see \-s
.RE
.PP
\-S <SIZE>
.RS 4
Explicitly specify the ctdb record header size of the input database in bytes\&.
.RE
.PP
\-O <SIZE>
.RS 4
Explicitly specify the ctdb record header size for the output database in bytes\&.
.RE
.PP
\-h
.RS 4
Print a help text\&.
.RE
.SH "EXAMPLES"
.PP
Print a local tdb in "tdbdump" style:
.sp
.if n \{\
.RS 4
.\}
.nf
ltdbtool dump idmap2\&.tdb\&.0
.fi
.if n \{\
.RE
.\}
.PP
Print a local tdb with header information similar to "ctdb catdb":
.sp
.if n \{\
.RS 4
.\}
.nf
ltdbtool dump \-p idmap2\&.tdb\&.0
.fi
.if n \{\
.RE
.\}
.PP
Strip the ctdb headers from records:
.sp
.if n \{\
.RS 4
.\}
.nf
ltdbtool convert \-o0 idmap2\&.tdb\&.0 idmap\&.tdb
.fi
.if n \{\
.RE
.\}
.PP
Strip 64 bit ctdb headers from records, running on i386:
.sp
.if n \{\
.RS 4
.\}
.nf
ltdbtool convert \-s64 \-o0 idmap2\&.tdb\&.0 idmap\&.tdb
.fi
.if n \{\
.RE
.\}
.PP
Strip the ctdb headers from records by piping through tdbrestore:
.sp
.if n \{\
.RS 4
.\}
.nf
ltdbtool dump idmap2\&.tdb\&.0 | tdbrestore idmap\&.tdb
.fi
.if n \{\
.RE
.\}
.PP
Convert a local tdb from a 64 bit system for usage on a 32 bit system:
.sp
.if n \{\
.RS 4
.\}
.nf
ltdbtool convert \-s64 \-o32 idmap2\&.tdb\&.0 idmap2\&.tdb\&.1
.fi
.if n \{\
.RE
.\}
.PP
Add a default header:
.sp
.if n \{\
.RS 4
.\}
.nf
ltdbtool convert \-s0 idmap\&.tdb idmap2\&.tdb\&.0
.fi
.if n \{\
.RE
.\}
.SH "SEE ALSO"
.PP
ctdbd(1), ctdb(1), tdbdump(1), tdbrestore(1),
\m[blue]\fB\%http://ctdb.samba.org/\fR\m[]
.SH "COPYRIGHT/LICENSE"
.sp
.if n \{\
.RS 4
.\}
.nf
Copyright (C) Gregor Beck 2011
Copyright (C) Michael Adam 2011
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\&.
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\&.
You should have received a copy of the GNU General Public License
along with this program; if not, see http://www\&.gnu\&.org/licenses/\&.
.fi
.if n \{\
.RE
.\}

84
ctdb/doc/ltdbtool.1.html
View File

@ -1,84 +0,0 @@
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>ltdbtool</title><meta name="generator" content="DocBook XSL Stylesheets V1.75.2"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" title="ltdbtool"><a name="ltdbtool.1"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>ltdbtool &#8212; handle ctdb's local tdb copies </p></div><div class="refsynopsisdiv" title="Synopsis"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">ltdbtool [OPTIONS] COMMAND</code> </p></div></div><div class="refsect1" title="DESCRIPTION"><a name="id417069"></a><h2>DESCRIPTION</h2><p>
ltdbtool is a utility to cope with ctdb's local tdb copies (LTDBs)
without connecting to a ctdb daemon.
</p><p>It can be used to
</p><div class="itemizedlist"><ul class="itemizedlist" type="disc" compact><li class="listitem"><p>
dump the contents of a LTDB, optionally printing the ctdb
record header information,
</p></li><li class="listitem"><p>
convert between an LTDB and a non-clustered tdb
by adding or removing ctdb headers and
</p></li><li class="listitem"><p>convert between 64 and 32 bit LTDBs where the ctdb record
headers differ by 4 bytes of padding.
</p></li></ul></div><p>
</p></div><div class="refsect1" title="COMMANDS"><a name="id417114"></a><h2>COMMANDS</h2><div class="variablelist"><dl><dt><span class="term">help</span></dt><dd><p>
Print a help text.
</p></dd><dt><span class="term">dump &lt;IDB&gt;</span></dt><dd><p>
Dump the contents of a LTDB file to standard output in a
human-readable format.
</p></dd><dt><span class="term">convert &lt;IDB&gt; &lt;ODB&gt;</span></dt><dd><p>
Make a copy of a LTDB optionally adding or removing ctdb headers.
</p></dd></dl></div></div><div class="refsect1" title="OPTIONS"><a name="id417160"></a><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">-p</span></dt><dd><p>
Dump with header information, similar to "ctdb catdb".
</p></dd><dt><span class="term">-s {0|32|64}</span></dt><dd><p>
Specify how to determine the ctdb record header size
for the input database:
</p><div class="variablelist"><dl><dt><span class="term">0</span></dt><dd><p>no ctdb header</p></dd><dt><span class="term">32</span></dt><dd><p>ctdb header size of a 32 bit system (20 bytes)</p></dd><dt><span class="term">64</span></dt><dd><p>ctdb header size of a 64 bit system (24 bytes)</p></dd></dl></div><p>
The default is 32 or 64 depending on the system architecture.
</p></dd><dt><span class="term">-o {0|32|64}</span></dt><dd><p>
Specify how to determine the ctdb record header size
for the output database, see -s
</p></dd><dt><span class="term">-S &lt;SIZE&gt;</span></dt><dd><p>
Explicitly specify the ctdb record header size of the input database in bytes.
</p></dd><dt><span class="term">-O &lt;SIZE&gt;</span></dt><dd><p>
Explicitly specify the ctdb record header size for the output database in bytes.
</p></dd><dt><span class="term">-h</span></dt><dd><p>
Print a help text.
</p></dd></dl></div></div><div class="refsect1" title="EXAMPLES"><a name="id417288"></a><h2>EXAMPLES</h2><p>
Print a local tdb in "tdbdump" style:
</p><pre class="screen">
ltdbtool dump idmap2.tdb.0
</pre><p>
Print a local tdb with header information similar to "ctdb catdb":
</p><pre class="screen">
ltdbtool dump -p idmap2.tdb.0
</pre><p>
Strip the ctdb headers from records:
</p><pre class="screen">
ltdbtool convert -o0 idmap2.tdb.0 idmap.tdb
</pre><p>
Strip 64 bit ctdb headers from records, running on i386:
</p><pre class="screen">
ltdbtool convert -s64 -o0 idmap2.tdb.0 idmap.tdb
</pre><p>
Strip the ctdb headers from records by piping through tdbrestore:
</p><pre class="screen">
ltdbtool dump idmap2.tdb.0 | tdbrestore idmap.tdb
</pre><p>
Convert a local tdb from a 64 bit system for usage on a 32 bit system:
</p><pre class="screen">
ltdbtool convert -s64 -o32 idmap2.tdb.0 idmap2.tdb.1
</pre><p>
Add a default header:
</p><pre class="screen">
ltdbtool convert -s0 idmap.tdb idmap2.tdb.0
</pre></div><div class="refsect1" title="SEE ALSO"><a name="id417355"></a><h2>SEE ALSO</h2><p>
ctdbd(1), ctdb(1), tdbdump(1), tdbrestore(1),
<a class="ulink" href="http://ctdb.samba.org/" target="_top">http://ctdb.samba.org/</a>
</p></div><div class="refsect1" title="COPYRIGHT/LICENSE"><a name="id417368"></a><h2>COPYRIGHT/LICENSE</h2><div class="literallayout"><p><br>
Copyright (C) Gregor Beck 2011<br>
Copyright (C) Michael Adam 2011<br>
<br>
This program is free software; you can redistribute it and/or modify<br>
it under the terms of the GNU General Public License as published by<br>
the Free Software Foundation; either version 3 of the License, or (at<br>
your option) any later version.<br>
<br>
This program is distributed in the hope that it will be useful, but<br>
WITHOUT ANY WARRANTY; without even the implied warranty of<br>
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU<br>
General Public License for more details.<br>
<br>
You should have received a copy of the GNU General Public License<br>
along with this program; if not, see http://www.gnu.org/licenses/.<br>
</p></div></div></div></body></html>

239
ctdb/doc/onnode.1
View File

@ -1,239 +0,0 @@
'\" t
.\" Title: onnode
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
.\" Date: 07/17/2012
.\" Manual:
.\" Source:
.\" Language: English
.\"
.TH "ONNODE" "1" "07/17/2012" "" ""
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
onnode \- run commands on ctdb nodes
.SH "SYNOPSIS"
.HP \w'\fBonnode\ [OPTION]\ \&.\&.\&.\ NODES\ COMMAND\ \&.\&.\&.\fR\ 'u
\fBonnode [OPTION] \&.\&.\&. NODES COMMAND \&.\&.\&.\fR
.SH "DESCRIPTION"
.PP
onnode is a utility to run commands on a specific node of a CTDB cluster, or on all nodes\&.
.PP
The NODES option specifies which node to run a command on\&. You can specify a numeric node number (from 0 to N\-1) or a descriptive node specification (see DESCRIPTIVE NODE SPECIFICATIONS below)\&. You can also specify lists of nodes, separated by commas, and ranges of numeric node numbers, separated by dashes\&. If nodes are specified multiple times then the command will be executed multiple times on those nodes\&. The order of nodes is significant\&.
.PP
The COMMAND can be any shell command\&. The onnode utility uses ssh or rsh to connect to the remote nodes and run the command\&.
.SH "DESCRIPTIVE NODE SPECIFICATIONS"
.PP
The following descriptive node specification can be used in place of numeric node numbers:
.PP
all
.RS 4
All nodes\&.
.RE
.PP
any
.RS 4
A node where ctdbd is running\&. This semi\-random but there is a bias towards choosing a low numbered node\&.
.RE
.PP
ok | healthy
.RS 4
All nodes that are not disconnected, banned, disabled or unhealthy\&.
.RE
.PP
con | connected
.RS 4
All nodes that are not disconnected\&.
.RE
.PP
lvs | lvsmaster
.RS 4
The current LVS master\&.
.RE
.PP
natgw | natgwlist
.RS 4
The current NAT gateway\&.
.RE
.PP
rm | recmaster
.RS 4
The current recovery master\&.
.RE
.SH "OPTIONS"
.PP
\-c
.RS 4
Execute COMMAND in the current working directory on the specified nodes\&.
.RE
.PP
\-o <prefix>
.RS 4
Causes standard output from each node to be saved into a file with name <prefix>\&.<ip>\&.
.RE
.PP
\-p
.RS 4
Run COMMAND in parallel on the specified nodes\&. The default is to run COMMAND sequentially on each node\&.
.RE
.PP
\-q
.RS 4
Do not print node addresses\&. Normally, onnode prints informational node addresses if more than one node is specified\&. This overrides \-v\&.
.RE
.PP
\-n
.RS 4
Allow nodes to be specified by name rather than node numbers\&. These nodes don\*(Aqt need to be listed in the nodes file\&. You can avoid the nodes file entirely by combining this with
\-f /dev/null\&.
.RE
.PP
\-f <file>
.RS 4
Specify an alternative nodes file to use instead of the default\&. This option overrides the CTDB_NODES_FILE environment variable\&. See the discussion of
/etc/ctdb/nodes
in the FILES section for more details\&.
.RE
.PP
\-v
.RS 4
Print a node addresses even if only one node is specified\&. Normally, onnode prints informational node addresses when more than one node is specified\&.
.RE
.PP
\-P
.RS 4
Push files to nodes\&. Names of files to push are specified rather than the usual command\&. Quoting is fragile/broken \- filenames with whitespace in them are not supported\&.
.RE
.PP
\-h, \-\-help
.RS 4
Show a short usage guide\&.
.RE
.SH "EXAMPLES"
.PP
The following command would show the process ID of ctdb on all nodes
.sp
.if n \{\
.RS 4
.\}
.nf
onnode all pidof ctdbd
.fi
.if n \{\
.RE
.\}
.PP
The following command would show the last 5 lines of log on each node, preceded by the node\*(Aqs hostname
.sp
.if n \{\
.RS 4
.\}
.nf
onnode all "hostname; tail \-5 /var/log/log\&.ctdb"
.fi
.if n \{\
.RE
.\}
.PP
The following command would restart the ctdb service on all nodes\&.
.sp
.if n \{\
.RS 4
.\}
.nf
onnode all service ctdb restart
.fi
.if n \{\
.RE
.\}
.PP
The following command would run \&./foo in the current working directory, in parallel, on nodes 0, 2, 3 and 4\&.
.sp
.if n \{\
.RS 4
.\}
.nf
onnode \-c \-p 0,2\-4 \&./foo
.fi
.if n \{\
.RE
.\}
.SH "ENVIRONMENT"
.PP
\fBCTDB_NODES_FILE\fR
.RS 4
Name of alternative nodes file to use instead of the default\&. See the discussion of
/etc/ctdb/nodes
in the FILES section for more details\&.
.RE
.SH "FILES"
.PP
/etc/ctdb/nodes
.RS 4
Default file containing a list of each node\*(Aqs IP address or hostname\&.
.sp
Actually, the default is
$\fBCTDB_BASE\fR/nodes, where
\fB$CTDB_BASE\fR
defaults to
/etc/ctdb\&. If a relative path is given (via the \-f option or
\fB$CTDB_BASE\fR) and no corresponding file exists relative to the current directory then the file is also searched for in the
$\fBCTDB_BASE\fR
directory\&.
.RE
.PP
/etc/ctdb/onnode\&.conf
.RS 4
If this file exists it is sourced by onnode\&. The main purpose is to allow the administrator to set $SSH to something other than "ssh"\&. In this case the \-t option is ignored\&. For example, the administrator may choose to use use rsh instead of ssh\&.
.RE
.SH "SEE ALSO"
.PP
ctdbd(1), ctdb(1),
\m[blue]\fB\%http://ctdb.samba.org/\fR\m[]
.SH "COPYRIGHT/LICENSE"
.sp
.if n \{\
.RS 4
.\}
.nf
Copyright (C) Andrew Tridgell 2007
Copyright (C) Ronnie sahlberg 2007
Copyright (C) Martin Schwenke 2008
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\&.
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\&.
You should have received a copy of the GNU General Public License
along with this program; if not, see http://www\&.gnu\&.org/licenses/\&.
.fi
.if n \{\
.RE
.\}

129
ctdb/doc/onnode.1.html
View File

@ -1,129 +0,0 @@
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>onnode</title><meta name="generator" content="DocBook XSL Stylesheets V1.76.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" title="onnode"><a name="onnode.1"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>onnode &#8212; run commands on ctdb nodes</p></div><div class="refsynopsisdiv" title="Synopsis"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">onnode [OPTION] ... NODES COMMAND ...</code> </p></div></div><div class="refsect1" title="DESCRIPTION"><a name="idp234704"></a><h2>DESCRIPTION</h2><p>
onnode is a utility to run commands on a specific node of a CTDB
cluster, or on all nodes.
</p><p>
The NODES option specifies which node to run a command on. You
can specify a numeric node number (from 0 to N-1) or a
descriptive node specification (see DESCRIPTIVE NODE
SPECIFICATIONS below). You can also specify lists of nodes,
separated by commas, and ranges of numeric node numbers,
separated by dashes. If nodes are specified multiple times then
the command will be executed multiple times on those nodes. The
order of nodes is significant.
</p><p>
The COMMAND can be any shell command. The onnode utility uses
ssh or rsh to connect to the remote nodes and run the command.
</p></div><div class="refsect1" title="DESCRIPTIVE NODE SPECIFICATIONS"><a name="idp236384"></a><h2>DESCRIPTIVE NODE SPECIFICATIONS</h2><p>
The following descriptive node specification can be used in
place of numeric node numbers:
</p><div class="variablelist"><dl><dt><span class="term">all</span></dt><dd><p>
All nodes.
</p></dd><dt><span class="term">any</span></dt><dd><p>
A node where ctdbd is running. This semi-random but
there is a bias towards choosing a low numbered node.
</p></dd><dt><span class="term">ok | healthy</span></dt><dd><p>
All nodes that are not disconnected, banned, disabled or
unhealthy.
</p></dd><dt><span class="term">con | connected</span></dt><dd><p>
All nodes that are not disconnected.
</p></dd><dt><span class="term">lvs | lvsmaster</span></dt><dd><p>
The current LVS master.
</p></dd><dt><span class="term">natgw | natgwlist</span></dt><dd><p>
The current NAT gateway.
</p></dd><dt><span class="term">rm | recmaster</span></dt><dd><p>
The current recovery master.
</p></dd></dl></div></div><div class="refsect1" title="OPTIONS"><a name="idp253704"></a><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">-c</span></dt><dd><p>
Execute COMMAND in the current working directory on the
specified nodes.
</p></dd><dt><span class="term">-o &lt;prefix&gt;</span></dt><dd><p>
Causes standard output from each node to be saved into a
file with name &lt;prefix&gt;.&lt;ip&gt;.
</p></dd><dt><span class="term">-p</span></dt><dd><p>
Run COMMAND in parallel on the specified nodes. The
default is to run COMMAND sequentially on each node.
</p></dd><dt><span class="term">-q</span></dt><dd><p>
Do not print node addresses. Normally, onnode prints
informational node addresses if more than one node is
specified. This overrides -v.
</p></dd><dt><span class="term">-n</span></dt><dd><p>
Allow nodes to be specified by name rather than node
numbers. These nodes don't need to be listed in the nodes
file. You can avoid the nodes file entirely by combining
this with <code class="code">-f /dev/null</code>.
</p></dd><dt><span class="term">-f &lt;file&gt;</span></dt><dd><p>
Specify an alternative nodes file to use instead of the
default. This option overrides the CTDB_NODES_FILE
environment variable. See the discussion of
<code class="filename">/etc/ctdb/nodes</code> in the FILES section
for more details.
</p></dd><dt><span class="term">-v</span></dt><dd><p>
Print a node addresses even if only one node is specified.
Normally, onnode prints informational node addresses when
more than one node is specified.
</p></dd><dt><span class="term">-P</span></dt><dd><p>
Push files to nodes. Names of files to push are specified
rather than the usual command. Quoting is fragile/broken
- filenames with whitespace in them are not supported.
</p></dd><dt><span class="term">-h, --help</span></dt><dd><p>
Show a short usage guide.
</p></dd></dl></div></div><div class="refsect1" title="EXAMPLES"><a name="idp262848"></a><h2>EXAMPLES</h2><p>
The following command would show the process ID of ctdb on all nodes
</p><pre class="screen">
onnode all pidof ctdbd
</pre><p>
The following command would show the last 5 lines of log on each
node, preceded by the node's hostname
</p><pre class="screen">
onnode all "hostname; tail -5 /var/log/log.ctdb"
</pre><p>
The following command would restart the ctdb service on all nodes.
</p><pre class="screen">
onnode all service ctdb restart
</pre><p>
The following command would run ./foo in the current working
directory, in parallel, on nodes 0, 2, 3 and 4.
</p><pre class="screen">
onnode -c -p 0,2-4 ./foo
</pre></div><div class="refsect1" title="ENVIRONMENT"><a name="idp265888"></a><h2>ENVIRONMENT</h2><div class="variablelist"><dl><dt><span class="term"><code class="envar">CTDB_NODES_FILE</code></span></dt><dd><p>
Name of alternative nodes file to use instead of the
default. See the discussion of
<code class="filename">/etc/ctdb/nodes</code> in the FILES section
for more details.
</p></dd></dl></div></div><div class="refsect1" title="FILES"><a name="idp124208"></a><h2>FILES</h2><div class="variablelist"><dl><dt><span class="term"><code class="filename">/etc/ctdb/nodes</code></span></dt><dd><p>
Default file containing a list of each node's IP address
or hostname.
</p><p>
Actually, the default is
<code class="filename">$<code class="envar">CTDB_BASE</code>/nodes</code>,
where <code class="envar">$CTDB_BASE</code> defaults to
<code class="filename">/etc/ctdb</code>. If a relative path is
given (via the -f option or <code class="envar">$CTDB_BASE</code>) and
no corresponding file exists relative to the current
directory then the file is also searched for in the
<code class="filename">$<code class="envar">CTDB_BASE</code></code> directory.
</p></dd><dt><span class="term"><code class="filename">/etc/ctdb/onnode.conf</code></span></dt><dd><p>
If this file exists it is sourced by onnode. The main
purpose is to allow the administrator to set $SSH to
something other than "ssh". In this case the -t option is
ignored. For example, the administrator may choose to use
use rsh instead of ssh.
</p></dd></dl></div></div><div class="refsect1" title="SEE ALSO"><a name="idp129264"></a><h2>SEE ALSO</h2><p>
ctdbd(1), ctdb(1), <a class="ulink" href="http://ctdb.samba.org/" target="_top">http://ctdb.samba.org/</a>
</p></div><div class="refsect1" title="COPYRIGHT/LICENSE"><a name="idp130040"></a><h2>COPYRIGHT/LICENSE</h2><div class="literallayout"><p><br>
Copyright (C) Andrew Tridgell 2007<br>
Copyright (C) Ronnie sahlberg 2007<br>
Copyright (C) Martin Schwenke 2008<br>
<br>
This program is free software; you can redistribute it and/or modify<br>
it under the terms of the GNU General Public License as published by<br>
the Free Software Foundation; either version 3 of the License, or (at<br>
your option) any later version.<br>
<br>
This program is distributed in the hope that it will be useful, but<br>
WITHOUT ANY WARRANTY; without even the implied warranty of<br>
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU<br>
General Public License for more details.<br>
<br>
You should have received a copy of the GNU General Public License<br>
along with this program; if not, see http://www.gnu.org/licenses/.<br>
</p></div></div></div></body></html>

110
ctdb/doc/ping_pong.1
View File

@ -1,110 +0,0 @@
'\" t
.\" Title: ping_pong
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
.\" Date: 03/26/2011
.\" Manual:
.\" Source:
.\" Language: English
.\"
.TH "PING_PONG" "1" "03/26/2011" "" ""
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
ping_pong \- measures the ping\-pong byte range lock latency
.SH "SYNOPSIS"
.HP \w'\fBping_pong\ [options]\ <file>\ <num_locks>\fR\ 'u
\fBping_pong [options] <file> <num_locks>\fR
.HP \w'\fBping_pong\fR\ 'u
\fBping_pong\fR [\-r] [\-w] [\-m]
.SH "DESCRIPTION"
.PP
This measures the ping\-pong byte range lock latency\&. It is especially useful on a cluster of nodes sharing a common lock manager as it will give some indication of the lock managers performance under stress\&.
.SH "OPTIONS"
.PP
\-r
.RS 4
do reads
.RE
.PP
\-w
.RS 4
do writes
.RE
.PP
\-m
.RS 4
use mmap
.RE
.SH "EXAMPLES"
.PP
Testing lock coherence
.sp
.if n \{\
.RS 4
.\}
.nf
ping_pong test\&.dat N
.fi
.if n \{\
.RE
.\}
.PP
Testing IO coherence
.sp
.if n \{\
.RS 4
.\}
.nf
ping_pong \-rw test\&.dat N
.fi
.if n \{\
.RE
.\}
.SH "SEE ALSO"
.PP
\m[blue]\fB\%https://wiki.samba.org/index.php/Ping_pong\fR\m[], ctdb(1), ctdbd(1)
.SH "COPYRIGHT/LICENSE"
.sp
.if n \{\
.RS 4
.\}
.nf
Copyright (C) Andrew Tridgell 2002
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\&.
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\&.
You should have received a copy of the GNU General Public License
along with this program; if not, see http://www\&.gnu\&.org/licenses/\&.
.fi
.if n \{\
.RE
.\}

37
ctdb/doc/ping_pong.1.html
View File

@ -1,37 +0,0 @@
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>ping_pong</title><meta name="generator" content="DocBook XSL Stylesheets V1.76.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" title="ping_pong"><a name="ping_pong.1"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>ping_pong &#8212; measures the ping-pong byte range lock latency</p></div><div class="refsynopsisdiv" title="Synopsis"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">ping_pong [options] &lt;file&gt; &lt;num_locks&gt;</code> </p></div><div class="cmdsynopsis"><p><code class="command">ping_pong</code> [-r] [-w] [-m]</p></div></div><div class="refsect1" title="DESCRIPTION"><a name="id2949769"></a><h2>DESCRIPTION</h2><p>
This measures the ping-pong byte range lock latency. It is
especially useful on a cluster of nodes sharing a common lock
manager as it will give some indication of the lock managers
performance under stress.
</p></div><div class="refsect1" title="OPTIONS"><a name="id2949782"></a><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">-r</span></dt><dd><p>
do reads
</p></dd><dt><span class="term">-w</span></dt><dd><p>
do writes
</p></dd><dt><span class="term">-m</span></dt><dd><p>
use mmap
</p></dd></dl></div></div><div class="refsect1" title="EXAMPLES"><a name="id2949828"></a><h2>EXAMPLES</h2><p>
Testing lock coherence
</p><pre class="screen">
ping_pong test.dat N
</pre><p>
Testing IO coherence
</p><pre class="screen">
ping_pong -rw test.dat N
</pre></div><div class="refsect1" title="SEE ALSO"><a name="id2949852"></a><h2>SEE ALSO</h2><p>
<a class="ulink" href="https://wiki.samba.org/index.php/Ping_pong" target="_top">https://wiki.samba.org/index.php/Ping_pong</a>, ctdb(1), ctdbd(1)
</p></div><div class="refsect1" title="COPYRIGHT/LICENSE"><a name="id2949866"></a><h2>COPYRIGHT/LICENSE</h2><div class="literallayout"><p><br>
Copyright (C) Andrew Tridgell 2002<br>
<br>
This program is free software; you can redistribute it and/or modify<br>
it under the terms of the GNU General Public License as published by<br>
the Free Software Foundation; either version 3 of the License, or (at<br>
your option) any later version.<br>
<br>
This program is distributed in the hope that it will be useful, but<br>
WITHOUT ANY WARRANTY; without even the implied warranty of<br>
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU<br>
General Public License for more details.<br>
<br>
You should have received a copy of the GNU General Public License<br>
along with this program; if not, see http://www.gnu.org/licenses/.<br>
</p></div></div></div></body></html>