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    KERNEL_NAME=<Xen Kernel name>
  27    KERNEL_VERSION=<Xen Kernel version>
  28    KERNEL_FLAVOR=<Xen Kernel flavor(suffix) >
  29    cd /tmp
  30    tar xfz /usr/src/redhat/SOURCES/openvswitch-$VERSION.tar.gz
  31    rpmbuild \
  32         -D "openvswitch_version $VERSION" \
  33         -D "kernel_name $KERNEL_NAME" \
  34         -D "kernel_version $KERNEL_VERSION" \
  35         -D "kernel_flavor $KERNEL_FLAVOR" \
  36         -bb openvswitch-$VERSION/xenserver/openvswitch-xen.spec
  37
  38 where:
  39
  40     <openvswitch version> is the version number that appears in the
  41     name of the Open vSwitch tarball, e.g. 0.90.0.
  42
  43     <Xen Kernel name> is the name of the Xen Kernel,
  44     e.g. kernel-xen or kernel-NAME-xen. By convention, the name
  45     starts with "kernel-" and ends with "-xen".
  46     This can be obtained by executing
  47         'rpm -q --queryformat "%{Name}" kernel.*xen'
  48     with the "kernel-" stripped out using  sed 's/kernel-//'
  49     e.g. kernel-NAME-xen => NAME-xen
  50
  51     <Xen Kernel version> is the output of:
  52     rpm -q --queryformat "%{Version}-%{Release}" kernel.*xen-devel
  53     e.g. 2.6.32.12-0.7.1.xs5.6.100.323.170596
  54
  55     <Xen Kernel flavor (suffix) > is either "xen" or "kdump".
  56     The "xen" flavor is the main running kernel flavor and the "kdump" flavor is
  57     the crashdump kernel flavor. Commonly, one would specify "xen" here.
  58
  59 Three RPMs will be output into /usr/src/redhat/RPMS/i386, whose names begin
  60 with "openvswitch", "openvswitch-modules-xen" (if building for kernel_flavor=xen),
  61 and "openvswitch-debuginfo".
  62
  63 Installing Open vSwitch for XenServer
  64 -------------------------------------
  65
  66 To install Open vSwitch on a XenServer host, or to upgrade to a newer version,
  67 copy the "openvswitch" and "openvswitch-modules-xen" RPMs to that host with
  68 "scp", then install them with "rpm -U", e.g.:
  69
  70      scp openvswitch-$VERSION-1.i386.rpm \
  71          openvswitch-modules-xen-$XEN_KERNEL_VERSION-$VERSION-1.i386.rpm \
  72          root@<host>:
  73 (At this point you will have to enter <host>'s root password.)
  74      ssh root@<host>
  75 (At this point you will have to enter <host>'s root password again.)
  76      rpm -U openvswitch-$VERSION-1.i386.rpm \
  77          openvswitch-modules-xen-$XEN_KERNEL_VERSION-$VERSION-1.i386.rpm
  78
  79 To uninstall Open vSwitch from a XenServer host, remove the packages:
  80
  81      ssh root@<host>
  82 (At this point you will have to enter <host>'s root password again.)
  83      rpm -e openvswitch openvswitch-modules-xen-$XEN_KERNEL_VERSION
  84
  85 After installing or uninstalling Open vSwitch, the XenServer should be
  86 rebooted as soon as possible.
  87
  88 Reporting Bugs
  89 --------------
  90
  91 Please report problems to bugs@openvswitch.org.