cluster: STABLE3 - man pages: dlm_controld

David Teigland teigland at fedoraproject.org
Mon Jan 18 21:55:03 UTC 2010


Gitweb:        http://git.fedorahosted.org/git/cluster.git?p=cluster.git;a=commitdiff;h=eb697c1614fb2aa31cff96d90340767f3c3ded01
Commit:        eb697c1614fb2aa31cff96d90340767f3c3ded01
Parent:        f66111ea45a4f7cf46dd63866abff18c5bd46bf7
Author:        David Teigland <teigland at redhat.com>
AuthorDate:    Mon Jan 18 15:00:55 2010 -0600
Committer:     David Teigland <teigland at redhat.com>
CommitterDate: Mon Jan 18 15:53:04 2010 -0600

man pages: dlm_controld

updates for cluster3

Signed-off-by: David Teigland <teigland at redhat.com>
---
 group/man/dlm_controld.8 |  320 ++++++++++++++++++++++++++++++++++++----------
 1 files changed, 255 insertions(+), 65 deletions(-)

diff --git a/group/man/dlm_controld.8 b/group/man/dlm_controld.8
index e8dc1c6..7100f0e 100644
--- a/group/man/dlm_controld.8
+++ b/group/man/dlm_controld.8
@@ -1,81 +1,282 @@
-.TH dlm_controld 8
+.TH DLM_CONTROLD 8 2009-01-18 cluster cluster
 
 .SH NAME
-dlm_controld - daemon that configures dlm according to cluster events
+dlm_controld \- daemon that configures dlm according to cluster events
 
 .SH SYNOPSIS
-.B
-dlm_controld
-[\fIOPTION\fR]...
+.B dlm_controld
+[OPTIONS]
 
 .SH DESCRIPTION
