format documentation to cover the new HVM domains.
Daniel
+Mon Jul 10 14:19:52 CEST 2006 Daniel Veillard <veillard@redhat.com>
+
+ * docs/format.html docs/libvir.html docs/news.html: updated the XML
+ format documentation to cover the new HVM domains.
+
Mon Jul 10 12:27:17 CEST 2006 Daniel Veillard <veillard@redhat.com>
* src/xend_internal.c src/xml.c: patches from Jim Fehlig for HVM
Releases
0.1.2: Jul 3 2006:
- - headers include paths fixup
-
- - proxy mechanism for unpriviledged read-only access by httpu
-
+ - headers include paths fixup
+ - proxy mechanism for unpriviledged read-only access by httpu
0.1.1: Jun 21 2006:
- - building fixes: ncurses fallback (Jim Fehlig), VPATH builds (Daniel P.
- Berrange)
-
- - driver cleanups: new entry points, cleanup of libvirt.c (with Daniel P.
- Berrange)
-
- - Cope with API change introduced in Xen changeset 10277
-
- - new test driver for regression checks (Daniel P. Berrange)
-
- - improvements: added UUID to XML serialization, buffer usage (Karel Zak),
- --connect argument to virsh (Daniel P. Berrange),
-
- - bug fixes: uninitialized memory access in error reporting, S-Expr
- parsing (Jim Fehlig, Jeremy Katz), virConnectOpen bug, remove a TODO
- in xs_internal.c
-
- - documentation: Python examples (David Lutterkort), new Perl binding URL,
- man page update (Karel Zak)
-
-
+ - building fixes: ncurses fallback (Jim Fehlig), VPATH builds (Daniel P.
+ Berrange)
+ - driver cleanups: new entry points, cleanup of libvirt.c (with Daniel P.
+ Berrange)
+ - Cope with API change introduced in Xen changeset 10277
+ - new test driver for regression checks (Daniel P. Berrange)
+ - improvements: added UUID to XML serialization, buffer usage (Karel
+ Zak), --connect argument to virsh (Daniel P. Berrange),
+ - bug fixes: uninitialized memory access in error reporting, S-Expr
+ parsing (Jim Fehlig, Jeremy Katz), virConnectOpen bug, remove a TODO in
+ xs_internal.c
+ - documentation: Python examples (David Lutterkort), new Perl binding
+ URL, man page update (Karel Zak)
0.1.0: Apr 10 2006:
- internal code cleanup: refactoring internals into a driver model, more
error handling, structure sharing, thread safety and ref counting
- bug fixes: error message (Jim Meyering), error allocation in virsh (Jim
- Meyering), virDomainLookupByID (Jim Fehlig),
+ Meyering), virDomainLookupByID (Jim Fehlig),
- documentation: updates on architecture, and format, typo fix (Jim
Meyering)
- bindings: exception handling in examples (Jim Meyering), perl ones out
<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" /><link rel="stylesheet" type="text/css" href="libvirt.css" /><link rel="SHORTCUT ICON" href="/32favicon.png" /><title>XML Format</title></head><body><div id="container"><div id="intro"><div id="adjustments"></div><div id="pageHeader"></div><div id="content2"><h1 class="style1">XML Format</h1><p>The library use an XML format to describe domains, as input to <a href="html/libvirt-libvirt.html#virDomainCreateLinux">virDomainCreateLinux()</a>
+<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" /><link rel="stylesheet" type="text/css" href="libvirt.css" /><link rel="SHORTCUT ICON" href="/32favicon.png" /><title>XML Format</title></head><body><div id="container"><div id="intro"><div id="adjustments"></div><div id="pageHeader"></div><div id="content2"><h1 class="style1">XML Format</h1><p>This section describes the XML format used to represent domains, there are
+variations on the format based on the kind of domains run and the options
+used to launch them:</p><p><a href="#Normal1">Normal paravirtualized Xen domains</a></p><p><a href="#Fully1">Fully virtualized Xen domains</a></p><p>The formats try as much as possible to follow the same structure and reuse
+elements and attributes where it makes sense.</p><h3 id="Normal"><a name="Normal1" id="Normal1">Normal paravirtualized Xen
+guests</a>:</h3><p>The library use an XML format to describe domains, as input to <a href="html/libvirt-libvirt.html#virDomainCreateLinux">virDomainCreateLinux()</a>
and as the output of <a href="html/libvirt-libvirt.html#virDomainGetXMLDesc">virDomainGetXMLDesc()</a>,
the following is an example of the format as returned by the shell command
<code>virsh xmldump fc4</code> , where fc4 was one of the running domains:</p><pre><domain type='xen' <span style="color: #0071FF; background-color: #FFFFFF">id='18'</span>>
...
</domain></pre><p>While the format may be extended in various ways as support for more
hypervisor types and features are added, it is expected that this core subset
-will remain functional in spite of the evolution of the library.</p></div></div><div class="linkList2"><div class="llinks2"><h3 class="links2"><span>main menu</span></h3><ul><li><a href="index.html">Home</a></li><li><a href="news.html">Releases</a></li><li><a href="intro.html">Introduction</a></li><li><a href="architecture.html">libvirt architecture</a></li><li><a href="downloads.html">Downloads</a></li><li><a href="format.html">XML Format</a></li><li><a href="python.html">Binding for Python</a></li><li><a href="errors.html">Handling of errors</a></li><li><a href="FAQ.html">FAQ</a></li><li><a href="bugs.html">Reporting bugs and getting help</a></li><li><a href="html/index.html">API Menu</a></li><li><a href="examples/index.html">C code examples</a></li><li><a href="ChangeLog.html">Recent Changes</a></li></ul></div><div class="llinks2"><h3 class="links2"><span>related links</span></h3><ul><li><a href="https://www.redhat.com/archives/libvir-list/">Mail archive</a></li><li><a href="https://bugzilla.redhat.com/bugzilla/buglist.cgi?product=Fedora+Core&component=libvirt&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&bug_status=MODIFIED&short_desc_type=allwordssubstr&short_desc=&long_desc_type=allwordssubstr">Open bugs</a></li><li><a href="http://search.cpan.org/~danberr/Sys-Virt-0.1.0/">Perl bindings</a></li><li><a href="http://www.cl.cam.ac.uk/Research/SRG/netos/xen/index.html">Xen project</a></li><li><form action="search.php" enctype="application/x-www-form-urlencoded" method="get"><input name="query" type="text" size="12" value="Search..." /><input name="submit" type="submit" value="Go" /></form></li><li><a href="http://xmlsoft.org/"><img src="Libxml2-Logo-90x34.gif" alt="Made with Libxml2 Logo" /></a></li></ul><p class="credits">Graphics and design by <a href="mail:dfong@redhat.com">Diana Fong</a></p></div></div><div id="bottom"><p class="p1"></p></div></div></body></html>
+will remain functional in spite of the evolution of the library.</p><h3 id="Fully"><a name="Fully1" id="Fully1">Fully virtualized guests</a>
+(added in 0.1.3):</h3><p>Here is an example of a domain description used to start an fully
+virtualized (a.k.a. HVM) Xen domain. This requires hardware virtualization
+support at the processor level but allows to run unmodified operating
+systems:</p><pre><domain type='xen' id='3'>
+ <name>fv0</name>
+ <uuid>4dea22b31d52d8f32516782e98ab3fa0</uuid>
+ <os>
+ <span style="color: #0000E5; background-color: #FFFFFF"><type>hvm</type></span>
+ <span style="color: #0000E5; background-color: #FFFFFF"><loader>/usr/lib/xen/boot/hvmloader</loader></span>
+ <span style="color: #0000E5; background-color: #FFFFFF"><boot dev='hda'/></span>
+ </os>
+ <memory>524288</memory>
+ <vcpu>1</vcpu>
+ <on_poweroff>destroy</on_poweroff>
+ <on_reboot>restart</on_reboot>
+ <on_crash>restart</on_crash>
+ <devices>
+ <span style="color: #0000E5; background-color: #FFFFFF"><emulator>/usr/lib/xen/bin/qemu-dm</emulator></span>
+ <interface type='bridge'>
+ <source bridge='xenbr0'/>
+ <mac address='00:16:3e:5d:c7:9e'/>
+ <script path='vif-bridge'/>
+ </interface>
+ <disk type='file'>
+ <source file='/root/fv0'/>
+ <target <span style="color: #0000E5; background-color: #FFFFFF">dev='ioemu:hda'</span>/>
+ </disk>
+ <span style="color: #0000E5; background-color: #FFFFFF"><graphics type='vnc'/></span>
+ </devices>
+</domain></pre><p>There is a few things to notice specifically for HVM domains:</p><ul><li>the <os> 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 ill extract the boot informations from the boot device specified in
+ a separate boot element</li>
+ <li>the <devices> 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 <devices> 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>
+</ul><p>It is likely that the HVM description gets additional elements and
+attributes as the support for fully virtualized domain expands especially for
+the kind of devices emulated and the graphic options offered.</p></div></div><div class="linkList2"><div class="llinks2"><h3 class="links2"><span>main menu</span></h3><ul><li><a href="index.html">Home</a></li><li><a href="news.html">Releases</a></li><li><a href="intro.html">Introduction</a></li><li><a href="architecture.html">libvirt architecture</a></li><li><a href="downloads.html">Downloads</a></li><li><a href="format.html">XML Format</a></li><li><a href="python.html">Binding for Python</a></li><li><a href="errors.html">Handling of errors</a></li><li><a href="FAQ.html">FAQ</a></li><li><a href="bugs.html">Reporting bugs and getting help</a></li><li><a href="html/index.html">API Menu</a></li><li><a href="examples/index.html">C code examples</a></li><li><a href="ChangeLog.html">Recent Changes</a></li></ul></div><div class="llinks2"><h3 class="links2"><span>related links</span></h3><ul><li><a href="https://www.redhat.com/archives/libvir-list/">Mail archive</a></li><li><a href="https://bugzilla.redhat.com/bugzilla/buglist.cgi?product=Fedora+Core&component=libvirt&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&bug_status=MODIFIED&short_desc_type=allwordssubstr&short_desc=&long_desc_type=allwordssubstr">Open bugs</a></li><li><a href="http://search.cpan.org/~danberr/Sys-Virt-0.1.0/">Perl bindings</a></li><li><a href="http://www.cl.cam.ac.uk/Research/SRG/netos/xen/index.html">Xen project</a></li><li><form action="search.php" enctype="application/x-www-form-urlencoded" method="get"><input name="query" type="text" size="12" value="Search..." /><input name="submit" type="submit" value="Go" /></form></li><li><a href="http://xmlsoft.org/"><img src="Libxml2-Logo-90x34.gif" alt="Made with Libxml2 Logo" /></a></li></ul><p class="credits">Graphics and design by <a href="mail:dfong@redhat.com">Diana Fong</a></p></div></div><div id="bottom"><p class="p1"></p></div></div></body></html>
<h3>0.1.2: Jul 3 2006</h3>
<ul>
- <li> headers include paths fixup
- <li> proxy mechanism for unpriviledged read-only access by httpu
+ <li>headers include paths fixup</li>
+ <li>proxy mechanism for unpriviledged read-only access by httpu</li>
</ul>
+
<h3>0.1.1: Jun 21 2006</h3>
<ul>
- <li> building fixes: ncurses fallback (Jim Fehlig), VPATH builds (Daniel P.
- Berrange)
- <li> driver cleanups: new entry points, cleanup of libvirt.c (with Daniel P.
- Berrange)
- <li> Cope with API change introduced in Xen changeset 10277
- <li> new test driver for regression checks (Daniel P. Berrange)
- <li> improvements: added UUID to XML serialization, buffer usage (Karel Zak),
- --connect argument to virsh (Daniel P. Berrange),
- <li> bug fixes: uninitialized memory access in error reporting, S-Expr
- parsing (Jim Fehlig, Jeremy Katz), virConnectOpen bug, remove a TODO
- in xs_internal.c
- <li> documentation: Python examples (David Lutterkort), new Perl binding URL,
- man page update (Karel Zak)
-
+ <li>building fixes: ncurses fallback (Jim Fehlig), VPATH builds (Daniel P.
+ Berrange)</li>
+ <li>driver cleanups: new entry points, cleanup of libvirt.c (with Daniel P.
+ Berrange)</li>
+ <li>Cope with API change introduced in Xen changeset 10277</li>
+ <li>new test driver for regression checks (Daniel P. Berrange)</li>
+ <li>improvements: added UUID to XML serialization, buffer usage (Karel
+ Zak), --connect argument to virsh (Daniel P. Berrange),</li>
+ <li>bug fixes: uninitialized memory access in error reporting, S-Expr
+ parsing (Jim Fehlig, Jeremy Katz), virConnectOpen bug, remove a TODO in
+ xs_internal.c</li>
+ <li>documentation: Python examples (David Lutterkort), new Perl binding
+ URL, man page update (Karel Zak)</li>
</ul>
+
<h3>0.1.0: Apr 10 2006</h3>
<ul>
<li>building fixes: --with-xen-distdir option (Ronald Aigner), out of tree
<li>internal code cleanup: refactoring internals into a driver model, more
error handling, structure sharing, thread safety and ref counting</li>
<li>bug fixes: error message (Jim Meyering), error allocation in virsh (Jim
- Meyering), virDomainLookupByID (Jim Fehlig), </li>
+ Meyering), virDomainLookupByID (Jim Fehlig),</li>
<li>documentation: updates on architecture, and format, typo fix (Jim
Meyering)</li>
<li>bindings: exception handling in examples (Jim Meyering), perl ones out
<h2><a name="Format">XML Format</a></h2>
+<p>This section describes the XML format used to represent domains, there are
+variations on the format based on the kind of domains run and the options
+used to launch them:</p>
+
+<p><a href="#Normal1">Normal paravirtualized Xen domains</a></p>
+
+<p><a href="#Fully1">Fully virtualized Xen domains</a></p>
+
+<p>The formats try as much as possible to follow the same structure and reuse
+elements and attributes where it makes sense.</p>
+
+<h3 id="Normal"><a name="Normal1" id="Normal1">Normal paravirtualized Xen
+guests</a>:</h3>
+
<p>The library use an XML format to describe domains, as input to <a
href="html/libvirt-libvirt.html#virDomainCreateLinux">virDomainCreateLinux()</a>
and as the output of <a
hypervisor types and features are added, it is expected that this core subset
will remain functional in spite of the evolution of the library.</p>
+<h3 id="Fully"><a name="Fully1" id="Fully1">Fully virtualized guests</a>
+(added in 0.1.3):</h3>
+
+<p>Here is an example of a domain description used to start an fully
+virtualized (a.k.a. HVM) Xen domain. This requires hardware virtualization
+support at the processor level but allows to run unmodified operating
+systems:</p>
+<pre><domain type='xen' id='3'>
+ <name>fv0</name>
+ <uuid>4dea22b31d52d8f32516782e98ab3fa0</uuid>
+ <os>
+ <span style="color: #0000E5; background-color: #FFFFFF"><type>hvm</type></span>
+ <span style="color: #0000E5; background-color: #FFFFFF"><loader>/usr/lib/xen/boot/hvmloader</loader></span>
+ <span style="color: #0000E5; background-color: #FFFFFF"><boot dev='hda'/></span>
+ </os>
+ <memory>524288</memory>
+ <vcpu>1</vcpu>
+ <on_poweroff>destroy</on_poweroff>
+ <on_reboot>restart</on_reboot>
+ <on_crash>restart</on_crash>
+ <devices>
+ <span style="color: #0000E5; background-color: #FFFFFF"><emulator>/usr/lib/xen/bin/qemu-dm</emulator></span>
+ <interface type='bridge'>
+ <source bridge='xenbr0'/>
+ <mac address='00:16:3e:5d:c7:9e'/>
+ <script path='vif-bridge'/>
+ </interface>
+ <disk type='file'>
+ <source file='/root/fv0'/>
+ <target <span style="color: #0000E5; background-color: #FFFFFF">dev='ioemu:hda'</span>/>
+ </disk>
+ <span style="color: #0000E5; background-color: #FFFFFF"><graphics type='vnc'/></span>
+ </devices>
+</domain></pre>
+
+<p>There is a few things to notice specifically for HVM domains:</p>
+<ul>
+ <li>the <os> 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 ill extract the boot informations from the boot device specified in
+ a separate boot element</li>
+ <li>the <devices> 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 <devices> 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>
+</ul>
+
+<p>It is likely that the HVM description gets additional elements and
+attributes as the support for fully virtualized domain expands especially for
+the kind of devices emulated and the graphic options offered.</p>
+
<h2><a name="Python" id="Python">Binding for Python</a></h2>
<p>Libvirt comes with direct support for the Python language (just make sure
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" /><link rel="stylesheet" type="text/css" href="libvirt.css" /><link rel="SHORTCUT ICON" href="/32favicon.png" /><title>Releases</title></head><body><div id="container"><div id="intro"><div id="adjustments"></div><div id="pageHeader"></div><div id="content2"><h1 class="style1">Releases</h1><p>Here is the list of official releases, however since it is early on in the
development of libvirt, it is preferable when possible to just use the <a href="downloads.html">CVS version or snapshot</a>, contact the mailing list
-and check the <a href="ChangeLog.html">ChangeLog</a> to gauge progresses.</p><h3>0.1.2: Jul 3 2006</h3><ul><li> headers include paths fixup
- </li><li> proxy mechanism for unpriviledged read-only access by httpu
-</li></ul><h3>0.1.1: Jun 21 2006</h3><ul><li> building fixes: ncurses fallback (Jim Fehlig), VPATH builds (Daniel P.
- Berrange)
- </li><li> driver cleanups: new entry points, cleanup of libvirt.c (with Daniel P.
- Berrange)
- </li><li> Cope with API change introduced in Xen changeset 10277
- </li><li> new test driver for regression checks (Daniel P. Berrange)
- </li><li> improvements: added UUID to XML serialization, buffer usage (Karel Zak),
- --connect argument to virsh (Daniel P. Berrange),
- </li><li> bug fixes: uninitialized memory access in error reporting, S-Expr
- parsing (Jim Fehlig, Jeremy Katz), virConnectOpen bug, remove a TODO
- in xs_internal.c
- </li><li> documentation: Python examples (David Lutterkort), new Perl binding URL,
- man page update (Karel Zak)
-
-</li></ul><h3>0.1.0: Apr 10 2006</h3><ul><li>building fixes: --with-xen-distdir option (Ronald Aigner), out of tree
+and check the <a href="ChangeLog.html">ChangeLog</a> to gauge progresses.</p><h3>0.1.2: Jul 3 2006</h3><ul><li>headers include paths fixup</li>
+ <li>proxy mechanism for unpriviledged read-only access by httpu</li>
+</ul><h3>0.1.1: Jun 21 2006</h3><ul><li>building fixes: ncurses fallback (Jim Fehlig), VPATH builds (Daniel P.
+ Berrange)</li>
+ <li>driver cleanups: new entry points, cleanup of libvirt.c (with Daniel P.
+ Berrange)</li>
+ <li>Cope with API change introduced in Xen changeset 10277</li>
+ <li>new test driver for regression checks (Daniel P. Berrange)</li>
+ <li>improvements: added UUID to XML serialization, buffer usage (Karel
+ Zak), --connect argument to virsh (Daniel P. Berrange),</li>
+ <li>bug fixes: uninitialized memory access in error reporting, S-Expr
+ parsing (Jim Fehlig, Jeremy Katz), virConnectOpen bug, remove a TODO in
+ xs_internal.c</li>
+ <li>documentation: Python examples (David Lutterkort), new Perl binding
+ URL, man page update (Karel Zak)</li>
+</ul><h3>0.1.0: Apr 10 2006</h3><ul><li>building fixes: --with-xen-distdir option (Ronald Aigner), out of tree
build and pkginfo cflag fix (Daniel Berrange)</li>
<li>enhancement and fixes of the XML description format (David Lutterkort
and Jim Fehlig)</li>
<li>internal code cleanup: refactoring internals into a driver model, more
error handling, structure sharing, thread safety and ref counting</li>
<li>bug fixes: error message (Jim Meyering), error allocation in virsh (Jim
- Meyering), virDomainLookupByID (Jim Fehlig), </li>
+ Meyering), virDomainLookupByID (Jim Fehlig),</li>
<li>documentation: updates on architecture, and format, typo fix (Jim
Meyering)</li>
<li>bindings: exception handling in examples (Jim Meyering), perl ones out
projects / people / liuw / libxenctrl-split / libvirt.git / commitdiff