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