vswitchd: Make the MAC entry aging time configurable.

[sliver-openvswitch.git] / INSTALL.Linux

diff --git a/INSTALL.Linux b/INSTALL.Linux
index e950c05..0d56da6 100644 (file)
--- 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
 
 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
 
 This version of Open vSwitch may be built manually with "configure"
 and "make", as described below.  You may also build Debian packages by


@@ -227,9 +227,22 @@ Prerequisites section, follow the procedure below to build.
         module loading, please include the output from the "dmesg" and
         "modinfo" commands mentioned above.
 
         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.:
 
 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
 =======
 
 Startup
 =======


@@ -242,9 +255,9 @@ 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:
 
 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=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 \
                       --private-key=db:SSL,private_key \
                       --certificate=db:SSL,certificate \
                       --bootstrap-ca-cert=db:SSL,ca_cert \


@@ -280,7 +293,7 @@ also upgrade the database schema:
 
 1. Stop the Open vSwitch daemons, e.g.:
 
 
 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.
 
 
 2. Install the new Open vSwitch release.
 


@@ -294,7 +307,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.:
 
       - 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.
 
 4. Start the Open vSwitch daemons as described under "Building and
    Installing Open vSwitch for Linux" above.