libvirt/docs/drvopenvz.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>OpenVZ container driver</h1>

    <ul id="toc"></ul>

    <p>
    The OpenVZ driver for libvirt allows use and management of container
    based virtualization on a Linux host OS. Prior to using the OpenVZ
    driver, the OpenVZ enabled kernel must be installed &amp; booted, and the
    OpenVZ userspace tools installed. The libvirt driver has been tested
    with OpenVZ 3.0.22, but other 3.0.x versions should also work without
    undue trouble.
    </p>

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

    <ul>
      <li>
        The <a href="http://openvz.org/">OpenVZ</a> Linux container
        system
      </li>
    </ul>

    <h2><a name="connections">Connections to OpenVZ driver</a></h2>

    <p>
    The libvirt OpenVZ driver is a single-instance privileged driver,
    with a driver name of 'openvz'. Some example connection URIs for
    the libvirt driver are:
    </p>

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

    <h2><a name="notes">Notes on bridged networking</a></h2>

    <p>
    Bridged networking enables a guest domain (ie container) to have its
    network interface connected directly to the host's physical LAN. Before
    this can be used there are a couple of configuration pre-requisites for
    the host OS.
    </p>

    <h3><a name="host">Host network devices</a></h3>

    <p>
    One or more of the physical devices must be attached to a bridge. The
    process for this varies according to the operating system in use, so
    for up to date notes consult the <a href="http://wiki.libvirt.org">Wiki</a>
    or your operating system's networking documentation. The basic idea is
    that the host OS should end up with a bridge device "br0" containing a
    physical device "eth0", or a bonding device "bond0".
    </p>

    <h3><a name="tools">OpenVZ tools configuration</a></h3>

    <p>
    OpenVZ releases later than 3.0.23 ship with a standard network device
    setup script that is able to setup bridging, named
    <code>/usr/sbin/vznetaddbr</code>. For releases prior to 3.0.23, this
    script must be created manually by the host OS administrator. The
    simplest way is to just download the latest version of this script
    from a newer OpenVZ release, or upstream source repository. Then
    a generic configuration file <code>/etc/vz/vznet.conf</code>
    must be created containing
    </p>

<pre>
#!/bin/bash
EXTERNAL_SCRIPT="/usr/sbin/vznetaddbr"
</pre>

    <p>
    The host OS is now ready to allow bridging of guest containers, which
    will work whether the container is started with libvirt, or OpenVZ
    tools.
    </p>


    <h2><a name="example">Example guest domain XML configuration</a></h2>

    <p>
    The current libvirt OpenVZ driver has a restriction that the
    domain names must match the OpenVZ container VEID, which by
    convention start at 100, and are incremented from there. The
    choice of OS template to use inside the container is determined
    by the <code>filesystem</code> tag, and the template source name
    matches the templates known to OpenVZ tools.
    </p>

<pre>
&lt;domain type='openvz' id='104'&gt;
  &lt;name&gt;104&lt;/name&gt;
  &lt;uuid&gt;86c12009-e591-a159-6e9f-91d18b85ef78&lt;/uuid&gt;
  &lt;vcpu&gt;3&lt;/vcpu&gt;
  &lt;os&gt;
    &lt;type&gt;exe&lt;/type&gt;
    &lt;init&gt;/sbin/init&lt;/init&gt;
  &lt;/os&gt;
  &lt;devices&gt;
    &lt;filesystem type='template'&gt;
      &lt;source name='fedora-9-i386-minimal'/&gt;
      &lt;target dir='/'/&gt;
    &lt;/filesystem&gt;
    &lt;interface type='bridge'&gt;
      &lt;mac address='00:18:51:5b:ea:bf'/&gt;
      &lt;source bridge='br0'/&gt;
      &lt;target dev='veth101.0'/&gt;
    &lt;/interface&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">`
Split website out into one file per page. APply new layout and styling 2008-04-23 21:08:31 +04:00			`<body>`
			`<h1>OpenVZ container driver</h1>`
Add bridged network to openvz driver & add some openvz docs 2008-11-12 19:35:47 +03:00
docs: fixed typo, added table of contents 2010-12-22 15:48:25 +03:00			`<ul id="toc"></ul>`

Add bridged network to openvz driver & add some openvz docs 2008-11-12 19:35:47 +03:00			`<p>`
			`The OpenVZ driver for libvirt allows use and management of container`
			`based virtualization on a Linux host OS. Prior to using the OpenVZ`
			`driver, the OpenVZ enabled kernel must be installed & booted, and the`
			`OpenVZ userspace tools installed. The libvirt driver has been tested`
			`with OpenVZ 3.0.22, but other 3.0.x versions should also work without`
			`undue trouble.`
			`</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://openvz.org/">OpenVZ</a> Linux container`
			`system`
			`</li>`
			`</ul>`

docs: fixed typo, added table of contents 2010-12-22 15:48:25 +03:00			`<h2><a name="connections">Connections to OpenVZ driver</a></h2>`
Add bridged network to openvz driver & add some openvz docs 2008-11-12 19:35:47 +03:00
			`<p>`
			`The libvirt OpenVZ driver is a single-instance privileged driver,`
docs: fixed typo, added table of contents 2010-12-22 15:48:25 +03:00			`with a driver name of 'openvz'. Some example connection URIs for`
Add bridged network to openvz driver & add some openvz docs 2008-11-12 19:35:47 +03:00			`the libvirt driver are:`
			`</p>`

