From: peusterm <manuel.peuster@uni-paderborn.de>
Date: Wed, 9 Mar 2016 12:03:37 +0000 (+0100)
Subject: Cleanup and README.md update based on inputs of WP5 call today.
X-Git-Tag: v3.1~164^2~1
X-Git-Url: https://osm.etsi.org/gitweb/?a=commitdiff_plain;h=e6b2b30a7666e24a349cc1920d99a1b07fc2ea5f;p=osm%2Fvim-emu.git

Cleanup and README.md update based on inputs of WP5 call today.
---

diff --git a/README.md b/README.md
index eefb97c..8c306d4 100755
--- a/README.md
+++ b/README.md
@@ -1,28 +1,44 @@
+[![Build Status](http://jenkins.sonata-nfv.eu/buildStatus/icon?job=son-emu)](http://jenkins.sonata-nfv.eu/job/son-emu)
+
 # Distributed Cloud Emulator
 
-Lead developers (able to merge pull requests):
+## Lead Developers
+The following lead developers are responsible for this repository and have admin rights. They can, for example, merge pull requests.
+
 
-* Manuel Peuster <manuel.peuster@upb.de>
-* Steven Van Rossem <steven.vanrossem@intec.ugent.be>
+* Manuel Peuster (mpeuster)
+* Steven Van Rossem (stevenvanrossem)
 
 
-### Requirements
+### Dependencies
 * needs the latest [Dockernet](https://github.com/mpeuster/dockernet) to be installed on the system
- * the emulator is implemented against Dockernet's APIs
-* The emulator uses ZeroMQ based RPC to for communication between demo CLI client and cloud-like APIs
- * `pip install zerorpc`
- * (This will be replaced / extended by a REST API later)
+* pyaml
+* zerorpc
+* tabulate
+* argparse
+* networkx
+* six>=1.9
+* ryu
+* oslo.config
+* pytest
+* pytest-runner
+* Flask
+* flask_restful
 
 ### Project structure
+
 * **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
+ * **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 Ansible playbooks.
+
 * Requires: Ubuntu 14.04 LTS
 * `sudo apt-get install ansible git`
 * `sudo vim /etc/ansible/hosts`
@@ -63,10 +79,6 @@ In the `~/son-emu` directory:
 * Second terminal:
  *  `son-emu-cli monitor get_rate -vnf vnf1`
 
-#### Example scripts:
- * `./start_dcnetwork` starts an example datacenter network with monitoring api endpoint
- * `./start_example_chain` sets up an example service chain, using the example docker container from `package_samples` https://github.com/sonata-nfv/packaging_samples/tree/master/VNFs
-
 ### 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)
diff --git a/setup.py b/setup.py
index 1973326..cde045b 100644
--- a/setup.py
+++ b/setup.py
@@ -17,7 +17,7 @@ setup(name='emuvim',
           'networkx',
           'six>=1.9',
           'ryu',
-          'oslo.config',
+          'ryu',
           'pytest',
           'Flask',
           'flask_restful'
diff --git a/start_dcnetwork b/start_dcnetwork
deleted file mode 100755
index 7280054..0000000
--- a/start_dcnetwork
+++ /dev/null
@@ -1,7 +0,0 @@
-#!/bin/bash
-
-# start DC Network
-python src/emuvim/examples/simple_topology.py
-
-
-
diff --git a/start_example_chain b/start_example_chain
deleted file mode 100755
index 9a130a6..0000000
--- a/start_example_chain
+++ /dev/null
@@ -1,15 +0,0 @@
-#!/bin/bash
-
-
-# deploy VNFs
-son-emu-cli compute start -d datacenter1 -n tsrc -i traffic_source -c ./start.sh
-son-emu-cli compute start -d datacenter2 -n fw -i firewall -c ./start.sh
-son-emu-cli compute start -d long_data_center_name3 -n tsink -i traffic_sink -c ./start.sh
-
-# setup links in the chain
-son-emu-cli network add -src tsrc -dst fw
-son-emu-cli network add -src fw -dst tsink
-son-emu-cli network add -src tsink -dst tsrc
-
-
-
diff --git a/utils/start_example_chain.sh b/utils/start_example_chain.sh
new file mode 100755
index 0000000..9a130a6
--- /dev/null
+++ b/utils/start_example_chain.sh
@@ -0,0 +1,15 @@
+#!/bin/bash
+
+
+# deploy VNFs
+son-emu-cli compute start -d datacenter1 -n tsrc -i traffic_source -c ./start.sh
+son-emu-cli compute start -d datacenter2 -n fw -i firewall -c ./start.sh
+son-emu-cli compute start -d long_data_center_name3 -n tsink -i traffic_sink -c ./start.sh
+
+# setup links in the chain
+son-emu-cli network add -src tsrc -dst fw
+son-emu-cli network add -src fw -dst tsink
+son-emu-cli network add -src tsink -dst tsrc
+
+
+
diff --git a/utils/start_example_topology.sh b/utils/start_example_topology.sh
new file mode 100755
index 0000000..eca74e1
--- /dev/null
+++ b/utils/start_example_topology.sh
@@ -0,0 +1,7 @@
+#!/bin/bash
+
+# start DC Network
+python ../src/emuvim/examples/simple_topology.py
+
+
+