From: peusterm <manuel.peuster@uni-paderborn.de>
Date: Tue, 2 Feb 2016 16:03:19 +0000 (+0100)
Subject: Merge branch 'master' of github.com:mpeuster/son-emu
X-Git-Tag: v3.1~185^2
X-Git-Url: https://osm.etsi.org/gitweb/?a=commitdiff_plain;h=7303abc38b4751466953c8db55815c63df6687ac;p=osm%2Fvim-emu.git

Merge branch 'master' of github.com:mpeuster/son-emu
---

7303abc38b4751466953c8db55815c63df6687ac
diff --cc .gitignore
index ba74660,1dbc687..5cbc2c6
--- a/.gitignore
+++ b/.gitignore
@@@ -1,7 -1,8 +1,9 @@@
  # Byte-compiled / optimized / DLL files
  __pycache__/
  *.py[cod]
+ *$py.class
+ 
 +
  # C extensions
  *.so
  
@@@ -55,3 -57,6 +58,7 @@@ docs/_build
  
  # PyBuilder
  target/
+ 
+ #Ipython Notebook
+ .ipynb_checkpoints
++
diff --cc README.md
index a6b4e5d,4cd094a..6309f7c
--- a/README.md
+++ b/README.md
@@@ -1,86 -1,1 +1,87 @@@
 -# son-emu
 +# Distributed Cloud Emulator
 +
 +Contributors:
 +
 +* Manuel Peuster <manuel.peuster@upb.de>
 +
 +
 +### 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
 +
 +### Project structure
 +* **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 an Ansible playbook.
 +* Requires: Ubuntu 14.04 LTS
 +* `sudo apt-get install ansible git`
 +* `sudo vim /etc/ansible/hosts`
 +* Add: `localhost ansible_connection=local`
 +
 +#### 1. Dockernet
 +* `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 emulator-strawman/ansible`
 +* `sudo ansible-playbook install.yml`
 +
 +
 +### Run
 +* First terminal:
 + * `cd emulator-strawman/emuvim`
 + * `sudo python example_topology.py`
 +* Second terminal:
 + * `cd emulator-strawman/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`
 +
 +
 +### TODO
 +* DCemulator
 + * Advanced network model
 +  * improve network management, multiple interfaces per container
 +  * API to create multiple networks (per DC?)
 +
 +
 +* Add resource constraints to datacenters
 +* Check if we can use the Mininet GUI to visualize our DCs?
 +* (Unit tests for zerorpc API 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
++