X-Git-Url: https://osm.etsi.org/gitweb/?a=blobdiff_plain;f=README.md;h=63f9778b2467c6af472ea4718946a9e4f57137a6;hb=f3bf0e72a2df0a10a62565279a71598f5d9c6e63;hp=f37712f94a61dd082be8976ea3f971b12353a80a;hpb=ee693dc9996b1076fef78f53983195577e574970;p=osm%2Fvim-emu.git

diff --git a/README.md b/README.md
index f37712f..63f9778 100755
--- a/README.md
+++ b/README.md
@@ -27,6 +27,7 @@ The following lead developers are responsible for this repository and have admin
 * flask_restful (BSD)
 * requests  (Apache 2.0)
 * docker-py (Apache 2.0)
+* paramiko (LGPL)
 
 ### 3rd-party code used
 * (none)
@@ -37,7 +38,7 @@ The following lead developers are responsible for this repository and have admin
 * **src/emuvim/** all emulator code 
  * **api/** Data center API endpoint implementations (zerorpc, OpenStack REST, ...)
  * **cli/** CLI client to interact with a running emulator
- * **dcemulator/** Dockernet wrapper that introduces the notion of data centers and API endpoints
+ * **dcemulator/** Containernet wrapper that introduces the notion of data centers and API endpoints
  * **examples/** Example topology scripts
  * **test/** Unit tests
 * **ansible/** Ansible install scripts
@@ -51,10 +52,10 @@ Automatic installation is provide through Ansible playbooks.
 * `sudo vim /etc/ansible/hosts`
 * Add: `localhost ansible_connection=local`
 
-#### 1. Dockernet
+#### 1. Containernet
 * `cd`
-* `git clone -b dockernet-sonata https://github.com/mpeuster/dockernet.git`
-* `cd ~/dockernet/ansible`
+* `git clone https://github.com/mpeuster/containernet.git`
+* `cd ~/containernet/ansible`
 * `sudo ansible-playbook install.yml`
 * Wait (and have a coffee) ...
 
@@ -82,14 +83,22 @@ In the `~/son-emu` directory:
  * `son-emu-cli compute start -d datacenter1 -n vnf2`
  * `son-emu-cli compute list`
 * First terminal:
- * `dockernet> vnf1 ping -c 2 vnf2`
-* Second terminal:
- *  `son-emu-cli monitor get_rate -vnf vnf1`
+ * `containernet> vnf1 ping -c 2 vnf2`
+
 
 ### Run Unit Tests
 * `cd ~/son-emu`
-* `sudo py.test -v src/emuvim` (equivalent to `python setup.py test -v --addopts 'src/emuvim'` but with direct access to the commandline arguments)
+* `sudo py.test -v src/emuvim/test/unittests`
 
 ### CLI
 * [Full CLI command documentation](https://github.com/sonata-nfv/son-emu/wiki/CLI-Command-Overview)
 
+### Vagrant VM creation
+A Vagrantfile allows to automatically create and provision a VM in which son-emu is installed and ready to be used.
+
+* `cd ~/son-emu`
+* `vagrant up`
+* `vagrant ssh` to enter the new VM in which the emulator is installed.
+
+Follow the MOTD in the VM to run the example topology and the fake-gatekeeper. The fake-gatekeeper's default port 5000 is forwarded to the host machine and can be accessed from it by using, e.g., curl http://127.0.0.1:5000/packages.
+