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, you must also install the following.  If
  31 you cannot build or install the kernel module, you may use the
  32 userspace-only implementation, at a cost in performance.  The
  33 userspace implementation may also lack some features.  Refer to
  34 INSTALL.userspace for more information.
  35
  36     - A supported Linux kernel version.  Please refer to README for a
  37       list of supported versions.
  38
  39       The Open vSwitch datapath requires bridging support
  40       (CONFIG_BRIDGE) to be built as a kernel module.  (This is common
  41       in kernels provided by Linux distributions.)  The bridge module
  42       must not be loaded or in use.  If the bridge module is running
  43       (check with "lsmod | grep bridge"), you must remove it ("rmmod
  44       bridge") before starting the datapath.
  45
  46       For optional support of ingress policing, you must enable kernel
  47       configuration options NET_CLS_ACT, NET_CLS_U32, NET_SCH_INGRESS,
  48       and NET_ACT_POLICE, either built-in or as modules.
  49       (NET_CLS_POLICE is obsolete and not needed.)
  50
  51       If GRE tunneling is being used it is recommended that the kernel
  52       be compiled with IPv6 support (CONFIG_IPV6).  This allows for
  53       special handling (such as path MTU discovery) of IPv6 packets.
  54
  55       To use Open vSwitch support for TAP devices, you must enable
  56       CONFIG_TUN.
  57
  58     - To build a kernel module, you need the same version of GCC that
  59       was used to build that kernel.
  60
  61     - A kernel build directory corresponding to the Linux kernel image
  62       the module is to run on.  Under Debian and Ubuntu, for example,
  63       each linux-image package containing a kernel binary has a
  64       corresponding linux-headers package with the required build
  65       infrastructure.
  66
  67 If you are working from a Git tree or snapshot (instead of from a
  68 distribution tarball), or if you modify the Open vSwitch build system,
  69 you will also need the following software:
  70
  71     - Autoconf version 2.64 or later.
  72
  73     - Automake version 1.10 or later.
  74
  75     - pkg-config.  We test with version 0.22.
  76
  77     - Python 2.x, for x >= 4.
  78
  79 If you modify the ovsdbmonitor tool, then you will also need the
  80 following:
  81
  82     - pyuic4 from PyQt4 (http://www.riverbankcomputing.co.uk).
  83
  84 Installation Requirements
  85 -------------------------
  86
  87 The machine on which Open vSwitch is to be installed must have the
  88 following software:
  89
  90     - libc compatible with the libc used for build.
  91
  92     - libssl compatible with the libssl used for build, if OpenSSL was
  93       used for the build.
  94
  95     - The Linux kernel version configured as part of the build.
  96
  97     - For optional support of ingress policing, the "tc" program from
  98       iproute2 (part of all major distributions and available at
  99       http://www.linux-foundation.org/en/Net:Iproute2).
 100
 101     - For debugging purposes, Open vSwitch expects that "tcpdump" is
 102       installed as /usr/sbin/tcpdump.  If tcpdump is not installed, or
 103       if it is installed in a different location, then some Open
 104       vSwitch log messages will not be as detailed.
 105
 106 You should ensure that /dev/urandom exists.  To support TAP devices,
 107 you must also ensure that /dev/net/tun exists.
 108
 109 To run the ovsdmonitor tool, the machine must also have the following
 110 software:
 111
 112     - Python 2.x, for x >= 4.
 113
 114     - Python Twisted Conch.
 115
 116     - Python JSON.
 117
 118     - PySide or PyQt4.
 119
 120     - Python Zope interface module.
 121
 122 (On Debian "lenny" the above can be installed with "apt-get install
 123 python-json python-qt4 python-zopeinterface python-twisted-conch".)
 124
 125 Building and Installing Open vSwitch for Linux
 126 ==============================================
 127
 128 Once you have installed all the prerequisites listed above in the Base
 129 Prerequisites section, follow the procedure below to build.
 130
 131 1. If you pulled the sources directly from an Open vSwitch Git tree,
 132    run boot.sh in the top source directory:
 133
 134       % ./boot.sh
 135
 136 2. In the top source directory, configure the package by running the
 137    configure script.  You can usually invoke configure without any
 138    arguments:
 139
 140       % ./configure
 141
 142    By default all files are installed under /usr/local.  If you want
 143    to install into, e.g., /usr and /var instead of /usr/local and
 144    /usr/local/var, add options as shown here:
 145
 146       % ./configure --prefix=/usr --localstatedir=/var
 147
 148    To use a specific C compiler for compiling Open vSwitch user
 149    programs, also specify it on the configure command line, like so:
 150
 151       % ./configure CC=gcc-4.2
 152
 153    To build the Linux kernel module, so that you can run the
 154    kernel-based switch, pass the location of the kernel build
 155    directory on --with-l26.  For example, to build for a running
 156    instance of Linux 2.6:
 157
 158       % ./configure --with-l26=/lib/modules/`uname -r`/build
 159
 160    If you wish to build the kernel module for an architecture other
 161    than the architecture of the machine used for the build, you may
 162    specify the kernel architecture string using the KARCH variable
 163    when invoking the configure script.  For example, to build for MIPS
 164    with Linux 2.6:
 165
 166       % ./configure --with-l26=/path/to/linux-2.6 KARCH=mips
 167
 168    The configure script accepts a number of other options and honors
 169    additional environment variables.  For a full list, invoke
 170    configure with the --help option.
 171
 172 3. Run make in the top source directory:
 173
 174       % make
 175
 176 4. Become root by running "su" or another program.
 177
 178 5. Run "make install" to install the executables and manpages into the
 179    running system, by default under /usr/local.
 180
 181 6. If you built kernel modules, you may load them with "insmod", e.g.:
 182
 183       % insmod datapath/linux-2.6/openvswitch_mod.ko
 184
 185    You may need to specify a full path to insmod, e.g. /sbin/insmod.
 186    To verify that the modules have been loaded, run "/sbin/lsmod" and
 187    check that openvswitch_mod is listed.
 188
 189 7. Initialize the configuration database using ovsdb-tool, e.g.:
 190
 191       % ovsdb-tool create /usr/local/etc/ovs-vswitchd.conf.db vswitchd/vswitch.ovsschema
 192
 193 Startup
 194 =======
 195
 196 Before starting ovs-vswitchd itself, you need to start its
 197 configuration database, ovsdb-server.  Configure it to use the
 198 database you created during step 7 of installation, above, and to
 199 listen on a Unix domain socket, e.g.:
 200
 201       % ovsdb-server /usr/local/etc/ovs-vswitchd.conf.db --remote=punix:/usr/local/var/run/openvswitch/db.sock
 202
 203 Then initialize the database with "ovs-vsctl init".  This is only
 204 necessary the first time after you create the database with
 205 ovsdb-tool (but running it at any time is harmless):
 206
 207       % ovs-vsctl init
 208
 209 Then start the main Open vSwitch daemon, telling it to connect to the
 210 same Unix domain socket:
 211
 212       % ovs-vswitchd unix:/usr/local/var/run/openvswitch/db.sock
 213
 214 Now you may use ovs-vsctl to set up bridges and other Open vSwitch
 215 features.  For example, to create a bridge named br0 and add ports
 216 eth0 and vif1.0 to it:
 217
 218       % ovs-vsctl add-br br0
 219       % ovs-vsctl add-port br0 eth0
 220       % ovs-vsctl add-port br0 vif1.0
 221
 222 Please refer to ovs-vsctl(8) for more details.
 223
 224 Bug Reporting
 225 -------------
 226
 227 Please report problems to bugs@openvswitch.org.