Completed dependency list in setup.py, README, ansible playbook

[osm/vim-emu.git] / README.md

diff --git a/README.md b/README.md
old mode 100644 (file)
new mode 100755 (executable)
index 22a94b1..32a4652
--- a/README.md
+++ b/README.md
@@ -1,54 +1,91 @@
-# emulator-strawman
+[![Build Status](http://jenkins.sonata-nfv.eu/buildStatus/icon?job=son-emu)](http://jenkins.sonata-nfv.eu/job/son-emu)
 
-(c) 2015 by Manuel Peuster
+# Distributed Cloud Emulator
 
+## Lead Developers
+The following lead developers are responsible for this repository and have admin rights. They can, for example, merge pull requests.
 
-## 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
+* Manuel Peuster (mpeuster)
+* Steven Van Rossem (stevenvanrossem)
+
+
+### Dependencies
+* needs the latest [Dockernet](https://github.com/mpeuster/dockernet) to be installed on the system
+* pyaml
+* zerorpc
+* tabulate
+* argparse
+* networkx
+* six>=1.9
+* ryu
+* oslo.config
+* pytest
+* pytest-runner
+* Flask
+* flask_restful
+* requests 
+* docker-py
+
 
 ### 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
+ * **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`
+* 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/examples/simple_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:
- * `sudo python example_topology.py`
+ * `dockernet> vnf1 ping -c 2 vnf2`
 * Second terminal:
- * TODO add CLI commands here (e.g. request the start of a new compute resource)
-
-
-### TODO
-* DCemulator
- * ...
-* Write unit tests
-* Create an Ansible-based automatic installation routine
-* Add resource constraints to datacenters
-* Check if we can use the Mininet GUI to visualize our DCs?
-
-
-### 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
- * Stop compute
+ *  `son-emu-cli monitor get_rate -vnf vnf1`
+
+### 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)
+