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