From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 17610 invoked by alias); 20 Mar 2009 19:10:22 -0000 Received: (qmail 17603 invoked by alias); 20 Mar 2009 19:10:21 -0000 X-SWARE-Spam-Status: No, hits=-1.9 required=5.0 tests=AWL,BAYES_00,SPF_HELO_PASS X-Spam-Status: No, hits=-1.9 required=5.0 tests=AWL,BAYES_00,SPF_HELO_PASS X-Spam-Check-By: sourceware.org X-Spam-Checker-Version: SpamAssassin 3.2.5 (2008-06-10) on bastion.fedora.phx.redhat.com Subject: cluster: RHEL5 - fence: Fix fence_xvm[d] man pages To: cluster-cvs-relay@redhat.com X-Project: Cluster Project X-Git-Module: cluster.git X-Git-Refname: refs/heads/RHEL5 X-Git-Reftype: branch X-Git-Oldrev: c9a1a4f5aad9a135ba135cc713a50ccaa2e4afa1 X-Git-Newrev: a734b2e752e0e20e712540b0799a7a067b011fd0 From: Lon Hohberger Message-Id: <20090320190955.54D001202D3@lists.fedorahosted.org> Date: Fri, 20 Mar 2009 19:10:00 -0000 X-Scanned-By: MIMEDefang 2.58 on 172.16.52.254 Mailing-List: contact cluster-cvs-help@sourceware.org; run by ezmlm Precedence: bulk List-Id: List-Subscribe: List-Post: List-Help: , Sender: cluster-cvs-owner@sourceware.org X-SW-Source: 2009-q1/txt/msg00850.txt.bz2 Gitweb: http://git.fedorahosted.org/git/cluster.git?p=cluster.git;a=commitdiff;h=a734b2e752e0e20e712540b0799a7a067b011fd0 Commit: a734b2e752e0e20e712540b0799a7a067b011fd0 Parent: c9a1a4f5aad9a135ba135cc713a50ccaa2e4afa1 Author: Lon Hohberger AuthorDate: Fri Mar 20 15:09:34 2009 -0400 Committer: Lon Hohberger CommitterDate: Fri Mar 20 15:09:34 2009 -0400 fence: Fix fence_xvm[d] man pages Signed-off-by: Lon Hohberger --- fence/man/fence_xvm.8 | 24 +++++++++++++----------- fence/man/fence_xvmd.8 | 32 +++++++++++++++++--------------- 2 files changed, 30 insertions(+), 26 deletions(-) diff --git a/fence/man/fence_xvm.8 b/fence/man/fence_xvm.8 index 10da4b5..55c7915 100644 --- a/fence/man/fence_xvm.8 +++ b/fence/man/fence_xvm.8 @@ -8,7 +8,7 @@ .TH fence_xvm 8 .SH NAME -fence_xvm - I/O Fencing agent for Xen virtual machines. +fence_xvm - General purpose fencing agent for virtual machines. .SH SYNOPSIS .B @@ -16,10 +16,11 @@ fence_xvm [\fIOPTION\fR]... .SH DESCRIPTION -fence_xvm is an I/O Fencing agent which can be used with Xen virtual machines -which are part of a cluster. There is a requirement that the parent -domain-0s are also a part of a CMAN/OpenAIS based cluster, such as -linux-cluster. +fence_xvm is an I/O Fencing agent which can be used with any virtual +machines for which libvirt has a backend. When used on virtual machines +which are backed by clustered storage (and thus, may be migrated about +several physical machines), there is a requirement that the host machines +are also a part of a CMAN/OpenAIS based cluster, such as linux-cluster. fence_xvm accepts options on the command line as well as from standard input. If no command line options are present, fence_xvm will automatically use @@ -58,8 +59,8 @@ random number generation and a shared private key. \fB-c\fP \fIhash\fP Packet hash type (none, sha1, sha256, sha512; default=sha256). This controls the hashing mechanism used to authenticate fencing requests. The -three SHA hashes use a key which must be shared between both the Xen virtual -machines and the host domain-0 cluster. +three SHA hashes use a key which must be shared between both the virtual +machines and the host (physical) cluster. .TP \fB-k\fP \fIkey_file\fP Use the specified key file for packet hashing / SHA authentication. @@ -67,12 +68,13 @@ When both the hash type and the authentication type are set to "none", this parameter is ignored. .TP \fB-H\fP \fIdomain\fP -This specifies unique domain name of the Xen guest which needs to be fenced. +This specifies unique domain name of the virtual machine name (or +UUID) which needs to be fenced. .TP \fB-u\fP -Fence by UUID instead of Xen Domain name. If specified, the above -H -parameter should be the statically-defined 36-character UUID of the Xen -domain rather than its human-readable name. +Fence by UUID instead of virtual machine name. If specified, the above -H +parameter should be the statically-defined 36-character UUID of the virtual +machine rather than its human-readable name. .TP \fB-o\fP \fIoperation\fP Fencing operation to perform (null, off, reboot; default=off). This specifies diff --git a/fence/man/fence_xvmd.8 b/fence/man/fence_xvmd.8 index ac176b2..b6f2cc7 100644 --- a/fence/man/fence_xvmd.8 +++ b/fence/man/fence_xvmd.8 @@ -8,7 +8,7 @@ .TH fence_xvmd 8 .SH NAME -fence_xvmd - I/O Fencing agent host for Xen virtual machines. +fence_xvmd - Libvirt-based, general purpose fencing host for virtual machines. .SH SYNOPSIS .B @@ -16,16 +16,18 @@ fence_xvmd [\fIOPTION\fR]... .SH DESCRIPTION -fence_xvmd is an I/O Fencing host which resides on dom0 and is used in -conjunction with the fence_xvm fencing agent. Together, these two programs -can be used to fence can be used to fence Xen virtual machines which are -part of a cluster. There is a requirement that the parent -dom0s are also a part of their own CMAN/OpenAIS based cluster, and that -the dom0 cluster does not share any members with the domU cluster. -Furthermore, the dom0 cluster is required to have fencing if domU recovery -is expected to be automatic. +fence_xvmd is an I/O Fencing host which resides on bare metal machines +and is used in conjunction with the fence_xvm fencing agent. Together, +these two programs can be used to fence can be used +machines which are part of a cluster. -fence_xvmd accepts options on the command line. +If the virtual machines are backed by clustered storage or the virtual +machines may be migrated to other physical machines, all physical +machines in question must also be a part of their own CMAN/OpenAIS based +cluster. Furthermore, the bare metal cluster is required to have +fencing configured if virtual machine recovery is expected to be automatic. + +fence_xvmd accepts options on the command line and from cluster.conf .SH OPTIONS .TP @@ -52,16 +54,16 @@ Network interface to listen on, e.g. eth0. \fB-C\fP \fIauth\fP Authentication type (none, sha1, sha256, sha512; default=sha256). This controls the authentication mechanism used to authenticate clients. The -three SHA hashes use a key which must be shared between both the Xen virtual -machines and the host domain-0 cluster. The three SHA authentication +three SHA hashes use a key which must be shared between both the virtual +machines and the host machine or cluster. The three SHA authentication mechanisms use a simple bidirectional challenge-response based on pseudo- random number generation and a shared private key. .TP \fB-c\fP \fIhash\fP Packet hash type (none, sha1, sha256, sha512; default=sha256). This controls the hashing mechanism used to authenticate fencing requests. The -three SHA hashes use a key which must be shared between both the Xen virtual -machines and the host domain-0 cluster. +three SHA hashes use a key which must be shared between both the virtual +machines and the host machine or cluster. .TP \fB-k\fP \fIkey_file\fP Use the specified key file for packet hashing / SHA authentication. @@ -69,7 +71,7 @@ When both the hash type and the authentication type are set to "none", this parameter is ignored. .TP \fB-u\fP -Fence by UUID instead of Xen Domain name. +Fence by UUID instead of virtual machine name. .TP \fB-?\fP Print out a help message describing available options, then exit.