-[](http://jenkins.sonata-nfv.eu/job/son-emu)
+# vim-emu: A NFV multi-PoP emulation platform
-# 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 their network services in realistic end-to-end multi-PoP scenarios. It allows the execution of real network functions, packaged as Docker containers, in emulated network topologies running locally on the developer's machine. The emulation platform also offers OpenStack-like APIs for each emulated PoP so that it can integrate with MANO solutions, like OSM. The core of the emulation platform is based on [Containernet](https://containernet.github.io).
-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.
+The emulation platform `vim-emu` is developed as part of OSM's DevOps MDG.
-More details about the the emulator's architecture and concepts can be found in the following publication:
+### Acknowledgments
-* 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).
+This software was originally developed by the [SONATA project](http://www.sonata-nfv.eu), funded by the European Commission under grant number 671517 through the Horizon 2020 and 5G-PPP programs.
-## 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.
+### Cite this work
+
+If you use the emulation platform for your research and/or other publications, please cite the following paper to reference our work:
+
+* M. Peuster, H. Karl, and S. v. Rossem: [MeDICINE: Rapid Prototyping of Production-Ready Network Services in Multi-PoP Environments](http://ieeexplore.ieee.org/document/7919490/). IEEE Conference on Network Function Virtualization and Software Defined Networks (NFV-SDN), Palo Alto, CA, USA, pp. 148-153. doi: 10.1109/NFV-SDN.2016.7919490. (2016)
## 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.
+There are three ways to install and use the emulation platform. The bare-metal installation requires a freshly installed Ubuntu 16.04 LTS and is done by an ansible playbook. The second option is to use a nested Docker environment to run the emulator inside a Docker container. The third option is to use Vagrant to create a VirtualBox-based VM on your machine that contains the pre-installed and configured emulator.
+
+### Option 1: Bare-metal installation
+
+* Requires: Ubuntu 16.04 LTS
+* `sudo apt-get install ansible git aptitude`
+
+#### 1. Containernet
+
+* `cd`
+* `git clone https://github.com/containernet/containernet.git`
+* `cd ~/containernet/ansible`
+* `sudo ansible-playbook -i "localhost," -c local install.yml`
+
+#### 2. vim-emu
+
+* `cd`
+* `git clone https://github.com/sonata-nfv/son-emu.git`
+* `cd ~/son-emu/ansible`
+* `sudo ansible-playbook -i "localhost," -c local install.yml`
+
+### Option 3: Nested Docker Deployment
+This option requires a Docker installation on the host machine on which the emulator should be deployed.
+
+* `git clone https://github.com/sonata-nfv/son-emu.git`
+* `cd ~/son-emu`
+* Build the container: `docker build -t son-emu-img .`
+* Run the (interactive) container: `docker run --name son-emu -it --rm --privileged --pid='host' -v /var/run/docker.sock:/var/run/docker.sock son-emu-img /bin/bash`
+
+### Option 3: Vagrant Installation
+* Request VirtualBox and Vagrant to be installed on the system.
+* `git clone https://github.com/sonata-nfv/son-emu.git`
+* `cd ~/son-emu`
+* `vagrant up`
+* `vagrant ssh` to enter the new VM in which the emulator is installed.
## Usage
-(if applicable) Describe briefly how to use the software.
-## License
+### Example
+
+This simple example shows how to start the emulator with a simple topology (terminal 1) and how to start (terminal 2) some empty VNF containers in the emulated datacenters (PoPs) by using the son-emu-cli.
-This [SOFTWARE] is published under Apache 2.0 license. Please see the LICENSE file for more details.
+* First terminal (start the emulation platform):
+ * `sudo python 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:
+ * `containernet> vnf1 ifconfig`
+ * `containernet> vnf1 ping -c 2 vnf2`
-## Useful Links
+### Further documentation and useful links
-* Any useful link and brief description. For example:
-* http://www.google/ Don't be evil.
+* [Full CLI command documentation](https://github.com/sonata-nfv/son-emu/wiki/CLI-Command-Overview)
+* [Requirements for Docker containers executed by the emulator](https://github.com/sonata-nfv/son-emu/wiki/Container-Requirements)
+* [REST API](https://github.com/sonata-nfv/son-emu/wiki/APIs)
+* [Mininet](http://mininet.org)
+* [Containernet](https://containernet.github.io)
+* [Maxinet](https://maxinet.github.io)
----
-#### Lead Developers
+## Development
+
+### How to contribute?
+
+Please check [this OSM wiki page](https://osm.etsi.org/wikipub/index.php/Workflow_with_OSM_tools) to learn how to contribute to a OSM module.
+
+### Testing
+
+To run the unit tests do:
+
+* `cd ~/son-emu`
+* `sudo py.test -v src/emuvim/test/unittests`
+(To force Python2: `python2 -m pytest -v src/emuvim/test/unittests`)
+
+## Seed code contributors:
+
+### Lead:
+
+* Manuel Peuster (https://github.com/mpeuster)
+* Steven Van Rossem (https://github.com/stevenvanrossem)
+
+### Contributors
+
+* Hadi Razzaghi Kouchaksaraei (https://github.com/hadik3r)
+* Wouter Tavernier (https://github.com/wtaverni)
+* Geoffroy Chollon (https://github.com/cgeoffroy)
+* Eduard Maas (https://github.com/edmaas)
+* Malte Splietker (https://github.com/splietker)
+* Johannes Kampmeyer (https://github.com/xschlef)
+
+## License
-The following lead developers are responsible for this repository and have admin rights. They can, for example, merge pull requests.
+The emulation platform is published under Apache 2.0 license. Please see the LICENSE file for more details.
-* Manuel Peuster (mpeuster)
-* Steven Van Rossem (stevenvanrossem)
+## Contact
-#### Feedback-Chanel
+Manuel Peuster (Paderborn University) <manuel@peuster.de>
-* 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