X-Git-Url: https://osm.etsi.org/gitweb/?p=osm%2Fvim-emu.git;a=blobdiff_plain;f=README.md;h=bf8947ec0cc641f695f159a0b4927860be0ab487;hp=e471c9e28081a473bbcc71efc592301b43db5fe2;hb=655815663bf8234c837793db7a5e2e3c50164d3f;hpb=ff8dd3197e951f100a76e93f67db98153ede81df diff --git a/README.md b/README.md index e471c9e..bf8947e 100755 --- a/README.md +++ b/README.md @@ -26,6 +26,7 @@ # 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). @@ -42,6 +43,22 @@ If you use the emulation platform for your research and/or other publications, p * 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 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 16.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. @@ -69,6 +86,8 @@ cd git clone https://github.com/containernet/containernet.git cd ~/containernet/ansible sudo ansible-playbook -i "localhost," -c local install.yml +cd .. +sudo python setup.py install ``` ##### Step 2. vim-emu installation @@ -78,6 +97,8 @@ 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 python setup.py install ``` #### Option 2: Nested Docker Deployment @@ -114,9 +135,7 @@ A more advanced example that includes OSM can be found in the [official vim-emu ### Further documentation and useful links * [Official vim-emu documentation in the OSM wiki](https://osm.etsi.org/wikipub/index.php/VIM_emulator) -* [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) +* [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) @@ -150,6 +169,7 @@ To run the unit tests do: * Eduard Maas (https://github.com/edmaas) * Malte Splietker (https://github.com/splietker) * Johannes Kampmeyer (https://github.com/xschlef) +* Stefan Schneider (https://github.com/StefanUPB) ## License