ofp-print: Remove tcpdump from ofp_packet_to_string().
[openvswitch] / 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, see INSTALL.XenServer instead.
7
8 This version of Open vSwitch may be built manually with "configure"
9 and "make", as described below.  You may also build Debian packages by
10 running "dpkg-buildpackage".
11
12 Build Requirements
13 ------------------
14
15 To compile the userspace programs in the Open vSwitch distribution,
16 you will need the following software:
17
18     - A make program, e.g. GNU make.  BSD make should also work.
19
20     - The GNU C compiler.  We generally test with version 4.1, 4.2, or
21       4.3.
22
23     - pkg-config.  We test with version 0.22.
24
25     - libssl, from OpenSSL, is optional but recommended if you plan to
26       connect the Open vSwitch to an OpenFlow controller.  libssl is
27       required to establish confidentiality and authenticity in the
28       connections from an Open vSwitch to an OpenFlow controller.  If
29       libssl is installed, then Open vSwitch will automatically build
30       with support for it.
31
32 To compile the kernel module, you must also install the following.  If
33 you cannot build or install the kernel module, you may use the
34 userspace-only implementation, at a cost in performance.  The
35 userspace implementation may also lack some features.  Refer to
36 INSTALL.userspace for more information.
37
38     - A supported Linux kernel version.  Please refer to README for a
39       list of supported versions.
40
41       The Open vSwitch datapath requires bridging support
42       (CONFIG_BRIDGE) to be built as a kernel module.  (This is common
43       in kernels provided by Linux distributions.)  The bridge module
44       must not be loaded or in use.  If the bridge module is running
45       (check with "lsmod | grep bridge"), you must remove it ("rmmod
46       bridge") before starting the datapath.
47
48       For optional support of ingress policing, you must enable kernel
49       configuration options NET_CLS_BASIC, NET_SCH_INGRESS, and
50       NET_ACT_POLICE, either built-in or as modules.  (NET_CLS_POLICE is
51       obsolete and not needed.)
52
53       If GRE tunneling is being used it is recommended that the kernel
54       be compiled with IPv6 support (CONFIG_IPV6).  This allows for
55       special handling (such as path MTU discovery) of IPv6 packets.
56
57       To configure HTB or HFSC quality of service with Open vSwitch,
58       you must enable the respective configuration options.
59
60       To use Open vSwitch support for TAP devices, you must enable
61       CONFIG_TUN.
62
63     - To build a kernel module, you need the same version of GCC that
64       was used to build that kernel.
65
66     - A kernel build directory corresponding to the Linux kernel image
67       the module is to run on.  Under Debian and Ubuntu, for example,
68       each linux-image package containing a kernel binary has a
69       corresponding linux-headers package with the required build
70       infrastructure.
71
72 If you are working from a Git tree or snapshot (instead of from a
73 distribution tarball), or if you modify the Open vSwitch build system
74 or the database schema, you will also need the following software:
75
76     - Autoconf version 2.64 or later.
77
78     - Automake version 1.10 or later.
79
80     - Python 2.x, for x >= 4.
81
82 If you modify the ovsdbmonitor tool, then you will also need the
83 following:
84
85     - pyuic4 from PyQt4 (http://www.riverbankcomputing.co.uk).
86
87 To run the unit tests, you also need:
88
89     - Perl.  Version 5.10.1 is known to work.  Earlier versions should
90       also work.
91
92 If you modify the vswitchd database schema, then the E-R diagram in
93 the ovs-vswitchd.conf.db(5) manpage will be updated properly only if
94 you have the following:
95
96     - "dot" from graphviz (http://www.graphviz.org/).
97
98     - Perl.  Version 5.10.1 is known to work.  Earlier versions should
99       also work.
100
101     - Python 2.x, for x >= 4.
102
103 Installation Requirements
104 -------------------------
105
106 The machine on which Open vSwitch is to be installed must have the
107 following software:
108
109     - libc compatible with the libc used for build.
110
111     - libssl compatible with the libssl used for build, if OpenSSL was
112       used for the build.
113
114     - The Linux kernel version configured as part of the build.
115
116     - For optional support of ingress policing, the "tc" program from
117       iproute2 (part of all major distributions and available at
118       http://www.linux-foundation.org/en/Net:Iproute2).
119
120 You should ensure that /dev/urandom exists.  To support TAP devices,
121 you must also ensure that /dev/net/tun exists.
122
123 To run the ovsdmonitor tool, the machine must also have the following
124 software:
125
126     - Python 2.x, for x >= 4.
127
128     - Python Twisted Conch.
129
130     - Python JSON.
131
132     - PySide or PyQt4.
133
134     - Python Zope interface module.
135
136 (On Debian "lenny" the above can be installed with "apt-get install
137 python-json python-qt4 python-zopeinterface python-twisted-conch".)
138
139 Building and Installing Open vSwitch for Linux
140 ==============================================
141
142 Once you have installed all the prerequisites listed above in the Base
143 Prerequisites section, follow the procedure below to build.
144
145 1. If you pulled the sources directly from an Open vSwitch Git tree, 
146    run boot.sh in the top source directory:
147
148       % ./boot.sh
149
150 2. In the top source directory, configure the package by running the
151    configure script.  You can usually invoke configure without any
152    arguments:
153
154       % ./configure
155
156    By default all files are installed under /usr/local.  If you want
157    to install into, e.g., /usr and /var instead of /usr/local and
158    /usr/local/var, add options as shown here:
159
160       % ./configure --prefix=/usr --localstatedir=/var
161
162    To use a specific C compiler for compiling Open vSwitch user
163    programs, also specify it on the configure command line, like so:
164
165       % ./configure CC=gcc-4.2
166
167    To build the Linux kernel module, so that you can run the
168    kernel-based switch, pass the location of the kernel build
169    directory on --with-linux.  For example, to build for a running
170    instance of Linux:
171
172       % ./configure --with-linux=/lib/modules/`uname -r`/build
173
174    If you wish to build the kernel module for an architecture other
175    than the architecture of the machine used for the build, you may
176    specify the kernel architecture string using the KARCH variable
177    when invoking the configure script.  For example, to build for MIPS
178    with Linux:
179
180       % ./configure --with-linux=/path/to/linux KARCH=mips
181
182    The configure script accepts a number of other options and honors
183    additional environment variables.  For a full list, invoke
184    configure with the --help option.
185
186 3. Run make in the top source directory: 
187
188       % make
189
190 4. Become root by running "su" or another program.
191
192 5. Run "make install" to install the executables and manpages into the
193    running system, by default under /usr/local.
194
195 6. If you built kernel modules, you may load them with "insmod", e.g.:
196
197       % insmod datapath/linux/openvswitch_mod.ko
198
199    You may need to specify a full path to insmod, e.g. /sbin/insmod.
200    To verify that the modules have been loaded, run "/sbin/lsmod" and
201    check that openvswitch_mod is listed.
202
203    If the "insmod" operation fails, look at the last few kernel log
204    messages (e.g. with "dmesg | tail"):
205
206       - The message "openvswitch_mod: exports duplicate symbol
207         br_should_route_hook (owned by bridge)" means that the bridge
208         module is loaded.  Run "/sbin/rmmod bridge" to remove it.
209
210         If "/sbin/rmmod bridge" fails with "ERROR: Module bridge does
211         not exist in /proc/modules", then the bridge is compiled into
212         the kernel, rather than as a module.  Open vSwitch does not
213         support this configuration (see "Build Requirements", above).
214
215       - The message "openvswitch_mod: exports duplicate symbol
216         dp_ioctl_hook (owned by ofdatapath)" means that the ofdatapath
217         module from the OpenFlow reference implementation is loaded.
218         Run "/sbin/rmmod ofdatapath" to remove it.  (You might have to
219         delete any existing datapaths beforehand, using the "dpctl"
220         program included with the OpenFlow reference implementation.
221         "ovs-dpctl" will not work.)
222
223       - Otherwise, the most likely problem is that Open vSwitch was
224         built for a kernel different from the one into which you are
225         trying to load it.  Run "modinfo" on openvswitch_mod.ko and on
226         a module built for the running kernel, e.g.:
227
228            % /sbin/modinfo openvswitch_mod.ko
229            % /sbin/modinfo /lib/modules/`uname -r`/kernel/net/bridge/bridge.ko
230
231         Compare the "vermagic" lines output by the two commands.  If
232         they differ, then Open vSwitch was built for the wrong kernel.
233
234       - If you decide to report a bug or ask a question related to
235         module loading, please include the output from the "dmesg" and
236         "modinfo" commands mentioned above.
237
238    There is an optional module parameter to openvswitch_mod.ko called
239    vlan_tso that enables TCP segmentation offload over VLANs on NICs
240    that support it. Many drivers do not expose support for TSO on VLANs
241    in a way that Open vSwitch can use but there is no way to detect
242    whether this is the case. If you know that your particular driver can
243    handle it (for example by testing sending large TCP packets over VLANs)
244    then passing in a value of 1 may improve performance. Modules built for
245    Linux kernels 2.6.37 and later, as well as specially patched versions
246    of earlier kernels, do not need this and do not have this parameter. If
247    you do not understand what this means or do not know if your driver
248    will work, do not set this.
249
250 7. Initialize the configuration database using ovsdb-tool, e.g.:
251
252       % mkdir -p /usr/local/etc/openvswitch
253       % ovsdb-tool create /usr/local/etc/openvswitch/conf.db vswitchd/vswitch.ovsschema
254
255 Startup
256 =======
257
258 Before starting ovs-vswitchd itself, you need to start its
259 configuration database, ovsdb-server.  Each machine on which Open
260 vSwitch is installed should run its own copy of ovsdb-server.
261 Configure it to use the database you created during step 7 of
262 installation, above, to listen on a Unix domain socket, to connect to
263 any managers specified in the database itself, and to use the SSL
264 configuration in the database:
265
266       % ovsdb-server --remote=punix:/usr/local/var/run/openvswitch/db.sock \
267                      --remote=db:Open_vSwitch,manager_options \
268                      --private-key=db:SSL,private_key \
269                      --certificate=db:SSL,certificate \
270                      --bootstrap-ca-cert=db:SSL,ca_cert \
271                      --pidfile --detach
272
273 (If you built Open vSwitch without SSL support, then omit
274 --private-key, --certificate, and --bootstrap-ca-cert.)
275
276 Then initialize the database using ovs-vsctl.  This is only
277 necessary the first time after you create the database with
278 ovsdb-tool (but running it at any time is harmless):
279
280       % ovs-vsctl --no-wait init
281
282 Then start the main Open vSwitch daemon, telling it to connect to the
283 same Unix domain socket:
284
285       % ovs-vswitchd --pidfile --detach
286
287 Now you may use ovs-vsctl to set up bridges and other Open vSwitch
288 features.  For example, to create a bridge named br0 and add ports
289 eth0 and vif1.0 to it:
290
291       % ovs-vsctl add-br br0
292       % ovs-vsctl add-port br0 eth0
293       % ovs-vsctl add-port br0 vif1.0
294
295 Please refer to ovs-vsctl(8) for more details.
296
297 Upgrading
298 =========
299
300 When you upgrade Open vSwitch from one version to another, you should
301 also upgrade the database schema:
302
303 1. Stop the Open vSwitch daemons, e.g.:
304
305       % kill `cd /usr/local/var/run && cat ovsdb-server.pid ovs-vswitchd.pid`
306
307 2. Install the new Open vSwitch release.
308
309 3. Upgrade the database, in one of the following two ways:
310
311       - If there is no important data in your database, then you may
312         delete the database file and recreate it with ovsdb-tool,
313         following the instructions under "Building and Installing Open
314         vSwitch for Linux".
315
316       - If you want to preserve the contents of your database, back it
317         up first, then use "ovsdb-tool convert" to upgrade it, e.g.:
318
319         % ovsdb-tool convert /usr/local/etc/openvswitch/conf.db vswitchd/vswitch.ovsschema
320
321 4. Start the Open vSwitch daemons as described under "Building and
322    Installing Open vSwitch for Linux" above.
323
324 Bug Reporting
325 -------------
326
327 Please report problems to bugs@openvswitch.org.