[Ocfs2-tools-devel] [PATCH 25/28] o2cb: Add manpage for sysconfig/o2cb

Sunil Mushran sunil.mushran at oracle.com
Fri Aug 19 15:16:22 PDT 2011 

Signed-off-by: Sunil Mushran <sunil.mushran at oracle.com>
---
 configure.in                              |    1 +
 debian/ocfs2-tools.manpages               |    1 +
 vendor/common/.gitignore                  |    1 +
 vendor/common/Makefile                    |    5 +-
 vendor/common/o2cb.sysconfig.5.in         |  135 +++++++++++++++++++++++++++++
 vendor/common/ocfs2-tools.spec-generic.in |    1 +
 6 files changed, 143 insertions(+), 1 deletions(-)
 create mode 100644 vendor/common/o2cb.sysconfig.5.in

diff --git a/configure.in b/configure.in
index 94c96dc..7079d2d 100644
--- a/configure.in
+++ b/configure.in
@@ -444,6 +444,7 @@ o2info/o2info.1
 libo2cb/o2cb.7
 o2monitor/o2hbmonitor.8
 o2cb_ctl/ocfs2.cluster.conf.5
+vendor/common/o2cb.sysconfig.5
 vendor/common/ocfs2-tools.spec-generic
 ])
 
diff --git a/debian/ocfs2-tools.manpages b/debian/ocfs2-tools.manpages
index ec95a85..cbd1567 100644
--- a/debian/ocfs2-tools.manpages
+++ b/debian/ocfs2-tools.manpages
@@ -11,3 +11,4 @@ debian/tmp/usr/share/man/man7/o2cb.7
 debian/tmp/usr/share/man/man1/o2info.1
 debian/tmp/usr/share/man/man8/o2hbmonitor.8
 debian/tmp/usr/share/man/man5/ocfs2.cluster.conf.5
+debian/tmp/usr/share/man/man5/o2cb.sysconfig.5
diff --git a/vendor/common/.gitignore b/vendor/common/.gitignore
index 6c7413f..7f1d807 100644
--- a/vendor/common/.gitignore
+++ b/vendor/common/.gitignore
@@ -2,3 +2,4 @@ ocfs2-tools.spec
 ocfs2-tools.spec-generic
 *.sw?
 o2cb.init
+o2cb.sysconfig.5
diff --git a/vendor/common/Makefile b/vendor/common/Makefile
index e087b41..864a71e 100644
--- a/vendor/common/Makefile
+++ b/vendor/common/Makefile
@@ -16,12 +16,15 @@ $(patsubst %.sh,%,$(SCRIPT_SH)) : % : %.sh
 
 ALL_RULES = $(SCRIPTS)
 
+MANS = o2cb.sysconfig.5
+
 DIST_FILES =					\
 	$(SCRIPT_SH)				\
 	o2cb.sysconfig				\
 	ocfs2.init				\
 	ocfs2-tools.spec-generic.in		\
 	51-ocfs2.rules				\
-	Vendor.make
+	Vendor.make				\
+	o2cb.sysconfig.5.in
 
 include $(TOPDIR)/Postamble.make
