-# emulator-strawman
-
-(c) 2015 by Manuel Peuster
-
-
-## 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
-
-### 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
-* `cd`
-* `git clone https://github.com/mpeuster/emulator-strawman.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
- * ...
-
-* 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)
- * Stop compute
-* Create an Ansible-based automatic installation routine
-* Unit tests
+[](http://jenkins.sonata-nfv.eu/job/son-emu)
+
+# son-emu
+This is the repository of [SONATA's](http://sonata-nfv.eu) emulation platform.
+
+This emulation platform was created to support network service developers to locally prototype and test complete network service chains in realistic end-to-end multi-PoP scenarios. It allows the direct execution of real network functions, packaged as Docker containers, in emulated network topologies running locally on the network service developer's machine.
+
+More details about the the emulator's architecture and concepts can be found in the following publication:
+
+* Peuster, Manuel, Holger Karl, and Steven van Rossem. ["MeDICINE: Rapid Prototyping of Production-Ready Network Services in Multi-PoP Environments."](http://arxiv.org/abs/1606.05995) pre-print arXiv:1606.05995 (2016).
+
+## Development
+(if applicable)
+
+### Building
+Describe briefly how to build the software.
+
+### Dependencies
+
+* [argparse](https://pypi.python.org/pypi/argparse) >= 1.4.0 (Python software foundation License)
+* [docker-py](https://pypi.python.org/pypi/docker-py) == 1.7.1(Apache 2.0)
+* [Flask](https://pypi.python.org/pypi/Flask) >= 0.11 (BSD)
+* [flask_restful](https://pypi.python.org/pypi/Flask-RESTful) >= 0.3 (BSD)
+* [networkx](https://pypi.python.org/pypi/networkx/) >= 1.11 (BSD)
+* [oslo.config](http://docs.openstack.org/developer/oslo.config/) >= 3.9.0 (Apache 2.0)
+* [paramiko](https://pypi.python.org/pypi/paramiko/1.16.0) >= 1.6 (LGPL)
+* [prometheus_client](https://pypi.python.org/pypi/prometheus_client) >= 0.0.13 (Apache 2.0)
+* [pyaml](https://pypi.python.org/pypi/pyaml) >=15.8.2 (WTFPL)
+* [pytest-runner](https://pypi.python.org/pypi/pytest-runner) >= 2.8 (MIT)
+* [pytest](https://pypi.python.org/pypi/pytest) >= 2.9 (MIT)
+* [requests](https://pypi.python.org/pypi/requests) >= 2.10 (Apache 2.0)
+* [ryu](https://pypi.python.org/pypi/ryu/4.4) >= 4.4 (Apache 2.0)
+* [six](https://pypi.python.org/pypi/six/) >=1.9 (MIT)
+* [tabulate](https://pypi.python.org/pypi/tabulate) >= 0.7.5 (public domain)
+* [urllib3](https://pypi.python.org/pypi/urllib3) >= 1.15 (MIT)
+* [zerorpc](http://www.zerorpc.io) >= 0.5.2 (MIT)
+
+### Contributing
+(if applicable) Description (encouraging) how to contribute to this project/repository.
+
+## Installation
+(if applicable) Describe briefly how to install the software. You may want to put a link to son-install instead:
+
+The installation of this component can be done using the [son-install](https://github.com/sonata-nfv/son-install) script.
+
+## Usage
+(if applicable) Describe briefly how to use the software.
+
+## License
+
+This [SOFTWARE] is published under Apache 2.0 license. Please see the LICENSE file for more details.
+
+## Useful Links
+
+* Any useful link and brief description. For example:
+* http://www.google/ Don't be evil.
+
+---
+#### Lead Developers
+
+The following lead developers are responsible for this repository and have admin rights. They can, for example, merge pull requests.
+
+* Manuel Peuster (mpeuster)
+* Steven Van Rossem (stevenvanrossem)
+
+#### Feedback-Chanel
+
+* You may use the mailing list sonata-dev@lists.atosresearch.eu
+* Please use the GitHub issues to report bugs.
projects / osm / vim-emu.git / blobdiff