From 990dd4b356a2ce29babdfb91a50ef365eb15bc62 Mon Sep 17 00:00:00 2001 From: Jim Fehlig Date: Fri, 6 Apr 2018 13:54:09 -0600 Subject: [PATCH] docs: update Xen driver information MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Now that the old Xen driver is removed, update the drvxen page with current information on the libxl drvier and remove all the old cruft. Signed-off-by: Jim Fehlig Reviewed-by: Daniel P. Berrangé --- docs/drvxen.html.in | 91 +++++++++++++++++---------------------------- 1 file changed, 35 insertions(+), 56 deletions(-) diff --git a/docs/drvxen.html.in b/docs/drvxen.html.in index d30ed2a042..b8d190c942 100644 --- a/docs/drvxen.html.in +++ b/docs/drvxen.html.in @@ -2,20 +2,20 @@ -

Xen hypervisor driver

+

libxl hypervisor driver for Xen

    - The libvirt Xen driver provides the ability to manage virtual machines - on any Xen release from 3.0.1 onwards. + The libvirt libxl driver provides the ability to manage virtual + machines on any Xen release from 4.4.0 onwards.

    Project Links

    • - The Xen + The Xen hypervisor on Linux and Solaris hosts
    @@ -23,54 +23,23 @@

    Deployment pre-requisites

    - The libvirt Xen driver uses a combination of channels to manage Xen - virtual machines. + The libvirt libxl driver uses Xen's libxl API, also known as + libxenlight, to implement libvirt's hypervisor driver + functionality. libxl provides a consolidated interface for + managing a Xen host and its virtual machines, unlike old + versions of Xen where applications often had to communicate + with xend, xenstored, and the hypervisor itself via hypercalls. + With libxl the only pre-requisit is a properly installed Xen + host with the libxl toolstack running in a service domain + (often Domain-0).

    -
      -
    • - XenD: Access to the Xen daemon is a mandatory - requirement for the libvirt Xen driver. It requires that the UNIX - socket interface be enabled in the /etc/xen/xend-config.sxp - configuration file. Specifically the config settings - (xend-unix-server yes). This path is usually restricted - to only allow the root user access. As an alternative, - the HTTP interface can be used, however, this has significant security - implications. -
      • -
    • - XenStoreD: Access to the Xenstore daemon enables - more efficient codepaths for looking up domain information which - lowers the CPU overhead of management. -
      • -
    • - Hypercalls: The ability to make direct hypercalls - allows the most efficient codepaths in the driver to be used for - monitoring domain status. -
      • -
    • - XM config: When using Xen releases prior to 3.0.4, - there is no inactive domain management in XenD. For such releases, - libvirt will automatically process XM configuration files kept in - the /etc/xen directory. It is important not to place - any other non-config files in this directory. -
      • -
    • - libxl: Starting with Xen 4.2, the legacy XenD/xm - toolstack is deprecated in favor of libxl, also commonly called - libxenlight. libvirt supports this new Xen toolstack via the - libxl driver. If XenD is enabled, the legacy xen driver consisting - of the above mentioned channels will be used. If XenD is disabled, - the libxl driver will be used. -
      • -
    - -

    Connections to Xen driver

    +

    Connections to libxl driver

    - The libvirt Xen driver is a single-instance privileged driver, - with a driver name of 'xen'. Some example connection URIs for - the libvirt driver are: + The libvirt libxl driver is a single-instance privileged driver, + with a driver name of 'xen'. Some example connection URIs for + the libxl driver are: 

    @@ -83,18 +52,28 @@ xen+ssh://root@example.com/    (remote access, SSH tunnelled)
 
     
    Import and export of libvirt domain XML configs
    
 
-    
    The Xen driver currently supports two native
-      config formats. The first known as xen-xm is the format
-      used by the XM tool for files in /etc/xen. The second
-      known as xen-sxpr, is the format used for interacting
-      with the XenD's legacy HTTP RPC service.
    
+    
    
+      The libxl driver currently supports three native
+      config formats. The first, known as xen-xm, is the
+      original Xen virtual machine config format used by the legacy
+      xm/xend toolstack. The second, known as xen-sxpr,
+      is also one of the original formats that was used by xend's
+      legacy HTTP RPC service. For compatibility, import and export
+      of these legacy formats is supported by the libxl driver.
+    
    
+
+    
    
+      The third format is xen-xl, which is the virtual
+      machine config format supported by modern Xen. The xen-xl
+      format is described in the xl.cfg(5) man page.
+    
    
 
     
    Converting from XM config files to domain XML
    
 
     
    
       The virsh domxml-from-native provides a way to convert an
-      existing set of XM config files into a guest description using libvirt Domain XML
-      that can then be used by libvirt.
+      existing set of xl, xm, or sxpr config files to libvirt Domain XML,
+      which can then be used by libvirt.
     
    
 
     
    $ virsh -c xen:/// domxml-from-native xen-xm rhel5.cfg
@@ -139,7 +118,7 @@ xen+ssh://root@example.com/    (remote access, SSH tunnelled)
 
     
    
       The virsh domxml-to-native provides a way to convert a
-      guest description using libvirt Domain XML, into the XM config file
+      guest description using libvirt Domain XML into xl, xm, or sxpr config
       format.