X-Git-Url: https://osm.etsi.org/gitweb/?a=blobdiff_plain;ds=sidebyside;f=README.md;h=734fad660bc0886a8e955989d83ca14241084e94;hb=6b9bf57784ccc3da1ef80eb50ec37897b19ccb07;hp=22a94b168309ca0b24a44367f4515b77a0476a80;hpb=293cbc3515b371d2029fdfd624ae6ae38ced77a9;p=osm%2Fvim-emu.git diff --git a/README.md b/README.md old mode 100644 new mode 100755 index 22a94b1..734fad6 --- a/README.md +++ b/README.md @@ -1,54 +1,69 @@ -# 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 - -### Run -* First terminal: - * `sudo python example_topology.py` -* 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 +[![Build Status](http://jenkins.sonata-nfv.eu/buildStatus/icon?job=son-emu)](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.