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