INSTALL.Docker.md: Clarify OVS python library path.

Reported-by: Taekho Nam <[email protected]> Signed-off-by: Gurucharan Shetty <[email protected]> Acked-by: Russell Bryant <[email protected]>
atheurer · Jul 7, 2016 · 8ba510b · 8ba510b
1 parent f0f96ba
commit 8ba510b
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 4 deletions.
diff --git a/AUTHORS b/AUTHORS
@@ -432,6 +432,7 @@ Salvatore Cambria       [email protected]
 Soner Sevinc            [email protected]
 Stephen Hemminger       [email protected]
 Suganya Ramachandran    [email protected]
+Taekho Nam              [email protected]
 Takayuki HAMA           [email protected]
 Teemu Koponen           [email protected]
 Thomas Morin            [email protected]

diff --git a/INSTALL.Docker.md b/INSTALL.Docker.md
@@ -110,10 +110,11 @@ pip install Flask
 ```
 
 Start the Open vSwitch driver on every host where you plan to create your
-containers.
+containers.  (Please read a note on $OVS_PYTHON_LIBS_PATH that is used below
+at the end of this document.)
 
 ```
-ovn-docker-overlay-driver --detach
+PYTHONPATH=$OVS_PYTHON_LIBS_PATH ovn-docker-overlay-driver --detach
 ```
 
 Docker has inbuilt primitives that closely match OVN's logical switches
@@ -257,10 +258,12 @@ Source the openrc file. e.g.:
 ```
 
 Start the network driver and provide your OpenStack tenant password
-when prompted.
+when prompted.  (Please read a note on $OVS_PYTHON_LIBS_PATH that is used below
+at the end of this document.)
 
 ```
-ovn-docker-underlay-driver --bridge breth0 --detach
+PYTHONPATH=$OVS_PYTHON_LIBS_PATH ovn-docker-underlay-driver --bridge breth0 \
+--detach
 ```
 
 From here-on you can use the same Docker commands as described in the
@@ -269,6 +272,18 @@ section 'The "overlay" mode'.
 Please read 'man ovn-architecture' to understand OVN's architecture in
 detail.
 
+Note on $OVS_PYTHON_LIBS_PATH
+=============================
+
+$OVS_PYTHON_LIBS_PATH should point to the directory where Open vSwitch
+python modules are installed.  If you installed Open vSwitch python
+modules via the debian package of 'python-openvswitch' or via pip by
+running 'pip install ovs', you do not need to specify the path.
+If you installed it by following the instructions in INSTALL.md, you
+should specify the path.  The path in that case depends on the options passed
+to ./configure.  (It is usually either '/usr/share/openvswitch/python' or
+'/usr/local/share/openvswitch/python'.)
+
 [INSTALL.md]: INSTALL.md
 [openvswitch-switch.README.Debian]: debian/openvswitch-switch.README.Debian
 [README.RHEL]: rhel/README.RHEL