[ovs-dev] INSTALL.Docker.md: Clarify OVS python library path.
diff mbox

Message ID 1467880331-27941-1-git-send-email-guru@ovn.org
State Accepted
Headers show

Commit Message

Guru Shetty July 7, 2016, 8:32 a.m. UTC
Reported-by: Taekho Nam <thnam@smartx.kr>
Signed-off-by: Gurucharan Shetty <guru@ovn.org>
---
 AUTHORS           |  1 +
 INSTALL.Docker.md | 23 +++++++++++++++++++----
 2 files changed, 20 insertions(+), 4 deletions(-)

Comments

Russell Bryant July 7, 2016, 6:57 p.m. UTC | #1
On Thu, Jul 7, 2016 at 3:32 AM, Gurucharan Shetty <guru@ovn.org> wrote:

> Reported-by: Taekho Nam <thnam@smartx.kr>
> Signed-off-by: Gurucharan Shetty <guru@ovn.org>
> ---
>  AUTHORS           |  1 +
>  INSTALL.Docker.md | 23 +++++++++++++++++++----
>  2 files changed, 20 insertions(+), 4 deletions(-)
>
> diff --git a/AUTHORS b/AUTHORS
> index 704ba40..5d86dc6 100644
> --- a/AUTHORS
> +++ b/AUTHORS
> @@ -432,6 +432,7 @@ Salvatore Cambria       salvatore.cambria@citrix.com
>  Soner Sevinc            sevincs@vmware.com
>  Stephen Hemminger       shemminger@vyatta.com
>  Suganya Ramachandran    suganyar@vmware.com
> +Taekho Nam              thnam@smartx.kr
>  Takayuki HAMA           t-hama@cb.jp.nec.com
>  Teemu Koponen           koponen@nicira.com
>  Thomas Morin            thomas.morin@orange.com
> diff --git a/INSTALL.Docker.md b/INSTALL.Docker.md
> index fd082cb..4525b44 100644
> --- 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 python-openvswitch', 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
>

Acked-by: Russell Bryant <russell@ovn.org>

though we should probably fix the install instructions to do a proper
installation of the Python library so this isn't required ...

Patch
diff mbox

diff --git a/AUTHORS b/AUTHORS
index 704ba40..5d86dc6 100644
--- a/AUTHORS
+++ b/AUTHORS
@@ -432,6 +432,7 @@  Salvatore Cambria       salvatore.cambria@citrix.com
 Soner Sevinc            sevincs@vmware.com
 Stephen Hemminger       shemminger@vyatta.com
 Suganya Ramachandran    suganyar@vmware.com
+Taekho Nam              thnam@smartx.kr
 Takayuki HAMA           t-hama@cb.jp.nec.com
 Teemu Koponen           koponen@nicira.com
 Thomas Morin            thomas.morin@orange.com
diff --git a/INSTALL.Docker.md b/INSTALL.Docker.md
index fd082cb..4525b44 100644
--- 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 python-openvswitch', 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