-[](http://jenkins.sonata-nfv.eu/job/son-emu)
+<!--
+# Copyright (c) 2017 SONATA-NFV and Paderborn University
+# ALL RIGHTS RESERVED.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# Neither the name of the SONATA-NFV, Paderborn University
+# nor the names of its contributors may be used to endorse or promote
+# products derived from this software without specific prior written
+# permission.
+#
+# This work has been performed in the framework of the SONATA project,
+# funded by the European Commission under Grant number 671517 through
+# the Horizon 2020 and 5G-PPP programmes. The authors would like to
+# acknowledge the contributions of their colleagues of the SONATA
+# partner consortium (www.sonata-nfv.eu).
+-->
+
+
+# vim-emu: A NFV multi-PoP 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).
+
+The emulation platform `vim-emu` is developed as part of OSM's DevOps MDG.
-# son-emu
-This is the repository of [SONATA's](http://sonata-nfv.eu) emulation platform.
+---
+## Acknowledgments
-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.
+This software was originally developed by the [SONATA project](http://www.sonata-nfv.eu) and the [5GTANGO project](https://5gtango.eu/), funded by the European Commission under grant number 671517 and 761493 through the Horizon 2020 and 5G-PPP programs.
-More details about the the emulator's architecture and concepts can be found in the following publication(s):
+## Cite this work
-* 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).
+If you use the emulation platform for your research and/or other publications, please cite the following paper to reference our work:
-## 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
-Contributing to the Gatekeeper is really easy. You must:
-
-1. Clone [this repository](http://github.com/sonata-nfv/son-emu);
-2. Work on your proposed changes, preferably through submiting [issues](https://github.com/sonata-nfv/son-emu/issues);
-3. Submit a Pull Request;
-4. Follow/answer related [issues](https://github.com/sonata-nfv/son-emu/issues) (see Feedback-Chanel, below).
+* 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)
+
+Bibtex:
+
+```bibtex
+@inproceedings{peuster2016medicine,
+ author={M. Peuster and H. Karl and S. van Rossem},
+ booktitle={2016 IEEE Conference on Network Function Virtualization and Software Defined Networks (NFV-SDN)},
+ title={MeDICINE: Rapid prototyping of production-ready network services in multi-PoP environments},
+ year={2016},
+ volume={},
+ number={},
+ pages={148-153},
+ doi={10.1109/NFV-SDN.2016.7919490},
+ month={Nov}
+}
+```
+---
## Installation
-There are two ways to install and use son-emu. The simple one is to use Vagrant to create a VirtualBox-based VM on you machine that contains the pre-installed and configured emulator. The more complicated installation requires a freshly installed Ubuntu 14.04 LTS or 16.04 LTS and is done by a ansible playbook.
-### Vagrant Installation
+There are multiple ways to install and use the emulation platform. The easiest way is the automated installation using the OSM installer. The bare-metal installation requires a freshly installed **Ubuntu 18.04 LTS** and is done by an Ansible playbook. Another option is to use a nested Docker environment to run the emulator inside a Docker container.
+
+### Automated OSM installation
+
+This installation option applies if you want to use vim-emu in combination with OSM.
+
+```sh
+./install_osm.sh --vimemu
+```
-* 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.
+This command will install OSM as well as the emulator (as a Docker container) on a local machine. It is recommended to use a machine with Ubuntu 18.04 LTS. More details about this installation option can be found in the [OSM wiki](https://osm.etsi.org/wikipub/index.php/VIM_emulator).
-Follow the MOTD in the VM to run the example topology and the dummy-gatekeeper. The dummy-gatekeeper's default port 5000 is forwarded to the host machine and can be accessed from it by using, e.g., curl http://127.0.0.1:5000/packages.
+### Standalone installation
-### Ansible Installation
+#### Option 1: Bare-metal installation
-* Requires: Ubuntu 14.04 LTS or 16.04 LTS
-* `sudo apt-get install ansible git`
-* `sudo vim /etc/ansible/hosts`
-* Add: `localhost ansible_connection=local`
+```sh
+sudo apt-get install ansible git aptitude
+```
-#### 1. Containernet
-* `cd`
-* `git clone https://github.com/mpeuster/containernet.git`
-* `cd ~/containernet/ansible`
-* `sudo ansible-playbook install.yml`
-* Wait (and have a coffee) ...
+##### Step 1. Containernet installation
-#### 2. Emulator
-* `cd`
-* `git clone https://github.com/sonata-nfv/son-emu.git`
-* `cd ~/son-emu/ansible`
-* `sudo ansible-playbook install.yml`
+```sh
+cd
+git clone https://github.com/containernet/containernet.git
+cd ~/containernet/ansible
+sudo ansible-playbook -i "localhost," -c local install.yml
+cd ..
+sudo make develop
+```
+##### Step 2. vim-emu installation
+
+```sh
+cd
+git clone https://osm.etsi.org/gerrit/osm/vim-emu.git
+cd ~/vim-emu/ansible
+sudo ansible-playbook -i "localhost," -c local install.yml
+cd ..
+sudo python3 setup.py develop
+```
+
+#### Option 2: Nested Docker Deployment
+This option requires a Docker installation on the host machine on which the emulator should be deployed.
+
+Build:
+```sh
+git clone https://osm.etsi.org/gerrit/osm/vim-emu.git
+cd ~/vim-emu
+# build the container:
+docker build -t vim-emu-img .
+```
+
+Run:
+```sh
+# run the (interactive) container:
+docker run --name vim-emu -it --rm --privileged --pid='host' -v /var/run/docker.sock:/var/run/docker.sock vim-emu-img /bin/bash
+```
+
+---
## Usage
-(if applicable) Describe briefly how to use the software.
-### CLI
-* [Full CLI command documentation](https://github.com/sonata-nfv/son-emu/wiki/CLI-Command-Overview)
+### Example
-## License
+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 vim-emu CLI.
-Son-emu is published under Apache 2.0 license. Please see the LICENSE file for more details.
+First terminal:
+```sh
+# start the emulation platform with a single NFV data center
+sudo python3 examples/default_single_dc_topology.py
+```
-## Useful Links
+Second terminal (use `docker exec vim-emu <command>` for nested Docker deployment):
+```sh
+# start two simple VNFs
+vim-emu compute start -d dc1 -n vnf1
+vim-emu compute start -d dc1 -n vnf2
+vim-emu compute list
+```
-* Any useful link and brief description. For example:
-* http://www.google/ Don't be evil.
+First terminal:
+```sh
+# check the connectivity between the two VNFs
+# press <ENTER> <ENTER>
+containernet> vnf1 ifconfig
+containernet> vnf1 ping -c2 vnf2
+```
+
+
+A more advanced example that includes OSM can be found in the [official vim-emu documentation in the OSM wiki](https://osm.etsi.org/wikipub/index.php/VIM_emulator).
+
+---
+## Documentation
+
+* [Official vim-emu repository mirror on GitHub](https://github.com/containernet/vim-emu)
+* [Official vim-emu documentation in the OSM wiki](https://osm.etsi.org/wikipub/index.php/VIM_emulator)
+* [Full vim-emu documentation on GitHub](https://github.com/containernet/vim-emu)
+* [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
+
+```sh
+sudo pytest -v
+```
+
+---
+## Contributors
+
+* [Manuel Peuster (lead developer)](https://github.com/mpeuster)
+* [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)
+* [Stefan Schneider](https://github.com/StefanUPB)
+* [Erik Schilling](https://github.com/Ablu)
+* [Rafael Schellenberg](https://github.com/RafaelSche)
+
+## License
+
+The emulation platform is published under Apache 2.0 license. Please see the LICENSE file for more details.
-The following lead developers are responsible for this repository and have admin rights. They can, for example, merge pull requests.
+## Contact
-* Manuel Peuster (https://github.com/mpeuster)
-* Steven Van Rossem (https://github.com/stevenvanrossem)
+Manuel Peuster
+* Mail: <manuel (at) peuster (dot) de>
+* Twitter: [@ManuelPeuster](https://twitter.com/ManuelPeuster)
+* GitHub: [@mpeuster](https://github.com/mpeuster)
+* Website: [https://peuster.de](https://peuster.de)
-#### Feedback-Chanel
-* You may use the mailing list [sonata-dev@lists.atosresearch.eu](mailto:sonata-dev@lists.atosresearch.eu)
-* * [GitHub issues](https://github.com/sonata-nfv/son-emu/issues)
projects / osm / vim-emu.git / blobdiff