[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]

[Cluster-devel] cluster/ccs/man ccs.7 ccs_test.8 ccs_tool.8 ccsd.8



CVSROOT:	/cvs/cluster
Module name:	cluster
Changes by:	teigland sourceware org	2007-08-20 18:10:04

Modified files:
	ccs/man        : ccs.7 ccs_test.8 ccs_tool.8 ccsd.8 

Log message:
	update ccs man pages

Patches:
http://sourceware.org/cgi-bin/cvsweb.cgi/cluster/ccs/man/ccs.7.diff?cvsroot=cluster&r1=1.3&r2=1.4
http://sourceware.org/cgi-bin/cvsweb.cgi/cluster/ccs/man/ccs_test.8.diff?cvsroot=cluster&r1=1.5&r2=1.6
http://sourceware.org/cgi-bin/cvsweb.cgi/cluster/ccs/man/ccs_tool.8.diff?cvsroot=cluster&r1=1.4&r2=1.5
http://sourceware.org/cgi-bin/cvsweb.cgi/cluster/ccs/man/ccsd.8.diff?cvsroot=cluster&r1=1.7&r2=1.8

--- cluster/ccs/man/ccs.7	2005/02/16 18:44:09	1.3
+++ cluster/ccs/man/ccs.7	2007/08/20 18:10:02	1.4
@@ -1,4 +1,4 @@
-.\"  Copyright (C) 2004 Red Hat, Inc.  All rights reserved.
+.\"  Copyright (C) 2004-2007 Red Hat, Inc.  All rights reserved.
 .\"  
 .\"  This copyrighted material is made available to anyone wishing to use,
 .\"  modify, copy, or redistribute it subject to the terms and conditions
@@ -10,41 +10,19 @@
 ccs - Cluster Configuration System
 
 .SH DESCRIPTION
-A cluster environment that shares resources has information that is
-essential to correct operation which must be available to
-every node in the cluster.  This information may include:
-names of the nodes composing the cluster, I/O fencing methods, and
-more.  \fICCS\fP is the system that makes it possible for the nodes in a
-cluster to retrieve the information they need.
-
-.SH OVERVIEW
-The following is a generic description of the steps one should take to produce
-a working CCS environment.
-
-.SS Step 1
-Choose a cluster name.  It is important to determine
-a name for the cluster before starting.  The cluster name is what
-binds a machine to specific resources that can only be shared by
-machines that are members of the same cluster name.
-
-.SS Step 2
-Create the directory \fI/etc/cluster\fP.
-
-.SS Step 3
-Create the \fI/etc/cluster/cluster.conf\fP file, according to the
-\fBcluster.conf(5)\fP man page, on one node in your cluster.
-
-.SS Step 4
-Start \fBccsd\fP and test the cluster.conf file by using \fBccs_test\fP.
-If you haven't started a cluster manager yet, you should use the 'force'
-option to \fBccs_test\fP - see the \fBccs_test(8)\fP man page for more info.
-
-If a failure occurs while parsing the config file, \fBccs_test\fP should
-report "ccs_connect failed: No data available" and /var/log/messages
-should report "Unable to parse /etc/cluster/cluster.conf".
 
-.SH FORMAT OF THE CCS FILE
-See \fBcluster.conf(5)\fP
+CCS is the system that manages the /etc/cluster/cluster.conf file on
+cluster nodes.  The primary users of cluster.conf are the cman cluster
+manager, the fenced fencing daemon and rgmanager which manages H/A
+services.
+
+libccs is the API used by the programs and daemons above to read
+cluster.conf information.  libccs requests go through the ccsd daemon.
+ccsd needs to be started before the cman cluster manager is started.
+
+The ccs_test program can be used to test the ccs system and read
+cluster.conf values.
 
 .SH SEE ALSO
-ccsd(8), ccs_tool(8), ccs_test(8), cluster.conf(5)
+ccsd(8), ccs_tool(8), ccs_test(8), cluster.conf(5), cman(5)
+
--- cluster/ccs/man/ccs_test.8	2005/02/16 18:44:09	1.5
+++ cluster/ccs/man/ccs_test.8	2007/08/20 18:10:03	1.6
@@ -1,4 +1,4 @@
-.\"  Copyright (C) 2004 Red Hat, Inc.  All rights reserved.
+.\"  Copyright (C) 2004-2007 Red Hat, Inc.  All rights reserved.
 .\"  
 .\"  This copyrighted material is made available to anyone wishing to use,
 .\"  modify, copy, or redistribute it subject to the terms and conditions
@@ -7,7 +7,7 @@
 .TH ccs_test 8
 
 .SH NAME
