tests: Add bundle action test with buffer realloc.

[cascardo/ovs.git] / debian / openvswitch-switch.README.Debian

diff --git a/debian/openvswitch-switch.README.Debian b/debian/openvswitch-switch.README.Debian
index 44154bd..5f8f823 100644 (file)
--- a/debian/openvswitch-switch.README.Debian
+++ b/debian/openvswitch-switch.README.Debian
@@ -56,9 +56,10 @@ allow-br0 eth0
 
 The following OVS specific "command" options are supported:
 
-    - ovs_type: This can either be OVSBridge, OVSPort, OVSIntPort, OVSBond or
-      OVSTunnel depending on whether you configure a bridge, port, an internal
-      port, a bond or a tunnel. This is a required option.
+    - ovs_type: This can either be OVSBridge, OVSPort, OVSIntPort, OVSBond,
+      OVSPatchPort or OVSTunnel depending on whether you configure a bridge,
+      port, an internal port, a bond, a patch port or a tunnel. This is a
+      required option.
 
     - ovs_ports: This option specifies all the ports that belong to a bridge.
 
@@ -68,6 +69,9 @@ The following OVS specific "command" options are supported:
     - ovs_bonds: This option specifies the list of physical interfaces to be
       bonded together.
 
+    - ovs_patch_peer: For "OVSPatchPort" interfaces, this field specifies
+      the patch's peer on the other bridge.
+
     - ovs_tunnel_type: For "OVSTunnel" interfaces, the type of the tunnel.
       For example, "gre", "vxlan", etc.
 
@@ -156,7 +160,31 @@ iface bond0 inet manual
     ovs_bonds eth2 eth3
     ovs_options bond_mode=balance-tcp lacp=active
 
-ex 6: Tunnel.
+ex 6: Patch ports.
+
+allow-ovs br0
+iface br0 inet manual
+    ovs_type OVSBridge
+    ovs_ports patch0
+
+allow-br0 patch0
+iface patch0 inet manual
+    ovs_bridge br0
+    ovs_type OVSPatchPort
+    ovs_patch_peer patch1
+
+allow-ovs br1
+iface br1 inet manual
+    ovs_type OVSBridge
+    ovs_ports patch1
+
+allow-br1 patch1
+iface patch1 inet manual
+    ovs_bridge br1
+    ovs_type OVSPatchPort
+    ovs_patch_peer patch0
+
+ex 7: Tunnel.
 
 allow-ovs br1
 iface br1 inet static
@@ -172,7 +200,34 @@ iface gre1 inet manual
     ovs_tunnel_type gre
     ovs_tunnel_options options:remote_ip=182.168.1.2 options:key=1
 
-ex 7: Create and destroy bridges.
+ex 8: Create and destroy bridges.
 
 ifup --allow=ovs $list_of_bridges
 ifdown --allow=ovs $list_of_bridges
+
+Notes on dependencies:
+---------------------
+
+openvswitch-switch depends on $network, $named $remote_fs and $syslog to start.
+This creates some startup dependency issues.
+
+* Since openvswitch utilities are placed in /usr and /usr can be mounted
+through NFS, openvswitch has to start after it.  But if a user uses openvswitch
+for all his networking needs and hence to mount NFS, there will be a deadlock.
+So, if /usr is mounted through NFS and openvswitch is used for all networking,
+the administrator should figure out a way to mount NFS before starting OVS.
+One way to do this is in initramfs.
+
+* Since openvswitch starts after $network, $remote_fs and $syslog, any startup
+script that depends on openvswitch but starts before it, needs to be changed
+to depend on openvswitch-switch too.
+
+* Ideally, an admin should not add openvswitch bridges in the 'auto'
+section of the 'interfaces' file.  This is because, when ifupdown starts
+working on bridges listed in 'auto', openvswitch has not yet started.
+
+But, if the admin wants to go down this route and adds openvswitch bridges
+in the 'auto' section, openvswitch-switch will forcefully be started when
+ifupdown kicks in. In a case like this, the admin needs to make sure that /usr
+has already been mounted and that a remote $syslog (if used) is ready to
+receive openvswitch logs.