virt-install: Add --watchdog support

Author: crobinso

man/en/virt-clone.1

@@ -1,15 +1,7 @@
-.\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.07)
+.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.07)
 .\"
 .\" Standard preamble:
 .\" ========================================================================
-.de Sh \" Subsection heading
-.br
-.if t .Sp
-.ne 5
-.PP
-\fB\\$1\fR
-.PP
-..
 .de Sp \" Vertical space (when we can't use .PP)
 .if t .sp .5v
 .if n .sp
@@ -53,7 +45,7 @@
 .el       .ds Aq '
 .\"
 .\" If the F register is turned on, we'll generate index entries on stderr for
-.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
+.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
 .\" entries marked with X<> in POD.  Of course, you'll have to process the
 .\" output yourself in some meaningful fashion.
 .ie \nF \{\
@@ -132,7 +124,7 @@
 .\" ========================================================================
 .\"
 .IX Title "VIRT-CLONE 1"
-.TH VIRT-CLONE 1 "2009-12-01" "" "Virtual Machine Install Tools"
+.TH VIRT-CLONE 1 "2010-03-03" "" "Virtual Machine Install Tools"
 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 .\" way too many mistakes in technical documents.
 .if n .ad l
@@ -166,7 +158,7 @@ Show the help message and exit
 .IP "\-\-connect=CONNECT" 4
 .IX Item "--connect=CONNECT"
 Connect to a non-default hypervisor. See \fIvirt\-install\fR\|(1) for details
-.Sh "General Options"
+.SS "General Options"
 .IX Subsection "General Options"
 General configuration parameters that apply to all guest clones.
 .IP "\-o \s-1ORIGINAL_GUEST\s0, \-\-original=ORIGINAL_GUEST" 2
@@ -205,7 +197,7 @@ currently active.
 specify \s-1UUID\s0, you should use a 32\-digit hexadecimal number. \s-1UUID\s0 are intended
 to be unique across the entire data center, and indeed world. Bear this in
 mind if manually specifying a \s-1UUID\s0
-.Sh "Storage Configuration"
+.SS "Storage Configuration"
 .IX Subsection "Storage Configuration"
 .IP "\-f \s-1DISKFILE\s0, \-\-file=DISKFILE" 2
 .IX Item "-f DISKFILE, --file=DISKFILE"
@@ -224,16 +216,18 @@ Fully allocate the new storage if the path being cloned is a sparse file.
 See \fIvirt\-install\fR\|(1) for more details on sparse vs. nonsparse.
 .IP "\-\-preserve\-data" 2
 .IX Item "--preserve-data"
-Preserve a new file to use as the disk image for the new guest.
-.Sh "Networking Configuration"
+No storage is cloned: disk images specific by \-\-file are preserved as is,
+and referenced in the new clone \s-1XML\s0. This is useful if you want to clone
+a \s-1VM\s0 \s-1XML\s0 template, but not the storage contents.
+.SS "Networking Configuration"
 .IX Subsection "Networking Configuration"
 .IP "\-m \s-1MAC\s0, \-\-mac=MAC" 2
 .IX Item "-m MAC, --mac=MAC"
 Fixed \s-1MAC\s0 address for the guest; If this parameter is omitted, or the value
 \&\f(CW\*(C`RANDOM\*(C'\fR is specified a suitable address will be randomly generated. Addresses
 are applied sequentially to the networks as they are listed in the original
 guest \s-1XML\s0.
-.Sh "Miscellaneous Options"
+.SS "Miscellaneous Options"
 .IX Subsection "Miscellaneous Options"
 .IP "\-d, \-\-debug" 2
 .IX Item "-d, --debug"

man/en/virt-install.1

@@ -124,7 +124,7 @@
 .\" ========================================================================
 .\"
 .IX Title "VIRT-INSTALL 1"
-.TH VIRT-INSTALL 1 "2010-02-08" "" "Virtual Machine Install Tools"
+.TH VIRT-INSTALL 1 "2010-03-22" "" "Virtual Machine Install Tools"
 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 .\" way too many mistakes in technical documents.
 .if n .ad l
@@ -299,6 +299,18 @@ Generic 2.6.x kernel
 .IP "virtio26" 4
 .IX Item "virtio26"
 Generic 2.6.25 or later kernel with virtio
+.IP "mandriva2009" 4
+.IX Item "mandriva2009"
+Mandriva Linux 2009 and earlier
+.IP "mandriva2010" 4
+.IX Item "mandriva2010"
+Mandriva Linux 2010 and later
+.IP "mes5" 4
+.IX Item "mes5"
+Mandriva Enterprise Server 5.0
+.IP "mes5.1" 4
+.IX Item "mes5.1"
+Mandriva Enterprise Server 5.1 and later
 .IP "rhel2.1" 4
 .IX Item "rhel2.1"
 Red Hat Enterprise Linux 2.1
@@ -454,7 +466,45 @@ A node device name via libvirt, as shown by 'virsh nodedev\-list'
 Parameters specific only to fully virtualized guest installs.
 .IP "\-\-sound" 2
 .IX Item "--sound"
-Attach a virtual audio device to the guest.
+Attach a virtual audio device to the guest. The device model will be \s-1AC97\s0
+if the hypervisor supports it, otherwise will be \s-1ES1370\s0
+.IP "\-\-watchdog MODEL[,action=ACTION]" 2
+.IX Item "--watchdog MODEL[,action=ACTION]"
+Attach a virtual hardware watchdog device to the guest. This requires a
+daemon and device driver in the guest. The watchdog fires a signal when
+the virtual machine appears to hung. \s-1ACTION\s0 specifies what libvirt will do
+when the watchdog fires. Values are
+.RS 2
+.IP "\fBreset\fR" 4
+.IX Item "reset"
+Forcefully reset the guest (the default)
+.IP "\fBpoweroff\fR" 4
+.IX Item "poweroff"
+Forcefully power off the guest
+.IP "\fBpause\fR" 4
+.IX Item "pause"
+Pause the guest
+.IP "\fBnone\fR" 4
+.IX Item "none"
+Do nothing
+.IP "\fBshutdown\fR" 4
+.IX Item "shutdown"
+Gracefully shutdown the guest (not recommended, since a hung guest probably
+won't respond to a graceful shutdown)
+.RE
+.RS 2
+.Sp
+\&\s-1MODEL\s0 is the emulated device model: either i6300esb (the default) or ib700.
+Some examples:
+.Sp
+Use the recommended settings:
+.Sp
+\&\-\-watchdog default
+.Sp
+Use the i6300esb with the 'poweroff' action
+.Sp
+\&\-\-watchdog i6300esb,action=poweroff
+.RE
 .IP "\-\-parallel=CHAROPTS" 2
 .IX Item "--parallel=CHAROPTS"
 .PD 0
@@ -527,6 +577,10 @@ Unix socket (see \fIunix\fR\|(7). \s-1MODE\s0 has similar behavior and defaults
 .RE
 .RS 2
 .RE
+.IP "\-\-description" 2
+.IX Item "--description"
+Human readable text description of the virtual machine. This will be stored
+in the guests \s-1XML\s0 configuration for access by other applications.
 .IP "\-\-noapic" 2
 .IX Item "--noapic"
 Override the \s-1OS\s0 type / variant to disables the \s-1APIC\s0 setting for fully

man/en/virt-install.pod.in

@@ -182,6 +182,49 @@ Parameters specific only to fully virtualized guest installs.
 Attach a virtual audio device to the guest. The device model will be AC97
 if the hypervisor supports it, otherwise will be ES1370
 
+=item --watchdog MODEL[,action=ACTION]
+
+Attach a virtual hardware watchdog device to the guest. This requires a
+daemon and device driver in the guest. The watchdog fires a signal when
+the virtual machine appears to hung. ACTION specifies what libvirt will do
+when the watchdog fires. Values are
+
+=over 4
+
+=item B<reset>
+
+Forcefully reset the guest (the default)
+
+=item B<poweroff>
+
+Forcefully power off the guest
+
+=item B<pause>
+
+Pause the guest
+
+=item B<none>
+
+Do nothing
+
+=item B<shutdown>
+
+Gracefully shutdown the guest (not recommended, since a hung guest probably
+won't respond to a graceful shutdown)
+
+=back
+
+MODEL is the emulated device model: either i6300esb (the default) or ib700.
+Some examples:
+
+Use the recommended settings:
+
+--watchdog default
+
+Use the i6300esb with the 'poweroff' action
+
+--watchdog i6300esb,action=poweroff
+
 =item --parallel=CHAROPTS
 
 =item --serial=CHAROPTS

tests/clitest.py

@@ -360,13 +360,19 @@
         "--hvm --nodisks --pxe --description \"foobar & baz\"",
         # HVM windows install with disk
         "--hvm --cdrom %(EXISTIMG2)s --file %(EXISTIMG1)s --os-variant win2k3 --wait 0",
+        # Watchdog dev default
+        "--hvm --nodisks --pxe --watchdog default",
+        # Watchdog opts
+        "--hvm --nodisks --pxe --watchdog ib700,action=pause",
       ],
 
       "invalid": [
         # pxe and nonetworks
         "--nodisks --pxe --nonetworks",
         # Colliding name
         "--nodisks --pxe --name test",
+        # Busted watchdog
+        "--hvm --nodisks --pxe --watchdog default,action=foobar",
       ],
      }, # category "misc"
 

tests/xmlconfig-xml/boot-many-devices.xml

@@ -71,6 +71,7 @@
         <product id='0x1234'/>
       </source>
     </hostdev>
+    <watchdog model='ib700' action='none'/>
   </devices>
   <seclabel type='static' model='selinux'>
     <label>foolabel</label>

tests/xmlconfig.py

@@ -27,6 +27,7 @@
 from virtinst import VirtualCharDevice
 from virtinst import VirtualVideoDevice
 from virtinst import VirtualController
+from virtinst import VirtualWatchdog
 import tests
 
 conn = tests.open_testdriver()
@@ -672,6 +673,11 @@ def testManyDevices(self):
         g.add_device(vdev2)
         g.add_device(vdev3)
 
+        wdev2 = VirtualWatchdog(g.conn)
+        wdev2.model = "ib700"
+        wdev2.action = "none"
+        g.add_device(wdev2)
+
         g.clock.offset = "localtime"
 
         seclabel = virtinst.Seclabel(g.conn)

virt-install

@@ -144,6 +144,38 @@ def get_chardevs(char_type, opts, guest):
             fail(_("Error in %(chartype)s device parameters: %(err)s") %
                  {"chartype": char_type, "err": str(e) })
 
+def parse_watchdog(guest, optstring):
+    # Peel the model type off the front
+    model, ignore, optstring = partition(optstring, ",")
+    opts = cli.parse_optstr(optstring)
+    dev = virtinst.VirtualWatchdog(guest.conn)
+
+    def set_param(paramname, dictname, val=None):
+        if not val:
+            if opts.has_key(dictname):
+                val = opts[dictname]
+                del(opts[dictname])
+            else:
+                return
+
+        setattr(dev, paramname, val)
+
+    set_param("model", "model", model)
+    set_param("action", "action")
+
+    # If extra parameters, then user passed some garbage param
+    if opts:
+        raise ValueError(_("Unknown option(s) %s") % opts.keys())
+
+    return dev
+
+def get_watchdog(watchdogs, guest):
+    for optstr in cli.listify(watchdogs):
+        try:
+            dev = parse_watchdog(guest, optstr)
+            guest.add_device(dev)
+        except Exception, e:
+            fail(_("Error in watchdog device parameters: %s") % str(e))
 
 def parse_disk_option(guest, path, size):
     """helper to properly parse --disk options"""
@@ -553,6 +585,9 @@ def parse_args():
     fulg = OptionGroup(parser, _("Full Virtualization specific options"))
     fulg.add_option("", "--sound", action="store_true", dest="sound",
                     default=False, help=_("Use sound device emulation"))
+    fulg.add_option("", "--watchdog", type="string", dest="watchdog",
+                    action="callback", callback=cli.check_before_append,
+                    help=_("Add a watchdog device to the domain."))
     fulg.add_option("", "--noapic", action="store_true", dest="noapic",
                     default=False,
                     help=_("Disables APIC for fully virtualized guest "
@@ -751,6 +786,7 @@ def main():
     cli.get_vcpus(options.vcpus, options.check_cpu, guest, conn)
     cli.get_cpuset(options.cpuset, guest.memory, guest, conn)
     if ishvm:
+        get_watchdog(options.watchdog, guest)
         cli.get_sound(options.sound, guest)
         get_chardevs(VirtualDevice.VIRTUAL_DEV_SERIAL, options.serials, guest)
         get_chardevs(VirtualDevice.VIRTUAL_DEV_PARALLEL, options.parallels,

virtinst/VirtualDevice.py

@@ -41,6 +41,7 @@ class VirtualDevice(object):
     VIRTUAL_DEV_CONSOLE         = "console"
     VIRTUAL_DEV_VIDEO           = "video"
     VIRTUAL_DEV_CONTROLLER      = "controller"
+    VIRTUAL_DEV_WATCHDOG        = "watchdog"
 
     # Ordering in this list is important: it will be the order the
     # Guest class outputs XML. So changing this may upset the test suite
@@ -49,7 +50,8 @@ class VirtualDevice(object):
                             VIRTUAL_DEV_INPUT, VIRTUAL_DEV_GRAPHICS,
                             VIRTUAL_DEV_SERIAL, VIRTUAL_DEV_PARALLEL,
                             VIRTUAL_DEV_CONSOLE, VIRTUAL_DEV_AUDIO,
-                            VIRTUAL_DEV_VIDEO, VIRTUAL_DEV_HOSTDEV ]
+                            VIRTUAL_DEV_VIDEO, VIRTUAL_DEV_HOSTDEV,
+                            VIRTUAL_DEV_WATCHDOG ]
 
     # General device type (disk, interface, etc.)
     _virtual_device_type = None