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