mirror of
https://github.com/samba-team/samba.git
synced 2025-01-12 09:18:10 +03:00
05e1f67381
it is --event-script-dir not --event-script add explanation of the public_addresses file (This used to be ctdb commit 21325b23e786ac1c2abc07ea75b0814e9c725a9e)
204 lines
13 KiB
HTML
204 lines
13 KiB
HTML
<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.71.0"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="ctdbd.1"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>ctdbd — The CTDB cluster daemon</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">ctdbd</code> </p></div><div class="cmdsynopsis"><p><code class="command">ctdbd</code> {--reclock=<filename>} {--nlist=<filename>} {--dbdir=<directory>} [-? --help] [--usage] [-i --interactive] [--public-addresses=<filename>] [--event-script-dir=<directory>] [--logfile=<filename>] [--listen=<address>] [--transport=<STRING>] [--socket=<filename>] [-d --debug=<INTEGER>] [--torture]</p></div></div><div class="refsect1" lang="en"><a name="id2480886"></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-awailability load-sharing CIFS server cluster.
|
||
</p></div><div class="refsect1" lang="en"><a name="id2481092"></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">--usage</span></dt><dd><p>
|
||
Print useage information to the screen.
|
||
</p></dd><dt><span class="term">--reclock=<filename></span></dt><dd><p>
|
||
This is the name of the lock file stored of the shared cluster filesystem that ctdbd uses to arbitrate which node has the role of recovery-master.
|
||
This file must be stored on shared storage.
|
||
</p></dd><dt><span class="term">--nlist=<filename></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">--dbdir=<directory></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">-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">--public_addresses=<filename></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">--event-script-dir=<directory></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">--logfile=<filename></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">--listen=<address></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">--transport=<STRING></span></dt><dd><p>
|
||
This option specifies which transport to use for ctdbd internode communications. The default is "tcp".
|
||
</p><p>
|
||
Suported transports are "tcp" and "infiniband".
|
||
</p></dd><dt><span class="term">--socket=<filename></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">-d --debug=<DEBUGLEVEL></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">--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></dl></div></div><div class="refsect1" lang="en"><a name="id2528417"></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" lang="en"><a name="id2528427"></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" lang="en"><a name="id2528476"></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" lang="en"><a name="id2528564"></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 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></div><div class="refsect1" lang="en"><a name="id2528621"></a><h2>SEE ALSO</h2><p>
|
||
ctdb(1), onnode(1)
|
||
<a href="http://ctdb.samba.org/" target="_top">http://ctdb.samba.org/</a>
|
||
</p></div><div class="refsect1" lang="en"><a name="id2528634"></a><h2>COPYRIGHT/LICENSE</h2><div class="literallayout"><p><br>
|
||
Copyright<EFBFBD>(C)<29>Andrew<65>Tridgell<6C>2007<br>
|
||
Copyright<EFBFBD>(C)<29>Ronnie<69>sahlberg<72>2007<br>
|
||
<br>
|
||
This<EFBFBD>program<EFBFBD>is<EFBFBD>free<EFBFBD>software;<3B>you<6F>can<61>redistribute<74>it<69>and/or<6F>modify<br>
|
||
it<EFBFBD>under<EFBFBD>the<EFBFBD>terms<EFBFBD>of<EFBFBD>the<EFBFBD>GNU<EFBFBD>General<EFBFBD>Public<EFBFBD>License<EFBFBD>as<EFBFBD>published<EFBFBD>by<br>
|
||
the<EFBFBD>Free<EFBFBD>Software<EFBFBD>Foundation;<3B>either<65>version<6F>3<EFBFBD>of<6F>the<68>License,<2C>or<6F>(at<br>
|
||
your<EFBFBD>option)<29>any<6E>later<65>version.<br>
|
||
<br>
|
||
This<EFBFBD>program<EFBFBD>is<EFBFBD>distributed<EFBFBD>in<EFBFBD>the<EFBFBD>hope<EFBFBD>that<EFBFBD>it<EFBFBD>will<EFBFBD>be<EFBFBD>useful,<2C>but<br>
|
||
WITHOUT<EFBFBD>ANY<EFBFBD>WARRANTY;<3B>without<75>even<65>the<68>implied<65>warranty<74>of<br>
|
||
MERCHANTABILITY<EFBFBD>or<EFBFBD>FITNESS<EFBFBD>FOR<EFBFBD>A<EFBFBD>PARTICULAR<EFBFBD>PURPOSE.<2E><>See<65>the<68>GNU<br>
|
||
General<EFBFBD>Public<EFBFBD>License<EFBFBD>for<EFBFBD>more<EFBFBD>details.<br>
|
||
<br>
|
||
You<EFBFBD>should<EFBFBD>have<EFBFBD>received<EFBFBD>a<EFBFBD>copy<EFBFBD>of<EFBFBD>the<EFBFBD>GNU<EFBFBD>General<EFBFBD>Public<EFBFBD>License<br>
|
||
along<EFBFBD>with<EFBFBD>this<EFBFBD>program;<3B>if<69>not,<2C>see<65>http://www.gnu.org/licenses/.<br>
|
||
</p></div></div></div></body></html>
|