datapath: <linux/if_vlan.h> needs <linux/skbuff.h> on some kernels.
[sliver-openvswitch.git] / 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 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.64 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 If you modify the ovsdbmonitor tool, then you will also need the
77 following:
78
79     - pyuic4 from PyQt4 (http://www.riverbankcomputing.co.uk).
80
81 Installation Requirements
82 -------------------------
83
84 The machine on which Open vSwitch is to be installed must have the
85 following software:
86
87     - libc compatible with the libc used for build.
88
89     - libssl compatible with the libssl used for build, if OpenSSL was
90       used for the build.
91
92     - The Linux kernel version configured as part of the build.
93
94     - For optional support of ingress policing, the "tc" program from
95       iproute2 (part of all major distributions and available at
96       http://www.linux-foundation.org/en/Net:Iproute2).
97
98     - For debugging purposes, Open vSwitch expects that "tcpdump" is
99       installed as /usr/sbin/tcpdump.  If tcpdump is not installed, or
100       if it is installed in a different location, then some Open
101       vSwitch log messages will not be as detailed.
102
103 To run the ovsdmonitor tool, the machine must also have the following
104 software:
105
106     - Python 2.x, for x >= 4.
107
108     - Python Twisted Conch.
109
110     - Python JSON.
111
112     - PySide or PyQt4.
113
114     - Python Zope interface module.
115
116 (On Debian "lenny" the above can be installed with "apt-get install
117 python-json python-qt4 python-zopeinterface python-twisted-conch".)
118
119 Building and Installing Open vSwitch for Linux
120 ==============================================
121
122 Once you have installed all the prerequisites listed above in the Base
123 Prerequisites section, follow the procedure below to build.
124
125 1. If you pulled the sources directly from an Open vSwitch Git tree, 
126    run boot.sh in the top source directory:
127
128       % ./boot.sh
129
130 2. In the top source directory, configure the package by running the
131    configure script.  You can usually invoke configure without any
132    arguments:
133
134       % ./configure
135
136    By default all files are installed under /usr/local.  If you want
137    to install into, e.g., /usr and /var instead of /usr/local and
138    /usr/local/var, add options as shown here:
139
140       % ./configure --prefix=/usr --localstatedir=/var
141
142    To use a specific C compiler for compiling Open vSwitch user
143    programs, also specify it on the configure command line, like so:
144
145       % ./configure CC=gcc-4.2
146
147    To build the Linux kernel module, so that you can run the
148    kernel-based switch, pass the location of the kernel build
149    directory on --with-l26.  For example, to build for a running
150    instance of Linux 2.6:
151
152       % ./configure --with-l26=/lib/modules/`uname -r`/build
153
154    If you wish to build the kernel module for an architecture other
155    than the architecture of the machine used for the build, you may
156    specify the kernel architecture string using the KARCH variable
157    when invoking the configure script.  For example, to build for MIPS
158    with Linux 2.6:
159
160       % ./configure --with-l26=/path/to/linux-2.6 KARCH=mips
161
162    The configure script accepts a number of other options and honors
163    additional environment variables.  For a full list, invoke
164    configure with the --help option.
165
166 3. Run make in the top source directory: 
167
168       % make
169
170 4. Become root by running "su" or another program.
171
172 5. Run "make install" to install the executables and manpages into the
173    running system, by default under /usr/local.
174
175 6. If you built kernel modules, you may load them with "insmod", e.g.:
176
177       % insmod datapath/linux-2.6/openvswitch_mod.ko
178
179    You may need to specify a full path to insmod, e.g. /sbin/insmod.
180    To verify that the modules have been loaded, run "/sbin/lsmod" and
181    check that openvswitch_mod is listed.
182
183 7. Initialize the configuration database using ovsdb-tool, e.g.:
184
185       % ovsdb-tool create /usr/local/etc/ovs-vswitchd.conf.db vswitchd/vswitch.ovsschema
186
187 Startup
188 =======
189
190 Before starting ovs-vswitchd itself, you need to start its
191 configuration database, ovsdb-server.  Configure it to use the
192 database you created during step 7 of installation, above, and to
193 listen on a Unix domain socket, e.g.:
194
195       % ovsdb-server /usr/local/etc/ovs-vswitchd.conf.db --remote=punix:/usr/local/var/run/openvswitch/db.sock
196
197 Then initialize the database with "ovs-vsctl init".  This is only
198 necessary the first time after you create the database with
199 ovsdb-tool (but running it at any time is harmless):
200
201       % ovs-vsctl init
202
203 Then start the main Open vSwitch daemon, telling it to connect to the
204 same Unix domain socket:
205
206       % ovs-vswitchd unix:/usr/local/var/run/openvswitch/db.sock
207
208 Now you may use ovs-vsctl to set up bridges and other Open vSwitch
209 features.  For example, to create a bridge named br0 and add ports
210 eth0 and vif1.0 to it:
211
212       % ovs-vsctl add-br br0
213       % ovs-vsctl add-port br0 eth0
214       % ovs-vsctl add-port br0 vif1.0
215
216 Please refer to ovs-vsctl(8) for more details.
217
218 Bug Reporting
219 -------------
220
221 Please report problems to bugs@openvswitch.org.