diff options
| author | Andrew Tridgell <tridge@samba.org> | 2007-06-12 13:44:01 +1000 |
|---|---|---|
| committer | Andrew Tridgell <tridge@samba.org> | 2007-06-12 13:44:01 +1000 |
| commit | d706a9730f95d25629ce70391e420d4bcd727237 (patch) | |
| tree | bf9ad400e0805da300526ada77e5c464ea702ec9 /ctdb | |
| parent | c64a914687ce0d84f9aaef641fc31c7a7a535c00 (diff) | |
| download | samba-d706a9730f95d25629ce70391e420d4bcd727237.tar.gz samba-d706a9730f95d25629ce70391e420d4bcd727237.tar.xz samba-d706a9730f95d25629ce70391e420d4bcd727237.zip | |
added onnode manual page
(This used to be ctdb commit 6f4a1b4dbc9a5d48513477fb4f5e214a51f70941)
Diffstat (limited to 'ctdb')
| -rw-r--r-- | ctdb/Makefile.in | 21 | ||||
| -rw-r--r-- | ctdb/doc/ctdb.1 | 4 | ||||
| -rw-r--r-- | ctdb/doc/ctdb.1.html | 74 | ||||
| -rw-r--r-- | ctdb/doc/ctdbd.1 | 4 | ||||
| -rw-r--r-- | ctdb/doc/ctdbd.1.html | 16 | ||||
| -rw-r--r-- | ctdb/doc/onnode.1 | 80 | ||||
| -rw-r--r-- | ctdb/doc/onnode.1.html | 46 | ||||
| -rw-r--r-- | ctdb/doc/onnode.1.xml | 92 | ||||
| -rw-r--r-- | ctdb/packaging/RPM/ctdb.spec | 1 | ||||
| -rw-r--r-- | ctdb/web/documentation.html | 4 |
10 files changed, 280 insertions, 62 deletions
diff --git a/ctdb/Makefile.in b/ctdb/Makefile.in index e817493bdc..151262d4ec 100644 --- a/ctdb/Makefile.in +++ b/ctdb/Makefile.in @@ -58,6 +58,8 @@ SBINS = bin/ctdbd DIRS = lib bin +.SUFFIXES: .c .o .h .1 .1.xml .1.html + all: showflags dirs doc $(CTDB_SERVER_OBJ) $(CTDB_CLIENT_OBJ) $(BINS) $(SBINS) $(TEST_BINS) showflags: @@ -93,19 +95,15 @@ bin/ibwrapper_test: $(CTDB_CLIENT_OBJ) ib/ibwrapper_test.o @echo Linking $@ @$(CC) $(CFLAGS) -o $@ ib/ibwrapper_test.o $(CTDB_CLIENT_OBJ) $(LIB_FLAGS) -doc: doc/ctdb.1 doc/ctdb.1.html doc/ctdbd.1 doc/ctdbd.1.html - -doc/ctdb.1: doc/ctdb.1.xml - -test -z "$(XSLTPROC)" || $(XSLTPROC) --nonet -o $@ http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl $< - -doc/ctdb.1.html: doc/ctdb.1.xml - -test -z "$(XSLTPROC)" || $(XSLTPROC) --nonet -o $@ http://docbook.sourceforge.net/release/xsl/current/html/docbook.xsl $< +.1.xml.1: + -test -z "$(XSLTPROC)" || $(XSLTPROC) -o $@ http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl $< -doc/ctdbd.1: doc/ctdbd.1.xml - -test -z "$(XSLTPROC)" || $(XSLTPROC) --nonet -o $@ http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl $< +.1.xml.1.html: + -test -z "$(XSLTPROC)" || $(XSLTPROC) -o $@ http://docbook.sourceforge.net/release/xsl/current/html/docbook.xsl $< -doc/ctdbd.1.html: doc/ctdbd.1.xml - -test -z "$(XSLTPROC)" || $(XSLTPROC) --nonet -o $@ http://docbook.sourceforge.net/release/xsl/current/html/docbook.xsl $< +doc: doc/ctdb.1 doc/ctdb.1.html \ + doc/ctdbd.1 doc/ctdbd.1.html \ + doc/onnode.1 doc/onnode.1.html clean: rm -f *.o */*.o */*/*.o */*~ @@ -140,6 +138,7 @@ install: all if [ -f doc/ctdb.1 ];then ${INSTALLCMD} -d $(DESTDIR)$(mandir)/man1; fi if [ -f doc/ctdb.1 ];then ${INSTALLCMD} -m 644 doc/ctdb.1 $(DESTDIR)$(mandir)/man1; fi if [ -f doc/ctdbd.1 ];then ${INSTALLCMD} -m 644 doc/ctdbd.1 $(DESTDIR)$(mandir)/man1; fi + if [ -f doc/onnode.1 ];then ${INSTALLCMD} -m 644 doc/onnode.1 $(DESTDIR)$(mandir)/man1; fi cd $(DESTDIR)$(bindir) && ln -sf onnode.ssh onnode test: all diff --git a/ctdb/doc/ctdb.1 b/ctdb/doc/ctdb.1 index 687c2bc0d7..829b1e67d1 100644 --- a/ctdb/doc/ctdb.1 +++ b/ctdb/doc/ctdb.1 @@ -1,11 +1,11 @@ .\" Title: ctdb .\" Author: .\" Generator: DocBook XSL Stylesheets v1.72.0 <http://docbook.sf.net/> -.\" Date: 06/11/2007 +.\" Date: 06/12/2007 .\" Manual: .\" Source: .\" -.TH "CTDB" "1" "06/11/2007" "" "" +.TH "CTDB" "1" "06/12/2007" "" "" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) diff --git a/ctdb/doc/ctdb.1.html b/ctdb/doc/ctdb.1.html index eb4633137a..48d683754a 100644 --- a/ctdb/doc/ctdb.1.html +++ b/ctdb/doc/ctdb.1.html @@ -1,6 +1,6 @@ -<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.72.0"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="ctdb.1"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>ctdb — clustered tdb database management utility</p></div><div class="refsynopsisdiv"><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 <node>] [-Y] [-t <timeout>] [-? --help] [--usage] [-d --debug=<INTEGER>] [--socket=<filename>]</p></div></div><div class="refsect1" lang="en"><a name="id2486758"></a><h2>DESCRIPTION</h2><p> +<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.72.0"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="ctdb.1"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>ctdb — clustered tdb database management utility</p></div><div class="refsynopsisdiv"><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 <node>] [-Y] [-t <timeout>] [-? --help] [--usage] [-d --debug=<INTEGER>] [--socket=<filename>]</p></div></div><div class="refsect1" lang="en"><a name="id2488867"></a><h2>DESCRIPTION</h2><p> ctdb is a utility to view and manage a ctdb cluster. - </p></div><div class="refsect1" lang="en"><a name="id2486768"></a><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">-n <node></span></dt><dd><p> + </p></div><div class="refsect1" lang="en"><a name="id2488877"></a><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">-n <node></span></dt><dd><p> This specifies on which node to execute the command. Default is to run the command on the deamon running on the local host. </p></dd><dt><span class="term">-Y</span></dt><dd><p> @@ -20,11 +20,11 @@ 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></dl></div></div><div class="refsect1" lang="en"><a name="id2486884"></a><h2>Administrative Commands</h2><p> + </p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id2488991"></a><h2>Administrative Commands</h2><p> These are commands used to monitor and administrate a CTDB cluster. - </p><div class="refsect2" lang="en"><a name="id2486894"></a><h3>status</h3><p> + </p><div class="refsect2" lang="en"><a name="id2489000"></a><h3>status</h3><p> This command shows the current status of the ctdb node. - </p><div class="refsect3" lang="en"><a name="id2486903"></a><h4>node status</h4><p> + </p><div class="refsect3" lang="en"><a name="id2489009"></a><h4>node status</h4><p> Node status reflects the current status of the node. There are four possible states: </p><p> OK - This node is fully functional. @@ -36,20 +36,20 @@ 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></div><div class="refsect3" lang="en"><a name="id2486954"></a><h4>generation</h4><p> + </p></div><div class="refsect3" lang="en"><a name="id2489061"></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></div><div class="refsect3" lang="en"><a name="id2486966"></a><h4>VNNMAP</h4><p> + </p></div><div class="refsect3" lang="en"><a name="id2490207"></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 parcipitating in the vnnmap can become lmaster or dmaster for a database record. - </p></div><div class="refsect3" lang="en"><a name="id2486980"></a><h4>Recovery mode</h4><p> + </p></div><div class="refsect3" lang="en"><a name="id2490221"></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></div><div class="refsect3" lang="en"><a name="id2487004"></a><h4>Recovery master</h4><p> + </p></div><div class="refsect3" lang="en"><a name="id2490244"></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></div><p> Example: ctdb status @@ -67,7 +67,7 @@ hash:2 lmaster:2 hash:3 lmaster:3 Recovery mode:NORMAL (0) Recovery master:0 - </pre></div><div class="refsect2" lang="en"><a name="id2487036"></a><h3>ping</h3><p> + </pre></div><div class="refsect2" lang="en"><a name="id2490275"></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 @@ -78,7 +78,7 @@ 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" lang="en"><a name="id2487063"></a><h3>ip</h3><p> + </pre></div><div class="refsect2" lang="en"><a name="id2490302"></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. </p><p> Example: ctdb ip @@ -90,7 +90,7 @@ Number of nodes:4 12.1.1.2 1 12.1.1.3 2 12.1.1.4 3 - </pre></div><div class="refsect2" lang="en"><a name="id2487090"></a><h3>getvar <name></h3><p> + </pre></div><div class="refsect2" lang="en"><a name="id2490327"></a><h3>getvar <name></h3><p> Get the runtime value of a tuneable variable. </p><p> Example: ctdb getvar MaxRedirectCount @@ -98,11 +98,11 @@ Number of nodes:4 Example output: </p><pre class="screen"> MaxRedirectCount = 3 - </pre></div><div class="refsect2" lang="en"><a name="id2487114"></a><h3>setvar <name> <value></h3><p> + </pre></div><div class="refsect2" lang="en"><a name="id2490350"></a><h3>setvar <name> <value></h3><p> Set the runtime value of a tuneable variable. </p><p> Example: ctdb setvar MaxRedirectCount 5 - </p></div><div class="refsect2" lang="en"><a name="id2487129"></a><h3>listvars</h3><p> + </p></div><div class="refsect2" lang="en"><a name="id2490365"></a><h3>listvars</h3><p> List all tuneable variables. </p><p> Example: ctdb listvars @@ -124,7 +124,7 @@ MonitorInterval = 15 EventScriptTimeout = 20 RecoveryGracePeriod = 60 RecoveryBanPeriod = 300 - </pre></div><div class="refsect2" lang="en"><a name="id2487158"></a><h3>statistics</h3><p> + </pre></div><div class="refsect2" lang="en"><a name="id2490393"></a><h3>statistics</h3><p> Collect statistics from the CTDB daemon about how many calls it has served. </p><p> Example: ctdb statistics @@ -166,45 +166,45 @@ CTDB version 1 max_hop_count 0 max_call_latency 4.948321 sec max_lockwait_latency 0.000000 sec - </pre></div><div class="refsect2" lang="en"><a name="id2487202"></a><h3>statisticsreset</h3><p> + </pre></div><div class="refsect2" lang="en"><a name="id2490436"></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" lang="en"><a name="id2487216"></a><h3>getdebug</h3><p> + </p></div><div class="refsect2" lang="en"><a name="id2490450"></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></div><div class="refsect2" lang="en"><a name="id2487227"></a><h3>setdebug <debuglevel></h3><p> + </p></div><div class="refsect2" lang="en"><a name="id2490461"></a><h3>setdebug <debuglevel></h3><p> Set the debug level of a node. This is a number between 0 and 9 and controls what information will be written to the logfile. - </p></div><div class="refsect2" lang="en"><a name="id2487239"></a><h3>getpid</h3><p> + </p></div><div class="refsect2" lang="en"><a name="id2536585"></a><h3>getpid</h3><p> This command will return the process id of the ctdb daemon. - </p></div><div class="refsect2" lang="en"><a name="id2487249"></a><h3>disable</h3><p> + </p></div><div class="refsect2" lang="en"><a name="id2536595"></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" lang="en"><a name="id2487267"></a><h3>enable</h3><p> + </p></div><div class="refsect2" lang="en"><a name="id2536613"></a><h3>enable</h3><p> Re-enable a node that has been administratively disabled. - </p></div><div class="refsect2" lang="en"><a name="id2487277"></a><h3>ban <bantime|0></h3><p> + </p></div><div class="refsect2" lang="en"><a name="id2536623"></a><h3>ban <bantime|0></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 an other node and no services are hosted. </p><p> Nodes are automatically banned if they are the cause of too many cluster recoveries. - </p></div><div class="refsect2" lang="en"><a name="id2487301"></a><h3>unban</h3><p> + </p></div><div class="refsect2" lang="en"><a name="id2536646"></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" lang="en"><a name="id2487312"></a><h3>shutdown</h3><p> + </p></div><div class="refsect2" lang="en"><a name="id2536658"></a><h3>shutdown</h3><p> This command will shutdown a specific CTDB daemon. - </p></div><div class="refsect2" lang="en"><a name="id2487322"></a><h3>recover</h3><p> + </p></div><div class="refsect2" lang="en"><a name="id2536668"></a><h3>recover</h3><p> This command will trigger the recovery daemon to do a cluster recovery. - </p></div></div><div class="refsect1" lang="en"><a name="id2487334"></a><h2>Debugging Commands</h2><p> + </p></div></div><div class="refsect1" lang="en"><a name="id2536680"></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" lang="en"><a name="id2487343"></a><h3>process-exists <pid></h3><p> + </p><div class="refsect2" lang="en"><a name="id2536690"></a><h3>process-exists <pid></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" lang="en"><a name="id2487356"></a><h3>getdbmap</h3><p> + </p></div><div class="refsect2" lang="en"><a name="id2536702"></a><h3>getdbmap</h3><p> This command lists all clustered TDB databases that the CTDB daemon has attahced to. </p><p> Example: ctdb getdbmap @@ -216,21 +216,21 @@ 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 - </pre></div><div class="refsect2" lang="en"><a name="id2487384"></a><h3>catdb <dbname></h3><p> + </pre></div><div class="refsect2" lang="en"><a name="id2536730"></a><h3>catdb <dbname></h3><p> This command will dump a clustered TDB database to the screen. This is a debugging command. - </p></div><div class="refsect2" lang="en"><a name="id2487395"></a><h3>getmonmode</h3><p> + </p></div><div class="refsect2" lang="en"><a name="id2536740"></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 continously 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" lang="en"><a name="id2487426"></a><h3>setmonmode <0|1></h3><p> + </p></div><div class="refsect2" lang="en"><a name="id2536771"></a><h3>setmonmode <0|1></h3><p> This command can be used to explicitely 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" lang="en"><a name="id2487448"></a><h3>attach <dbname></h3><p> + </p></div><div class="refsect2" lang="en"><a name="id2536794"></a><h3>attach <dbname></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" lang="en"><a name="id2487459"></a><h3>dumpmemory</h3><p> + </p></div><div class="refsect2" lang="en"><a name="id2536805"></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 the log file. - </p></div><div class="refsect2" lang="en"><a name="id2487470"></a><h3>freeze</h3><p> + </p></div><div class="refsect2" lang="en"><a name="id2536816"></a><h3>freeze</h3><p> This command will lock all the local TDB databases causing clients that are accessing these TDBs such as samba3 to block until the databases are thawed. @@ -238,12 +238,12 @@ dbid:0xc0bdde6a name:sessionid.tdb path:/var/ctdb/sessionid.tdb.0 This is primarily used by the recovery daemon to stop all samba daemons from accessing any databases while the database is recovered and rebuilt. - </p></div><div class="refsect2" lang="en"><a name="id2487488"></a><h3>thaw</h3><p> + </p></div><div class="refsect2" lang="en"><a name="id2536834"></a><h3>thaw</h3><p> Thaw a previously frozen node. - </p></div></div><div class="refsect1" lang="en"><a name="id2487499"></a><h2>SEE ALSO</h2><p> + </p></div></div><div class="refsect1" lang="en"><a name="id2536845"></a><h2>SEE ALSO</h2><p> ctdbd(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="id2487513"></a><h2>COPYRIGHT/LICENSE</h2><div class="literallayout"><p><br> + </p></div><div class="refsect1" lang="en"><a name="id2536858"></a><h2>COPYRIGHT/LICENSE</h2><div class="literallayout"><p><br> Copyright (C) Andrew Tridgell 2007<br> Copyright (C) Ronnie sahlberg 2007<br> <br> diff --git a/ctdb/doc/ctdbd.1 b/ctdb/doc/ctdbd.1 index f88edd92c3..1fabde9115 100644 --- a/ctdb/doc/ctdbd.1 +++ b/ctdb/doc/ctdbd.1 @@ -1,11 +1,11 @@ .\" Title: ctdbd .\" Author: .\" Generator: DocBook XSL Stylesheets v1.72.0 <http://docbook.sf.net/> -.\" Date: 06/11/2007 +.\" Date: 06/12/2007 .\" Manual: .\" Source: .\" -.TH "CTDBD" "1" "06/11/2007" "" "" +.TH "CTDBD" "1" "06/12/2007" "" "" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) diff --git a/ctdb/doc/ctdbd.1.html b/ctdb/doc/ctdbd.1.html index ebf6be39cb..e6a63d2aba 100644 --- a/ctdb/doc/ctdbd.1.html +++ b/ctdb/doc/ctdbd.1.html @@ -1,4 +1,4 @@ -<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.72.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>] [--public-interface=<interface>] [--event-script=<filename>] [--logfile=<filename>] [--listen=<address>] [--transport=<STRING>] [--socket=<filename>] [-d --debug=<INTEGER>] [--torture]</p></div></div><div class="refsect1" lang="en"><a name="id2486804"></a><h2>DESCRIPTION</h2><p> +<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.72.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>] [--public-interface=<interface>] [--event-script=<filename>] [--logfile=<filename>] [--listen=<address>] [--transport=<STRING>] [--socket=<filename>] [-d --debug=<INTEGER>] [--torture]</p></div></div><div class="refsect1" lang="en"><a name="id2488930"></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. @@ -8,7 +8,7 @@ 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="id2486836"></a><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">-? --help</span></dt><dd><p> + </p></div><div class="refsect1" lang="en"><a name="id2488962"></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. @@ -58,10 +58,10 @@ 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="id2487118"></a><h2>Private vs Public addresses</h2><p> + </p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id2490376"></a><h2>Private vs Public addresses</h2><p> When used for ip takeover in a HA environment, each node in a ctdb cluster has two ip addresses assigned to it. One private and one public. - </p><div class="refsect2" lang="en"><a name="id2487129"></a><h3>Private address</h3><p> + </p><div class="refsect2" lang="en"><a name="id2490386"></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 @@ -89,7 +89,7 @@ 10.1.1.2 10.1.1.3 10.1.1.4 - </pre></div><div class="refsect2" lang="en"><a name="id2487175"></a><h3>Public address</h3><p> + </pre></div><div class="refsect2" lang="en"><a name="id2490432"></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. You should NOT have this address configured @@ -129,7 +129,7 @@ In this example, if node 3 fails, its public address can be taken over by node 2 since node 2 is on the same subnet as 3 but not by node 0 or node 1 since node 0 and 1 are both on a different subnet from node 3. - </p></div></div><div class="refsect1" lang="en"><a name="id2487244"></a><h2>Node status</h2><p> + </p></div></div><div class="refsect1" lang="en"><a name="id2536612"></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> @@ -160,10 +160,10 @@ 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="id2487300"></a><h2>SEE ALSO</h2><p> + </p></div><div class="refsect1" lang="en"><a name="id2536669"></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="id2487314"></a><h2>COPYRIGHT/LICENSE</h2><div class="literallayout"><p><br> + </p></div><div class="refsect1" lang="en"><a name="id2536682"></a><h2>COPYRIGHT/LICENSE</h2><div class="literallayout"><p><br> Copyright (C) Andrew Tridgell 2007<br> Copyright (C) Ronnie sahlberg 2007<br> <br> diff --git a/ctdb/doc/onnode.1 b/ctdb/doc/onnode.1 new file mode 100644 index 0000000000..34d370f8b1 --- /dev/null +++ b/ctdb/doc/onnode.1 @@ -0,0 +1,80 @@ +.\" Title: onnode +.\" Author: +.\" Generator: DocBook XSL Stylesheets v1.72.0 <http://docbook.sf.net/> +.\" Date: 06/12/2007 +.\" Manual: +.\" Source: +.\" +.TH "ONNODE" "1" "06/12/2007" "" "" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" +onnode \- run commands on ctdb nodes +.SH "SYNOPSIS" +.HP 24 +\fBonnode NODE 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 NODE option specifies which node to run a command on. You can specify a numeric node number (from 0 to N\-1) or the special node 'all'. +.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. +.PP +If the COMMAND starts with a /, then the command is run via the 'at' service. Otherwise the command is run in the foreground. +.SH "EXAMPLES" +.PP +The following command would show the process ID of ctdb on all nodes +.sp +.RS 4 +.nf +onnode all pidof ctdbd + +.fi +.RE +.PP +The following command would show the last 5 lines of log on each node, preceded by the nodes hostname +.sp +.RS 4 +.nf +onnode all "hostname; tail \-5 /var/log/log.ctdb" + +.fi +.RE +.PP +The following command would restart the ctdb service on all nodes. +.sp +.RS 4 +.nf +onnode all service ctdb restart + +.fi +.RE +.SH "SEE ALSO" +.PP +ctdbd(1), ctdb(1), +\fI\%http://ctdb.samba.org/\fR +.SH "COPYRIGHT/LICENSE" +.sp +.RS 4 +.nf +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 2 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, write to the Free Software +Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. +.fi +.RE diff --git a/ctdb/doc/onnode.1.html b/ctdb/doc/onnode.1.html new file mode 100644 index 0000000000..27ee5812d5 --- /dev/null +++ b/ctdb/doc/onnode.1.html @@ -0,0 +1,46 @@ +<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.72.0"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="onnode.1"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>onnode — run commands on ctdb nodes</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">onnode NODE COMMAND ...</code> </p></div></div><div class="refsect1" lang="en"><a name="id2490458"></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 NODE option specifies which node to run a command on. You + can specify a numeric node number (from 0 to N-1) or the special + node 'all'. + </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><p> + If the COMMAND starts with a /, then the command is run via the + 'at' service. Otherwise the command is run in the foreground. + </p></div><div class="refsect1" lang="en"><a name="id2487794"></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 nodes 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></div><div class="refsect1" lang="en"><a name="id2488692"></a><h2>SEE ALSO</h2><p> + ctdbd(1), ctdb(1), <a href="http://ctdb.samba.org/" target="_top">http://ctdb.samba.org/</a> + </p></div><div class="refsect1" lang="en"><a name="id2488704"></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 2 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, write to the Free Software<br> +Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.<br> +</p></div></div></div></body></html> diff --git a/ctdb/doc/onnode.1.xml b/ctdb/doc/onnode.1.xml new file mode 100644 index 0000000000..f9add34e40 --- /dev/null +++ b/ctdb/doc/onnode.1.xml @@ -0,0 +1,92 @@ +<?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="onnode.1"> + +<refmeta> + <refentrytitle>onnode</refentrytitle> + <manvolnum>1</manvolnum> +</refmeta> + + +<refnamediv> + <refname>onnode</refname> + <refpurpose>run commands on ctdb nodes</refpurpose> +</refnamediv> + +<refsynopsisdiv> + <cmdsynopsis> + <command>onnode NODE COMMAND ...</command> + </cmdsynopsis> +</refsynopsisdiv> + + <refsect1><title>DESCRIPTION</title> + <para> + onnode is a utility to run commands on a specific node of a CTDB + cluster, or on all nodes. + </para> + <para> + The NODE option specifies which node to run a command on. You + can specify a numeric node number (from 0 to N-1) or the special + node 'all'. + </para> + <para> + The COMMAND can be any shell command. The onnode utility uses + ssh or rsh to connect to the remote nodes and run the command. + </para> + <para> + If the COMMAND starts with a /, then the command is run via the + 'at' service. Otherwise the command is run in the foreground. + </para> + </refsect1> + + <refsect1><title>EXAMPLES</title> + <para> + The following command would show the process ID of ctdb on all nodes + </para> + <screen format="linespecific"> +onnode all pidof ctdbd + </screen> + + <para> + The following command would show the last 5 lines of log on each + node, preceded by the nodes hostname + </para> + <screen format="linespecific"> +onnode all "hostname; tail -5 /var/log/log.ctdb" + </screen> + + <para> + The following command would restart the ctdb service on all nodes. + </para> + <screen format="linespecific"> +onnode all service ctdb restart + </screen> + + </refsect1> + + <refsect1><title>SEE ALSO</title> + <para> + ctdbd(1), ctdb(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 2 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, write to the Free Software +Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. +</literallayout> + </refsect1> +</refentry> diff --git a/ctdb/packaging/RPM/ctdb.spec b/ctdb/packaging/RPM/ctdb.spec index 4ec8b6df13..7d7ad53b1b 100644 --- a/ctdb/packaging/RPM/ctdb.spec +++ b/ctdb/packaging/RPM/ctdb.spec @@ -107,5 +107,6 @@ fi %{_bindir}/onnode %{_mandir}/man1/ctdb.1.gz %{_mandir}/man1/ctdbd.1.gz +%{_mandir}/man1/onnode.1.gz %{_includedir}/ctdb.h %{_includedir}/ctdb_private.h diff --git a/ctdb/web/documentation.html b/ctdb/web/documentation.html index 74a59ddd5f..456311f98d 100644 --- a/ctdb/web/documentation.html +++ b/ctdb/web/documentation.html @@ -5,8 +5,7 @@ <h1>CTDB Documentation</h1> -Not all CTDB documentation is complete yet, but here are some bits to -get you started +The following documentation should get you started with CTDB. <ul> <li><a href="prerequisites.html">Prerequisites</a> @@ -24,6 +23,7 @@ Man pages: <ul> <li><a href="http://ctdb.samba.org/~tridge/ctdb/doc/ctdb.1.html">ctdb manual page</a> <li><a href="http://ctdb.samba.org/~tridge/ctdb/doc/ctdbd.1.html">ctdbd manual page</a> +<li><a href="http://ctdb.samba.org/~tridge/ctdb/doc/onnode.1.html">onnode manual page</a> </ul> <!--#include virtual="footer.html" --> |