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