Whitespace cleanup for pre-tags on the website 2009-11-14 02:09:20 +03:00			`<pre>`
			`openvz:///system (local access)`
			`openvz+unix:///system (local access)`
			`openvz://example.com/system (remote access, TLS/x509)`
			`openvz+tcp://example.com/system (remote access, SASl/Kerberos)`
			`openvz+ssh://root@example.com/system (remote access, SSH tunnelled)`
			`</pre>`
Add bridged network to openvz driver & add some openvz docs 2008-11-12 19:35:47 +03:00
docs: fixed typo, added table of contents 2010-12-22 15:48:25 +03:00			`<h2><a name="notes">Notes on bridged networking</a></h2>`
Add bridged network to openvz driver & add some openvz docs 2008-11-12 19:35:47 +03:00
			`<p>`
			`Bridged networking enables a guest domain (ie container) to have its`
			`network interface connected directly to the host's physical LAN. Before`
			`this can be used there are a couple of configuration pre-requisites for`
			`the host OS.`
			`</p>`

docs: fixed typo, added table of contents 2010-12-22 15:48:25 +03:00			`<h3><a name="host">Host network devices</a></h3>`
Add bridged network to openvz driver & add some openvz docs 2008-11-12 19:35:47 +03:00
			`<p>`
			`One or more of the physical devices must be attached to a bridge. The`
			`process for this varies according to the operating system in use, so`
			`for up to date notes consult the <a href="http://wiki.libvirt.org">Wiki</a>`
			`or your operating system's networking documentation. The basic idea is`
			`that the host OS should end up with a bridge device "br0" containing a`
			`physical device "eth0", or a bonding device "bond0".`
			`</p>`

docs: fixed typo, added table of contents 2010-12-22 15:48:25 +03:00			`<h3><a name="tools">OpenVZ tools configuration</a></h3>`
Add bridged network to openvz driver & add some openvz docs 2008-11-12 19:35:47 +03:00
			`<p>`
			`OpenVZ releases later than 3.0.23 ship with a standard network device`
			`setup script that is able to setup bridging, named`
			`<code>/usr/sbin/vznetaddbr</code>. For releases prior to 3.0.23, this`
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			`script must be created manually by the host OS administrator. The`
Add bridged network to openvz driver & add some openvz docs 2008-11-12 19:35:47 +03:00			`simplest way is to just download the latest version of this script`
			`from a newer OpenVZ release, or upstream source repository. Then`
docs: fix path to openvz network configuration file It's vznet.conf not vznetctl.conf, see e.g.: http://git.openvz.org/?p=vzctl;a=blob;f=bin/vznetcfg.in;h=e91f5c4a0744c1ea149e1b8c241b666052e10b12;hb=HEAD 2012-04-16 18:18:29 +04:00			`a generic configuration file <code>/etc/vz/vznet.conf</code>`
Add bridged network to openvz driver & add some openvz docs 2008-11-12 19:35:47 +03:00			`must be created containing`
			`</p>`

Whitespace cleanup for pre-tags on the website 2009-11-14 02:09:20 +03:00			`<pre>`
Add bridged network to openvz driver & add some openvz docs 2008-11-12 19:35:47 +03:00			`#!/bin/bash`
			`EXTERNAL_SCRIPT="/usr/sbin/vznetaddbr"`
Whitespace cleanup for pre-tags on the website 2009-11-14 02:09:20 +03:00			`</pre>`
Add bridged network to openvz driver & add some openvz docs 2008-11-12 19:35:47 +03:00
			`<p>`
			`The host OS is now ready to allow bridging of guest containers, which`
			`will work whether the container is started with libvirt, or OpenVZ`
			`tools.`
			`</p>`


docs: fixed typo, added table of contents 2010-12-22 15:48:25 +03:00			`<h2><a name="example">Example guest domain XML configuration</a></h2>`
Add bridged network to openvz driver & add some openvz docs 2008-11-12 19:35:47 +03:00
			`<p>`
			`The current libvirt OpenVZ driver has a restriction that the`
			`domain names must match the OpenVZ container VEID, which by`
			`convention start at 100, and are incremented from there. The`
			`choice of OS template to use inside the container is determined`
			`by the <code>filesystem</code> tag, and the template source name`
			`matches the templates known to OpenVZ tools.`
			`</p>`

Whitespace cleanup for pre-tags on the website 2009-11-14 02:09:20 +03:00			`<pre>`
Add bridged network to openvz driver & add some openvz docs 2008-11-12 19:35:47 +03:00			`<domain type='openvz' id='104'>`
			`<name>104</name>`
			`<uuid>86c12009-e591-a159-6e9f-91d18b85ef78</uuid>`
			`<vcpu>3</vcpu>`
			`<os>`
			`<type>exe</type>`
			`<init>/sbin/init</init>`
			`</os>`
			`<devices>`
			`<filesystem type='template'>`
			`<source name='fedora-9-i386-minimal'/>`
			`<target dir='/'/>`
			`</filesystem>`
			`<interface type='bridge'>`
			`<mac address='00:18:51:5b:ea:bf'/>`
			`<source bridge='br0'/>`
			`<target dev='veth101.0'/>`
			`</interface>`
			`</devices>`
			`</domain>`
Whitespace cleanup for pre-tags on the website 2009-11-14 02:09:20 +03:00			`</pre>`
Add bridged network to openvz driver & add some openvz docs 2008-11-12 19:35:47 +03:00
Split website out into one file per page. APply new layout and styling 2008-04-23 21:08:31 +04:00			`</body>`
			`</html>`