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

diff --git a/README.md b/README.md
old mode 100644
new mode 100755
index 4cd094a..68e5087
--- a/README.md
+++ b/README.md
@@ -1 +1,74 @@
-# son-emu
+# Distributed Cloud Emulator
+
+Contributors:
+
+* Manuel Peuster <manuel.peuster@upb.de>
+
+
+### 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
+
+In the `~/son-emu` directory:
+
+* During development:
+ * `python setup.py develop`
+* Otherwise, for a classic installation:
+ * `python setup.py install`
+* First terminal:
+ * `sudo python src/emuvim/example_topology.py`
+* Second terminal:
+ * `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)
+