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