-ccs_test - The diagnostic tool for a running Cluster Configuration System.
+ccs_test - CCS daemon (ccsd) diagnostic tool
 
 .SH SYNOPSIS
 .B ccs_test
@@ -15,10 +15,8 @@
 <\fBcommand\fP>
 
 .SH DESCRIPTION
-\fBccs_test\fP is part of the Cluster Configuration System (CCS).  It
-is a diagnostic tool designed to validate the correct operation of a
-running CCS system.  It will communicate with the CCS daemon - \fBccsd\fP -
-to obtain any information stored in the system.
+\fBccs_test\fP is part of the Cluster Configuration System (CCS).  It is a
+diagnostic tool that reads cluster.conf information to test ccsd.
 
 .SH OPTIONS
 .TP
--- cluster/ccs/man/ccs_tool.8	2007/02/14 09:16:13	1.4
+++ cluster/ccs/man/ccs_tool.8	2007/08/20 18:10:03	1.5
@@ -14,10 +14,11 @@
 [\fIOPTION\fR].. <\fBcommand\fP>
 
 .SH "DESCRIPTION"
-\fBccs_tool\fP is part of the Cluster Configuration System (CCS).  It
-is used to make online updates of CCS config files.  Additionally, it
-can be used to upgrade old style (GFS <= 6.0) CCS archives to the new
-xml format.
+
+\fBccs_tool\fP is part of the Cluster Configuration System (CCS).  It is
+used to make online updates to cluster.conf.  It can also be used to
+upgrade old style (GFS <= 6.0) CCS archives to the new xml cluster.conf
+format.
 
 .SH "OPTIONS"
 .TP 
@@ -32,14 +33,9 @@
 .TP 
 \fBupdate\fP \fI<xml file>\fP
 This command is used to update the config file that ccsd is working with
-while the cluster is operational (i.e. online).  Run this on a single
-machine to update all instances of ccsd across the cluster.
-
-If you are using 'cman' as your cluster manager, you will also need to
-run \fBcman_tool version \-r <new version number>\fP once the update is
-complete.  Failure to do so will result in new nodes (or nodes rejoining
-after a failure) not being allowed
-to join the working set due to version number mismatches.
+while the cman cluster is operational (i.e. online).  Run this on a single
+machine to update cluster.conf on all current cluster members.  This also
+notfies cman of the new config version.
 
 .TP 
 \fBupgrade\fP \fI<location>\fP
--- cluster/ccs/man/ccsd.8	2006/01/11 16:00:55	1.7
+++ cluster/ccs/man/ccsd.8	2007/08/20 18:10:03	1.8
@@ -1,5 +1,5 @@
 .\"  Copyright (C) Sistina Software, Inc.  1997-2003  All rights reserved.
-.\"  Copyright (C) 2004 Red Hat, Inc.  All rights reserved.
+.\"  Copyright (C) 2004-2007 Red Hat, Inc.  All rights reserved.
 .\"  
 .\"  This copyrighted material is made available to anyone wishing to use,
 .\"  modify, copy, or redistribute it subject to the terms and conditions
@@ -8,19 +8,27 @@
 .TH ccsd 8
 
 .SH NAME
-ccsd - The daemon used to access CCS cluster configuration files.
+ccsd - manages the /etc/cluster/cluster.conf file
 
 .SH SYNOPSIS
 .B ccsd
 [\fIOPTION\fR]..
 
 .SH DESCRIPTION
-\fBccsd\fP is part of the Cluster Configuration System (CCS).  It is the
-daemon which accesses cluster the configuration file for other cluster
-applications.  It must be run on each node that wishes to join a cluster.
+
+\fBccsd\fP is part of the Cluster Configuration System (CCS) and manages
+the cluster.conf file in a cman cluster.  It handles requests for
+cluster.conf information made through libccs.  It also keeps the
+cluster.conf file in sync among cluster nodes based on the value of
+cluster.conf:cluster/config_version.  ccsd may replace the local
+cluster.conf file if it discovers a newer version on another node.
 
 .SH OPTIONS
 .TP
+\fB-X\fP
+Disable all cluster manager (cman) and inter-node interactions. Simply
+respond to local libccs requests based on the current cluster.conf file.
+.TP
 \fB-4\fP
 Use IPv4 for inter-node communication.  By default, IPv6 is tried, then IPv4.
 .TP
@@ -66,4 +74,5 @@
 Print the version information.
 
 .SH SEE ALSO
-ccs(7), ccs_tool(8), ccs_test(8), cluster.conf(5)
+ccs(7), cman(5), ccs_tool(8), ccs_test(8), cluster.conf(5)
+


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]