INSTALL.Linux

   1                  How to Install Open vSwitch on Linux
   2                  ====================================
   3
   4 This document describes how to build and install Open vSwitch on a
   5 generic Linux host.  If you want to install Open vSwitch on a Citrix
   6 XenServer version 5.5.0, see INSTALL.XenServer instead.
   7
   8 This version of Open vSwitch should be built manually with "configure"
   9 and "make".  Debian packaging for Open vSwitch is also included, but
  10 they have not been recently tested, and so Debian packages are not a
  11 recommended way to use this version of Open vSwitch.
  12
  13 Build Requirements
  14 ------------------
  15
  16 To compile the userspace programs in the Open vSwitch distribution,
  17 you will need the following software:
  18
  19     - A make program, e.g. GNU make.  BSD make should also work.
  20
  21     - The GNU C compiler.  We generally test with version 4.1, 4.2, or
  22       4.3.
  23
  24     - libssl, from OpenSSL, is optional but recommended if you plan to
  25       connect the Open vSwitch to an OpenFlow controller.  libssl is
  26       required to establish confidentiality and authenticity in the
  27       connections from an Open vSwitch to an OpenFlow controller.  To
  28       enable, configure with --enable-ssl=yes.
  29
  30     - libpcre, the Perl Compatible Regular Expression library, is
  31       optional but recommended.  Without it, OVSDB will not be able to
  32       validate regular-expression based contraints.
  33
  34 To compile the kernel module, you must also install the following.  If
  35 you cannot build or install the kernel module, you may use the
  36 userspace-only implementation, at a cost in performance.  The
  37 userspace implementation may also lack some features.  Refer to
  38 INSTALL.userspace for more information.
  39
  40     - A supported Linux kernel version.  Please refer to README for a
  41       list of supported versions.
  42
  43       The Open vSwitch datapath requires bridging support
  44       (CONFIG_BRIDGE) to be built as a kernel module.  (This is common
  45       in kernels provided by Linux distributions.)  The bridge module
  46       must not be loaded or in use.  If the bridge module is running
  47       (check with "lsmod | grep bridge"), you must remove it ("rmmod
  48       bridge") before starting the datapath.
  49
  50       For optional support of ingress policing, you must enable kernel
  51       configuration options NET_CLS_ACT, NET_CLS_U32, NET_SCH_INGRESS,
  52       and NET_ACT_POLICE, either built-in or as modules.
  53       (NET_CLS_POLICE is obsolete and not needed.)
  54
  55     - To build a kernel module, you need the same version of GCC that
  56       was used to build that kernel.
  57
  58     - A kernel build directory corresponding to the Linux kernel image
  59       the module is to run on.  Under Debian and Ubuntu, for example,
  60       each linux-image package containing a kernel binary has a
  61       corresponding linux-headers package with the required build
  62       infrastructure.
  63
  64 If you are working from a Git tree or snapshot (instead of from a
  65 distribution tarball), or if you modify the Open vSwitch build system,
  66 you will also need the following software:
  67
  68     - Autoconf version 2.63 or later.
  69
  70     - Automake version 1.10 or later.
  71
  72     - pkg-config.  We test with version 0.22.
  73
  74     - Python 2.x, for x >= 4.
  75
  76 Installation Requirements
  77 -------------------------
  78
  79 The machine on which Open vSwitch is to be installed must have the
  80 following software:
  81
  82     - libc compatible with the libc used for build.
  83
  84     - libssl compatible with the libssl used for build, if OpenSSL was
  85       used for the build.
  86
  87     - libpcre compatible with the libpcre used for build, if PCRE was
  88       used for the build.
  89
  90     - The Linux kernel version configured as part of the build.
  91
  92     - For optional support of ingress policing, the "tc" program from
  93       iproute2 (part of all major distributions and available at
  94       http://www.linux-foundation.org/en/Net:Iproute2).
  95
  96     - For debugging purposes, Open vSwitch expects that "tcpdump" is
  97       installed as /usr/sbin/tcpdump.  If tcpdump is not installed, or
  98       if it is installed in a different location, then some Open
  99       vSwitch log messages will not be as detailed.
 100
 101 Building and Installing Open vSwitch for Linux
 102 ==============================================
 103
 104 Once you have installed all the prerequisites listed above in the Base
 105 Prerequisites section, follow the procedure below to build.
 106
 107 1. If you pulled the sources directly from an Open vSwitch Git tree,
 108    run boot.sh in the top source directory:
 109
 110       % ./boot.sh
 111
 112 2. In the top source directory, configure the package by running the
 113    configure script.  You can usually invoke configure without any
 114    arguments:
 115
 116       % ./configure
 117
 118    By default all files are installed under /usr/local.  If you want
 119    to install into, e.g., /usr and /var instead of /usr/local and
 120    /usr/local/var, add options as shown here:
 121
 122       % ./configure --prefix=/usr --localstatedir=/var
 123
 124    To use a specific C compiler for compiling Open vSwitch user
 125    programs, also specify it on the configure command line, like so:
 126
 127       % ./configure CC=gcc-4.2
 128
 129    To build the Linux kernel module, so that you can run the
 130    kernel-based switch, pass the location of the kernel build
 131    directory on --with-l26.  For example, to build for a running
 132    instance of Linux 2.6:
 133
 134       % ./configure --with-l26=/lib/modules/`uname -r`/build
 135
 136    If you wish to build the kernel module for an architecture other
 137    than the architecture of the machine used for the build, you may
 138    specify the kernel architecture string using the KARCH variable
 139    when invoking the configure script.  For example, to build for MIPS
 140    with Linux 2.6:
 141
 142       % ./configure --with-l26=/path/to/linux-2.6 KARCH=mips
 143
 144    The configure script accepts a number of other options and honors
 145    additional environment variables.  For a full list, invoke
 146    configure with the --help option.
 147
 148 3. Run make in the top source directory:
 149
 150       % make
 151
 152 4. Become root by running "su" or another program.
 153
 154 5. Run "make install" to install the executables and manpages into the
 155    running system, by default under /usr/local.
 156
 157 6. If you built kernel modules, you may load them with "insmod", e.g.:
 158
 159       % insmod datapath/linux-2.6/openvswitch_mod.ko
 160
 161    You may need to specify a full path to insmod, e.g. /sbin/insmod.
 162    To verify that the modules have been loaded, run "/sbin/lsmod" and
 163    check that openvswitch_mod is listed.
 164
 165 Configuration
 166 =============
 167
 168 Open vSwitch is configured primarily through a configuration file,
 169 whose name is specified on the ovs-vswitchd command line.  Please
 170 refer to ovs-vswitchd(8) and ovs-vswitchd.conf(5) for information on
 171 how to start ovs-vswitchd and the syntax of its configuration file,
 172 respectively.
 173
 174 At runtime, you may make ovs-vswitchd reload its configuration file
 175 and update its configuration accordingly by sending it a SIGHUP
 176 signal.  The ovs-appctl utility can also be used to do this:
 177
 178     % ovs-appctl vswitchd/reload
 179
 180 In the latter case, ovs-appctl will wait for ovs-vswitchd to finish
 181 reloading before it exits.
 182
 183 Bug Reporting
 184 -------------
 185
 186 Please report problems to bugs@openvswitch.org.