libvirt/docs/drvuml.html.in

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
  <body>
    <h1>User Mode Linux driver</h1>

    <p>
    The UML driver for libvirt allows use and management of paravirtualized
    guests built for User Mode Linux. UML requires no special support in
    the host kernel, so can be used by any user of any linux system, provided
    they have enough free RAM for their guest's needs, though there are
    certain restrictions on network connectivity unless the administrator
    has pre-created TAP devices.
    </p>

    <h2><a name="project">Project Links</a></h2>

    <ul>
      <li>
        The <a href="http://user-mode-linux.sourceforge.net/">User
        Mode Linux</a> paravirtualized kernel
      </li>
    </ul>

    <h2>Connections to UML driver</h2>

    <p>
    The libvirt UML driver follows the QEMU driver in providing two
    types of connection. There is one privileged instance per host,
    which runs as root. This is called the "system" instance, and allows
    full use of all host resources. Then, there is a per-user unprivileged
    "session", instance. This has more restricted capabilities, and may
    require the host administrator to setup certain resources ahead of
    time to allow full integration with the network. Example connection
    URIs are
    </p>

<pre>
uml:///session                       (local access to per-user instance)
uml+unix:///session                  (local access to per-user instance)

uml:///system                        (local access to system instance)
uml+unix:///system                   (local access to system instance)
uml://example.com/system             (remote access, TLS/x509)
uml+tcp://example.com/system         (remote access, SASl/Kerberos)
uml+ssh://root@example.com/system    (remote access, SSH tunnelled)
</pre>

    <h2>Example XML configuration</h2>

    <p>
      User mode Linux driver only supports directly kernel boot at
      this time. A future driver enhancement may allow a paravirt
      bootloader in a similar style to Xen's pygrub. For now though,
      the UML kernel must be stored on the host and referenced
      explicitly in the "os" element. Since UML is a paravirtualized
      technology, the kernel "type" is set to "uml"
    </p>

    <p>
      There is not yet support for networking in the driver, but
      disks can be specified in the usual libvirt manner. The main
      variation is the target device naming scheme "ubd0", and
      bus type of "uml".
    </p>

    <p>
      Once booted the primary console is connected to a PTY, and
      thus accessible with "virsh console" or equivalent tools
    </p>

<pre>
&lt;domain type='uml'&gt;
  &lt;name&gt;demo&lt;/name&gt;
  &lt;uuid&gt;b4433fc2-a22e-ffb3-0a3d-9c173b395800&lt;/uuid&gt;
  &lt;memory&gt;500000&lt;/memory&gt;
  &lt;currentMemory&gt;500000&lt;/currentMemory&gt;
  &lt;vcpu&gt;1&lt;/vcpu&gt;
  &lt;os&gt;
    &lt;type arch='x86_64'&gt;uml&lt;/type&gt;
    &lt;kernel&gt;/home/berrange/linux-uml-2.6.26-x86_64&lt;/kernel&gt;
  &lt;/os&gt;
  &lt;devices&gt;
    &lt;disk type='file' device='disk'&gt;
      &lt;source file='/home/berrange/FedoraCore6-AMD64-root_fs'/&gt;
      &lt;target dev='ubd0' bus='uml'/&gt;
    &lt;/disk&gt;
    &lt;console type='pty'/&gt;
  &lt;/devices&gt;
&lt;/domain&gt;
</pre>
  </body>
</html>
Fix multiple formatting problems in HTML docs The rule generating the HTML docs passing the --html flag to xsltproc. This makes it use the legacy HTML parser, which either ignores or tries to fix all sorts of broken XML tags. There's no reason why we should be writing broken XML in the first place, so removing --html and adding the XHTML doctype to all files forces us to create good XML. This adds the XHTML doc type and fixes many, many XML tag problems it exposes. Signed-off-by: Daniel P. Berrange <berrange@redhat.com> 2013-05-03 18:25:37 +04:00			`<?xml version="1.0" encoding="UTF-8"?>`
			`<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">`
			`<html xmlns="http://www.w3.org/1999/xhtml">`
Add an initial User Mode Linux Driver 2008-11-19 19:58:23 +03:00			`<body>`
			`<h1>User Mode Linux driver</h1>`

			`<p>`
			`The UML driver for libvirt allows use and management of paravirtualized`
			`guests built for User Mode Linux. UML requires no special support in`
			`the host kernel, so can be used by any user of any linux system, provided`
			`they have enough free RAM for their guest's needs, though there are`
docs: fix typos * docs/drvopenvz.html.in: Spell administrator correctly. * docs/drvuml.html.in: Likewise. * src/qemu/qemu.conf: Likewise. Fix other typos, too. 2011-02-15 23:50:28 +03:00			`certain restrictions on network connectivity unless the administrator`
Add an initial User Mode Linux Driver 2008-11-19 19:58:23 +03:00			`has pre-created TAP devices.`
			`</p>`

