README warn against virtualenv --system-site-packages

If using --system-site-packages, some system python modules may conflict
with the ones required. For example, the python modules paramiko and gssapi
conflict: if you have both, then "import paramiko" will fail while looking
for gssapi exceptions.

Also rename the sample topology to use the *.example available the
available topologies. "topology.yaml.example" does not exist.

Change-Id: I816177f305ad6f4675c12c64d49d04f075bee817
Signed-off-by: Gabriel Ganne <gabriel.ganne@enea.com>

diff --git a/README b/README
index 2b4fbce..343e3bb 100644 (file)
--- a/README
+++ b/README
@@ -2,13 +2,18 @@
  - install virtualenv
  - generate environment using virtualenv:
     # cd $ROOT
-    # virtualenv --system-site-packages env
+    # virtualenv env
     # source env/bin/activate
  - install python requirements for this project by executing:
     # pip install -r requirements.txt
  - make sure user mentioned in topology.py has NOPASSWD sudo access to
     vpp_api_test
 
+Note:
+You can alternatively create the virtualenv with the flag --system-site-packages
+It give access to the global site-packages dir to the virtual environment, which
+is faster, but you may end up with some conflicts.
+
 
  Done.
 
@@ -16,7 +21,7 @@
 export PYTHONPATH=.
 
 # create topology, edit ip addresses
-cp topologies/available/topology.yaml.example topologies/available/topology.yaml
+cp topologies/available/3_node_hw_topo1.yaml.example topologies/available/topology.yaml
 ln -s ../available/topology.yaml topologies/enabled/topology.yaml
 
 pybot -L TRACE -v TOPOLOGY_PATH:topologies/enabled/topology.yaml tests