X-Git-Url: https://osm.etsi.org/gitweb/?a=blobdiff_plain;f=README.md;h=68e50877f62e575e7a1740a91c13c863dbb90fd5;hb=7f89ec08278873d335e15a9cf39034692c666bff;hp=59cd0927bc6e4a75581e3512213e2318fa5bd5ca;hpb=45dce6172f28aab5b2c6af52a04e426cf9f18aee;p=osm%2Fvim-emu.git

diff --git a/README.md b/README.md
old mode 100644
new mode 100755
index 59cd092..68e5087
--- a/README.md
+++ b/README.md
@@ -1,19 +1,19 @@
-# emulator-strawman
+# Distributed Cloud Emulator
 
-(c) 2015 by Manuel Peuster
+Contributors:
 
+* Manuel Peuster <manuel.peuster@upb.de>
 
-## emu-vim
 
 ### 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
+* 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)
 
 ### 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
@@ -21,65 +21,54 @@
  * **example_topology.py** An example topology script to show how topologies can be specified
 
 ### 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`
+* `cd`
+* `git clone -b dockernet-sonata https://github.com/mpeuster/dockernet.git`
+* `cd ~/dockernet/ansible`
 * `sudo ansible-playbook install.yml`
 * Wait (and have a coffee) ...
 
 #### 2. Emulator
+* Fork the repository.
 * `cd`
-* `git clone https://github.com/mpeuster/emulator-strawman.git`
-* `cd emulator-strawman/ansible`
+* `git clone https://github.com/<user>/son-emu.git`
+* `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/example_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`
+* 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)
 
+### CLI
+* [Full CLI command documentation](https://github.com/sonata-nfv/son-emu/wiki/CLI-Command-Overview)
 
-### 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