X-Git-Url: https://osm.etsi.org/gitweb/?a=blobdiff_plain;f=README.md;h=93e033d4cef2e85500f5124d6c2d0125f8dcbdb5;hb=345776321aeb7cc4a5e1be8fbdeedfc3ef59e4b6;hp=6309f7c181664cdd5a2c00f20c12c9e999c24d97;hpb=726a45874fda781f19d1bc1c21b18ba8526e2c19;p=osm%2Fvim-emu.git

diff --git a/README.md b/README.md
old mode 100644
new mode 100755
index 6309f7c..93e033d
--- a/README.md
+++ b/README.md
@@ -1,35 +1,61 @@
-# Distributed Cloud Emulator
-
-Contributors:
+[![Build Status](http://jenkins.sonata-nfv.eu/buildStatus/icon?job=son-emu)](http://jenkins.sonata-nfv.eu/job/son-emu)
 
-* Manuel Peuster <manuel.peuster@upb.de>
+# Distributed Cloud Emulator
 
+### Lead Developers
+The following lead developers are responsible for this repository and have admin rights. They can, for example, merge pull requests.
+
+* Manuel Peuster (mpeuster)
+* Steven Van Rossem (stevenvanrossem)
+
+### Environment
+* Python 2.7
+* Latest [Containernet](https://github.com/mpeuster/containernet) installed on the system
+
+### Dependencies
+* pyaml (public domain)
+* zerorpc (MIT)
+* tabulate (public domain)
+* argparse (Python software foundation license)
+* networkx (BSD)
+* six>=1.9 (MIT)
+* ryu (Apache 2.0)
+* oslo.config (Apache 2.0)
+* pytest (MIT)
+* pytest-runner (MIT)
+* Flask (BSD)
+* flask_restful (BSD)
+* requests  (Apache 2.0)
+* docker-py (Apache 2.0)
+* paramiko (LGPL)
+
+### 3rd-party code used
+* (none)
 
-### Requirements
-* needs the latest Dockernet to be installed in the system
- * the wrapper uses standard Python imports to use the Dockernet modules
-* Uses ZeroMQ based RPC to open a cloud-like interface that can be used by a demo CLI client
- * pip install import zerorpc
- * This will be replaced / extended by a REST API later
 
 ### Project structure
-* **emuvim/** all emulator code 
+
+* **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
- * **example_topology.py** An example topology script to show how topologies can be specified
+* **ansible/** Ansible install scripts
+* **util/** helper scripts
 
 ### Installation
-Automatic installation is provide through an Ansible playbook.
+Automatic installation is provide through Ansible playbooks.
+
 * Requires: Ubuntu 14.04 LTS
 * `sudo apt-get install ansible git`
 * `sudo vim /etc/ansible/hosts`
 * Add: `localhost ansible_connection=local`
 
-#### 1. Dockernet
-* `git clone https://github.com/mpeuster/dockernet.git`
-* `cd dockernet/ansible`
+#### 1. Containernet
+* `cd`
+* `git clone https://github.com/mpeuster/containernet.git`
+* `cd ~/containernet/ansible`
 * `sudo ansible-playbook install.yml`
 * Wait (and have a coffee) ...
 
@@ -37,51 +63,34 @@ Automatic installation is provide through an Ansible playbook.
 * Fork the repository.
 * `cd`
 * `git clone https://github.com/<user>/son-emu.git`
-* `cd emulator-strawman/ansible`
+* `cd ~/son-emu/ansible`
 * `sudo ansible-playbook install.yml`
 
 
+
 ### Run
+
+In the `~/son-emu` directory:
+
+* During development:
+ * `python setup.py develop`
+* Otherwise, for a classic installation:
+ * `python setup.py install`
 * First terminal:
- * `cd emulator-strawman/emuvim`
- * `sudo python example_topology.py`
+ * `sudo python src/emuvim/examples/simple_topology.py 
+`
 * Second terminal:
- * `cd emulator-strawman/emuvim/cli`
- * `./son-emu-cli compute start -d dc1 -n vnf1`
- * `./son-emu-cli compute start -d dc1 -n vnf2`
- * `./son-emu-cli compute list`
+ * `son-emu-cli compute start -d datacenter1 -n vnf1`
+ * `son-emu-cli compute start -d datacenter1 -n vnf2`
+ * `son-emu-cli compute list`
 * First terminal:
- * `dockernet> vnf1 ping -c 2 vnf2`
-
-
-### TODO
-* DCemulator
- * Advanced network model
-  * improve network management, multiple interfaces per container
-  * API to create multiple networks (per DC?)
-
-
-* Add resource constraints to datacenters
-* Check if we can use the Mininet GUI to visualize our DCs?
-* (Unit tests for zerorpc API endpoint)
-
-
-### Features / Done
-* Define a topology (Python script)
- * Add data centers
- * Add switches and links between the,
-* Define API endpoints in topology
- * call startAPI from topology definition and start it in a own thread
- * make it possible to start different API endpoints for different DCs
-* DCemulator
- * correctly start and connect new compute resources at runtime
- * remove and disconnect compute resources at runtime
- * do IP management for new containers
- * list active compute resources
-* Cloud-like reference API with CLI for demonstrations
- * Write CLI client
- * Start compute (name, DC, image, network)
- * Stop compute
-* Create an Ansible-based automatic installation routine
-* Unit tests
+ * `containernet> vnf1 ping -c 2 vnf2`
+* Second terminal:
+ *  `son-emu-cli monitor get_rate -vnf vnf1`
+
+### Run Unit Tests
+* `cd ~/son-emu`
+* `sudo py.test -v src/emuvim/test/unittests`
 
+### CLI
+* [Full CLI command documentation](https://github.com/sonata-nfv/son-emu/wiki/CLI-Command-Overview)