-The dlm lives in the kernel, and the cluster infrastructure (cluster
+The dlm lives in the kernel, and the cluster infrastructure (corosync
 membership and group management) lives in user space.  The dlm in the
 kernel needs to adjust/recover for certain cluster events.  It's the job
 of dlm_controld to receive these events and reconfigure the kernel dlm as
 needed.  dlm_controld controls and configures the dlm through sysfs and
-configfs files that are considered dlm-internal interfaces; not a general
-API/ABI.
+configfs files that are considered dlm-internal interfaces.
 
-The dlm also exports lock state through debugfs so that dlm_controld can
-implement deadlock detection in user space.
+The cman init script usually starts the dlm_controld daemon.
 
-.SH CONFIGURATION FILE
+.SH OPTIONS
+Command line options override a corresponding setting in cluster.conf.
+
+.TP
+.B \-D
+Enable debugging to stderr and don't fork.
+.br
+See also
+.B dlm_tool dump
+in
+.BR dlm_tool (8).
+
+.TP
+.B \-L
+Enable debugging to log file.
+.br
+See also
+.B logging
+in
+.BR cluster.conf (5).
+
+.TP
+.B \-K
+Enable kernel dlm debugging messages.
+.br
+See also
+.B log_debug
+below.
+
+.TP
+.BI \-r " num"
+dlm kernel lowcomms protocol, 0 tcp, 1 sctp, 2 detect.
+2 selects tcp if corosync rrp_mode is "none", otherwise sctp.
+.br
+Default 2.
+
+.TP
+.BI \-g " num"
+groupd compatibility mode, 0 off, 1 on.
+.br
+Default 0.
+
+.TP
+.BI \-f " num"
+Enable (1) or disable (0) fencing recovery dependency.
+.br
+Default 1.
 
-Optional cluster.conf settings are placed in the <dlm> section.
+.TP
+.BI \-q " num"
+Enable (1) or disable (0) quorum recovery dependency.
+.br
+Default 0.
+
+.TP
+.BI \-d " num"
+Enable (1) or disable (0) deadlock detection code.
+.br
+Default 0.
 
-.SS Global settings
+.TP
+.BI \-p " num"
+Enable (1) or disable (0) plock code for cluster fs.
+.br
+Default 1.
+
+.TP
+.BI \-l " num"
+Limit the rate of plock operations, 0 for no limit.
+.br
+Default 0.
+
+.TP
+.BI \-o " num"
+Enable (1) or disable (0) plock ownership.
+.br
+Default 1.
+
+.TP
+.BI \-t " ms"
+Plock ownership drop resources time (milliseconds).
+.br
+Default 10000.
+
+.TP
+.BI \-c " num"
+Plock ownership drop resources count.
+.br
+Default 10.
+
+.TP
+.BI \-a " ms"
+Plock ownership drop resources age (milliseconds).
+.br
+Default 10000.
+
+.TP
+.B \-P
+Enable plock debugging messages (can produce excessive output).
+
+.TP
+.B \-h
+Print a help message describing available options, then exit.
+
+.TP
+.B \-V
+Print program version information, then exit.
+
+
+.SH FILES
+.BR cluster.conf (5)
+is usually located at /etc/cluster/cluster.conf.  It is not read directly.
+Other cluster components load the contents into memory, and the values are
+accessed through the libccs library.
+
+Configuration options for dlm (kernel) and dlm_controld are added to the
+<dlm /> section of cluster.conf, within the top level <cluster> section.
+
+.SS Kernel options
+
+.TP
+.B protocol
 The network
-.I protocol
-can be set to "tcp" or "sctp".  The default is tcp.
+.B protocol
+can be set to tcp, sctp or detect which selects tcp or sctp based on
+the corosync rrp_mode configuration (redundant ring protocol).
+The rrp_mode "none" results in tcp.  Default detect.
 
-  <dlm protocol="tcp"/>
+<dlm protocol="detect"/>
 
+.TP
+.B timewarn
 After waiting
-.I timewarn
+.B timewarn
 centiseconds, the dlm will emit a warning via netlink.  This only applies
 to lockspaces created with the DLM_LSFL_TIMEWARN flag, and is used for
-deadlock detection.  The default is 500 (5 seconds).
+deadlock detection.  Default 500 (5 seconds).
 
-  <dlm timewarn="500"/>
+<dlm timewarn="500"/>
 
+.TP
+.B log_debug
 DLM kernel debug messages can be enabled by setting
-.I log_debug
-to 1.  The default is 0.
+.B log_debug
+to 1.  Default 0.
+
+<dlm log_debug="0"/>
+
+.TP
+.B clusternode/weight
+The lock directory
+.B weight
+can be specified one the clusternode lines.  Weights would usually be
+used in the lock server configurations shown below instead.
+
+<clusternode name="node01" nodeid="1" weight="1"/>
+
+.SS Daemon options
+
+.TP
+.B enable_fencing
+See command line description.
+
+<dlm enable_fencing="1"/>
+
+.TP
+.B enable_quorum
+See command line description.
+
+<dlm enable_quorum="0"/>
+
+.TP
+.B enable_deadlk
+See command line description.
+
+<dlm enable_deadlk="0"/>
+
+.TP
+.B enable_plock
+See command line description.
+
+<dlm enable_plock="1"/>
+
+.TP
+.B plock_rate_limit
+See command line description.
+
+<dlm plock_rate_limit="0"/>
+
+.TP
+.B plock_ownership
+See command line description.
+
+<dlm plock_ownership="1"/>
+
+.TP
+.B drop_resources_time
+See command line description.
+
+<dlm drop_resources_time="10000"/>
+
+.TP
+.B drop_resources_count
+See command line description.
+
+<dlm drop_resources_count="10"/>
+
+.TP
+.B drop_resources_age
+See command line description.
+
+<dlm drop_resources_age="10000"/>
+
+.TP
+.B plock_debug
+Enable (1) or disable (0) plock debugging messages (can produce excessive
+output). Default 0.
+
+<dlm plock_debug="0"/>
 
-  <dlm log_debug="0"/>
 
 .SS Disabling resource directory
 
 Lockspaces usually use a resource directory to keep track of which node is
 the master of each resource.  The dlm can operate without the resource
 directory, though, by statically assigning the master of a resource using
-a hash of the resource name.
+a hash of the resource name.  To enable, set the per-lockspace
+.B nodir
+option to 1.
 
-  <dlm>
-    <lockspace name="foo" nodir="1">
-  </dlm>
+.nf
+<dlm>
+  <lockspace name="foo" nodir="1">
+</dlm>
+.fi
 
 .SS Lock-server configuration
 
 The nodir setting can be combined with node weights to create a
 configuration where select node(s) are the master of all resources/locks.
-These "master" nodes can be viewed as "lock servers" for the other nodes.
+These
+.B master
+nodes can be viewed as "lock servers" for the other nodes.
 
-  <dlm>
-    <lockspace name="foo" nodir="1">
-      <master name="node01"/>
-    </lockspace>
-  </dlm>
+.nf
+<dlm>
+  <lockspace name="foo" nodir="1">
+    <master name="node01"/>
+  </lockspace>
+</dlm>
 
 or,
 
-  <dlm>
-    <lockspace name="foo" nodir="1">
-      <master name="node01"/>
-      <master name="node02"/>
-    </lockspace>
-  </dlm>
+<dlm>
+  <lockspace name="foo" nodir="1">
+    <master name="node01"/>
+    <master name="node02"/>
+  </lockspace>
+</dlm>
+.fi
 
 Lock management will be partitioned among the available masters.  There
 can be any number of masters defined.  The designated master nodes will
@@ -87,37 +288,26 @@ disruption, when a non-master node joins/leaves.
 There is no special mode in the dlm for this lock server configuration,
 it's just a natural consequence of combining the "nodir" option with node
 weights.  When a lockspace has master nodes defined, the master has a
-default weight of 1 and all non-master nodes have weight of 0.  Explicit
-non-zero weights can also be assigned to master nodes, e.g.
+default weight of 1 and all non-master nodes have weight of 0.  An explicit
+non-zero
+.B weight
+can also be assigned to master nodes, e.g.
 
-  <dlm>
-    <lockspace name="foo" nodir="1">
-      <master name="node01" weight="2"/>
-      <master name="node02" weight="1"/>
-    </lockspace>
-  </dlm>
+.nf
+<dlm>
+  <lockspace name="foo" nodir="1">
+    <master name="node01" weight="2"/>
+    <master name="node02" weight="1"/>
+  </lockspace>
+</dlm>
+.fi
 
 In which case node01 will master 2/3 of the total resources and node2 will
 master the other 1/3.
 
-
-.SH OPTIONS
-.TP
-\fB-d\fP <num>
-Enable (1) or disable (0) the deadlock detection code.
-.TP
-\fB-D\fP
-Run the daemon in the foreground and print debug statements to stdout.
-.TP
-\fB-K\fP
-Enable kernel dlm debugging messages.
-.TP
-\fB-V\fP
-Print the version information and exit.
-.TP
-\fB-h\fP 
-Print out a help message describing available options, then exit.
-
 .SH SEE ALSO
-groupd(8)
+.BR dlm_tool (8),
+.BR fenced (8),
+.BR cman (5),
+.BR cluster.conf (5)
 


More information about the cluster-commits mailing list