* (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
#### 1. Dockernet
* `cd`
-* `git clone https://github.com/mpeuster/dockernet.git`
+* `git clone -b dockernet-sonata https://github.com/mpeuster/dockernet.git`
* `cd ~/dockernet/ansible`
* `sudo ansible-playbook install.yml`
* Wait (and have a coffee) ...
### Run
* First terminal:
- * `cd ~/son-emu/emuvim`
+ * `cd ~/son-emu/src/emuvim`
* `sudo python example_topology.py`
* Second terminal:
- * `cd ~/son-emu/emuvim/cli`
- * `./son-emu-cli compute start -d dc1 -n vnf1`
- * `./son-emu-cli compute start -d dc1 -n vnf2`
+ * `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/emuvim`
+* `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)
-
-### TODO
-* DCemulator
- * Advanced network model
- * improve network management, multiple interfaces per container
- * API to create multiple networks (per DC?)
-* SDN Controller
- * simple API to chain running VNFs
-* Add resource constraints to datacenters
-* Check if we can use the Mininet GUI to visualize our DCs?
-* (Unit tests for zerorpc API endpoint, and any other new 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
-