INSTALL.XenServer.md

   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](INSTALL.md) 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](INSTALL.md) as
  23    prerequisites for 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    ```
  54    VERSION=<Open vSwitch version>
  55    KERNEL_NAME=<Xen Kernel name>
  56    KERNEL_VERSION=<Xen Kernel version>
  57    KERNEL_FLAVOR=<Xen Kernel flavor(suffix) >
  58    rpmbuild \
  59         -D "openvswitch_version $VERSION" \
  60         -D "kernel_name $KERNEL_NAME" \
  61         -D "kernel_version $KERNEL_VERSION" \
  62         -D "kernel_flavor $KERNEL_FLAVOR" \
  63         -bb xenserver/openvswitch-xen.spec
  64    ```
  65
  66 where:
  67
  68     `<openvswitch version>` is the version number that appears in the
  69     name of the Open vSwitch tarball, e.g. 0.90.0.
  70
  71     `<Xen Kernel name>` is the name of the XenServer kernel package,
  72     e.g. kernel-xen or kernel-NAME-xen, without the "kernel-" prefix.
  73
  74     `<Xen Kernel version>` is the output of:
  75     rpm -q --queryformat "%{Version}-%{Release}" <kernel-devel-package>,
  76     e.g. 2.6.32.12-0.7.1.xs5.6.100.323.170596, where <kernel-devel-package> is
  77     the name of the -devel package corresponding to <Xen Kernel name>.
  78
  79     `<Xen Kernel flavor (suffix) >` is either "xen" or "kdump".
  80     The "xen" flavor is the main running kernel flavor and the "kdump" flavor is
  81     the crashdump kernel flavor. Commonly, one would specify "xen" here.
  82
  83 Installing Open vSwitch for XenServer
  84 -------------------------------------
  85
  86 To install Open vSwitch on a XenServer host, or to upgrade to a newer version,
  87 copy the "openvswitch" and "openvswitch-modules-xen" RPMs to that host with
  88 "scp", then install them with "rpm -U", e.g.:
  89
  90      ```
  91      scp openvswitch-$VERSION-1.i386.rpm \
  92          openvswitch-modules-xen-$XEN_KERNEL_VERSION-$VERSION-1.i386.rpm \
  93          root@<host>:
  94 (At this point you will have to enter <host>'s root password.)
  95      ssh root@<host>
  96 (At this point you will have to enter <host>'s root password again.)
  97      rpm -U openvswitch-$VERSION-1.i386.rpm \
  98          openvswitch-modules-xen-$XEN_KERNEL_VERSION-$VERSION-1.i386.rpm
  99      ```
 100
 101 To uninstall Open vSwitch from a XenServer host, remove the packages:
 102
 103      `ssh root@<host>`
 104 (At this point you will have to enter <host>'s root password again.)
 105      `rpm -e openvswitch openvswitch-modules-xen-$XEN_KERNEL_VERSION`
 106
 107 After installing or uninstalling Open vSwitch, the XenServer should be
 108 rebooted as soon as possible.
 109
 110 Open vSwitch Boot Sequence on XenServer
 111 ---------------------------------------
 112
 113 When Open vSwitch is installed on XenServer, its startup script
 114 /etc/init.d/openvswitch runs early in boot.  It does roughly the
 115 following:
 116
 117         * Loads the OVS kernel module, openvswitch.
 118
 119         * Starts ovsdb-server, the OVS configuration database.
 120
 121         * XenServer expects there to be no bridges configured at
 122           startup, but the OVS configuration database likely still has
 123           bridges configured from before reboot.  To match XenServer
 124           expectations, the startup script deletes all configured
 125           bridges from the database.
 126
 127         * Starts ovs-vswitchd, the OVS switching daemon.
 128
 129 At this point in the boot process, then, there are no Open vSwitch
 130 bridges, even though all of the Open vSwitch daemons are running.
 131 Later on in boot, /etc/init.d/management-interface (part of XenServer,
 132 not Open vSwitch) creates the bridge for the XAPI management interface
 133 by invoking /opt/xensource/libexec/interface-reconfigure.  Normally
 134 this program consults XAPI's database to obtain information about how
 135 to configure the bridge, but XAPI is not running yet[*] so it instead
 136 consults /var/xapi/network.dbcache, which is a cached copy of the most
 137 recent network configuration.
 138
 139 [*] Even if XAPI were running, if this XenServer node is a pool slave
 140     then the query would have to consult the master, which requires
 141     network access, which begs the question of how to configure the
 142     management interface.
 143
 144 XAPI starts later on in the boot process.  XAPI can then create other
 145 bridges on demand using /opt/xensource/libexec/interface-reconfigure.
 146 Now that XAPI is running, that program consults XAPI directly instead
 147 of reading the cache.
 148
 149 As part of its own startup, XAPI invokes the Open vSwitch XAPI plugin
 150 script /etc/xapi.d/openvswitch-cfg-update passing the "update"
 151 command.  The plugin script does roughly the following:
 152
 153         * Calls /opt/xensource/libexec/interface-reconfigure with the
 154           "rewrite" command, to ensure that the network cache is
 155           up-to-date.
 156
 157         * Queries the Open vSwitch manager setting (named
 158           "vswitch_controller") from the XAPI database for the
 159           XenServer pool.
 160
 161         * If XAPI and OVS are configured for different managers, or if
 162           OVS is configured for a manager but XAPI is not, runs
 163           "ovs-vsctl emer-reset" to bring the Open vSwitch
 164           configuration to a known state.  One effect of emer-reset is
 165           to deconfigure any manager from the OVS database.
 166
 167         * If XAPI is configured for a manager, configures the OVS
 168           manager to match with "ovs-vsctl set-manager".
 169
 170 Notes
 171 -----
 172
 173 * The Open vSwitch boot sequence only configures an OVS configuration
 174 database manager.  There is no way to directly configure an OpenFlow
 175 controller on XenServer and, as a consequence of the step above that
 176 deletes all of the bridges at boot time, controller configuration only
 177 persists until XenServer reboot.  The configuration database manager
 178 can, however, configure controllers for bridges.  See the BUGS section
 179 of ovs-testcontroller(8) for more information on this topic.
 180
 181 * The Open vSwitch startup script automatically adds a firewall rule
 182 to allow GRE traffic. This rule is needed for the XenServer feature
 183 called "Cross-Host Internal Networks" (CHIN) that uses GRE. If a user
 184 configures tunnels other than GRE (ex: Geneve, VXLAN, LISP), they will have
 185 to either manually add a iptables firewall rule to allow the tunnel traffic
 186 or add it through a startup script (Please refer to the "enable-protocol"
 187 command in the ovs-ctl(8) manpage).
 188
 189 Reporting Bugs
 190 --------------
 191
 192 Please report problems to bugs@openvswitch.org.