<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
-<refentry id="ctdbd.1">
-
-<refmeta>
- <refentrytitle>ctdbd</refentrytitle>
- <manvolnum>1</manvolnum>
-</refmeta>
-
+<!DOCTYPE refentry
+ PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
+ "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
-<refnamediv>
- <refname>ctdbd</refname>
- <refpurpose>The CTDB cluster daemon</refpurpose>
-</refnamediv>
+<refentry id="ctdbd.1">
-<refsynopsisdiv>
- <cmdsynopsis>
- <command>ctdbd</command>
- </cmdsynopsis>
-
- <cmdsynopsis>
- <command>ctdbd</command>
- <arg choice="opt">-? --help</arg>
- <arg choice="opt">-d --debug=<INTEGER></arg>
- <arg choice="req">--dbdir=<directory></arg>
- <arg choice="req">--dbdir-persistent=<directory></arg>
- <arg choice="opt">--event-script-dir=<directory></arg>
- <arg choice="opt">-i --interactive</arg>
- <arg choice="opt">--listen=<address></arg>
- <arg choice="opt">--logfile=<filename></arg>
- <arg choice="req">--nlist=<filename></arg>
- <arg choice="opt">--nosetsched</arg>
- <arg choice="opt">--public-addresses=<filename></arg>
- <arg choice="opt">--public-interface=<interface></arg>
- <arg choice="req">--reclock=<filename></arg>
- <arg choice="opt">--single-public-ip=<address></arg>
- <arg choice="opt">--socket=<filename></arg>
- <arg choice="opt">--syslog</arg>
- <arg choice="opt">--torture</arg>
- <arg choice="opt">--transport=<STRING></arg>
- <arg choice="opt">--usage</arg>
- </cmdsynopsis>
-
-</refsynopsisdiv>
+ <refmeta>
+ <refentrytitle>ctdbd</refentrytitle>
+ <manvolnum>1</manvolnum>
+ <refmiscinfo class="source">ctdb</refmiscinfo>
+ <refmiscinfo class="manual">CTDB - clustered TDB database</refmiscinfo>
+ </refmeta>
+
+ <refnamediv>
+ <refname>ctdbd</refname>
+ <refpurpose>The CTDB cluster daemon</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ <command>ctdbd</command>
+ <arg rep="repeat"><replaceable>OPTION</replaceable></arg>
+ </cmdsynopsis>
+ </refsynopsisdiv>
- <refsect1><title>DESCRIPTION</title>
- <para>
- ctdbd is the main ctdb daemon.
- </para>
- <para>
- ctdbd provides a clustered version of the TDB database with automatic rebuild/recovery of the databases upon nodefailures.
- </para>
+ <refsect1>
+ <title>DESCRIPTION</title>
<para>
- Combined with a cluster filesystem ctdbd provides a full HA environment for services such as clustered Samba and NFS as well as other services.
+ ctdbd is the main CTDB daemon.
</para>
+
<para>
- ctdbd provides monitoring of all nodes in the cluster and automatically reconfigures the cluster and recovers upon node failures.
+ Note that ctdbd is not usually invoked directly. It is invoked
+ via <citerefentry><refentrytitle>ctdbd_wrapper</refentrytitle>
+ <manvolnum>1</manvolnum></citerefentry> or via the initscript.
</para>
+
<para>
- ctdbd is the main component in clustered Samba that provides a high-awailability load-sharing CIFS server cluster.
+ See <citerefentry><refentrytitle>ctdb</refentrytitle>
+ <manvolnum>7</manvolnum></citerefentry> for an overview of CTDB.
</para>
</refsect1>
-
<refsect1>
- <title>OPTIONS</title>
+ <title>GENERAL OPTIONS</title>
<variablelist>
- <varlistentry><term>-? --help</term>
- <listitem>
- <para>
- Print some help text to the screen.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry><term>-d --debug=<DEBUGLEVEL></term>
- <listitem>
- <para>
- 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.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry><term>--dbdir=<directory></term>
- <listitem>
- <para>
- 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.
- </para>
- <para>
- This directory would usually be /var/ctdb .
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry><term>--dbdir-persistent=<directory></term>
- <listitem>
- <para>
- 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.
- </para>
- <para>
- This directory would usually be /etc/ctdb/persistent .
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry><term>--event-script-dir=<directory></term>
- <listitem>
- <para>
- This option is used to specify the directory where the CTDB event
- scripts are stored.
- </para>
- <para>
- This will normally be /etc/ctdb/events.d which is part of the ctdb distribution.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry><term>-i --interactive</term>
- <listitem>
- <para>
- 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.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry><term>--listen=<address></term>
- <listitem>
- <para>
- 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.
- </para>
- <para>
- 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.
- </para>
- </listitem>
+ <varlistentry>
+ <term>-i, --interactive</term>
+ <listitem>
+ <para>
+ Enable interactive mode. This will make ctdbd run in the
+ foreground and not detach from the terminal. By default
+ ctdbd will detach itself and run in the background as a
+ daemon.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>-?, --help</term>
+ <listitem>
+ <para>
+ Display a summary of options.
+ </para>
+ </listitem>
</varlistentry>
- <varlistentry><term>--logfile=<filename></term>
- <listitem>
- <para>
- This is the file where ctdbd will write its log. This is usually /var/log/log.ctdb .
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry><term>--nlist=<filename></term>
- <listitem>
- <para>
- 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.
- </para>
- <para>
- This file is usually /etc/ctdb/nodes .
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry><term>--nosetsched</term>
- <listitem>
- <para>
- Normally ctdb will change its scheduler to run as a real-time
- process. This option is used to change this behaviour and have
- ctdb run as a normal process.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry><term>--public_addresses=<filename></term>
- <listitem>
- <para>
- 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.
- </para>
- <para>
- This is usually the file /etc/ctdb/public_addresses
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry><term>--public_interface=<interface></term>
- <listitem>
- <para>
- This option tells ctdb which interface to attach public-addresses
- to and also where to attach the single-public-ip when used.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry><term>--reclock=<filename></term>
- <listitem>
- <para>
- 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.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry><term>--single-public-ip=<address></term>
- <listitem>
- <para>
- This option is used to activate the "ipmux" functionality of ctdb.
- In this mode, all nodes of the cluster will expose a single
- ip address from all nodes with all incoming traffic to the cluster
- being passed through the current recmaster. This functionality
- is similar to using a load-balancing switch.
- </para>
- <para>
- All incoming packets are sent to the recmaster which will multiplex
- the clients across all available nodes and pass the packets on to
- a different node in the cluster to manage the connection based
- on the clients ip address. Outgoing packets however are sent
- directly from the node that was choosen back to the client.
- Since all incoming packets are sent through the recmaster this will
- have a throughput and performance impact when used. This impact
- in performance primarily affects write-performance while
- read-performance should be mainly unaffected.
- Only use this feature if your environment is mostly-read
- (i.e. most traffic is from the nodes back to the clients) or
- if it is not important to get maximum write-performance to the
- cluster.
- </para>
- <para>
- When using a single public ip, you must also specify the
- public-interface so that ctdb knows which interface to attach the
- single public ip to.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry><term>--socket=<filename></term>
- <listitem>
- <para>
- 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.
- </para>
- <para>
- 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.
- </para>
- </listitem>
- </varlistentry>
+ </variablelist>
+ </refsect1>
- <varlistentry><term>--syslog</term>
- <listitem>
- <para>
- Send all log messages to syslog instead of to the ctdb logfile.
- </para>
- </listitem>
- </varlistentry>
+ <refsect1>
+ <title>SEE ALSO</title>
+ <para>
+ <citerefentry><refentrytitle>ctdb</refentrytitle>
+ <manvolnum>1</manvolnum></citerefentry>,
- <varlistentry><term>--torture</term>
- <listitem>
- <para>
- 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.
- </para>
- <para>
- You do NOT want to use this option unless you are developing and testing new functionality in ctdbd.
- </para>
- </listitem>
- </varlistentry>
+ <citerefentry><refentrytitle>ctdbd_wrapper</refentrytitle>
+ <manvolnum>1</manvolnum></citerefentry>,
- <varlistentry><term>--transport=<STRING></term>
- <listitem>
- <para>
- This option specifies which transport to use for ctdbd internode communications. The default is "tcp".
- </para>
- <para>
- Suported transports are "tcp" and "infiniband".
- </para>
- </listitem>
- </varlistentry>
+ <citerefentry><refentrytitle>onnode</refentrytitle>
+ <manvolnum>1</manvolnum></citerefentry>,
- <varlistentry><term>--usage</term>
- <listitem>
- <para>
- Print useage information to the screen.
- </para>
- </listitem>
- </varlistentry>
+ <citerefentry><refentrytitle>ctdb.conf</refentrytitle>
+ <manvolnum>5</manvolnum></citerefentry>,
- </variablelist>
- </refsect1>
+ <citerefentry><refentrytitle>ctdb</refentrytitle>
+ <manvolnum>7</manvolnum></citerefentry>,
+ <citerefentry><refentrytitle>ctdb-tunables</refentrytitle>
+ <manvolnum>7</manvolnum></citerefentry>,
- <refsect1><title>Private vs Public addresses</title>
- <para>
- 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.
+ <ulink url="http://ctdb.samba.org/"/>
</para>
+ </refsect1>
- <refsect2><title>Private address</title>
- <para>
- 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.
- </para>
- <para>
- 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.
- </para>
- <para>
- 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.
- </para>
- <para>
- 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.
- </para>
- Example /etc/ctdb/nodes for a four node cluster:
- <screen format="linespecific">
- 10.1.1.1
- 10.1.1.2
- 10.1.1.3
- 10.1.1.4
- </screen>
- </refsect2>
- <refsect2><title>Public address</title>
- <para>
- 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.
- </para>
+ <refentryinfo>
+ <author>
+ <contrib>
+ This documentation was written by
+ Ronnie Sahlberg,
+ Amitay Isaacs,
+ Martin Schwenke
+ </contrib>
+ </author>
+
+ <copyright>
+ <year>2007</year>
+ <holder>Andrew Tridgell</holder>
+ <holder>Ronnie Sahlberg</holder>
+ </copyright>
+ <legalnotice>
<para>
- 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.
+ 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.
</para>
<para>
- 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.
+ 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.
</para>
<para>
- 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.
+ You should have received a copy of the GNU General Public
+ License along with this program; if not, see
+ <ulink url="http://www.gnu.org/licenses"/>.
</para>
- Example /etc/ctdb/public_addresses for a node that can host 4 public addresses:
- <screen format="linespecific">
- 11.1.1.1/24 eth0
- 11.1.1.2/24 eth0
- 11.1.2.1/24 eth1
- 11.1.2.2/24 eth1
- </screen>
-
- <para>
- 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.
- </para>
- Example: 4 nodes partitioned into two subgroups :
- <screen format="linespecific">
- 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
+ </legalnotice>
+ </refentryinfo>
- Node 3:/etc/ctdb/public_addresses
- 10.2.1.1/24 eth0
- 10.2.1.2/24 eth0
- </screen>
- <para>
- 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.
- </para>
- <para>
- 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.
- </para>
- </refsect2>
- </refsect1>
-
-
- <refsect1><title>Node status</title>
- <para>
- The current status of each node in the cluster can be viewed by the
- 'ctdb status' command.
- </para>
- <para>
- There are five possible for a node.
- </para>
-
- <para>
- OK - This node is fully functional.
- </para>
-
- <para>
- 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.
- </para>
-
- <para>
- 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.
- </para>
-
- <para>
- 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.
- </para>
-
- <para>
- 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.
- </para>
- </refsect1>
-
-
- <refsect1><title>SEE ALSO</title>
- <para>
- ctdb(1), onnode(1)
- <ulink url="http://ctdb.samba.org/"/>
- </para>
- </refsect1>
- <refsect1><title>COPYRIGHT/LICENSE</title>
-<literallayout>
-Copyright (C) Andrew Tridgell 2007
-Copyright (C) Ronnie sahlberg 2007
-
-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/.
-</literallayout>
- </refsect1>
</refentry>
git.samba.org / samba.git / blobdiff