X-Git-Url: https://osm.etsi.org/gitweb/?a=blobdiff_plain;f=README.md;h=e2b66587dda3de27046048fd928cfeb40587a714;hb=9a9bd45b0879a3484990c2efc0106c006ecafe27;hp=0ee1d9e5290eafb6f86ecd7ff305258943a7d4fd;hpb=db05bfd96fc98ec1e688521ced5f84b2c569f06d;p=osm%2Fvim-emu.git

diff --git a/README.md b/README.md
old mode 100644
new mode 100755
index 0ee1d9e..e2b6658
--- a/README.md
+++ b/README.md
@@ -1,15 +1,69 @@
-# emulator-strawman
+# Distributed Cloud Emulator
 
-(c) 2015 by Manuel Peuster
+Contributors:
 
+* Manuel Peuster <manuel.peuster@upb.de>
 
-## emu-vim
 
-### TODO
+### Requirements
+* 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
+* **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
+ * **test/** Unit tests
+ * **example_topology.py** An example topology script to show how topologies can be specified
+
+### Installation
+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
+* `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/<user>/son-emu.git`
+* `cd ~/son-emu/ansible`
+* `sudo ansible-playbook install.yml`
+
+
+### Run
+* First terminal:
+ * `cd ~/son-emu/src/emuvim`
+ * `sudo python example_topology.py`
+* Second terminal:
+ * `cd ~/son-emu/src/emuvim/cli`
+ * `./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/src/emuvim`
+* `sudo python test` or `sudo python test -v` for more outputs
+
+### CLI
+* [Full CLI command documentation](https://github.com/sonata-nfv/son-emu/wiki/CLI-Command-Overview)
 
-* Add runtime API
-** call startAPI from topology definition and start it in a own thread?
-** make it possible to start different API endpoints for different DCs?
-* Add resource constraints to datacenters
-* Add constraints to Links
-* Check if we can use the Mininet GUI to visualize our DCs?
\ No newline at end of file