website: Point main page links to libvirt driver pages The "libvirt supports:" section on the main page of libvirt.org contains a list of hypervisors with links that point to the sites of the underlying virt technologies. The entry for KVM points to http://www.linux-kvm.org/, for example. People coming to libvirt.org for the first time are likely to know about those sites, and they're probably interested in how libvirt manages those technologies. This patch points those links to the libvirt driver pages instead. It also consolidates KVM and QEMU as there is only one libvirt driver page for them. Finally, it adds a line about networking support. v2: incorporate Eric's feedback adding project links to driver pages. website: Add project links to KVM/QEMU driver page website: Add project links to Xen driver page website: Add project links to LXC driver page website: Add project links to OpenVZ driver page website: Add project links to UML driver page website: Add project links to Virtualbox driver page website: Add project links to ESX driver page website: Add project links to VMware driver page 2011-07-15 22:33:17 +04:00			`<h2><a name="project">Project Links</a></h2>`

			`<ul>`
			`<li>`
			`The <a href="http://user-mode-linux.sourceforge.net/">User`
			`Mode Linux</a> paravirtualized kernel`
			`</li>`
			`</ul>`

Add an initial User Mode Linux Driver 2008-11-19 19:58:23 +03:00			`<h2>Connections to UML driver</h2>`

			`<p>`
			`The libvirt UML driver follows the QEMU driver in providing two`
			`types of connection. There is one privileged instance per host,`
			`which runs as root. This is called the "system" instance, and allows`
			`full use of all host resources. Then, there is a per-user unprivileged`
			`"session", instance. This has more restricted capabilities, and may`
			`require the host administrator to setup certain resources ahead of`
			`time to allow full integration with the network. Example connection`
			`URIs are`
			`</p>`

Whitespace cleanup for pre-tags on the website 2009-11-14 02:09:20 +03:00			`<pre>`
			`uml:///session (local access to per-user instance)`
			`uml+unix:///session (local access to per-user instance)`
Added link to libvirt-qpid on front page, and docs on URI formats for each driver 2009-01-27 17:49:09 +03:00
Whitespace cleanup for pre-tags on the website 2009-11-14 02:09:20 +03:00			`uml:///system (local access to system instance)`
			`uml+unix:///system (local access to system instance)`
			`uml://example.com/system (remote access, TLS/x509)`
			`uml+tcp://example.com/system (remote access, SASl/Kerberos)`
			`uml+ssh://root@example.com/system (remote access, SSH tunnelled)`
			`</pre>`
Add an initial User Mode Linux Driver 2008-11-19 19:58:23 +03:00
			`<h2>Example XML configuration</h2>`

			`<p>`
			`User mode Linux driver only supports directly kernel boot at`
			`this time. A future driver enhancement may allow a paravirt`
			`bootloader in a similar style to Xen's pygrub. For now though,`
			`the UML kernel must be stored on the host and referenced`
			`explicitly in the "os" element. Since UML is a paravirtualized`
			`technology, the kernel "type" is set to "uml"`
			`</p>`

			`<p>`
			`There is not yet support for networking in the driver, but`
			`disks can be specified in the usual libvirt manner. The main`
			`variation is the target device naming scheme "ubd0", and`
			`bus type of "uml".`
			`</p>`

			`<p>`
docs: typo fix * drvuml.html.in: (connected) s/toa PTY/to a PTY/ 2014-03-01 13:41:20 +04:00			`Once booted the primary console is connected to a PTY, and`
Add an initial User Mode Linux Driver 2008-11-19 19:58:23 +03:00			`thus accessible with "virsh console" or equivalent tools`
			`</p>`

Whitespace cleanup for pre-tags on the website 2009-11-14 02:09:20 +03:00			`<pre>`
Add an initial User Mode Linux Driver 2008-11-19 19:58:23 +03:00			`<domain type='uml'>`
			`<name>demo</name>`
			`<uuid>b4433fc2-a22e-ffb3-0a3d-9c173b395800</uuid>`
			`<memory>500000</memory>`
			`<currentMemory>500000</currentMemory>`
			`<vcpu>1</vcpu>`
			`<os>`
			`<type arch='x86_64'>uml</type>`
			`<kernel>/home/berrange/linux-uml-2.6.26-x86_64</kernel>`
			`</os>`
			`<devices>`
			`<disk type='file' device='disk'>`
			`<source file='/home/berrange/FedoraCore6-AMD64-root_fs'/>`
			`<target dev='ubd0' bus='uml'/>`
			`</disk>`
			`<console type='pty'/>`
			`</devices>`
			`</domain>`
Whitespace cleanup for pre-tags on the website 2009-11-14 02:09:20 +03:00			`</pre>`
Add an initial User Mode Linux Driver 2008-11-19 19:58:23 +03:00			`</body>`
			`</html>`