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 5.5.0 host.  If you want to install Open vSwitch on a
   6 generic Linux host, see INSTALL.Linux instead.
   7
   8 Building Open vSwitch for XenServer
   9 -----------------------------------
  10
  11 The recommended build environment to build RPMs for Citrix XenServer
  12 is the DDK VM available from Citrix.  If you are building from an Open
  13 vSwitch distribution tarball, this VM has all the tools that you will
  14 need.  If you are building from an Open vSwitch Git tree, then you
  15 will need to first create a distribution tarball elsewhere, by running
  16 "./boot.sh; ./configure; make dist" in the Git tree, because the DDK
  17 VM does not include Autoconf or Automake that are required to
  18 bootstrap the Open vSwitch distribution.
  19
  20 Once you have a distribution tarball, copy it into
  21 /usr/src/redhat/SOURCES inside the VM.  Then execute the following:
  22
  23    VERSION=<Open vSwitch version>
  24    XENKERNEL=<Xen kernel version>
  25    cd /tmp
  26    tar xfz /usr/src/redhat/SOURCES/openvswitch-$VERSION.tar.gz
  27    rpmbuild \
  28         -D "vswitch_version $VERSION" \
  29         -D "xen_version $XENKERNEL" \
  30         -bb openvswitch-$VERSION/xenserver/vswitch-xen.spec
  31
  32 where:
  33
  34     <openvswitch version> is the version number that appears in the
  35     name of the Open vSwitch tarball, e.g. 0.90.0.
  36
  37     <Xen kernel version> is the version number of the Xen kernel,
  38     e.g. 2.6.18-128.1.1.el5.xs5.5.0.487.1006xen.  This version number
  39     appears as the name of a directory in /lib/modules inside the VM.
  40     It always ends in "xen".
  41
  42 Two RPMs will be output into /usr/src/redhat/RPMS, whose names begin
  43 with "vswitch" and "vswitch-debuginfo".
  44
  45 Installing Open vSwitch for XenServer
  46 -------------------------------------
  47
  48 To install Open vSwitch on a XenServer host, or to upgrade to a newer
  49 version, copy the "vswitch" RPM to that host with "scp", then install
  50 it with "rpm -U", e.g.:
  51
  52      scp vswitch-$VERSION-1.i386.rpm root@<host>:
  53 (At this point you will have to enter <host>'s root password.)
  54      ssh root@<host>
  55 (At this point you will have to enter <host>'s root password again.)
  56      rpm -U vswitch-$VERSION-1.i386.rpm
  57
  58 To uninstall Open vSwitch from a XenServer host, remove the package:
  59
  60      ssh root@<host>
  61 (At this point you will have to enter <host>'s root password again.)
  62      rpm -e vswitch
  63
  64 After installing or uninstalling Open vSwitch, the XenServer should be
  65 rebooted as soon as possible.
  66
  67 Reporting Bugs
  68 --------------
  69
  70 Please report problems to bugs@openvswitch.org.