X-Git-Url: http://git.cascardo.eti.br/?a=blobdiff_plain;f=INSTALL.md;h=dd4d9651a30b0eb48bd8c9627f8de13576a91fcd;hb=968eec593cc61690c9e0ed97450c4889258381af;hp=8fae214a7e4cda2d1094fcc86c92e58f3f64cd4d;hpb=e9e85443fb72bcbceedc9a7e5d0c9b32ae0f3dad;p=cascardo%2Fovs.git diff --git a/INSTALL.md b/INSTALL.md index 8fae214a7..dd4d9651a 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -10,6 +10,7 @@ on a specific platform, please see one of these files: - [INSTALL.RHEL.md] - [INSTALL.XenServer.md] - [INSTALL.NetBSD.md] + - [INSTALL.Windows.md] - [INSTALL.DPDK.md] Build Requirements @@ -28,6 +29,9 @@ you will need the following software: analysis and thread-safety checks. For Ubuntu, there are nightly built packages available on clang's website. + * MSVC 2013. See [INSTALL.Windows] for additional Windows build + instructions. + While OVS may be compatible with other compilers, optimal support for atomic operations may be missing, making OVS very slow (see lib/ovs-atomic.h). @@ -39,7 +43,12 @@ you will need the following software: libssl is installed, then Open vSwitch will automatically build with support for it. - - Python 2.x, for x >= 4. + - libcap-ng, written by Steve Grubb, is optional but recommended. It + is required to run OVS daemons as a non-root user with dropped root + privileges. If libcap-ng is installed, then Open vSwitch will + automatically build with support for it. + + - Python 2.7. You must also have the Python six library. On Linux, you may choose to compile the kernel module that comes with the Open vSwitch distribution or to use the kernel module built into @@ -110,8 +119,6 @@ formats other than plain text, only if you have the following: - Perl. Version 5.10.1 is known to work. Earlier versions should also work. - - Python 2.x, for x >= 4. - If you are going to extensively modify Open vSwitch, please consider installing the following to obtain better warnings: @@ -122,6 +129,8 @@ installing the following to obtain better warnings: - clang, version 3.4 or later + - flake8 (for Python code) + Also, you may find the ovs-dev script found in utilities/ovs-dev.py useful. Installation Requirements @@ -141,6 +150,8 @@ following software: from iproute2 (part of all major distributions and available at http://www.linux-foundation.org/en/Net:Iproute2). + - Python 2.7. You must also have the Python six library. + On Linux you should ensure that /dev/urandom exists. To support TAP devices, you must also ensure that /dev/net/tun exists. @@ -179,7 +190,7 @@ to install into, e.g., /usr and /var instead of /usr/local and By default, static libraries are built and linked against. If you want to use shared libraries instead: - % ./configure --enable-shared + `% ./configure --enable-shared` To use a specific C compiler for compiling Open vSwitch user programs, also specify it on the configure command line, like so: @@ -190,6 +201,20 @@ To use 'clang' compiler: `% ./configure CC=clang` +To supply special flags to the C compiler, specify them as CFLAGS on +the configure command line. If you want the default CFLAGS, which +include "-g" to build debug symbols and "-O2" to enable optimizations, +you must include them yourself. For example, to build with the +default CFLAGS plus "-mssse3", you might run configure as follows: + + `% ./configure CFLAGS="-g -O2 -mssse3"` + +Note that these CFLAGS are not applied when building the Linux +kernel module. Custom CFLAGS for the kernel module are supplied +using the EXTRA_CFLAGS variable when running make. So, for example: + + `% make EXTRA_CFLAGS="-Wno-error=date-time"` + To build the Linux kernel module, so that you can run the kernel-based switch, pass the location of the kernel build directory on --with-linux. For example, to build for a running @@ -229,7 +254,7 @@ from a single source directory, e.g. to try out both GCC and Clang builds, or to build kernel modules for more than one Linux version. Here is an example: - `% mkdir _gcc && (cd _gcc && ../configure CC=gcc)` + `% mkdir _gcc && (cd _gcc && ../configure CC=gcc)` `% mkdir _clang && (cd _clang && ../configure CC=clang)` @@ -247,12 +272,16 @@ Building the Sources If you used a separate build directory, run make or gmake from that directory, e.g.: - `% make -C _gcc` + `% make -C _gcc` `% make -C _clang` For improved warnings if you installed "sparse" (see "Prerequisites"), add C=1 to the command line. + Some versions of Clang and ccache are not completely compatible. + If you see unusual warnings when you use both together, consider + disabling ccache for use with Clang. + 2. Consider running the testsuite. Refer to "Running the Testsuite" below, for instructions. @@ -263,7 +292,7 @@ Building the Sources 5. If you built kernel modules, you may install and load them, e.g.: - `% make modules_install` + `% make modules_install` `% /sbin/modprobe openvswitch` To verify that the modules have been loaded, run "/sbin/lsmod" and @@ -320,7 +349,7 @@ will work, do not set this. 6. Initialize the configuration database using ovsdb-tool, e.g.: - `% mkdir -p /usr/local/etc/openvswitch` + `% mkdir -p /usr/local/etc/openvswitch` `% ovsdb-tool create /usr/local/etc/openvswitch/conf.db vswitchd/vswitch.ovsschema` Startup @@ -334,12 +363,14 @@ explained above), to listen on a Unix domain socket, to connect to any managers specified in the database itself, and to use the SSL configuration in the database: + ``` % ovsdb-server --remote=punix:/usr/local/var/run/openvswitch/db.sock \ --remote=db:Open_vSwitch,Open_vSwitch,manager_options \ --private-key=db:Open_vSwitch,SSL,private_key \ --certificate=db:Open_vSwitch,SSL,certificate \ --bootstrap-ca-cert=db:Open_vSwitch,SSL,ca_cert \ --pidfile --detach + ``` (If you built Open vSwitch without SSL support, then omit --private-key, --certificate, and --bootstrap-ca-cert.) @@ -348,20 +379,20 @@ Then initialize the database using ovs-vsctl. This is only necessary the first time after you create the database with ovsdb-tool (but running it at any time is harmless): - % ovs-vsctl --no-wait init + `% ovs-vsctl --no-wait init` Then start the main Open vSwitch daemon, telling it to connect to the same Unix domain socket: - % ovs-vswitchd --pidfile --detach + `% ovs-vswitchd --pidfile --detach` Now you may use ovs-vsctl to set up bridges and other Open vSwitch features. For example, to create a bridge named br0 and add ports eth0 and vif1.0 to it: - % ovs-vsctl add-br br0 - % ovs-vsctl add-port br0 eth0 - % ovs-vsctl add-port br0 vif1.0 + `% ovs-vsctl add-br br0` + `% ovs-vsctl add-port br0 eth0` + `% ovs-vsctl add-port br0 vif1.0` Please refer to ovs-vsctl(8) for more details. @@ -579,7 +610,7 @@ report, plus any other information needed to reproduce the problem. Vagrant ------- -Requires: Vagrant and a compatible hypervisor +Requires: Vagrant (version 1.7.0 or later) and a compatible hypervisor You must bootstrap and configure the sources (steps are in "Building and Installing Open vSwitch for Linux, FreeBSD or NetBSD" above) before @@ -592,12 +623,32 @@ tree as found locally in a virtual machine using the following commands: vagrant ssh This will bring up w Fedora 20 VM by default, alternatively the -`Vagrantfile.in` can be modified to use a different distribution box as -base. Also, the VM can be reprovisioned at any time to recompile and -reinstall OVS: +`Vagrantfile` can be modified to use a different distribution box as +base. Also, the VM can be reprovisioned at any time: vagrant provision +OVS out-of-tree compilation environment can be set up with: + + ./boot.sh + vagrant provision --provision-with configure_ovs,build_ovs + +This will set up an out-of-tree build environment in /home/vagrant/build. +The source code can be found in /vagrant. Out-of-tree build is preferred +to work around limitations of the sync file systems. + +To recompile and reinstall OVS using RPM: + + ./boot.sh + vagrant provision --provision-with configure_ovs,install_rpm + +Two provisioners are included to run system tests with the OVS kernel +module or with a userspace datapath. This tests are different from +the self-tests mentioned above. To run them: + + ./boot.sh + vagrant provision --provision-with configure_ovs,test_ovs_kmod,test_ovs_system_userspace + Continuous Integration with Travis-CI -------------------------------------