Updated notes about HVM devices / boot details

diff --git a/ChangeLog b/ChangeLog
index fcd5014a33c5569cc6126441eaf1692dbb221268..4482714db4ee5a93befdeda212265c35bd1828db 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,9 @@
+Mon Aug 14 10:55:02 EDT 2006 Daniel Berrange <berrange@redhat.com>
+
+       * docs/libvir.html, docs/format.html: Updated description of
+       HVM boot device, and disk device configuration to match up
+       new new behaviour from previous changes
+
 Fri Aug 11 09:37:02 EDT 2006 Daniel Berrange <berrange@redhat.com>
 
        * src/libvirt.c: Avoid duplicated attempts to shutdown or

diff --git a/docs/format.html b/docs/format.html
index 2749deaf95961de2fefcdf7462197ad28f3ccba3..af71e9a21be6f75227804c784b0cbe720ba8e310 100644 (file)
--- a/docs/format.html
+++ b/docs/format.html
@@ -99,7 +99,7 @@ systems:</p><pre>&lt;domain type='xen' id='3'&gt;
   &lt;os&gt;
     <span style="color: #0000E5; background-color: #FFFFFF">&lt;type&gt;hvm&lt;/type&gt;</span>
     <span style="color: #0000E5; background-color: #FFFFFF">&lt;loader&gt;/usr/lib/xen/boot/hvmloader&lt;/loader&gt;</span>
-    <span style="color: #0000E5; background-color: #FFFFFF">&lt;boot dev='hda'/&gt;</span>
+    <span style="color: #0000E5; background-color: #FFFFFF">&lt;boot dev='da'/&gt;</span>
   &lt;/os&gt;
   &lt;memory&gt;524288&lt;/memory&gt;
   &lt;vcpu&gt;1&lt;/vcpu&gt;
@@ -115,22 +115,50 @@ systems:</p><pre>&lt;domain type='xen' id='3'&gt;
     &lt;/interface&gt;
     &lt;disk type='file'&gt;
       &lt;source file='/root/fv0'/&gt;
-      &lt;target <span style="color: #0000E5; background-color: #FFFFFF">dev='ioemu:hda'</span>/&gt;
+      &lt;target <span style="color: #0000E5; background-color: #FFFFFF">dev='hda'</span>/&gt;
+    &lt;/disk&gt;
+    &lt;disk type='file' <span style="color: #0000E5; background-color: #FFFFFF">device='cdrom'</span>&gt;
+      &lt;source file='/root/fc5-x86_64-boot.iso'/&gt;
+      &lt;target <span style="color: #0000E5; background-color: #FFFFFF">dev='hdc'</span>/&gt;
+      &lt;readonly/&gt;
+    &lt;/disk&gt;
+    &lt;disk type='file' <span style="color: #0000E5; background-color: #FFFFFF">device='floppy'</span>&gt;
+      &lt;source file='/root/fd.img'/&gt;
+      &lt;target <span style="color: #0000E5; background-color: #FFFFFF">dev='fda'</span>/&gt;
     &lt;/disk&gt;
     <span style="color: #0000E5; background-color: #FFFFFF">&lt;graphics type='vnc' port='5904'/&gt;</span>
   &lt;/devices&gt;
-&lt;/domain&gt;</pre><p>There is a few things to notice specifically for HVM domains:</p><ul><li>the &lt;os&gt; block description is very different, first it indicates
+&lt;/domain&gt;</pre><p>There is a few things to notice specifically for HVM domains:</p><ul><li>the <code>&lt;os&gt;</code> block description is very different, first it indicates
     that the type is 'hvm' for hardware virtualization, then instead of a
     kernel, boot and command line arguments, it points to an os boot loader
     which will extract the boot informations from the boot device specified
-    in a separate boot element</li>
-  <li>the &lt;devices&gt; section includes an emulator entry pointing to an
+    in a separate boot element. The <code>dev</code> attribute on the <code>boot</code>
+    tag can be one of:
+    <ul><li><code>fd</code> - boot from first floppy device</li>
+    <li><code>hd</code> - boot from first harddisk device</li>
+    <li><code>cdrom</code> - boot from first cdrom device</li>
+    </ul></li>
+  <li>the <code>&lt;devices&gt;</code> section includes an emulator entry pointing to an
     additional program in charge of emulating the devices</li>
   <li>the disk entry indicates in the dev target section that the emulation
-    for the drive is the first IDE disk device hda</li>
-  <li>the &lt;devices&gt; section also include at least one entry for the
+    for the drive is the first IDE disk device hda. The list of device names
+    supported is dependant on the Hypervisor, but for Xen it can be any IDE 
+    device <code>hda</code>-<code>hdd</code>, or a floppy device <code>fda</code>,
+    <code>fdb</code>. The <code>&lt;disk&gt;</code> element also supports a 'device' 
+    attribute to indicate what kinda of hardware to emulate. The following values are 
+    supported:
+    <ul><li><code>floppy</code> - a floppy disk controller</li>
+    <li><code>disk</code> - a generic hard drive (the default it omitted)</li>
+    <li><code>cdrom</code> - a CDROM device</li>
+    </ul>
+    For Xen 3.0.2 and earlier a CDROM device can only be emulated on the
+    <code>hdc</code> channel, while for 3.0.3 and later, it can be emulated on
+    any IDE channel.</li>
+  <li>the <code>&lt;devices&gt;</code> section also include at least one entry for the
     graphic device used to render the os. Currently there is just 2 types
