install ryu,networkx

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

diff --git a/README.md b/README.md
old mode 100644 (file)
new mode 100755 (executable)
index 92c3655..f58d007
--- a/README.md
+++ b/README.md
@@ -1,16 +1,16 @@
-# 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 
@@ -20,27 +20,61 @@
  * **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 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/emuvim`
  * `sudo python example_topology.py`
 * Second terminal:
- * TODO add CLI commands here (e.g. request the start of a new compute resource)
+ * `cd ~/son-emu/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`
+* First terminal:
+ * `dockernet> vnf1 ping -c 2 vnf2`
+
+### Run Unit Tests
+* `cd ~/son-emu/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
- * ...
-* Cloud-like reference API with CLI for demonstrations
- * Write CLI client
- * Start compute
- * Stop compute
-* Re-factor endpoint API so that API objects can be more or less statless (ask DCEmulator for available DCs instead of maintaining a own list)
-* Create an Ansible-based automatic installation routine
+ * 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
+### Features / Done
 * Define a topology (Python script)
  * Add data centers
  * Add switches and links between the,
@@ -52,3 +86,10 @@
  * 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
+