1 How to Install Open vSwitch on Linux, FreeBSD and NetBSD
2 ========================================================
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:
11 - [INSTALL.XenServer.md]
13 - [INSTALL.Windows.md]
19 To compile the userspace programs in the Open vSwitch distribution,
20 you will need the following software:
24 - A C compiler, such as:
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.
32 * MSVC 2013. See [INSTALL.Windows] for additional Windows build
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).
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
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.
51 - Python 2.7. You must also have the Python six library.
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:
63 - A supported Linux kernel version. Please refer to [README.md] for a
64 list of supported versions.
66 For optional support of ingress policing, you must enable kernel
67 configuration options NET_CLS_BASIC, NET_SCH_INGRESS, and
68 NET_ACT_POLICE, either built-in or as modules. (NET_CLS_POLICE is
69 obsolete and not needed.)
71 On kernels before 3.11, the ip_gre module, for GRE tunnels over IP
72 (NET_IPGRE), must not be loaded or compiled in.
74 To configure HTB or HFSC quality of service with Open vSwitch,
75 you must enable the respective configuration options.
77 To use Open vSwitch support for TAP devices, you must enable
80 - To build a kernel module, you need the same version of GCC that
81 was used to build that kernel.
83 - A kernel build directory corresponding to the Linux kernel image
84 the module is to run on. Under Debian and Ubuntu, for example,
85 each linux-image package containing a kernel binary has a
86 corresponding linux-headers package with the required build
89 If you are working from a Git tree or snapshot (instead of from a
90 distribution tarball), or if you modify the Open vSwitch build system
91 or the database schema, you will also need the following software:
93 - Autoconf version 2.63 or later.
95 - Automake version 1.10 or later.
97 - libtool version 2.4 or later. (Older versions might work too.)
99 To run the unit tests, you also need:
101 - Perl. Version 5.10.1 is known to work. Earlier versions should
104 The datapath tests for userspace and Linux datapaths also rely upon:
106 - pyftpdlib. Version 1.2.0 is known to work. Earlier versions should
109 - GNU wget. Version 1.16 is known to work. Earlier versions should
112 The ovs-vswitchd.conf.db(5) manpage will include an E-R diagram, in
113 formats other than plain text, only if you have the following:
115 - "dot" from graphviz (http://www.graphviz.org/).
117 - Perl. Version 5.10.1 is known to work. Earlier versions should
120 If you are going to extensively modify Open vSwitch, please consider
121 installing the following to obtain better warnings:
123 - "sparse" version 0.4.4 or later
124 (http://www.kernel.org/pub/software/devel/sparse/dist/).
128 - clang, version 3.4 or later
130 - “flake8”, along with the “hacking” flake8 plugin (for Python code).
131 The automatic flake8 check that runs against Python code has some
132 warnings enabled that come from the "hacking" flake8 plugin. If it's
133 not installed, the warnings just won't occur until it's run on a system
134 with "hacking" installed.
136 Also, you may find the ovs-dev script found in utilities/ovs-dev.py useful.
138 Installation Requirements
139 -------------------------
141 The machine on which Open vSwitch is to be installed must have the
144 - libc compatible with the libc used for build.
146 - libssl compatible with the libssl used for build, if OpenSSL was
149 - On Linux, the same kernel version configured as part of the build.
151 - For optional support of ingress policing on Linux, the "tc" program
152 from iproute2 (part of all major distributions and available at
153 http://www.linux-foundation.org/en/Net:Iproute2).
155 - Python 2.7. You must also have the Python six library.
157 On Linux you should ensure that /dev/urandom exists. To support TAP
158 devices, you must also ensure that /dev/net/tun exists.
160 Building and Installing Open vSwitch for Linux, FreeBSD or NetBSD
161 =================================================================
163 Once you have installed all the prerequisites listed above in the
164 Base Prerequisites section, follow the procedures below to bootstrap,
165 to configure and to build the code.
167 Bootstrapping the Sources
168 -------------------------
170 This step is not needed if you have downloaded a released tarball.
171 If you pulled the sources directly from an Open vSwitch Git tree or
172 got a Git tree snapshot, then run boot.sh in the top source directory
173 to build the "configure" script.
178 Configuring the Sources
179 -----------------------
181 Configure the package by running the configure script. You can
182 usually invoke configure without any arguments. For example:
186 By default all files are installed under /usr/local. Open vSwitch also
187 expects to find its database in /usr/local/etc/openvswitch by default.
188 If you want to install all files into, e.g., /usr and /var instead of
189 /usr/local and /usr/local/var and expect to use /etc/openvswitch as the default
190 database directory, add options as shown here:
192 `% ./configure --prefix=/usr --localstatedir=/var --sysconfdir=/etc`
194 Note that the Open vSwitch installed with packages like .rpm (e.g. via 'yum
195 install' or 'rpm -ivh') and .deb (e.g. via 'apt-get install' or 'dpkg -i') use
196 the above configure options.
198 By default, static libraries are built and linked against. If you
199 want to use shared libraries instead:
201 `% ./configure --enable-shared`
203 To use a specific C compiler for compiling Open vSwitch user
204 programs, also specify it on the configure command line, like so:
206 `% ./configure CC=gcc-4.2`
208 To use 'clang' compiler:
210 `% ./configure CC=clang`
212 To supply special flags to the C compiler, specify them as CFLAGS on
213 the configure command line. If you want the default CFLAGS, which
214 include "-g" to build debug symbols and "-O2" to enable optimizations,
215 you must include them yourself. For example, to build with the
216 default CFLAGS plus "-mssse3", you might run configure as follows:
218 `% ./configure CFLAGS="-g -O2 -mssse3"`
220 Note that these CFLAGS are not applied when building the Linux
221 kernel module. Custom CFLAGS for the kernel module are supplied
222 using the EXTRA_CFLAGS variable when running make. So, for example:
224 `% make EXTRA_CFLAGS="-Wno-error=date-time"`
226 To build the Linux kernel module, so that you can run the
227 kernel-based switch, pass the location of the kernel build
228 directory on --with-linux. For example, to build for a running
231 `% ./configure --with-linux=/lib/modules/`uname -r`/build`
233 If --with-linux requests building for an unsupported version of
234 Linux, then "configure" will fail with an error message. Please
235 refer to the [FAQ.md] for advice in that case.
237 If you wish to build the kernel module for an architecture other
238 than the architecture of the machine used for the build, you may
239 specify the kernel architecture string using the KARCH variable
240 when invoking the configure script. For example, to build for MIPS
243 `% ./configure --with-linux=/path/to/linux KARCH=mips`
245 If you plan to do much Open vSwitch development, you might want to
246 add --enable-Werror, which adds the -Werror option to the compiler
247 command line, turning warnings into errors. That makes it
248 impossible to miss warnings generated by the build.
250 To build with gcov code coverage support, add --enable-coverage,
253 `% ./configure --enable-coverage`
255 The configure script accepts a number of other options and honors
256 additional environment variables. For a full list, invoke
257 configure with the --help option.
259 You can also run configure from a separate build directory. This
260 is helpful if you want to build Open vSwitch in more than one way
261 from a single source directory, e.g. to try out both GCC and Clang
262 builds, or to build kernel modules for more than one Linux version.
265 `% mkdir _gcc && (cd _gcc && ../configure CC=gcc)`
266 `% mkdir _clang && (cd _clang && ../configure CC=clang)`
268 Under certains loads the ovsdb-server and other components perform
269 better when using the jemalloc memory allocator, instead of the glibc
272 If you wish to link with jemalloc add it to LIBS:
274 `% ./configure LIBS=-ljemalloc`
279 1. Run GNU make in the build directory, e.g.:
283 or if GNU make is installed as "gmake":
287 If you used a separate build directory, run make or gmake from that
293 For improved warnings if you installed "sparse" (see "Prerequisites"),
294 add C=1 to the command line.
296 Some versions of Clang and ccache are not completely compatible.
297 If you see unusual warnings when you use both together, consider
298 disabling ccache for use with Clang.
300 2. Consider running the testsuite. Refer to "Running the Testsuite"
301 below, for instructions.
303 3. Become root by running "su" or another program.
305 4. Run "make install" to install the executables and manpages into the
306 running system, by default under /usr/local.
308 5. If you built kernel modules, you may install and load them, e.g.:
310 `% make modules_install`
311 `% /sbin/modprobe openvswitch`
313 To verify that the modules have been loaded, run "/sbin/lsmod" and
314 check that openvswitch is listed.
316 If the `modprobe` operation fails, look at the last few kernel log
317 messages (e.g. with `dmesg | tail`):
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.:
325 % /sbin/modinfo openvswitch.ko
326 % /sbin/modinfo /lib/modules/`uname -r`/kernel/net/bridge/bridge.ko
329 Compare the "vermagic" lines output by the two commands. If
330 they differ, then Open vSwitch was built for the wrong kernel.
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.
336 6. Initialize the configuration database using ovsdb-tool, e.g.:
338 `% mkdir -p /usr/local/etc/openvswitch`
339 `% ovsdb-tool create /usr/local/etc/openvswitch/conf.db vswitchd/vswitch.ovsschema`
344 Before starting ovs-vswitchd itself, you need to start its
345 configuration database, ovsdb-server. Each machine on which Open
346 vSwitch is installed should run its own copy of ovsdb-server.
347 Configure it to use the database you created during installation (as
348 explained above), to listen on a Unix domain socket, to connect to any
349 managers specified in the database itself, and to use the SSL
350 configuration in the database:
353 % ovsdb-server --remote=punix:/usr/local/var/run/openvswitch/db.sock \
354 --remote=db:Open_vSwitch,Open_vSwitch,manager_options \
355 --private-key=db:Open_vSwitch,SSL,private_key \
356 --certificate=db:Open_vSwitch,SSL,certificate \
357 --bootstrap-ca-cert=db:Open_vSwitch,SSL,ca_cert \
361 (If you built Open vSwitch without SSL support, then omit
362 --private-key, --certificate, and --bootstrap-ca-cert.)
364 Then initialize the database using ovs-vsctl. This is only
365 necessary the first time after you create the database with
366 ovsdb-tool (but running it at any time is harmless):
368 `% ovs-vsctl --no-wait init`
370 Then start the main Open vSwitch daemon, telling it to connect to the
371 same Unix domain socket:
373 `% ovs-vswitchd --pidfile --detach`
375 Now you may use ovs-vsctl to set up bridges and other Open vSwitch
376 features. For example, to create a bridge named br0 and add ports
377 eth0 and vif1.0 to it:
379 `% ovs-vsctl add-br br0`
380 `% ovs-vsctl add-port br0 eth0`
381 `% ovs-vsctl add-port br0 vif1.0`
383 Please refer to ovs-vsctl(8) for more details.
388 When you upgrade Open vSwitch from one version to another, you should
389 also upgrade the database schema:
391 1. Stop the Open vSwitch daemons, e.g.:
394 % kill `cd /usr/local/var/run/openvswitch && cat ovsdb-server.pid ovs-vswitchd.pid`
397 2. Install the new Open vSwitch release by using the same configure options as
398 was used for installing the previous version. If you do not use the same
399 configure options, you can end up with two different versions of Open vSwitch
400 executables installed in different locations.
402 3. Upgrade the database, in one of the following two ways:
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".
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.:
412 `% ovsdb-tool convert /usr/local/etc/openvswitch/conf.db vswitchd/vswitch.ovsschema`
414 4. Start the Open vSwitch daemons as described under "Building and
415 Installing Open vSwitch for Linux, FreeBSD or NetBSD" above.
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:
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.
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'
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.
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.
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.
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
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.
479 Refer to "Testsuites" above for prerequisites.
481 To run all the unit tests in Open vSwitch, one at a time:
483 This takes under 5 minutes on a modern desktop system.
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.
489 To see a list of all the available tests, run:
490 `make check TESTSUITEFLAGS=--list`
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.)
496 To run tests matching a keyword, e.g. "ovsdb":
497 `make check TESTSUITEFLAGS='-k ovsdb'`
499 To see a complete list of test options:
500 `make check TESTSUITEFLAGS=--help`
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
506 If the build was configured with "--enable-coverage" and the "lcov"
507 utility is installed, you can run the testsuite and generate a code
508 coverage report by using "make check-lcov". All of the options for
509 TESTSUITEFLAGS are available, so you can e.g.:
510 `make check-lcov TESTSUITEFLAGS=-j8 -k ovn`
512 If you have "valgrind" installed, then you can also run the testsuite
513 under valgrind by using "make check-valgrind" in place of "make
514 check". All the same options are available via TESTSUITEFLAGS. When
515 you do this, the "valgrind" results for test `<N>` are reported in files
516 named `tests/testsuite.dir/<N>/valgrind.*`. You may find that the
517 valgrind results are easier to interpret if you put "-q" in
518 ~/.valgrindrc, since that reduces the amount of output.
520 Sometimes a few tests may fail on some runs but not others. This is
521 usually a bug in the testsuite, not a bug in Open vSwitch itself. If
522 you find that a test fails intermittently, please report it, since the
523 developers may not have noticed. You can make the testsuite
524 automatically rerun tests that fail, by adding RECHECK=yes to the
525 "make" command line, e.g.:
526 `make check TESTSUITEFLAGS=-j8 RECHECK=yes`
531 OFTest is an OpenFlow protocol testing suite. Open vSwitch includes a
532 Makefile target to run OFTest with Open vSwitch in "dummy mode". In
533 this mode of testing, no packets travel across physical or virtual
534 networks. Instead, Unix domain sockets stand in as simulated
535 networks. This simulation is imperfect, but it is much easier to set
536 up, does not require extra physical or virtual hardware, and does not
537 require supervisor privileges.
539 To run OFTest with Open vSwitch, first read and follow the
540 instructions under "Testsuites" above. Second, obtain a copy of
541 OFTest and install its prerequisites. You need a copy of OFTest that
542 includes commit 406614846c5 (make ovs-dummy platform work again).
543 This commit was merged into the OFTest repository on Feb 1, 2013, so
544 any copy of OFTest more recent than that should work. Testing OVS in
545 dummy mode does not require root privilege, so you may ignore that
548 Optionally, add the top-level OFTest directory (containing the "oft"
549 program) to your $PATH. This slightly simplifies running OFTest later.
551 To run OFTest in dummy mode, run the following command from your Open
552 vSwitch build directory:
553 `make check-oftest OFT=<oft-binary>`
554 where `<oft-binary>` is the absolute path to the "oft" program in
557 If you added "oft" to your $PATH, you may omit the OFT variable
560 By default, "check-oftest" passes "oft" just enough options to enable
561 dummy mode. You can use OFTFLAGS to pass additional options. For
562 example, to run just the basic.Echo test instead of all tests (the
563 default) and enable verbose logging:
564 `make check-oftest OFT=<oft-binary> OFTFLAGS='--verbose -T basic.Echo'`
566 If you use OFTest that does not include commit 4d1f3eb2c792 (oft:
567 change default port to 6653), merged into the OFTest repository in
568 October 2013, then you need to add an option to use the IETF-assigned
570 `make check-oftest OFT=<oft-binary> OFTFLAGS='--port=6653'`
572 Please interpret OFTest results cautiously. Open vSwitch can fail a
573 given test in OFTest for many reasons, including bugs in Open vSwitch,
574 bugs in OFTest, bugs in the "dummy mode" integration, and differing
575 interpretations of the OpenFlow standard and other standards.
577 Open vSwitch has not been validated against OFTest. Please do report
578 test failures that you believe to represent bugs in Open vSwitch.
579 Include the precise versions of Open vSwitch and OFTest in your bug
580 report, plus any other information needed to reproduce the problem.
585 Ryu is an OpenFlow controller written in Python that includes an
586 extensive OpenFlow testsuite. Open vSwitch includes a Makefile target
587 to run Ryu in "dummy mode". See "OFTest" above for an explanation of
590 To run Ryu tests with Open vSwitch, first read and follow the
591 instructions under "Testsuites" above. Second, obtain a copy of Ryu,
592 install its prerequisites, and build it. You do not need to install
593 Ryu (some of the tests do not get installed, so it does not help).
595 To run Ryu tests, run the following command from your Open vSwitch
597 `make check-ryu RYUDIR=<ryu-source-dir>`
598 where `<ryu-source-dir>` is the absolute path to the root of the Ryu
599 source distribution. The default `<ryu-source-dir>` is `$srcdir/../ryu`
600 where $srcdir is your Open vSwitch source directory, so if this
601 default is correct then you make simply run `make check-ryu`.
603 Open vSwitch has not been validated against Ryu. Please do report
604 test failures that you believe to represent bugs in Open vSwitch.
605 Include the precise versions of Open vSwitch and Ryu in your bug
606 report, plus any other information needed to reproduce the problem.
611 Open vSwitch also includes a suite of tests specifically for datapath
612 functionality, which can be run against the userspace or kernel datapaths.
613 If you are developing datapath features, it is recommended that you use
614 these tests and build upon them to verify your implementation.
616 The datapath tests make some assumptions about the environment. They
617 must be run under root privileges on a Linux system with support for
618 network namespaces. For ease of use, the OVS source tree includes a
619 vagrant box to invoke these tests. Running the tests inside Vagrant
620 provides kernel isolation, protecting your development host from kernel
621 panics or configuration conflicts in the testsuite. If you wish to run
622 the tests without using the vagrant box, there are further instructions
627 *Requires Vagrant (version 1.7.0 or later) and a compatible hypervisor*
629 You must bootstrap and configure the sources (steps are in "Building
630 and Installing Open vSwitch for Linux, FreeBSD or NetBSD" above) before
631 you run the steps described here.
633 A Vagrantfile is provided allowing to compile and provision the source
634 tree as found locally in a virtual machine using the following command:
638 This will bring up a Fedora 23 VM by default. If you wish to use a
639 different box or a vagrant backend not supported by the default box,
640 the `Vagrantfile` can be modified to use a different box as base.
642 The VM can be reprovisioned at any time:
646 OVS out-of-tree compilation environment can be set up with:
649 vagrant provision --provision-with configure_ovs,build_ovs
651 This will set up an out-of-tree build environment inside the VM in
652 /root/build. The source code can be found in /vagrant.
654 To recompile and reinstall OVS in the VM using RPM:
657 vagrant provision --provision-with configure_ovs,install_rpm
659 Two provisioners are included to run system tests with the OVS kernel
660 module or with a userspace datapath. This tests are different from
661 the self-tests mentioned above. To run them:
664 vagrant provision --provision-with configure_ovs,test_ovs_kmod,test_ovs_system_userspace
666 The results of the testsuite reside in the VM root user's home directory:
675 The datapath testsuite as invoked by Vagrant above may also be run
676 manually on a Linux system with root privileges. These tests may take
677 several minutes to complete, and cannot be run in parallel.
679 #### Userspace datapath
681 To invoke the datapath testsuite with the userspace datapath:
683 make check-system-userspace
685 The results of the testsuite are in tests/system-userspace-traffic.dir/.
689 Make targets are also provided for testing the Linux kernel module.
690 Note that these tests operate by inserting modules into the running
691 Linux kernel, so if the tests are able to trigger a bug in the OVS
692 kernel module or in the upstream kernel then the kernel may panic.
694 To run the testsuite against the kernel module which is currently
695 installed on your system:
699 To install the kernel module from the current build directory and
700 run the testsuite against that kernel module:
704 The results of the testsuite are in tests/system-kmod-traffic.dir/.
706 Continuous Integration with Travis-CI
707 -------------------------------------
709 A .travis.yml file is provided to automatically build Open vSwitch with
710 various build configurations and run the testsuite using travis-ci.
711 Builds will be performed with gcc, sparse and clang with the -Werror
712 compiler flag included, therefore the build will fail if a new warning
715 The CI build is triggered via git push (regardless of the specific
716 branch) or pull request against any Open vSwitch GitHub repository that
717 is linked to travis-ci.
719 Instructions to setup travis-ci for your GitHub repository:
721 1. Go to http://travis-ci.org/ and sign in using your GitHub ID.
722 2. Go to the "Repositories" tab and enable the ovs repository. You
723 may disable builds for pushes or pull requests.
724 3. In order to avoid forks sending build failures to the upstream
725 mailing list, the notification email recipient is encrypted. If you
726 want to receive email notification for build failures, replace the
727 the encrypted string:
728 3.1) Install the travis-ci CLI (Requires ruby >=2.0):
730 3.2) In your Open vSwitch repository:
731 travis encrypt mylist@mydomain.org
732 3.3) Add/replace the notifications section in .travis.yml and fill
733 in the secure string as returned by travis encrypt:
740 (You may remove/omit the notifications section to fall back to
741 default notification behaviour which is to send an email directly
742 to the author and committer of the failing commit. Note that the
743 email is only sent if the author/committer have commit rights for
744 the particular GitHub repository).
746 4. Pushing a commit to the repository which breaks the build or the
747 testsuite will now trigger a email sent to mylist@mydomain.org
752 Please report problems to bugs@openvswitch.org.
754 [README.md]:README.md
755 [INSTALL.Debian.md]:INSTALL.Debian.md
756 [INSTALL.Fedora.md]:INSTALL.Fedora.md
757 [INSTALL.RHEL.md]:INSTALL.RHEL.md
758 [INSTALL.XenServer.md]:INSTALL.XenServer.md
759 [INSTALL.NetBSD.md]:INSTALL.NetBSD.md
760 [INSTALL.DPDK.md]:INSTALL.DPDK.md
761 [INSTALL.userspace.md]:INSTALL.userspace.md