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 To compile the kernel module (which is required for operation), you
  31 must also install the following:
  32
  33     - A supported Linux kernel version.  Please refer to README for a
  34       list of supported versions.
  35
  36       The Open vSwitch datapath requires bridging support
  37       (CONFIG_BRIDGE) to be built as a kernel module.  (This is common
  38       in kernels provided by Linux distributions.)  The bridge module
  39       must not be loaded or in use.  If the bridge module is running
  40       (check with "lsmod | grep bridge"), you must remove it ("rmmod
  41       bridge") before starting the datapath.
  42
  43       For optional support of ingress policing, you must enable kernel
  44       configuration options NET_CLS_ACT, NET_CLS_U32, NET_SCH_INGRESS,
  45       and NET_ACT_POLICE, either built-in or as modules.
  46       (NET_CLS_POLICE is obsolete and not needed.)
  47
  48     - To build a kernel module, you need the same version of GCC that
  49       was used to build that kernel.
  50
  51     - A kernel build directory corresponding to the Linux kernel image
  52       the module is to run on.  Under Debian and Ubuntu, for example,
  53       each linux-image package containing a kernel binary has a
  54       corresponding linux-headers package with the required build
  55       infrastructure.
  56
  57 If you are working from a Git tree or snapshot (instead of from a
  58 distribution tarball), or if you modify the Open vSwitch build system,
  59 you will also need the following software:
  60
  61     - Autoconf version 2.60 or later.
  62
  63     - Automake version 1.10 or later.
  64
  65     - pkg-config.  We test with version 0.22.
  66
  67 Installation Requirements
  68 -------------------------
  69
  70 The machine on which Open vSwitch is to be installed must have the
  71 following software:
  72
  73     - libc compatible with the libc used for build.
  74
  75     - libssl compatible with the libssl used for build, if OpenSSL was
  76       used for the build.
  77
  78     - The Linux kernel version configured as part of the build.
  79
  80     - For optional support of ingress policing, the "tc" program from
  81       iproute2 (part of all major distributions and available at
  82       http://www.linux-foundation.org/en/Net:Iproute2).
  83
  84     - For debugging purposes, Open vSwitch expects that "tcpdump" is
  85       installed as /usr/sbin/tcpdump.  If tcpdump is not installed, or
  86       if it is installed in a different location, then some Open
  87       vSwitch log messages will not be as detailed.
  88
  89 Building and Installing Open vSwitch for Linux
  90 ==============================================
  91
  92 Once you have installed all the prerequisites listed above in the Base
  93 Prerequisites section, follow the procedure below to build.
  94
  95 1. In the top source directory, configure the package by running the
  96    configure script.  You can usually invoke configure without any
  97    arguments:
  98
  99       % ./configure
 100
 101    By default all files are installed under /usr/local.  If you want
 102    to install into, e.g., /usr and /var instead of /usr/local and
 103    /usr/local/var, add options as shown here:
 104
 105       % ./configure --prefix=/usr --localstatedir=/var
 106
 107    To use a specific C compiler for compiling Open vSwitch user
 108    programs, also specify it on the configure command line, like so:
 109
 110       % ./configure CC=gcc-4.2
 111
 112    To build the Linux kernel module, so that you can run the
 113    kernel-based switch, pass the location of the kernel build
 114    directory on --with-l26.  For example, to build for a running
 115    instance of Linux 2.6:
 116
 117       % ./configure --with-l26=/lib/modules/`uname -r`/build
 118
 119    If you wish to build the kernel module for an architecture other
 120    than the architecture of the machine used for the build, you may
 121    specify the kernel architecture string using the KARCH variable
 122    when invoking the configure script.  For example, to build for MIPS
 123    with Linux 2.6:
 124
 125       % ./configure --with-l26=/path/to/linux-2.6 KARCH=mips
 126
 127    The configure script accepts a number of other options and honors
 128    additional environment variables.  For a full list, invoke
 129    configure with the --help option.
 130
 131 2. Run make in the top source directory:
 132
 133       % make
 134
 135 3. Become root by running "su" or another program.
 136
 137 4. Run "make install" to install the executables and manpages into the
 138    running system, by default under /usr/local.
 139
 140 5. If you built kernel modules, you may load them with "insmod", e.g.:
 141
 142       % insmod datapath/linux-2.6/openvswitch_mod.ko
 143
 144    You may need to specify a full path to insmod, e.g. /sbin/insmod.
 145    To verify that the modules have been loaded, run "/sbin/lsmod" and
 146    check that openvswitch_mod is listed.
 147
 148 Configuration
 149 =============
 150
 151 Open vSwitch is configured primarily through a configuration file,
 152 whose name is specified on the ovs-vswitchd command line.  Please
 153 refer to ovs-vswitchd(8) and ovs-vswitchd.conf(5) for information on
 154 how to start ovs-vswitchd and the syntax of its configuration file,
 155 respectively.
 156
 157 At runtime, you may make ovs-vswitchd reload its configuration file
 158 and update its configuration accordingly by sending it a SIGHUP
 159 signal.  The ovs-appctl utility can also be used to do this with a
 160 command such as:
 161
 162     % ovs-appctl -t <pid> -e vswitchd/reload
 163
 164 where <pid> is ovs-vswitchd's process ID.  In the latter case,
 165 ovs-appctl will not exit until the reload and reconfiguration is
 166 complete.
 167
 168 Bug Reporting
 169 -------------
 170
 171 Please report problems to bugs@openvswitch.org.