INSTALL.XenServer

   1            How to Install Open vSwitch on Citrix XenServer
   2            ===============================================
   3
   4 This document describes how to build and install Open vSwitch on a
   5 Citrix XenServer host.  If you want to install Open vSwitch on a
   6 generic Linux or BSD host, see INSTALL instead.
   7
   8 These instructions have been tested with XenServer 5.6 FP1.
   9
  10 Building Open vSwitch for XenServer
  11 -----------------------------------
  12
  13 You may build from an Open vSwitch distribution tarball or from an
  14 Open vSwitch Git tree.  The recommended build environment to build
  15 RPMs for Citrix XenServer is the DDK VM available from Citrix.
  16
  17 1. If you are building from an Open vSwitch Git tree, then you will
  18    need to first create a distribution tarball by running "./boot.sh;
  19    ./configure; make dist" in the Git tree.  You cannot run this in
  20    the DDK VM, because it lacks tools that are necessary to bootstrap
  21    the Open vSwitch distribution.  Instead, you must run this on a
  22    machine that has the tools listed in INSTALL as prerequisites for
  23    building from a Git tree.
  24
  25 2. Copy the distribution tarball into /usr/src/redhat/SOURCES inside
  26    the DDK VM.
  27
  28 3. In the DDK VM, unpack the distribution tarball into a temporary
  29    directory and "cd" into the root of the distribution tarball.
  30
  31 4. To build Open vSwitch userspace, run:
  32
  33        rpmbuild -bb xenserver/openvswitch-xen.spec
  34
  35    This produces three RPMs in /usr/src/redhat/RPMS/i386:
  36    "openvswitch", "openvswitch-modules-xen", and
  37    "openvswitch-debuginfo".
  38
  39    The above command automatically runs the Open vSwitch unit tests.
  40    To disable the unit tests, run:
  41
  42        rpmbuild -bb --without check xenserver/openvswitch-xen.spec
  43
  44 Build Parameters
  45 ----------------
  46
  47 openvswitch-xen.spec needs to know a number of pieces of information
  48 about the XenServer kernel.  Usually, it can figure these out for
  49 itself, but if it does not do it correctly then you can specify them
  50 yourself as parameters to the build.  Thus, the final "rpmbuild" step
  51 above can be elaborated as:
  52
  53    VERSION=<Open vSwitch version>
  54    KERNEL_NAME=<Xen Kernel name>
  55    KERNEL_VERSION=<Xen Kernel version>
  56    KERNEL_FLAVOR=<Xen Kernel flavor(suffix) >
  57    rpmbuild \
  58         -D "openvswitch_version $VERSION" \
  59         -D "kernel_name $KERNEL_NAME" \
  60         -D "kernel_version $KERNEL_VERSION" \
  61         -D "kernel_flavor $KERNEL_FLAVOR" \
  62         -bb xenserver/openvswitch-xen.spec
  63
  64 where:
  65
  66     <openvswitch version> is the version number that appears in the
  67     name of the Open vSwitch tarball, e.g. 0.90.0.
  68
  69     <Xen Kernel name> is the name of the XenServer kernel package,
  70     e.g. kernel-xen or kernel-NAME-xen, without the "kernel-" prefix.
  71
  72     <Xen Kernel version> is the output of:
  73     rpm -q --queryformat "%{Version}-%{Release}" <kernel-devel-package>,
  74     e.g. 2.6.32.12-0.7.1.xs5.6.100.323.170596, where <kernel-devel-package> is
  75     the name of the -devel package corresponding to <Xen Kernel name>.
  76
  77     <Xen Kernel flavor (suffix) > is either "xen" or "kdump".
  78     The "xen" flavor is the main running kernel flavor and the "kdump" flavor is
  79     the crashdump kernel flavor. Commonly, one would specify "xen" here.
  80
  81 For XenServer 6.5 or above, the kernel version naming no longer contains
  82 KERNEL_FLAVOR.  In fact, only providing the `uname -r` output is enough.
  83 So, the final "rpmbuild" step changes to:
  84
  85    ```
  86    KERNEL_UNAME=<`uname -r` output>
  87    rpmbuild \
  88         -D "kenel_uname $KERNEL_UNAME" \
  89         -bb xenserver/openvswitch-xen.spec
  90    ```
  91
  92
  93 Installing Open vSwitch for XenServer
  94 -------------------------------------
  95
  96 To install Open vSwitch on a XenServer host, or to upgrade to a newer version,
  97 copy the "openvswitch" and "openvswitch-modules-xen" RPMs to that host with
  98 "scp", then install them with "rpm -U", e.g.:
  99
 100      scp openvswitch-$VERSION-1.i386.rpm \
 101          openvswitch-modules-xen-$XEN_KERNEL_VERSION-$VERSION-1.i386.rpm \
 102          root@<host>:
 103 (At this point you will have to enter <host>'s root password.)
 104      ssh root@<host>
 105 (At this point you will have to enter <host>'s root password again.)
 106      rpm -U openvswitch-$VERSION-1.i386.rpm \
 107          openvswitch-modules-xen-$XEN_KERNEL_VERSION-$VERSION-1.i386.rpm
 108
 109 To uninstall Open vSwitch from a XenServer host, remove the packages:
 110
 111      ssh root@<host>
 112 (At this point you will have to enter <host>'s root password again.)
 113      rpm -e openvswitch openvswitch-modules-xen-$XEN_KERNEL_VERSION
 114
 115 After installing or uninstalling Open vSwitch, the XenServer should be
 116 rebooted as soon as possible.
 117
 118 Open vSwitch Boot Sequence on XenServer
 119 ---------------------------------------
 120
 121 When Open vSwitch is installed on XenServer, its startup script
 122 /etc/init.d/openvswitch runs early in boot.  It does roughly the
 123 following:
 124
 125         * Loads the OVS kernel module, openvswitch.
 126
 127         * Starts ovsdb-server, the OVS configuration database.
 128
 129         * XenServer expects there to be no bridges configured at
 130           startup, but the OVS configuration database likely still has
 131           bridges configured from before reboot.  To match XenServer
 132           expectations, the startup script deletes all configured
 133           bridges from the database.
 134
 135         * Starts ovs-vswitchd, the OVS switching daemon.
 136
 137 At this point in the boot process, then, there are no Open vSwitch
 138 bridges, even though all of the Open vSwitch daemons are running.
 139 Later on in boot, /etc/init.d/management-interface (part of XenServer,
 140 not Open vSwitch) creates the bridge for the XAPI management interface
 141 by invoking /opt/xensource/libexec/interface-reconfigure.  Normally
 142 this program consults XAPI's database to obtain information about how
 143 to configure the bridge, but XAPI is not running yet[*] so it instead
 144 consults /var/xapi/network.dbcache, which is a cached copy of the most
 145 recent network configuration.
 146
 147 [*] Even if XAPI were running, if this XenServer node is a pool slave
 148     then the query would have to consult the master, which requires
 149     network access, which begs the question of how to configure the
 150     management interface.
 151
 152 XAPI starts later on in the boot process.  XAPI can then create other
 153 bridges on demand using /opt/xensource/libexec/interface-reconfigure.
 154 Now that XAPI is running, that program consults XAPI directly instead
 155 of reading the cache.
 156
 157 As part of its own startup, XAPI invokes the Open vSwitch XAPI plugin
 158 script /etc/xapi.d/openvswitch-cfg-update passing the "update"
 159 command.  The plugin script does roughly the following:
 160
 161         * Calls /opt/xensource/libexec/interface-reconfigure with the
 162           "rewrite" command, to ensure that the network cache is
 163           up-to-date.
 164
 165         * Queries the Open vSwitch manager setting (named
 166           "vswitch_controller") from the XAPI database for the
 167           XenServer pool.
 168
 169         * If XAPI and OVS are configured for different managers, or if
 170           OVS is configured for a manager but XAPI is not, runs
 171           "ovs-vsctl emer-reset" to bring the Open vSwitch
 172           configuration to a known state.  One effect of emer-reset is
 173           to deconfigure any manager from the OVS database.
 174
 175         * If XAPI is configured for a manager, configures the OVS
 176           manager to match with "ovs-vsctl set-manager".
 177
 178 Notes
 179 -----
 180
 181 * The Open vSwitch boot sequence only configures an OVS configuration
 182 database manager.  There is no way to directly configure an OpenFlow
 183 controller on XenServer and, as a consequence of the step above that
 184 deletes all of the bridges at boot time, controller configuration only
 185 persists until XenServer reboot.  The configuration database manager
 186 can, however, configure controllers for bridges.  See the BUGS section
 187 of test-controller(8) for more information on this topic.
 188
 189 * The Open vSwitch startup script automatically adds a firewall rule
 190 to allow GRE traffic. This rule is needed for the XenServer feature
 191 called "Cross-Host Internal Networks" (CHIN) that uses GRE. If a user
 192 configures tunnels other than GRE (ex: VXLAN, LISP), they will have
 193 to either manually add a iptables firewall rule to allow the tunnel traffic
 194 or add it through a startup script (Please refer to the "enable-protocol"
 195 command in the ovs-ctl(8) manpage).
 196
 197 Reporting Bugs
 198 --------------
 199
 200 Please report problems to bugs@openvswitch.org.