Page MenuHomeClusterLabs Projects
Files F4511827

No OneTemporary
Actions

View Options

diff --git a/man/Makefile.in b/man/Makefile.in
index cc33fc91..8c1d599a 100644
--- a/man/Makefile.in
+++ b/man/Makefile.in
@@ -1,25 +1,31 @@
###############################################################################
###############################################################################
##
## Copyright (C) 2009 Red Hat, Inc.
##
## This copyrighted material is made available to anyone wishing to use,
## modify, copy, or redistribute it subject to the terms and conditions
## of the GNU General Public License v.2.
##
###############################################################################
###############################################################################
include ../Makefile.top
-TARGETS=fence_virt.8 fence_xvm.8
+MAN8=fence_virt.8 fence_xvm.8 fence_virtd.8
+MAN5=fence_virtd.conf.5
-all: $(TARGETS)
+all: $(MAN5) $(MAN8)
install: all
if [ ! -d ${DESTDIR}/${mandir}/man8 ]; then \
install -d ${DESTDIR}/${mandir}/man8 ; \
fi
- install -m755 ${TARGETS} ${DESTDIR}/${mandir}/man8
+ install -m755 ${MAN8} ${DESTDIR}/${mandir}/man8
+ if [ ! -d ${DESTDIR}/${mandir}/man5 ]; then \
+ install -d ${DESTDIR}/${mandir}/man5 ; \
+ fi
+ install -m755 ${MAN5} ${DESTDIR}/${mandir}/man5
+
clean:
diff --git a/man/fence_virt.8 b/man/fence_virt.8
index 7849cc67..43f698a4 100644
--- a/man/fence_virt.8
+++ b/man/fence_virt.8
@@ -1,178 +1,179 @@
-
.TH FENCE_AGENT 8 2009-12-04 "fence_virt (Fence Agent)"
.SH NAME
fence_virt - Fencing agent for virtual machines using VM Channel
fence_xvm - Fencing agent for virtual machines using multicast
.SH DESCRIPTION
.P
fence_virt and fence_xvm are an I/O Fencing agents which can be used with virtual machines. Fence_xvm is backward compatible with fence_xvmd.
Fence_virt and fence_xvm talk to fence_virtd, which supports multiple backend plugins, including:
- libvirt for single-node operation
- Cluster Checkpoints when using Linux-cluster release 3.0.0 or later
- libvirt-qpid for multi-node, non-cluster operation
For compatibility, fence_xvm may talk to fence_xvmd from linux-cluster
release 2 or later.
.P
fence_virt and fence_xvm accept options on the command line as well
as from stdin. The fencing daemon sends parameters through stdin
when it execs the agent. The agent may be run by itself with command
line options, which is useful for testing or turning on or off virtual
machines from scripts.
.SH PARAMETERS
.TP
.B -d
.
Specify (CCS) / increment (command line) debug level
.TP
.B -i
.
IP Family ([auto], ipv4, ipv6) (Default Value: auto)
.TP
.B -a
.
Multicast address (default=225.0.0.12 / ff02::3:1)
.TP
.B -p
.
IP port (default=1229) (Default Value: 1229)
.TP
.B -T
.
Multicast time-to-live (in hops; default=2) (Default Value: 2)
.TP
.B -r
.
Multicast retransmit time (in 1/10sec; default=20) (Default Value: 20)
.TP
.B -C
.
Authentication (none, sha1, [sha256], sha512) (Default Value: sha256)
.TP
.B -c
.
Packet hash strength (none, sha1, [sha256], sha512) (Default Value: sha256)
.TP
.B -k
.
Shared key file (Default Value: /etc/cluster/fence_xvm.key)
.TP
.B -H
.
Virtual machine (domain name) to fence
.TP
.B -u
.
Treat 'domain' as UUID instead of domain name.
.TP
.B -o
.
Fencing action (null, off, on, [reboot], or status) (Default Value: reboot)
.TP
.B -t
.
Fencing timeout (in seconds; default=30) (Default Value: 30)
.SH ACTIONS
.TP
\fBoff \fP
Destroy or turn off virtual machine.
.TP
\fBreboot \fP
Reboot virtual machine.
.TP
\fBon \fP
Turn on a virtual machine. Note: Turning on a virtual machine only works
with some fence_virt backends.
.TP
\fBstatus \fP
Query the status of a virtual machine.
.SH STDIN PARAMETERS
-
.TP
.B debug
.
Specify (CCS) / increment (command line) debug level
.TP
.B ip_family
.
IP Family ([auto], ipv4, ipv6) (Default Value: auto)
.TP
.B multicast_address
.
Multicast address (default=225.0.0.12 / ff02::3:1)
.TP
.B port
.
IP port (default=1229) (Default Value: 1229)
.TP
.B multicast_ttl
.
Multicast time-to-live (in hops; default=2) (Default Value: 2)
.TP
.B retrans
.
Multicast retransmit time (in 1/10sec; default=20) (Default Value: 20)
.TP
.B auth
.
Authentication (none, sha1, [sha256], sha512) (Default Value: sha256)
.TP
.B hash
.
Packet hash strength (none, sha1, [sha256], sha512) (Default Value: sha256)
.TP
.B key_file
.
Shared key file (default=/etc/cluster/fence_xvm.key) (Default Value: /etc/cluster/fence_xvm.key)
.TP
.B domain
.
Virtual machine (domain name) to fence
.TP
.B use_uuid
.
Treat 'domain' as UUID instead of domain name
.TP
.B action
.
Fencing action (null, off, on, [reboot], or status) (Default Value: reboot)
.TP
.B timeout
.
Fencing timeout (in seconds; default=30) (Default Value: 30)
+
+.SH SEE ALSO
+
diff --git a/man/fence_virtd.8 b/man/fence_virtd.8
new file mode 100644
index 00000000..c22f520a
--- /dev/null
+++ b/man/fence_virtd.8
@@ -0,0 +1,38 @@
+.TH FENCE_AGENT 8 2010-01-05 "fence_virtd (Fence Agent)"
+.SH NAME
+fence_virtd - Fencing host for virtual machines
+
+.SH DESCRIPTION
+.P
+fence_virtd is a host daemon designed to route fencing requests for
+virtual machines.
+
+Fence_virt and fence_xvm talk to fence_virtd, which supports multiple backend plugins, including:
+ - libvirt for single-node operation
+ - Cluster Checkpoints when using Linux-cluster release 3.0.0 or later
+ - libvirt-qpid for multi-node, non-cluster operation
+
+For compatibility, fence_xvm from linux-cluster release 2 may talk to fence_virtd.
+
+.P
+fence_virtd accepts a few options on the command line, but most options
+are read from fence_virtd.conf.
+
+.SH PARAMETERS
+.TP
+.B -d
+.
+Specify debug level, e.g. "-d99"
+
+.TP
+.B -c
+.
+Interactively prompt user for configuration information
+
+.TP
+.B -f
+.
+Specify an alternate configuration file instead of /etc/fence_virtd.conf
+
+.SH SEE ALSO
+fence_virt(8), fence_xvm(8), fence(8), fence_virtd.conf(5)
diff --git a/man/fence_virtd.conf.5 b/man/fence_virtd.conf.5
new file mode 100644
index 00000000..a701d4d8
--- /dev/null
+++ b/man/fence_virtd.conf.5
@@ -0,0 +1,161 @@
+.TH fence_virtd.conf 5
+
+.SH NAME
+fence_virtd.conf - configuration file for fence_virtd
+
+.SH DESCRIPTION
+
+The fence_virtd.conf file contains configuration information for fence_virtd,
+a fencing request routing daemon for clusters of virtual machines.
+
+The file is tree-structured. There are parent/child relationships and sibling
+relationships between the nodes.
+
+ foo {
+ bar {
+ baz = "1";
+ }
+ }
+
+There are three primary sections of fence_virtd.conf.
+
+.SH SECTIONS
+.SS fence_virtd
+
+This section contains global information about how fence_virtd is to operate.
+The most important pieces of information are as follows:
+
+.TP
+.B listener
+.
+the listener plugin for receiving fencing requests from clients
+
+.TP
+.B backend
+.
+the plugin to be used to carry out fencing requests
+
+.SS listeners
+
+This section contains listener-specific configuration information; see the
+section about listeners below.
+
+.SS backends
+
+This section contains listener-specific configuration information; see the
+section about listeners below.
+
+.SH LISTENERS
+
+There are various listeners available for fence_virtd, each one handles
+decoding and authentication of a given fencing request. The following
+configuration blocks belong in the \fBlisteners\fP section of fence_virtd.conf
+
+.SS multicast
+.TP
+.B key_file
+.
+the shared key file to use (default: /etc/cluster/fence_xvm.key).
+
+.TP
+.B hash
+.
+the hashing algorithm to use for packet signing (default: sha256, but could
+be sha1, sha512, or none)
+
+.TP
+.B auth
+.
+the hashing algorithm to use for the simplistic challenge-response authentication
+(default: sha256, but could be sha1, sha512, or none)
+
+.TP
+.B family
+.
+the IP family to use (default: ipv4, but may be ipv6)
+
+.TP
+.B address
+.
+the multicast address to listen on (default: 225.0.0.12)
+
+.TP
+.B port
+.
+the multicast port to listen on (default: 1229)
+
+.TP
+.B interface
+.
+interface to listen on. By default, fence_virtd listens on all interfaces.
+However, this causes problems in some environments where the host computer
+is used as a gateway.
+
+
+.SH BACKENDS
+
+There are various backends available for fence_virtd, each one handles
+routing a fencing request to a hypervisor or management tool. The following
+configuration blocks belong in the \fBbackends\fP section of fence_virtd.conf
+
+.SS libvirt
+
+The libvirt plugin is the simplest plugin. It is used in environments where
+routing fencing requests between multiple hosts is not required, for example
+by a user running a cluster of virtual machines on a single desktop computer.
+
+.TP
+.B uri
+.
+the URI to use when connecting to libvirt.
+
+.SS libvirt-qpid
+
+The libvirt-qpid plugin acts as a QMF Console to the libvirt-qpid daemon in
+order to route fencing requests over AMQP to the appropriate computer. There
+are currently no configuration options for libvirt-qpid.
+
+.SS checkpoint
+
+The checkpoint plugin uses CMAN, CPG, and OpenAIS checkpoints to track virtual
+machines and route fencing requests to the appropriate computer.
+
+.TP
+.B uri
+.
+the URI to use when connecting to libvirt by the checkpoint plugin.
+
+.TP
+.B name_mode
+.
+The checkpoint plugin, in order to retain compatibility with fence_xvm,
+stores virtual machines in a certain way in the OpenAIS checkpoints. The
+default was to use 'name' when using fence_xvm and fence_xvmd, and so this
+is still the default. However, it is strongly recommended to use 'uuid'
+instead of 'name' in all cluster environments involving more than one
+physical host in order to avoid the potential for name collisions.
+
+
+.SH EXAMPLE
+
+ fence_virtd {
+ listener = "multicast";
+ backend = "checkpoint";
+ }
+
+ # this is the listeners section
+
+ listeners {
+ multicast {
+ key_file = "/etc/cluster/fence_xvm.key";
+ }
+ }
+
+ backends {
+ libvirt {
+ uri = "qemu:///system";
+ }
+ }
+
+.SH SEE ALSO
+fence_virtd(8)

File Metadata

Mime Type
text/x-diff
Expires
Wed, Jun 25, 2:49 AM (15 h, 2 m)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
1951913
Default Alt Text
(10 KB)

Event Timeline