X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=INSTALL.Linux;h=8ec82a25a43f088cf419e034545601fe82bedd77;hb=4b9fd100e8dbd3d7c2945d2916d563b5d703cdae;hp=d5a3b7d651733d606acaea07d41c50ce09ccc471;hpb=8b055d92533271b05843f4b62fa98aba5e7ce90a;p=sliver-openvswitch.git diff --git a/INSTALL.Linux b/INSTALL.Linux index d5a3b7d65..8ec82a25a 100644 --- a/INSTALL.Linux +++ b/INSTALL.Linux @@ -3,7 +3,7 @@ This document describes how to build and install Open vSwitch on a generic Linux host. If you want to install Open vSwitch on a Citrix -XenServer version 5.5.0, see INSTALL.XenServer instead. +XenServer, see INSTALL.XenServer instead. This version of Open vSwitch may be built manually with "configure" and "make", as described below. You may also build Debian packages by @@ -20,6 +20,8 @@ you will need the following software: - The GNU C compiler. We generally test with version 4.1, 4.2, or 4.3. + - pkg-config. We test with version 0.22. + - libssl, from OpenSSL, is optional but recommended if you plan to connect the Open vSwitch to an OpenFlow controller. libssl is required to establish confidentiality and authenticity in the @@ -52,6 +54,9 @@ INSTALL.userspace for more information. be compiled with IPv6 support (CONFIG_IPV6). This allows for special handling (such as path MTU discovery) of IPv6 packets. + To configure HTB or HFSC quality of service with Open vSwitch, + you must enable the respective configuration options. + To use Open vSwitch support for TAP devices, you must enable CONFIG_TUN. @@ -65,15 +70,13 @@ INSTALL.userspace for more information. infrastructure. If you are working from a Git tree or snapshot (instead of from a -distribution tarball), or if you modify the Open vSwitch build system, -you will also need the following software: +distribution tarball), or if you modify the Open vSwitch build system +or the database schema, you will also need the following software: - Autoconf version 2.64 or later. - Automake version 1.10 or later. - - pkg-config. We test with version 0.22. - - Python 2.x, for x >= 4. If you modify the ovsdbmonitor tool, then you will also need the @@ -81,12 +84,22 @@ following: - pyuic4 from PyQt4 (http://www.riverbankcomputing.co.uk). +To run the unit tests, you also need: + + - Perl. Version 5.10.1 is known to work. Earlier versions should + also work. + If you modify the vswitchd database schema, then the E-R diagram in the ovs-vswitchd.conf.db(5) manpage will be updated properly only if you have the following: - "dot" from graphviz (http://www.graphviz.org/). + - Perl. Version 5.10.1 is known to work. Earlier versions should + also work. + + - Python 2.x, for x >= 4. + Installation Requirements ------------------------- @@ -227,9 +240,22 @@ Prerequisites section, follow the procedure below to build. module loading, please include the output from the "dmesg" and "modinfo" commands mentioned above. + There is an optional module parameter to openvswitch_mod.ko called + vlan_tso that enables TCP segmentation offload over VLANs on NICs + that support it. Many drivers do not expose support for TSO on VLANs + in a way that Open vSwitch can use but there is no way to detect + whether this is the case. If you know that your particular driver can + handle it (for example by testing sending large TCP packets over VLANs) + then passing in a value of 1 may improve performance. Modules built for + Linux kernels 2.6.37 and later, as well as specially patched versions + of earlier kernels, do not need this and do not have this parameter. If + you do not understand what this means or do not know if your driver + will work, do not set this. + 7. Initialize the configuration database using ovsdb-tool, e.g.: - % ovsdb-tool create /usr/local/etc/ovs-vswitchd.conf.db vswitchd/vswitch.ovsschema + % mkdir -p /usr/local/etc/openvswitch + % ovsdb-tool create /usr/local/etc/openvswitch/conf.db vswitchd/vswitch.ovsschema Startup ======= @@ -242,14 +268,17 @@ installation, 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 /usr/local/etc/ovs-vswitchd.conf.db \ + % ovsdb-server /usr/local/etc/openvswitch/conf.db \ --remote=punix:/usr/local/var/run/openvswitch/db.sock \ - --remote=db:Open_vSwitch,managers \ + --remote=db:Open_vSwitch,manager_options \ --private-key=db:SSL,private_key \ --certificate=db:SSL,certificate \ --bootstrap-ca-cert=db:SSL,ca_cert \ --pidfile --detach +(If you built Open vSwitch without SSL support, then omit +--private-key, --certificate, and --bootstrap-ca-cert.) + 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): @@ -280,7 +309,7 @@ also upgrade the database schema: 1. Stop the Open vSwitch daemons, e.g.: - % ovs-kill ovsdb-server.pid ovs-vswitchd.pid + % kill `cd /usr/local/var/run && cat ovsdb-server.pid ovs-vswitchd.pid` 2. Install the new Open vSwitch release. @@ -294,7 +323,7 @@ also upgrade the database schema: - If you want to preserve the contents of your database, back it up first, then use "ovsdb-tool convert" to upgrade it, e.g.: - % ovsdb-tool convert /usr/local/etc/ovs-vswitchd.conf.db vswitchd/vswitch.ovsschema + % ovsdb-tool convert /usr/local/etc/openvswitch/conf.db vswitchd/vswitch.ovsschema 4. Start the Open vSwitch daemons as described under "Building and Installing Open vSwitch for Linux" above.