]>
Commit | Line | Data |
---|---|---|
542cc9bb TG |
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 | |
9feb1017 TG |
8 | - [INSTALL.Debian.md] |
9 | - [INSTALL.Fedora.md] | |
10 | - [INSTALL.RHEL.md] | |
11 | - [INSTALL.XenServer.md] | |
12 | - [INSTALL.NetBSD.md] | |
13 | - [INSTALL.DPDK.md] | |
4b11d5e8 BP |
14 | |
15 | Build Requirements | |
16 | ------------------ | |
17 | ||
18 | To compile the userspace programs in the Open vSwitch distribution, | |
19 | you will need the following software: | |
20 | ||
542cc9bb | 21 | - GNU make. |
4b11d5e8 | 22 | |
542cc9bb | 23 | - A C compiler, such as: |
8a6de510 | 24 | |
542cc9bb | 25 | * GCC 4.x. |
8a6de510 | 26 | |
542cc9bb TG |
27 | * Clang. Clang 3.4 and later provide useful static semantic |
28 | analysis and thread-safety checks. For Ubuntu, there are | |
29 | nightly built packages available on clang's website. | |
4b11d5e8 | 30 | |
542cc9bb TG |
31 | While OVS may be compatible with other compilers, optimal |
32 | support for atomic operations may be missing, making OVS very | |
33 | slow (see lib/ovs-atomic.h). | |
29d204ef | 34 | |
542cc9bb TG |
35 | - libssl, from OpenSSL, is optional but recommended if you plan to |
36 | connect the Open vSwitch to an OpenFlow controller. libssl is | |
37 | required to establish confidentiality and authenticity in the | |
38 | connections from an Open vSwitch to an OpenFlow controller. If | |
39 | libssl is installed, then Open vSwitch will automatically build | |
40 | with support for it. | |
4b11d5e8 | 41 | |
542cc9bb | 42 | - Python 2.x, for x >= 4. |
deb64473 | 43 | |
ddd347c2 GS |
44 | - patch (The utility that is used to patch files). |
45 | ||
c6435221 BP |
46 | On Linux, you may choose to compile the kernel module that comes with |
47 | the Open vSwitch distribution or to use the kernel module built into | |
9feb1017 TG |
48 | the Linux kernel (version 3.3 or later). See the [FAQ.md] question |
49 | "What features are not available in the Open vSwitch kernel datapath that | |
c6435221 BP |
50 | ships as part of the upstream Linux kernel?" for more information on |
51 | this trade-off. You may also use the userspace-only implementation, | |
9feb1017 TG |
52 | at some cost in features and performance (see [INSTALL.userspace.md] |
53 | for details). To compile the kernel module on Linux, you must also | |
c6435221 | 54 | install the following: |
4b11d5e8 | 55 | |
9feb1017 | 56 | - A supported Linux kernel version. Please refer to [README.md] for a |
542cc9bb | 57 | list of supported versions. |
4b11d5e8 | 58 | |
542cc9bb TG |
59 | The Open vSwitch datapath requires bridging support |
60 | (CONFIG_BRIDGE) to be built as a kernel module. (This is common | |
61 | in kernels provided by Linux distributions.) The bridge module | |
62 | must not be loaded or in use. If the bridge module is running | |
63 | (check with "lsmod | grep bridge"), you must remove it ("rmmod | |
64 | bridge") before starting the datapath. | |
4b11d5e8 | 65 | |
542cc9bb TG |
66 | For optional support of ingress policing, you must enable kernel |
67 | configuration options NET_CLS_BASIC, NET_SCH_INGRESS, and | |
68 | NET_ACT_POLICE, either built-in or as modules. (NET_CLS_POLICE is | |
69 | obsolete and not needed.) | |
4b11d5e8 | 70 | |
542cc9bb TG |
71 | To use GRE tunneling on Linux 2.6.37 or newer, kernel support |
72 | for GRE demultiplexing (CONFIG_NET_IPGRE_DEMUX) must be compiled | |
73 | in or available as a module. Also, on kernels before 3.11, the | |
74 | ip_gre module, for GRE tunnels over IP (NET_IPGRE), must not be | |
75 | loaded or compiled in. | |
6f470982 | 76 | |
542cc9bb TG |
77 | To configure HTB or HFSC quality of service with Open vSwitch, |
78 | you must enable the respective configuration options. | |
c9d3af4e | 79 | |
542cc9bb TG |
80 | To use Open vSwitch support for TAP devices, you must enable |
81 | CONFIG_TUN. | |
26bb189d | 82 | |
542cc9bb TG |
83 | - To build a kernel module, you need the same version of GCC that |
84 | was used to build that kernel. | |
4b11d5e8 | 85 | |
542cc9bb TG |
86 | - A kernel build directory corresponding to the Linux kernel image |
87 | the module is to run on. Under Debian and Ubuntu, for example, | |
88 | each linux-image package containing a kernel binary has a | |
89 | corresponding linux-headers package with the required build | |
90 | infrastructure. | |
4b11d5e8 BP |
91 | |
92 | If you are working from a Git tree or snapshot (instead of from a | |
c9d3af4e BP |
93 | distribution tarball), or if you modify the Open vSwitch build system |
94 | or the database schema, you will also need the following software: | |
4b11d5e8 | 95 | |
542cc9bb | 96 | - Autoconf version 2.63 or later. |
4b11d5e8 | 97 | |
542cc9bb | 98 | - Automake version 1.10 or later. |
4b11d5e8 | 99 | |
542cc9bb | 100 | - libtool version 2.4 or later. (Older versions might work too.) |
195b5c35 | 101 | |
c9d3af4e BP |
102 | To run the unit tests, you also need: |
103 | ||
542cc9bb TG |
104 | - Perl. Version 5.10.1 is known to work. Earlier versions should |
105 | also work. | |
c9d3af4e | 106 | |
a5ae88ff AA |
107 | The ovs-vswitchd.conf.db(5) manpage will include an E-R diagram, in |
108 | formats other than plain text, only if you have the following: | |
f8d739a9 | 109 | |
542cc9bb | 110 | - "dot" from graphviz (http://www.graphviz.org/). |
f8d739a9 | 111 | |
542cc9bb TG |
112 | - Perl. Version 5.10.1 is known to work. Earlier versions should |
113 | also work. | |
c9d3af4e | 114 | |
542cc9bb | 115 | - Python 2.x, for x >= 4. |
c9d3af4e | 116 | |
f8f26e98 BP |
117 | If you are going to extensively modify Open vSwitch, please consider |
118 | installing the following to obtain better warnings: | |
119 | ||
542cc9bb TG |
120 | - "sparse" version 0.4.4 or later |
121 | (http://www.kernel.org/pub/software/devel/sparse/dist/). | |
f8f26e98 | 122 | |
542cc9bb | 123 | - GNU make. |
f8f26e98 | 124 | |
542cc9bb | 125 | - clang, version 3.4 or later |
97be1538 | 126 | |
fef5244f EJ |
127 | Also, you may find the ovs-dev script found in utilities/ovs-dev.py useful. |
128 | ||
4b11d5e8 BP |
129 | Installation Requirements |
130 | ------------------------- | |
131 | ||
132 | The machine on which Open vSwitch is to be installed must have the | |
133 | following software: | |
134 | ||
542cc9bb | 135 | - libc compatible with the libc used for build. |
4b11d5e8 | 136 | |
542cc9bb TG |
137 | - libssl compatible with the libssl used for build, if OpenSSL was |
138 | used for the build. | |
4b11d5e8 | 139 | |
542cc9bb | 140 | - On Linux, the same kernel version configured as part of the build. |
4b11d5e8 | 141 | |
542cc9bb TG |
142 | - For optional support of ingress policing on Linux, the "tc" program |
143 | from iproute2 (part of all major distributions and available at | |
144 | http://www.linux-foundation.org/en/Net:Iproute2). | |
4b11d5e8 | 145 | |
f6eb6b20 GL |
146 | On Linux you should ensure that /dev/urandom exists. To support TAP |
147 | devices, you must also ensure that /dev/net/tun exists. | |
6e8e271c | 148 | |
76d5beb9 YT |
149 | Building and Installing Open vSwitch for Linux, FreeBSD or NetBSD |
150 | ================================================================= | |
4b11d5e8 | 151 | |
e9e85443 FL |
152 | Once you have installed all the prerequisites listed above in the |
153 | Base Prerequisites section, follow the procedures below to bootstrap, | |
154 | to configure and to build the code. | |
4b11d5e8 | 155 | |
e9e85443 FL |
156 | Bootstrapping the Sources |
157 | ------------------------- | |
158 | ||
159 | This step is not needed if you have downloaded a released tarball. | |
160 | If you pulled the sources directly from an Open vSwitch Git tree or | |
161 | got a Git tree snapshot, then run boot.sh in the top source directory | |
162 | to build the "configure" script. | |
30746a1b | 163 | |
542cc9bb | 164 | `% ./boot.sh` |
30746a1b | 165 | |
e9e85443 FL |
166 | |
167 | Configuring the Sources | |
168 | ----------------------- | |
169 | ||
170 | Configure the package by running the configure script. You can | |
171 | usually invoke configure without any arguments. For example: | |
4b11d5e8 | 172 | |
542cc9bb | 173 | `% ./configure` |
4b11d5e8 | 174 | |
e9e85443 FL |
175 | By default all files are installed under /usr/local. If you want |
176 | to install into, e.g., /usr and /var instead of /usr/local and | |
177 | /usr/local/var, add options as shown here: | |
4b11d5e8 | 178 | |
542cc9bb | 179 | `% ./configure --prefix=/usr --localstatedir=/var` |
4b11d5e8 | 180 | |
e9e85443 FL |
181 | By default, static libraries are built and linked against. If you |
182 | want to use shared libraries instead: | |
7748423a TG |
183 | |
184 | % ./configure --enable-shared | |
185 | ||
e9e85443 FL |
186 | To use a specific C compiler for compiling Open vSwitch user |
187 | programs, also specify it on the configure command line, like so: | |
4b11d5e8 | 188 | |
542cc9bb | 189 | `% ./configure CC=gcc-4.2` |
4b11d5e8 | 190 | |
e9e85443 | 191 | To use 'clang' compiler: |
97be1538 | 192 | |
542cc9bb | 193 | `% ./configure CC=clang` |
97be1538 | 194 | |
e9e85443 FL |
195 | To build the Linux kernel module, so that you can run the |
196 | kernel-based switch, pass the location of the kernel build | |
197 | directory on --with-linux. For example, to build for a running | |
198 | instance of Linux: | |
4b11d5e8 | 199 | |
542cc9bb | 200 | `% ./configure --with-linux=/lib/modules/`uname -r`/build` |
4b11d5e8 | 201 | |
e9e85443 FL |
202 | If --with-linux requests building for an unsupported version of |
203 | Linux, then "configure" will fail with an error message. Please | |
204 | refer to the [FAQ.md] for advice in that case. | |
a7ae9380 | 205 | |
e9e85443 FL |
206 | If you wish to build the kernel module for an architecture other |
207 | than the architecture of the machine used for the build, you may | |
208 | specify the kernel architecture string using the KARCH variable | |
209 | when invoking the configure script. For example, to build for MIPS | |
210 | with Linux: | |
4b11d5e8 | 211 | |
542cc9bb | 212 | `% ./configure --with-linux=/path/to/linux KARCH=mips` |
4b11d5e8 | 213 | |
e9e85443 FL |
214 | If you plan to do much Open vSwitch development, you might want to |
215 | add --enable-Werror, which adds the -Werror option to the compiler | |
216 | command line, turning warnings into errors. That makes it | |
217 | impossible to miss warnings generated by the build. | |
ad367b28 | 218 | |
e9e85443 FL |
219 | To build with gcov code coverage support, add --enable-coverage, |
220 | e.g.: | |
e3c7ed29 | 221 | |
542cc9bb | 222 | `% ./configure --enable-coverage` |
e3c7ed29 | 223 | |
e9e85443 FL |
224 | The configure script accepts a number of other options and honors |
225 | additional environment variables. For a full list, invoke | |
226 | configure with the --help option. | |
4b11d5e8 | 227 | |
e9e85443 FL |
228 | You can also run configure from a separate build directory. This |
229 | is helpful if you want to build Open vSwitch in more than one way | |
230 | from a single source directory, e.g. to try out both GCC and Clang | |
231 | builds, or to build kernel modules for more than one Linux version. | |
232 | Here is an example: | |
ef7889b4 | 233 | |
542cc9bb TG |
234 | `% mkdir _gcc && (cd _gcc && ../configure CC=gcc)` |
235 | `% mkdir _clang && (cd _clang && ../configure CC=clang)` | |
ef7889b4 | 236 | |
e9e85443 FL |
237 | |
238 | Building the Sources | |
239 | -------------------- | |
240 | ||
241 | 1. Run GNU make in the build directory, e.g.: | |
4b11d5e8 | 242 | |
542cc9bb | 243 | `% make` |
4b11d5e8 | 244 | |
380b39f7 BP |
245 | or if GNU make is installed as "gmake": |
246 | ||
542cc9bb | 247 | `% gmake` |
f6eb6b20 | 248 | |
ef7889b4 BP |
249 | If you used a separate build directory, run make or gmake from that |
250 | directory, e.g.: | |
251 | ||
542cc9bb TG |
252 | `% make -C _gcc` |
253 | `% make -C _clang` | |
ef7889b4 | 254 | |
e9e85443 FL |
255 | For improved warnings if you installed "sparse" (see "Prerequisites"), |
256 | add C=1 to the command line. | |
f8f26e98 | 257 | |
e9e85443 | 258 | 2. Consider running the testsuite. Refer to "Running the Testsuite" |
875ef81b | 259 | below, for instructions. |
4b11d5e8 | 260 | |
e9e85443 | 261 | 3. Become root by running "su" or another program. |
875ef81b | 262 | |
e9e85443 | 263 | 4. Run "make install" to install the executables and manpages into the |
4b11d5e8 BP |
264 | running system, by default under /usr/local. |
265 | ||
e9e85443 | 266 | 5. If you built kernel modules, you may install and load them, e.g.: |
4b11d5e8 | 267 | |
542cc9bb TG |
268 | `% make modules_install` |
269 | `% /sbin/modprobe openvswitch` | |
4b11d5e8 | 270 | |
4b11d5e8 | 271 | To verify that the modules have been loaded, run "/sbin/lsmod" and |
9b80f761 | 272 | check that openvswitch is listed. |
4b11d5e8 | 273 | |
542cc9bb TG |
274 | If the `modprobe` operation fails, look at the last few kernel log |
275 | messages (e.g. with `dmesg | tail`): | |
dd2d79ce | 276 | |
9b80f761 | 277 | - The message "openvswitch: exports duplicate symbol |
dd2d79ce | 278 | br_should_route_hook (owned by bridge)" means that the bridge |
542cc9bb | 279 | module is loaded. Run `/sbin/rmmod bridge` to remove it. |
dd2d79ce | 280 | |
542cc9bb | 281 | If `/sbin/rmmod bridge` fails with "ERROR: Module bridge does |
dd2d79ce BP |
282 | not exist in /proc/modules", then the bridge is compiled into |
283 | the kernel, rather than as a module. Open vSwitch does not | |
284 | support this configuration (see "Build Requirements", above). | |
285 | ||
9b80f761 | 286 | - The message "openvswitch: exports duplicate symbol |
dd2d79ce BP |
287 | dp_ioctl_hook (owned by ofdatapath)" means that the ofdatapath |
288 | module from the OpenFlow reference implementation is loaded. | |
542cc9bb | 289 | Run `/sbin/rmmod ofdatapath` to remove it. (You might have to |
dd2d79ce BP |
290 | delete any existing datapaths beforehand, using the "dpctl" |
291 | program included with the OpenFlow reference implementation. | |
292 | "ovs-dpctl" will not work.) | |
293 | ||
294 | - Otherwise, the most likely problem is that Open vSwitch was | |
295 | built for a kernel different from the one into which you are | |
542cc9bb | 296 | trying to load it. Run `modinfo` on openvswitch.ko and on |
dd2d79ce BP |
297 | a module built for the running kernel, e.g.: |
298 | ||
542cc9bb | 299 | ``` |
9b80f761 | 300 | % /sbin/modinfo openvswitch.ko |
dd2d79ce | 301 | % /sbin/modinfo /lib/modules/`uname -r`/kernel/net/bridge/bridge.ko |
542cc9bb | 302 | ``` |
dd2d79ce BP |
303 | |
304 | Compare the "vermagic" lines output by the two commands. If | |
305 | they differ, then Open vSwitch was built for the wrong kernel. | |
306 | ||
307 | - If you decide to report a bug or ask a question related to | |
542cc9bb TG |
308 | module loading, please include the output from the `dmesg` and |
309 | `modinfo` commands mentioned above. | |
dd2d79ce | 310 | |
e9e85443 FL |
311 | There is an optional module parameter to openvswitch.ko called |
312 | vlan_tso that enables TCP segmentation offload over VLANs on NICs | |
313 | that support it. Many drivers do not expose support for TSO on VLANs | |
314 | in a way that Open vSwitch can use but there is no way to detect | |
315 | whether this is the case. If you know that your particular driver can | |
316 | handle it (for example by testing sending large TCP packets over VLANs) | |
317 | then passing in a value of 1 may improve performance. Modules built for | |
318 | Linux kernels 2.6.37 and later, as well as specially patched versions | |
319 | of earlier kernels, do not need this and do not have this parameter. If | |
320 | you do not understand what this means or do not know if your driver | |
321 | will work, do not set this. | |
3f6256af | 322 | |
e9e85443 | 323 | 6. Initialize the configuration database using ovsdb-tool, e.g.: |
4b11d5e8 | 324 | |
542cc9bb TG |
325 | `% mkdir -p /usr/local/etc/openvswitch` |
326 | `% ovsdb-tool create /usr/local/etc/openvswitch/conf.db vswitchd/vswitch.ovsschema` | |
4b11d5e8 | 327 | |
3b12adda BP |
328 | Startup |
329 | ======= | |
4b11d5e8 | 330 | |
3b12adda | 331 | Before starting ovs-vswitchd itself, you need to start its |
cb8141b2 BP |
332 | configuration database, ovsdb-server. Each machine on which Open |
333 | vSwitch is installed should run its own copy of ovsdb-server. | |
566b8c8d BP |
334 | Configure it to use the database you created during installation (as |
335 | explained above), to listen on a Unix domain socket, to connect to any | |
336 | managers specified in the database itself, and to use the SSL | |
8084a280 BP |
337 | configuration in the database: |
338 | ||
29701194 | 339 | % ovsdb-server --remote=punix:/usr/local/var/run/openvswitch/db.sock \ |
6faab099 JP |
340 | --remote=db:Open_vSwitch,Open_vSwitch,manager_options \ |
341 | --private-key=db:Open_vSwitch,SSL,private_key \ | |
342 | --certificate=db:Open_vSwitch,SSL,certificate \ | |
343 | --bootstrap-ca-cert=db:Open_vSwitch,SSL,ca_cert \ | |
29701194 | 344 | --pidfile --detach |
3b12adda | 345 | |
d3e3fb58 BP |
346 | (If you built Open vSwitch without SSL support, then omit |
347 | --private-key, --certificate, and --bootstrap-ca-cert.) | |
348 | ||
de4f3c10 | 349 | Then initialize the database using ovs-vsctl. This is only |
332b4e09 BP |
350 | necessary the first time after you create the database with |
351 | ovsdb-tool (but running it at any time is harmless): | |
352 | ||
de4f3c10 | 353 | % ovs-vsctl --no-wait init |
332b4e09 | 354 | |
3b12adda BP |
355 | Then start the main Open vSwitch daemon, telling it to connect to the |
356 | same Unix domain socket: | |
357 | ||
80df177a | 358 | % ovs-vswitchd --pidfile --detach |
3b12adda BP |
359 | |
360 | Now you may use ovs-vsctl to set up bridges and other Open vSwitch | |
361 | features. For example, to create a bridge named br0 and add ports | |
362 | eth0 and vif1.0 to it: | |
363 | ||
364 | % ovs-vsctl add-br br0 | |
365 | % ovs-vsctl add-port br0 eth0 | |
366 | % ovs-vsctl add-port br0 vif1.0 | |
367 | ||
368 | Please refer to ovs-vsctl(8) for more details. | |
4b11d5e8 | 369 | |
8b055d92 BP |
370 | Upgrading |
371 | ========= | |
372 | ||
373 | When you upgrade Open vSwitch from one version to another, you should | |
374 | also upgrade the database schema: | |
375 | ||
376 | 1. Stop the Open vSwitch daemons, e.g.: | |
377 | ||
542cc9bb | 378 | ``` |
012f5c4b | 379 | % kill `cd /usr/local/var/run/openvswitch && cat ovsdb-server.pid ovs-vswitchd.pid` |
542cc9bb | 380 | ``` |
8b055d92 BP |
381 | |
382 | 2. Install the new Open vSwitch release. | |
383 | ||
384 | 3. Upgrade the database, in one of the following two ways: | |
385 | ||
386 | - If there is no important data in your database, then you may | |
387 | delete the database file and recreate it with ovsdb-tool, | |
388 | following the instructions under "Building and Installing Open | |
76d5beb9 | 389 | vSwitch for Linux, FreeBSD or NetBSD". |
8b055d92 BP |
390 | |
391 | - If you want to preserve the contents of your database, back it | |
392 | up first, then use "ovsdb-tool convert" to upgrade it, e.g.: | |
393 | ||
542cc9bb | 394 | `% ovsdb-tool convert /usr/local/etc/openvswitch/conf.db vswitchd/vswitch.ovsschema` |
8b055d92 BP |
395 | |
396 | 4. Start the Open vSwitch daemons as described under "Building and | |
76d5beb9 | 397 | Installing Open vSwitch for Linux, FreeBSD or NetBSD" above. |
8b055d92 | 398 | |
4e375050 GS |
399 | Hot Upgrading |
400 | ============= | |
401 | Upgrading Open vSwitch from one version to the next version with minimum | |
402 | disruption of traffic going through the system that is using that Open vSwitch | |
403 | needs some considerations: | |
404 | ||
405 | 1. If the upgrade only involves upgrading the userspace utilities and daemons | |
406 | of Open vSwitch, make sure that the new userspace version is compatible with | |
407 | the previously loaded kernel module. | |
408 | ||
409 | 2. An upgrade of userspace daemons means that they have to be restarted. | |
ea274df9 | 410 | Restarting the daemons means that the OpenFlow flows in the ovs-vswitchd daemon |
4e375050 GS |
411 | will be lost. One way to restore the flows is to let the controller |
412 | re-populate it. Another way is to save the previous flows using a utility | |
413 | like ovs-ofctl and then re-add them after the restart. Restoring the old flows | |
414 | is accurate only if the new Open vSwitch interfaces retain the old 'ofport' | |
415 | values. | |
416 | ||
417 | 3. When the new userspace daemons get restarted, they automatically flush | |
418 | the old flows setup in the kernel. This can be expensive if there are hundreds | |
419 | of new flows that are entering the kernel but userspace daemons are busy | |
420 | setting up new userspace flows from either the controller or an utility like | |
421 | ovs-ofctl. Open vSwitch database provides an option to solve this problem | |
422 | through the other_config:flow-restore-wait column of the Open_vSwitch table. | |
423 | Refer to the ovs-vswitchd.conf.db(5) manpage for details. | |
424 | ||
425 | 4. If the upgrade also involves upgrading the kernel module, the old kernel | |
426 | module needs to be unloaded and the new kernel module should be loaded. This | |
427 | means that the kernel network devices belonging to Open vSwitch is recreated | |
428 | and the kernel flows are lost. The downtime of the traffic can be reduced | |
429 | if the userspace daemons are restarted immediately and the userspace flows | |
430 | are restored as soon as possible. | |
431 | ||
432 | The ovs-ctl utility's "restart" function only restarts the userspace daemons, | |
433 | makes sure that the 'ofport' values remain consistent across restarts, restores | |
434 | userspace flows using the ovs-ofctl utility and also uses the | |
435 | other_config:flow-restore-wait column to keep the traffic downtime to the | |
436 | minimum. The ovs-ctl utility's "force-reload-kmod" function does all of the | |
437 | above, but also replaces the old kernel module with the new one. Open vSwitch | |
438 | startup scripts for Debian, XenServer and RHEL use ovs-ctl's functions and it | |
439 | is recommended that these functions be used for other software platforms too. | |
440 | ||
e3c7ed29 BP |
441 | Testsuites |
442 | ========== | |
443 | ||
444 | This section describe Open vSwitch's built-in support for various test | |
e9e85443 | 445 | suites. You must bootstrap, configure and build Open vSwitch (steps are |
e3c7ed29 BP |
446 | in "Building and Installing Open vSwitch for Linux, FreeBSD or NetBSD" |
447 | above) before you run the tests described here. You do not need to | |
448 | install Open vSwitch or to build or load the kernel module to run | |
449 | these test suites. You do not need supervisor privilege to run these | |
450 | test suites. | |
875ef81b | 451 | |
e3c7ed29 BP |
452 | Self-Tests |
453 | ---------- | |
454 | ||
455 | Open vSwitch includes a suite of self-tests. Before you submit patches | |
875ef81b KM |
456 | upstream, we advise that you run the tests and ensure that they pass. |
457 | If you add new features to Open vSwitch, then adding tests for those | |
458 | features will ensure your features don't break as developers modify | |
459 | other areas of Open vSwitch. | |
460 | ||
e3c7ed29 | 461 | Refer to "Testsuites" above for prerequisites. |
875ef81b KM |
462 | |
463 | To run all the unit tests in Open vSwitch, one at a time: | |
542cc9bb | 464 | `make check` |
875ef81b KM |
465 | This takes under 5 minutes on a modern desktop system. |
466 | ||
467 | To run all the unit tests in Open vSwitch, up to 8 in parallel: | |
542cc9bb | 468 | `make check TESTSUITEFLAGS=-j8` |
875ef81b KM |
469 | This takes under a minute on a modern 4-core desktop system. |
470 | ||
471 | To see a list of all the available tests, run: | |
542cc9bb | 472 | `make check TESTSUITEFLAGS=--list` |
875ef81b KM |
473 | |
474 | To run only a subset of tests, e.g. test 123 and tests 477 through 484: | |
542cc9bb | 475 | `make check TESTSUITEFLAGS='123 477-484'` |
875ef81b KM |
476 | (Tests do not have inter-dependencies, so you may run any subset.) |
477 | ||
478 | To run tests matching a keyword, e.g. "ovsdb": | |
542cc9bb | 479 | `make check TESTSUITEFLAGS='-k ovsdb'` |
875ef81b KM |
480 | |
481 | To see a complete list of test options: | |
542cc9bb | 482 | `make check TESTSUITEFLAGS=--help` |
875ef81b KM |
483 | |
484 | The results of a testing run are reported in tests/testsuite.log. | |
485 | Please report test failures as bugs and include the testsuite.log in | |
486 | your report. | |
487 | ||
488 | If you have "valgrind" installed, then you can also run the testsuite | |
489 | under valgrind by using "make check-valgrind" in place of "make | |
490 | check". All the same options are available via TESTSUITEFLAGS. When | |
542cc9bb TG |
491 | you do this, the "valgrind" results for test `<N>` are reported in files |
492 | named `tests/testsuite.dir/<N>/valgrind.*`. You may find that the | |
875ef81b | 493 | valgrind results are easier to interpret if you put "-q" in |
447fe5cf | 494 | ~/.valgrindrc, since that reduces the amount of output. |
875ef81b KM |
495 | |
496 | Sometimes a few tests may fail on some runs but not others. This is | |
497 | usually a bug in the testsuite, not a bug in Open vSwitch itself. If | |
498 | you find that a test fails intermittently, please report it, since the | |
499 | developers may not have noticed. | |
500 | ||
e3c7ed29 BP |
501 | OFTest |
502 | ------ | |
503 | ||
504 | OFTest is an OpenFlow protocol testing suite. Open vSwitch includes a | |
505 | Makefile target to run OFTest with Open vSwitch in "dummy mode". In | |
506 | this mode of testing, no packets travel across physical or virtual | |
507 | networks. Instead, Unix domain sockets stand in as simulated | |
508 | networks. This simulation is imperfect, but it is much easier to set | |
509 | up, does not require extra physical or virtual hardware, and does not | |
510 | require supervisor privileges. | |
511 | ||
512 | To run OFTest with Open vSwitch, first read and follow the | |
513 | instructions under "Testsuites" above. Second, obtain a copy of | |
514 | OFTest and install its prerequisites. You need a copy of OFTest that | |
515 | includes commit 406614846c5 (make ovs-dummy platform work again). | |
516 | This commit was merged into the OFTest repository on Feb 1, 2013, so | |
517 | any copy of OFTest more recent than that should work. Testing OVS in | |
518 | dummy mode does not require root privilege, so you may ignore that | |
519 | requirement. | |
520 | ||
521 | Optionally, add the top-level OFTest directory (containing the "oft" | |
522 | program) to your $PATH. This slightly simplifies running OFTest later. | |
523 | ||
524 | To run OFTest in dummy mode, run the following command from your Open | |
525 | vSwitch build directory: | |
542cc9bb TG |
526 | `make check-oftest OFT=<oft-binary>` |
527 | where `<oft-binary>` is the absolute path to the "oft" program in | |
e3c7ed29 BP |
528 | OFTest. |
529 | ||
530 | If you added "oft" to your $PATH, you may omit the OFT variable | |
531 | assignment: | |
542cc9bb | 532 | `make check-oftest` |
e3c7ed29 BP |
533 | By default, "check-oftest" passes "oft" just enough options to enable |
534 | dummy mode. You can use OFTFLAGS to pass additional options. For | |
535 | example, to run just the basic.Echo test instead of all tests (the | |
536 | default) and enable verbose logging: | |
542cc9bb | 537 | `make check-oftest OFT=<oft-binary> OFTFLAGS='--verbose -T basic.Echo'` |
e3c7ed29 BP |
538 | |
539 | If you use OFTest that does not include commit 4d1f3eb2c792 (oft: | |
540 | change default port to 6653), merged into the OFTest repository in | |
541 | October 2013, then you need to add an option to use the IETF-assigned | |
542 | controller port: | |
542cc9bb | 543 | `make check-oftest OFT=<oft-binary> OFTFLAGS='--port=6653'` |
e3c7ed29 BP |
544 | |
545 | Please interpret OFTest results cautiously. Open vSwitch can fail a | |
546 | given test in OFTest for many reasons, including bugs in Open vSwitch, | |
547 | bugs in OFTest, bugs in the "dummy mode" integration, and differing | |
548 | interpretations of the OpenFlow standard and other standards. | |
549 | ||
550 | Open vSwitch has not been validated against OFTest. Please do report | |
551 | test failures that you believe to represent bugs in Open vSwitch. | |
552 | Include the precise versions of Open vSwitch and OFTest in your bug | |
553 | report, plus any other information needed to reproduce the problem. | |
554 | ||
555 | Ryu | |
556 | --- | |
557 | ||
558 | Ryu is an OpenFlow controller written in Python that includes an | |
559 | extensive OpenFlow testsuite. Open vSwitch includes a Makefile target | |
560 | to run Ryu in "dummy mode". See "OFTest" above for an explanation of | |
561 | dummy mode. | |
562 | ||
563 | To run Ryu tests with Open vSwitch, first read and follow the | |
564 | instructions under "Testsuites" above. Second, obtain a copy of Ryu, | |
565 | install its prerequisites, and build it. You do not need to install | |
566 | Ryu (some of the tests do not get installed, so it does not help). | |
567 | ||
568 | To run Ryu tests, run the following command from your Open vSwitch | |
569 | build directory: | |
542cc9bb TG |
570 | `make check-ryu RYUDIR=<ryu-source-dir>` |
571 | where `<ryu-source-dir>` is the absolute path to the root of the Ryu | |
572 | source distribution. The default `<ryu-source-dir>` is `$srcdir/../ryu` | |
e3c7ed29 | 573 | where $srcdir is your Open vSwitch source directory, so if this |
542cc9bb | 574 | default is correct then you make simply run `make check-ryu`. |
e3c7ed29 BP |
575 | |
576 | Open vSwitch has not been validated against Ryu. Please do report | |
577 | test failures that you believe to represent bugs in Open vSwitch. | |
578 | Include the precise versions of Open vSwitch and Ryu in your bug | |
579 | report, plus any other information needed to reproduce the problem. | |
580 | ||
1ce96d2a TG |
581 | Vagrant |
582 | ------- | |
583 | ||
b56b2566 | 584 | Requires: Vagrant (version 1.7.0 or later) and a compatible hypervisor |
1ce96d2a | 585 | |
e9e85443 FL |
586 | You must bootstrap and configure the sources (steps are in "Building |
587 | and Installing Open vSwitch for Linux, FreeBSD or NetBSD" above) before | |
588 | you run the steps described here. | |
589 | ||
1ce96d2a TG |
590 | A Vagrantfile is provided allowing to compile and provision the source |
591 | tree as found locally in a virtual machine using the following commands: | |
592 | ||
593 | vagrant up | |
594 | vagrant ssh | |
595 | ||
596 | This will bring up w Fedora 20 VM by default, alternatively the | |
b56b2566 AZ |
597 | `Vagrantfile` can be modified to use a different distribution box as |
598 | base. Also, the VM can be reprovisioned at any time: | |
1ce96d2a TG |
599 | |
600 | vagrant provision | |
601 | ||
b56b2566 AZ |
602 | OVS out-of-tree compilation environment can be set up with: |
603 | ||
604 | ./boot.sh | |
605 | vagrant provision --provision-with configure_ovs,build_ovs | |
606 | ||
607 | This will set up an out-of-tree build environment in /home/vagrant/build. | |
608 | The source code can be found in /vagrant. Out-of-tree build is preferred | |
609 | to work around limitations of the sync file systems. | |
610 | ||
611 | To recompile and reinstall OVS using RPM: | |
612 | ||
613 | ./boot.sh | |
614 | vagrant provision --provision-with configure_ovs,install_rpm | |
615 | ||
8187f55b TG |
616 | Continuous Integration with Travis-CI |
617 | ------------------------------------- | |
618 | ||
619 | A .travis.yml file is provided to automatically build Open vSwitch with | |
620 | various build configurations and run the testsuite using travis-ci. | |
621 | Builds will be performed with gcc, sparse and clang with the -Werror | |
622 | compiler flag included, therefore the build will fail if a new warning | |
623 | has been introduced. | |
624 | ||
625 | The CI build is triggered via git push (regardless of the specific | |
626 | branch) or pull request against any Open vSwitch GitHub repository that | |
627 | is linked to travis-ci. | |
628 | ||
629 | Instructions to setup travis-ci for your GitHub repository: | |
630 | ||
35ab726f | 631 | 1. Go to http://travis-ci.org/ and sign in using your GitHub ID. |
8187f55b TG |
632 | 2. Go to the "Repositories" tab and enable the ovs repository. You |
633 | may disable builds for pushes or pull requests. | |
634 | 3. In order to avoid forks sending build failures to the upstream | |
635 | mailing list, the notification email recipient is encrypted. If you | |
636 | want to receive email notification for build failures, replace the | |
637 | the encrypted string: | |
638 | 3.1) Install the travis-ci CLI (Requires ruby >=2.0): | |
639 | gem install travis | |
640 | 3.2) In your Open vSwitch repository: | |
641 | travis encrypt mylist@mydomain.org | |
642 | 3.3) Add/replace the notifications section in .travis.yml and fill | |
643 | in the secure string as returned by travis encrypt: | |
644 | ||
645 | notifications: | |
646 | email: | |
647 | recipients: | |
648 | - secure: "....." | |
649 | ||
650 | (You may remove/omit the notifications section to fall back to | |
651 | default notification behaviour which is to send an email directly | |
652 | to the author and committer of the failing commit. Note that the | |
653 | email is only sent if the author/committer have commit rights for | |
654 | the particular GitHub repository). | |
655 | ||
656 | 4. Pushing a commit to the repository which breaks the build or the | |
657 | testsuite will now trigger a email sent to mylist@mydomain.org | |
658 | ||
4b11d5e8 | 659 | Bug Reporting |
e3c7ed29 | 660 | ============= |
4b11d5e8 | 661 | |
37ea6436 | 662 | Please report problems to bugs@openvswitch.org. |
9feb1017 TG |
663 | |
664 | [README.md]:README.md | |
665 | [INSTALL.Debian.md]:INSTALL.Debian.md | |
666 | [INSTALL.Fedora.md]:INSTALL.Fedora.md | |
667 | [INSTALL.RHEL.md]:INSTALL.RHEL.md | |
668 | [INSTALL.XenServer.md]:INSTALL.XenServer.md | |
669 | [INSTALL.NetBSD.md]:INSTALL.NetBSD.md | |
670 | [INSTALL.DPDK.md]:INSTALL.DPDK.md | |
671 | [INSTALL.userspace.md]:INSTALL.userspace.md | |
672 | [FAQ.md]:FAQ.md |