]>
Commit | Line | Data |
---|---|---|
76d5beb9 YT |
1 | How to Install Open vSwitch on Linux, FreeBSD and NetBSD |
2 | ======================================================== | |
4b11d5e8 BP |
3 | |
4 | This document describes how to build and install Open vSwitch on a | |
76d5beb9 YT |
5 | generic Linux, FreeBSD, or NetBSD host. For specifics around installation |
6 | on a specific platform, please see one of these files: | |
4b11d5e8 | 7 | |
6494ea4c BP |
8 | - INSTALL.Debian |
9 | - INSTALL.Fedora | |
10 | - INSTALL.RHEL | |
11 | - INSTALL.XenServer | |
4b11d5e8 BP |
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 | ||
380b39f7 | 19 | - GNU make. |
4b11d5e8 | 20 | |
8a6de510 BP |
21 | - A C compiler, such as: |
22 | ||
23 | * GCC 4.x. | |
24 | ||
25 | * Clang. Clang 3.4 and later provide useful static semantic | |
26 | analysis and thread-safety checks. For Ubuntu, there are | |
27 | nightly built packages available on clang's website. | |
4b11d5e8 BP |
28 | |
29 | - libssl, from OpenSSL, is optional but recommended if you plan to | |
30 | connect the Open vSwitch to an OpenFlow controller. libssl is | |
31 | required to establish confidentiality and authenticity in the | |
f272ec73 BP |
32 | connections from an Open vSwitch to an OpenFlow controller. If |
33 | libssl is installed, then Open vSwitch will automatically build | |
34 | with support for it. | |
4b11d5e8 | 35 | |
f6eb6b20 GL |
36 | To compile the kernel module on Linux, you must also install the |
37 | following. If you cannot build or install the kernel module, you may | |
38 | use the userspace-only implementation, at a cost in performance. The | |
d377243b BP |
39 | userspace implementation may also lack some features. Refer to |
40 | INSTALL.userspace for more information. | |
4b11d5e8 BP |
41 | |
42 | - A supported Linux kernel version. Please refer to README for a | |
43 | list of supported versions. | |
44 | ||
45 | The Open vSwitch datapath requires bridging support | |
46 | (CONFIG_BRIDGE) to be built as a kernel module. (This is common | |
47 | in kernels provided by Linux distributions.) The bridge module | |
48 | must not be loaded or in use. If the bridge module is running | |
49 | (check with "lsmod | grep bridge"), you must remove it ("rmmod | |
50 | bridge") before starting the datapath. | |
51 | ||
52 | For optional support of ingress policing, you must enable kernel | |
f8500004 JP |
53 | configuration options NET_CLS_BASIC, NET_SCH_INGRESS, and |
54 | NET_ACT_POLICE, either built-in or as modules. (NET_CLS_POLICE is | |
55 | obsolete and not needed.) | |
4b11d5e8 | 56 | |
2be0b371 JG |
57 | To use GRE tunneling on Linux 2.6.37 or newer, kernel support |
58 | for GRE must be compiled in or available as a module | |
59 | (CONFIG_NET_IPGRE_DEMUX). | |
6f470982 | 60 | |
c9d3af4e BP |
61 | To configure HTB or HFSC quality of service with Open vSwitch, |
62 | you must enable the respective configuration options. | |
63 | ||
26bb189d BP |
64 | To use Open vSwitch support for TAP devices, you must enable |
65 | CONFIG_TUN. | |
66 | ||
4b11d5e8 BP |
67 | - To build a kernel module, you need the same version of GCC that |
68 | was used to build that kernel. | |
69 | ||
70 | - A kernel build directory corresponding to the Linux kernel image | |
71 | the module is to run on. Under Debian and Ubuntu, for example, | |
72 | each linux-image package containing a kernel binary has a | |
73 | corresponding linux-headers package with the required build | |
74 | infrastructure. | |
75 | ||
76 | If you are working from a Git tree or snapshot (instead of from a | |
c9d3af4e BP |
77 | distribution tarball), or if you modify the Open vSwitch build system |
78 | or the database schema, you will also need the following software: | |
4b11d5e8 | 79 | |
55aa00e0 | 80 | - Autoconf version 2.64 or later. |
4b11d5e8 BP |
81 | |
82 | - Automake version 1.10 or later. | |
83 | ||
195b5c35 BP |
84 | - Python 2.x, for x >= 4. |
85 | ||
436f27dd AS |
86 | If you modify the ovsdbmonitor tool, then you will also need the |
87 | following: | |
88 | ||
89 | - pyuic4 from PyQt4 (http://www.riverbankcomputing.co.uk). | |
90 | ||
c9d3af4e BP |
91 | To run the unit tests, you also need: |
92 | ||
93 | - Perl. Version 5.10.1 is known to work. Earlier versions should | |
94 | also work. | |
95 | ||
a5ae88ff AA |
96 | The ovs-vswitchd.conf.db(5) manpage will include an E-R diagram, in |
97 | formats other than plain text, only if you have the following: | |
f8d739a9 BP |
98 | |
99 | - "dot" from graphviz (http://www.graphviz.org/). | |
100 | ||
c9d3af4e BP |
101 | - Perl. Version 5.10.1 is known to work. Earlier versions should |
102 | also work. | |
103 | ||
104 | - Python 2.x, for x >= 4. | |
105 | ||
f8f26e98 BP |
106 | If you are going to extensively modify Open vSwitch, please consider |
107 | installing the following to obtain better warnings: | |
108 | ||
109 | - "sparse" version 0.4.4 or later | |
110 | (http://www.kernel.org/pub/software/devel/sparse/dist/). | |
111 | ||
112 | - GNU make. | |
113 | ||
97be1538 EJ |
114 | - clang, version 3.4 or later |
115 | ||
fef5244f EJ |
116 | Also, you may find the ovs-dev script found in utilities/ovs-dev.py useful. |
117 | ||
4b11d5e8 BP |
118 | Installation Requirements |
119 | ------------------------- | |
120 | ||
121 | The machine on which Open vSwitch is to be installed must have the | |
122 | following software: | |
123 | ||
124 | - libc compatible with the libc used for build. | |
125 | ||
126 | - libssl compatible with the libssl used for build, if OpenSSL was | |
127 | used for the build. | |
128 | ||
f6eb6b20 | 129 | - On Linux, the same kernel version configured as part of the build. |
4b11d5e8 | 130 | |
f6eb6b20 GL |
131 | - For optional support of ingress policing on Linux, the "tc" program |
132 | from iproute2 (part of all major distributions and available at | |
4b11d5e8 BP |
133 | http://www.linux-foundation.org/en/Net:Iproute2). |
134 | ||
f6eb6b20 GL |
135 | On Linux you should ensure that /dev/urandom exists. To support TAP |
136 | devices, you must also ensure that /dev/net/tun exists. | |
6e8e271c | 137 | |
2ac7bbf5 | 138 | To run the ovsdbmonitor tool, the machine must also have the following |
436f27dd AS |
139 | software: |
140 | ||
141 | - Python 2.x, for x >= 4. | |
142 | ||
143 | - Python Twisted Conch. | |
144 | ||
145 | - Python JSON. | |
146 | ||
147 | - PySide or PyQt4. | |
148 | ||
149 | - Python Zope interface module. | |
150 | ||
151 | (On Debian "lenny" the above can be installed with "apt-get install | |
152 | python-json python-qt4 python-zopeinterface python-twisted-conch".) | |
153 | ||
76d5beb9 YT |
154 | Building and Installing Open vSwitch for Linux, FreeBSD or NetBSD |
155 | ================================================================= | |
4b11d5e8 BP |
156 | |
157 | Once you have installed all the prerequisites listed above in the Base | |
158 | Prerequisites section, follow the procedure below to build. | |
159 | ||
f6eb6b20 | 160 | 1. If you pulled the sources directly from an Open vSwitch Git tree, |
30746a1b JP |
161 | run boot.sh in the top source directory: |
162 | ||
163 | % ./boot.sh | |
164 | ||
165 | 2. In the top source directory, configure the package by running the | |
4b11d5e8 BP |
166 | configure script. You can usually invoke configure without any |
167 | arguments: | |
168 | ||
169 | % ./configure | |
170 | ||
171 | By default all files are installed under /usr/local. If you want | |
172 | to install into, e.g., /usr and /var instead of /usr/local and | |
173 | /usr/local/var, add options as shown here: | |
174 | ||
175 | % ./configure --prefix=/usr --localstatedir=/var | |
176 | ||
177 | To use a specific C compiler for compiling Open vSwitch user | |
178 | programs, also specify it on the configure command line, like so: | |
179 | ||
180 | % ./configure CC=gcc-4.2 | |
181 | ||
97be1538 EJ |
182 | To use 'clang' compiler: |
183 | ||
184 | % ./configure CC=clang | |
185 | ||
4b11d5e8 BP |
186 | To build the Linux kernel module, so that you can run the |
187 | kernel-based switch, pass the location of the kernel build | |
338fb44a | 188 | directory on --with-linux. For example, to build for a running |
8a2d6596 | 189 | instance of Linux: |
4b11d5e8 | 190 | |
8a2d6596 | 191 | % ./configure --with-linux=/lib/modules/`uname -r`/build |
4b11d5e8 BP |
192 | |
193 | If you wish to build the kernel module for an architecture other | |
194 | than the architecture of the machine used for the build, you may | |
195 | specify the kernel architecture string using the KARCH variable | |
196 | when invoking the configure script. For example, to build for MIPS | |
8a2d6596 | 197 | with Linux: |
4b11d5e8 | 198 | |
22bcc0e7 | 199 | % ./configure --with-linux=/path/to/linux KARCH=mips |
4b11d5e8 BP |
200 | |
201 | The configure script accepts a number of other options and honors | |
202 | additional environment variables. For a full list, invoke | |
203 | configure with the --help option. | |
204 | ||
380b39f7 | 205 | 3. Run GNU make in the top source directory, e.g.: |
4b11d5e8 BP |
206 | |
207 | % make | |
208 | ||
380b39f7 BP |
209 | or if GNU make is installed as "gmake": |
210 | ||
211 | % gmake | |
f6eb6b20 | 212 | |
f8f26e98 | 213 | For improved warnings if you installed "sparse" (see |
380b39f7 | 214 | "Prerequisites"), add C=1 to the command line. |
f8f26e98 | 215 | |
875ef81b KM |
216 | 4. Consider running the testsuite. Refer to "Running the Testsuite" |
217 | below, for instructions. | |
4b11d5e8 | 218 | |
875ef81b KM |
219 | 5. Become root by running "su" or another program. |
220 | ||
221 | 6. Run "make install" to install the executables and manpages into the | |
4b11d5e8 BP |
222 | running system, by default under /usr/local. |
223 | ||
ffd6065a | 224 | 7. If you built kernel modules, you may install and load them, e.g.: |
4b11d5e8 | 225 | |
ffd6065a JG |
226 | % make modules_install |
227 | % /sbin/modprobe openvswitch | |
4b11d5e8 | 228 | |
4b11d5e8 | 229 | To verify that the modules have been loaded, run "/sbin/lsmod" and |
9b80f761 | 230 | check that openvswitch is listed. |
4b11d5e8 | 231 | |
ffd6065a | 232 | If the "modprobe" operation fails, look at the last few kernel log |
dd2d79ce BP |
233 | messages (e.g. with "dmesg | tail"): |
234 | ||
9b80f761 | 235 | - The message "openvswitch: exports duplicate symbol |
dd2d79ce BP |
236 | br_should_route_hook (owned by bridge)" means that the bridge |
237 | module is loaded. Run "/sbin/rmmod bridge" to remove it. | |
238 | ||
239 | If "/sbin/rmmod bridge" fails with "ERROR: Module bridge does | |
240 | not exist in /proc/modules", then the bridge is compiled into | |
241 | the kernel, rather than as a module. Open vSwitch does not | |
242 | support this configuration (see "Build Requirements", above). | |
243 | ||
9b80f761 | 244 | - The message "openvswitch: exports duplicate symbol |
dd2d79ce BP |
245 | dp_ioctl_hook (owned by ofdatapath)" means that the ofdatapath |
246 | module from the OpenFlow reference implementation is loaded. | |
247 | Run "/sbin/rmmod ofdatapath" to remove it. (You might have to | |
248 | delete any existing datapaths beforehand, using the "dpctl" | |
249 | program included with the OpenFlow reference implementation. | |
250 | "ovs-dpctl" will not work.) | |
251 | ||
252 | - Otherwise, the most likely problem is that Open vSwitch was | |
253 | built for a kernel different from the one into which you are | |
9b80f761 | 254 | trying to load it. Run "modinfo" on openvswitch.ko and on |
dd2d79ce BP |
255 | a module built for the running kernel, e.g.: |
256 | ||
9b80f761 | 257 | % /sbin/modinfo openvswitch.ko |
dd2d79ce BP |
258 | % /sbin/modinfo /lib/modules/`uname -r`/kernel/net/bridge/bridge.ko |
259 | ||
260 | Compare the "vermagic" lines output by the two commands. If | |
261 | they differ, then Open vSwitch was built for the wrong kernel. | |
262 | ||
263 | - If you decide to report a bug or ask a question related to | |
264 | module loading, please include the output from the "dmesg" and | |
265 | "modinfo" commands mentioned above. | |
266 | ||
9b80f761 | 267 | There is an optional module parameter to openvswitch.ko called |
3f6256af JG |
268 | vlan_tso that enables TCP segmentation offload over VLANs on NICs |
269 | that support it. Many drivers do not expose support for TSO on VLANs | |
270 | in a way that Open vSwitch can use but there is no way to detect | |
271 | whether this is the case. If you know that your particular driver can | |
272 | handle it (for example by testing sending large TCP packets over VLANs) | |
273 | then passing in a value of 1 may improve performance. Modules built for | |
431488e6 BP |
274 | Linux kernels 2.6.37 and later, as well as specially patched versions |
275 | of earlier kernels, do not need this and do not have this parameter. If | |
276 | you do not understand what this means or do not know if your driver | |
277 | will work, do not set this. | |
3f6256af | 278 | |
875ef81b | 279 | 8. Initialize the configuration database using ovsdb-tool, e.g.: |
4b11d5e8 | 280 | |
028415b6 BP |
281 | % mkdir -p /usr/local/etc/openvswitch |
282 | % ovsdb-tool create /usr/local/etc/openvswitch/conf.db vswitchd/vswitch.ovsschema | |
4b11d5e8 | 283 | |
3b12adda BP |
284 | Startup |
285 | ======= | |
4b11d5e8 | 286 | |
3b12adda | 287 | Before starting ovs-vswitchd itself, you need to start its |
cb8141b2 BP |
288 | configuration database, ovsdb-server. Each machine on which Open |
289 | vSwitch is installed should run its own copy of ovsdb-server. | |
290 | Configure it to use the database you created during step 7 of | |
8084a280 BP |
291 | installation, above, to listen on a Unix domain socket, to connect to |
292 | any managers specified in the database itself, and to use the SSL | |
293 | configuration in the database: | |
294 | ||
29701194 | 295 | % ovsdb-server --remote=punix:/usr/local/var/run/openvswitch/db.sock \ |
6faab099 JP |
296 | --remote=db:Open_vSwitch,Open_vSwitch,manager_options \ |
297 | --private-key=db:Open_vSwitch,SSL,private_key \ | |
298 | --certificate=db:Open_vSwitch,SSL,certificate \ | |
299 | --bootstrap-ca-cert=db:Open_vSwitch,SSL,ca_cert \ | |
29701194 | 300 | --pidfile --detach |
3b12adda | 301 | |
d3e3fb58 BP |
302 | (If you built Open vSwitch without SSL support, then omit |
303 | --private-key, --certificate, and --bootstrap-ca-cert.) | |
304 | ||
de4f3c10 | 305 | Then initialize the database using ovs-vsctl. This is only |
332b4e09 BP |
306 | necessary the first time after you create the database with |
307 | ovsdb-tool (but running it at any time is harmless): | |
308 | ||
de4f3c10 | 309 | % ovs-vsctl --no-wait init |
332b4e09 | 310 | |
3b12adda BP |
311 | Then start the main Open vSwitch daemon, telling it to connect to the |
312 | same Unix domain socket: | |
313 | ||
80df177a | 314 | % ovs-vswitchd --pidfile --detach |
3b12adda BP |
315 | |
316 | Now you may use ovs-vsctl to set up bridges and other Open vSwitch | |
317 | features. For example, to create a bridge named br0 and add ports | |
318 | eth0 and vif1.0 to it: | |
319 | ||
320 | % ovs-vsctl add-br br0 | |
321 | % ovs-vsctl add-port br0 eth0 | |
322 | % ovs-vsctl add-port br0 vif1.0 | |
323 | ||
324 | Please refer to ovs-vsctl(8) for more details. | |
4b11d5e8 | 325 | |
8b055d92 BP |
326 | Upgrading |
327 | ========= | |
328 | ||
329 | When you upgrade Open vSwitch from one version to another, you should | |
330 | also upgrade the database schema: | |
331 | ||
332 | 1. Stop the Open vSwitch daemons, e.g.: | |
333 | ||
012f5c4b | 334 | % kill `cd /usr/local/var/run/openvswitch && cat ovsdb-server.pid ovs-vswitchd.pid` |
8b055d92 BP |
335 | |
336 | 2. Install the new Open vSwitch release. | |
337 | ||
338 | 3. Upgrade the database, in one of the following two ways: | |
339 | ||
340 | - If there is no important data in your database, then you may | |
341 | delete the database file and recreate it with ovsdb-tool, | |
342 | following the instructions under "Building and Installing Open | |
76d5beb9 | 343 | vSwitch for Linux, FreeBSD or NetBSD". |
8b055d92 BP |
344 | |
345 | - If you want to preserve the contents of your database, back it | |
346 | up first, then use "ovsdb-tool convert" to upgrade it, e.g.: | |
347 | ||
028415b6 | 348 | % ovsdb-tool convert /usr/local/etc/openvswitch/conf.db vswitchd/vswitch.ovsschema |
8b055d92 BP |
349 | |
350 | 4. Start the Open vSwitch daemons as described under "Building and | |
76d5beb9 | 351 | Installing Open vSwitch for Linux, FreeBSD or NetBSD" above. |
8b055d92 | 352 | |
4e375050 GS |
353 | Hot Upgrading |
354 | ============= | |
355 | Upgrading Open vSwitch from one version to the next version with minimum | |
356 | disruption of traffic going through the system that is using that Open vSwitch | |
357 | needs some considerations: | |
358 | ||
359 | 1. If the upgrade only involves upgrading the userspace utilities and daemons | |
360 | of Open vSwitch, make sure that the new userspace version is compatible with | |
361 | the previously loaded kernel module. | |
362 | ||
363 | 2. An upgrade of userspace daemons means that they have to be restarted. | |
364 | Restarting the daemons means that the Openflow flows in the ovs-vswitchd daemon | |
365 | will be lost. One way to restore the flows is to let the controller | |
366 | re-populate it. Another way is to save the previous flows using a utility | |
367 | like ovs-ofctl and then re-add them after the restart. Restoring the old flows | |
368 | is accurate only if the new Open vSwitch interfaces retain the old 'ofport' | |
369 | values. | |
370 | ||
371 | 3. When the new userspace daemons get restarted, they automatically flush | |
372 | the old flows setup in the kernel. This can be expensive if there are hundreds | |
373 | of new flows that are entering the kernel but userspace daemons are busy | |
374 | setting up new userspace flows from either the controller or an utility like | |
375 | ovs-ofctl. Open vSwitch database provides an option to solve this problem | |
376 | through the other_config:flow-restore-wait column of the Open_vSwitch table. | |
377 | Refer to the ovs-vswitchd.conf.db(5) manpage for details. | |
378 | ||
379 | 4. If the upgrade also involves upgrading the kernel module, the old kernel | |
380 | module needs to be unloaded and the new kernel module should be loaded. This | |
381 | means that the kernel network devices belonging to Open vSwitch is recreated | |
382 | and the kernel flows are lost. The downtime of the traffic can be reduced | |
383 | if the userspace daemons are restarted immediately and the userspace flows | |
384 | are restored as soon as possible. | |
385 | ||
386 | The ovs-ctl utility's "restart" function only restarts the userspace daemons, | |
387 | makes sure that the 'ofport' values remain consistent across restarts, restores | |
388 | userspace flows using the ovs-ofctl utility and also uses the | |
389 | other_config:flow-restore-wait column to keep the traffic downtime to the | |
390 | minimum. The ovs-ctl utility's "force-reload-kmod" function does all of the | |
391 | above, but also replaces the old kernel module with the new one. Open vSwitch | |
392 | startup scripts for Debian, XenServer and RHEL use ovs-ctl's functions and it | |
393 | is recommended that these functions be used for other software platforms too. | |
394 | ||
875ef81b KM |
395 | Running the Testsuite |
396 | ===================== | |
397 | ||
398 | Open vSwitch includes a testsuite. Before you submit patches | |
399 | upstream, we advise that you run the tests and ensure that they pass. | |
400 | If you add new features to Open vSwitch, then adding tests for those | |
401 | features will ensure your features don't break as developers modify | |
402 | other areas of Open vSwitch. | |
403 | ||
404 | You must configure and build Open vSwitch (steps 1 through 3 in | |
76d5beb9 | 405 | "Building and Installing Open vSwitch for Linux, FreeBSD or NetBSD" above) |
875ef81b KM |
406 | before you run the testsuite. You do not need to install Open vSwitch |
407 | or to build or load the kernel module to run the testsuite. You do | |
408 | not need supervisor privilege to run the testsuite. | |
409 | ||
410 | To run all the unit tests in Open vSwitch, one at a time: | |
411 | make check | |
412 | This takes under 5 minutes on a modern desktop system. | |
413 | ||
414 | To run all the unit tests in Open vSwitch, up to 8 in parallel: | |
415 | make check TESTSUITEFLAGS=-j8 | |
416 | This takes under a minute on a modern 4-core desktop system. | |
417 | ||
418 | To see a list of all the available tests, run: | |
419 | make check TESTSUITEFLAGS=--list | |
420 | ||
421 | To run only a subset of tests, e.g. test 123 and tests 477 through 484: | |
422 | make check TESTSUITEFLAGS='123 477-484' | |
423 | (Tests do not have inter-dependencies, so you may run any subset.) | |
424 | ||
425 | To run tests matching a keyword, e.g. "ovsdb": | |
426 | make check TESTSUITEFLAGS='-k ovsdb' | |
427 | ||
428 | To see a complete list of test options: | |
429 | make check TESTSUITEFLAGS=--help | |
430 | ||
431 | The results of a testing run are reported in tests/testsuite.log. | |
432 | Please report test failures as bugs and include the testsuite.log in | |
433 | your report. | |
434 | ||
435 | If you have "valgrind" installed, then you can also run the testsuite | |
436 | under valgrind by using "make check-valgrind" in place of "make | |
437 | check". All the same options are available via TESTSUITEFLAGS. When | |
438 | you do this, the "valgrind" results for test <N> are reported in files | |
439 | named tests/testsuite.dir/<N>/valgrind.*. You may find that the | |
440 | valgrind results are easier to interpret if you put "-q" in | |
447fe5cf | 441 | ~/.valgrindrc, since that reduces the amount of output. |
875ef81b KM |
442 | |
443 | Sometimes a few tests may fail on some runs but not others. This is | |
444 | usually a bug in the testsuite, not a bug in Open vSwitch itself. If | |
445 | you find that a test fails intermittently, please report it, since the | |
446 | developers may not have noticed. | |
447 | ||
4b11d5e8 BP |
448 | Bug Reporting |
449 | ------------- | |
450 | ||
37ea6436 | 451 | Please report problems to bugs@openvswitch.org. |