-    possible 'vnc' or 'sdl'</li>
+    possible 'vnc' or 'sdl'. If the type is 'vnc', then an additional <code>port</code>
+    attribute will be present indicating the TCP port on which the VNC server is
+    accepting client connections.</li>
 </ul><p>It is likely that the HVM description gets additional optional elements
 and attributes as the support for fully virtualized domain expands,
 especially for the variety of devices emulated and the graphic support

diff --git a/docs/libvir.html b/docs/libvir.html
index f2534ff063a230e30306d5da3bc16d6d499282dd..4ad76554f64a8f0a58edc22fa76b48b91ee1d14a 100644 (file)
--- a/docs/libvir.html
+++ b/docs/libvir.html
@@ -423,7 +423,7 @@ systems:</p>
   &lt;os&gt;
     <span style="color: #0000E5; background-color: #FFFFFF">&lt;type&gt;hvm&lt;/type&gt;</span>
     <span style="color: #0000E5; background-color: #FFFFFF">&lt;loader&gt;/usr/lib/xen/boot/hvmloader&lt;/loader&gt;</span>
-    <span style="color: #0000E5; background-color: #FFFFFF">&lt;boot dev='hda'/&gt;</span>
+    <span style="color: #0000E5; background-color: #FFFFFF">&lt;boot dev='hd'/&gt;</span>
   &lt;/os&gt;
   &lt;memory&gt;524288&lt;/memory&gt;
   &lt;vcpu&gt;1&lt;/vcpu&gt;
@@ -439,7 +439,16 @@ systems:</p>
     &lt;/interface&gt;
     &lt;disk type='file'&gt;
       &lt;source file='/root/fv0'/&gt;
-      &lt;target <span style="color: #0000E5; background-color: #FFFFFF">dev='ioemu:hda'</span>/&gt;
+      &lt;target <span style="color: #0000E5; background-color: #FFFFFF">dev='hda'</span>/&gt;
+    &lt;/disk&gt;
+    &lt;disk type='file' <span style="color: #0000E5; background-color: #FFFFFF">device='cdrom'</span>&gt;
+      &lt;source file='/root/fc5-x86_64-boot.iso'/&gt;
+      &lt;target <span style="color: #0000E5; background-color: #FFFFFF">dev='hdc'</span>/&gt;
+      &lt;readonly/&gt;
+    &lt;/disk&gt;
+    &lt;disk type='file' <span style="color: #0000E5; background-color: #FFFFFF">device='floppy'</span>&gt;
+      &lt;source file='/root/fd.img'/&gt;
+      &lt;target <span style="color: #0000E5; background-color: #FFFFFF">dev='fda'</span>/&gt;
     &lt;/disk&gt;
     <span style="color: #0000E5; background-color: #FFFFFF">&lt;graphics type='vnc' port='5904'/&gt;</span>
   &lt;/devices&gt;
@@ -447,18 +456,40 @@ systems:</p>
 
 <p>There is a few things to notice specifically for HVM domains:</p>
 <ul>
-  <li>the &lt;os&gt; block description is very different, first it indicates
+  <li>the <code>&lt;os&gt;</code> block description is very different, first it indicates
     that the type is 'hvm' for hardware virtualization, then instead of a
     kernel, boot and command line arguments, it points to an os boot loader
     which will extract the boot informations from the boot device specified
-    in a separate boot element</li>
-  <li>the &lt;devices&gt; section includes an emulator entry pointing to an
+    in a separate boot element. The <code>dev</code> attribute on the <code>boot</code>
+    tag can be one of:
+    <ul>
+    <li><code>fd</code> - boot from first floppy device</li>
+    <li><code>hd</code> - boot from first harddisk device</li>
+    <li><code>cdrom</code> - boot from first cdrom device</li>
+    </ul>
+  </li>
+  <li>the <code>&lt;devices&gt;</code> section includes an emulator entry pointing to an
     additional program in charge of emulating the devices</li>
   <li>the disk entry indicates in the dev target section that the emulation
-    for the drive is the first IDE disk device hda</li>
-  <li>the &lt;devices&gt; section also include at least one entry for the
+    for the drive is the first IDE disk device hda. The list of device names
+    supported is dependant on the Hypervisor, but for Xen it can be any IDE 
+    device <code>hda</code>-<code>hdd</code>, or a floppy device <code>fda</code>,
+    <code>fdb</code>. The <code>&lt;disk&gt;</code> element also supports a 'device' 
+    attribute to indicate what kinda of hardware to emulate. The following values are 
+    supported:
+    <ul>
+    <li><code>floppy</code> - a floppy disk controller</li>
+    <li><code>disk</code> - a generic hard drive (the default it omitted)</li>
+    <li><code>cdrom</code> - a CDROM device</li>
+    </ul>
+    For Xen 3.0.2 and earlier a CDROM device can only be emulated on the
+    <code>hdc</code> channel, while for 3.0.3 and later, it can be emulated on
+    any IDE channel.</li>
+  <li>the <code>&lt;devices&gt;</code> section also include at least one entry for the
     graphic device used to render the os. Currently there is just 2 types
-    possible 'vnc' or 'sdl'</li>
+    possible 'vnc' or 'sdl'. If the type is 'vnc', then an additional <code>port</code>
+    attribute will be present indicating the TCP port on which the VNC server is
+    accepting client connections.</li>
 </ul>
 
 <p>It is likely that the HVM description gets additional optional elements