drvopenvz.html.in

<html> <!-- -*- html -*- -->
  <body>
    <h1>OpenVZ container driver</h1>

    <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>Connections to OpenVZ driver</h2>

    <p>
    The libvirt OpenVZ driver is a single-instance privileged driver,
    with a driver name of 'openvz'. Some example conection 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>Notes on bridged networking</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>Host network devices</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>OpenVZ tools configuration</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 adminstrator. 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/vznetctl.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>Example guest domain XML configuration</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>