debian: install openvswitch kernel module under "updates" directory

[cascardo/ovs.git] / INSTALL.XenServer

diff --git a/INSTALL.XenServer b/INSTALL.XenServer
index 7a4dd76..bb5f262 100644 (file)
--- a/INSTALL.XenServer
+++ b/INSTALL.XenServer
@@ -36,6 +36,11 @@ RPMs for Citrix XenServer is the DDK VM available from Citrix.
    "openvswitch", "openvswitch-modules-xen", and
    "openvswitch-debuginfo".
 
+   The above command automatically runs the Open vSwitch unit tests.
+   To disable the unit tests, run:
+
+       rpmbuild -bb --without check xenserver/openvswitch-xen.spec
+
 Build Parameters
 ----------------
 
@@ -73,6 +78,18 @@ where:
     The "xen" flavor is the main running kernel flavor and the "kdump" flavor is
     the crashdump kernel flavor. Commonly, one would specify "xen" here.
 
+For XenServer 6.5 or above, the kernel version naming no longer contains
+KERNEL_FLAVOR.  In fact, only providing the `uname -r` output is enough.
+So, the final "rpmbuild" step changes to:
+
+   ```
+   KERNEL_UNAME=<`uname -r` output>
+   rpmbuild \
+        -D "kenel_uname $KERNEL_UNAME" \
+        -bb xenserver/openvswitch-xen.spec
+   ```
+
+
 Installing Open vSwitch for XenServer
 -------------------------------------
 
@@ -158,13 +175,24 @@ command.  The plugin script does roughly the following:
         * If XAPI is configured for a manager, configures the OVS
           manager to match with "ovs-vsctl set-manager".
 
-The Open vSwitch boot sequence only configures an OVS configuration
+Notes
+-----
+
+* The Open vSwitch boot sequence only configures an OVS configuration
 database manager.  There is no way to directly configure an OpenFlow
 controller on XenServer and, as a consequence of the step above that
 deletes all of the bridges at boot time, controller configuration only
 persists until XenServer reboot.  The configuration database manager
 can, however, configure controllers for bridges.  See the BUGS section
-of ovs-controller(8) for more information on this topic.
+of test-controller(8) for more information on this topic.
+
+* The Open vSwitch startup script automatically adds a firewall rule
+to allow GRE traffic. This rule is needed for the XenServer feature
+called "Cross-Host Internal Networks" (CHIN) that uses GRE. If a user
+configures tunnels other than GRE (ex: VXLAN, LISP), they will have
+to either manually add a iptables firewall rule to allow the tunnel traffic
+or add it through a startup script (Please refer to the "enable-protocol"
+command in the ovs-ctl(8) manpage).
 
 Reporting Bugs
 --------------