diff --git a/vendor/common/o2cb.sysconfig.5.in b/vendor/common/o2cb.sysconfig.5.in
new file mode 100644
index 0000000..dcc1cd7
--- /dev/null
+++ b/vendor/common/o2cb.sysconfig.5.in
@@ -0,0 +1,135 @@
+.TH "/etc/sysconfig/o2cb" "5" "August 2011" "Version @VERSION@" "OCFS2 Manual Pages"
+.SH "NAME"
+/etc/sysconfig/o2cb \- Cluster configuration file for the \fBo2cb\fR cluster stack.
+.SH "SYNOPSIS"
+.PP 
+The configuration file \fB/etc/sysconfig/o2cb\fR stores the active cluster stack,
+its name and the various cluster timeouts for the \fBo2cb\fR cluster stack.
+
+.SH "DESCRIPTION"
+.PP
+This file can be populated using the \fIo2cb\fR init script. An example of the same
+is illustrated in the examples section.
+
+The list of configurable parameters in this file are:
+
+.TP
+\fBO2CB_STACK\fR
+Name of the cluster stack. The possible values are \fBo2cb\fR, \fBpcmk\fR and \fBcman\fR.
+\fBo2cb\fR is the default cluster stack of the \fBOCFS2\fR file system. \fBpcmk\fR
+(Pacemaker) and \fBcman\fR (rgmanager) are the two other cluster stacks that are
+supported by the same file system.
+
+.TP
+\fBO2CB_BOOTCLUSTER\fR
+Name of the active cluster. While /etc/ocfs2/cluster.conf can hold descriptions of
+multiple clusters, only one can be active at any one time. The name of that
+active cluster is specified here. The name itself can be upto 16 alphanumeric
+characters [0-9A-Za-z] with no special characters.
+.PP
+
+The remaining configurable parameters (cluster timeouts) are only relevant for the
+\fBo2cb\fR cluster stack. These cluster timeouts are used by the \fBo2cb\fR cluster
+stack to determine whether a node is dead or alive. The default timeouts are just
+a guide and may need to be tweaked depending on the hardware the software is running on.
+
+The various \fIcluster timeouts\fR for the \fBo2cb\fR cluster stack are:
+.TP
+\fBO2CB_HEARTBEAT_THRESHOLD\fR
+The disk heartbeat timeout is the number of two second iterations before a node is
+considered dead. The exact formula used to convert the timeout in seconds to the
+number of iterations is as follows:
+
+.in +4n
+O2CB_HEARTBEAT_THRESHOLD = (((timeout in seconds) / 2) + 1)
+.in
+
+For example, to specify a 60 sec timeout, set it to 31. For 120 secs, set it to 61.
+The default for this timeout is 60 secs (O2CB_HEARTBEAT_THRESHOLD = 31).
+
+While it defaults to 60 secs, multipath users typically set it to 120 secs.
+
+.TP
+\fBO2CB_IDLE_TIMEOUT_MS\fR
+The network idle timeout specifies the time in milliseconds before a network connection
+is considered dead. While it defaults to 30000 ms, network bonding users typically set it
+to 60000 ms.
+
+.TP
+\fBO2CB_KEEPALIVE_DELAY_MS\fR
+The network keepalive specifies the maximum delay in milliseconds before a keepalive
+packet is sent to another node to check whether it is alive or not. It defaults to
+2000 ms.
+
+.TP
+\fBO2CB_RECONNECT_DELAY_MS\fR
+The network reconnect specifies the minimum delay in milliseconds between repeated
+connect attempts. It defaults to 2000 ms.
+.PP
+
+.SH "EXAMPLE"
+The example below illustrates populating the o2cb sysconfig file using the \fIo2cb\fR
+init script.
+
+.in +4n
+.nf
+.sp
+$ \fBservice o2cb configure\fR
+Configuring the O2CB driver.
+
+This will configure the on-boot properties of the O2CB driver.
+The following questions will determine whether the driver is loaded on
+boot.  The current values will be shown in brackets ('[]').  Hitting
+<ENTER> without typing an answer will keep that current value.  Ctrl-C
+will abort.
+
+Load O2CB driver on boot (y/n) [n]: y
+Cluster stack backing O2CB [o2cb]: 
+Cluster to start on boot (Enter "none" to clear) [ocfs2]: webcluster
+Specify heartbeat dead threshold (>=7) [31]: 62
+Specify network idle timeout in ms (>=5000) [30000]: 60000
+Specify network keepalive delay in ms (>=1000) [2000]: 
+Specify network reconnect delay in ms (>=2000) [2000]: 
+Writing O2CB configuration: OK
+
+$ \fBcat /etc/sysconfig/o2cb\fR
+#
+# This is a configuration file for automatic startup of the O2CB
+# driver.  It is generated by running /etc/init.d/o2cb configure.
+# On Debian based systems the preferred method is running
+# 'dpkg-reconfigure ocfs2-tools'.
+#
+
+# O2CB_ENABLED: 'true' means to load the driver on boot.
+O2CB_ENABLED=true
+
+# O2CB_STACK: The name of the cluster stack backing O2CB.
+O2CB_STACK=o2cb
+
+# O2CB_BOOTCLUSTER: If not empty, the name of a cluster to start.
+O2CB_BOOTCLUSTER=webcluster
+
+# O2CB_HEARTBEAT_THRESHOLD: Iterations before a node is considered dead.
+O2CB_HEARTBEAT_THRESHOLD=62
+
+# O2CB_IDLE_TIMEOUT_MS: Time in ms before a network connection is considered dead.
+O2CB_IDLE_TIMEOUT_MS=60000
+
+# O2CB_KEEPALIVE_DELAY_MS: Max time in ms before a keepalive packet is sent
+O2CB_KEEPALIVE_DELAY_MS=2000
+
+# O2CB_RECONNECT_DELAY_MS: Min time in ms between connection attempts
+O2CB_RECONNECT_DELAY_MS=2000
+.fi
+.in
+
+.SH "SEE ALSO"
+.BR o2cb(7)
+.BR o2cb(8)
+.BR ocfs2.cluster.conf(5)
+
+.SH "AUTHORS"
+Oracle Corporation
+
+.SH "COPYRIGHT"
+Copyright \(co 2004, 2011 Oracle. All rights reserved.
diff --git a/vendor/common/ocfs2-tools.spec-generic.in b/vendor/common/ocfs2-tools.spec-generic.in
index 1e8a154..9117e2d 100644
--- a/vendor/common/ocfs2-tools.spec-generic.in
+++ b/vendor/common/ocfs2-tools.spec-generic.in
@@ -147,6 +147,7 @@ fi
 /usr/share/man/man1/o2info.1.gz
 /usr/share/man/man8/o2hbmonitor.8.gz
 /usr/share/man/man5/ocfs2.cluster.conf.5.gz
+/usr/share/man/man5/o2cb.sysconfig.5.gz
 
 
 %if %{build_ocfs2console}
-- 
1.7.4.1

More information about the Ocfs2-tools-devel mailing list