datapath-windows: Allow NdisSwitchPortTypeSynthetic to be updated
[cascardo/ovs.git] / INSTALL.Docker.md
index ddbef99..6bd5660 100644 (file)
@@ -2,10 +2,9 @@ How to Use Open vSwitch with Docker
 ====================================
 
 This document describes how to use Open vSwitch with Docker 1.2.0 or
-later.  This document assumes that you followed [INSTALL.md] or installed
-Open vSwitch from distribution packaging such as a .deb or .rpm.  Consult
-www.docker.com for instructions on how to install or .rpm.  Consult
-www.docker.com for instructions on how to install Docker.
+later.  This document assumes that you installed Open vSwitch by following
+[INSTALL.md] or by using the distribution packages such as .deb or .rpm.
+Consult www.docker.com for instructions on how to install Docker.
 
 Limitations
 -----------
@@ -76,8 +75,22 @@ and del-port[s] commands.
 
 Once a container interface is added to an Open vSwitch bridge, one can
 set VLANs, create Tunnels, add OpenFlow rules etc for more network control.
+Many times, it is important that the underlying network infrastructure is
+plumbed (or programmed) before the application inside the container starts.
+To handle this, one can create a micro-container, attach an Open vSwitch
+interface to that container, set the UUIDS in OVSDB as mentioned in
+[IntegrationGuide.md] and then program the bridge to handle traffic coming out
+of that container. Now, you can start the main container asking it
+to share the network of the micro-container. When your application starts,
+the underlying network infrastructure would be ready. e.g.:
+
+```
+% docker run -d --net=container:$MICROCONTAINER_ID ubuntu:14.04 /bin/sh -c \
+"while true; do echo hello world; sleep 1; done"
+```
+
 Please read the man pages of ovs-vsctl, ovs-ofctl, ovs-vswitchd,
-ovsdb-server ovs-vswitchd.conf.db etc for more details.
+ovsdb-server and ovs-vswitchd.conf.db etc for more details about Open vSwitch.
 
 Docker networking is quite flexible and can be used in multiple ways.  For more
 information, please read:
@@ -89,3 +102,4 @@ Bug Reporting
 Please report problems to bugs@openvswitch.org.
 
 [INSTALL.md]:INSTALL.md
+[IntegrationGuide.md]:IntegrationGuide.md