X-Git-Url: https://osm.etsi.org/gitweb/?p=osm%2Fvim-emu.git;a=blobdiff_plain;f=README.md;h=e471c9e28081a473bbcc71efc592301b43db5fe2;hp=3877e875596f359a86519b817227c5a8c517bc19;hb=20e54456216efbcca714ae7464f4cf196999b662;hpb=78faf0ec78bffc066105e090646b13faa6a26305 diff --git a/README.md b/README.md index 3877e87..e471c9e 100755 --- a/README.md +++ b/README.md @@ -1,167 +1,161 @@ -[![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 execution of real network functions, packaged as Docker containers, in emulated network topologies running locally on the network service developer's machine. + + +# 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. + +### Acknowledgments + +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. ### Cite this work -If you use son-emu for your research and/or other publications, please cite the following paper to reference our work: - -* M. Peuster, H. Karl and S. van Rossem, **"MeDICINE: Rapid prototyping of production-ready network services in multi-PoP environments,"** 2016 IEEE Conference on Network Function Virtualization and Software Defined Networks (NFV-SDN), Palo Alto, CA, USA, 2016, pp. 148-153. -doi: 10.1109/NFV-SDN.2016.7919490 - * Link: http://ieeexplore.ieee.org/document/7919490/ - * Pre-print: http://arxiv.org/abs/1606.05995 - -A short demo that showcases son-emu together with its dummy gatekeeper is available [here](https://www.youtube.com/watch?v=ZANz97pV9ao). - -### Development - -To install the emulator package in development mode, do: - -* `python setup.py develop` - -#### Folder Structure - -* `ansible` Install scripts -* `misc` Example packages and VNFs -* `src` - * `emuvim` Emulator components - * `api` API endpoint implementations - * `rest` REST API for son-emu-cli - * `sonata` Dummy gatekeeper API - * `openstack` OpenStack-like APIs for MANO integration - * `cli` Command line client to control the emulator - * `dashboard` A web-based dashboard to display the emulator's state - * `dcemulator` Emulator core - * `resourcemodel` Resource limitation models - * `examples` Example topology scripts - * `test` Test scripts -* `utils` Helper scripts for SONATA's CI/CD setup - - -#### Run Unit Tests -* `cd ~/son-emu` -* `sudo py.test -v src/emuvim/test/unittests` - - -### Building +If you use the emulation platform for your research and/or other publications, please cite the following paper to reference our work: -Son-emu is entirely written in Python and does not require a special build process. Please check the [Installation](https://github.com/sonata-nfv/son-emu#installation) section for more details about the installation of son-emu. +* 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) -### Dependencies - -Son-emu requires the latest version of [Containernet](https://github.com/mpeuster/containernet) to be installed on the system. +## Installation -Despite of this son-emu has the following dependencies: +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. -* [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) -* [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) +### Automated installation (recommended) -### Contributing -Contributing to the son-emu is really easy. You must: +```sh +./install_osm.sh --lxdimages --vimemu +``` -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). +This command will install OSM (as LXC containers) as well as the emulator (as a Docker container) on a local machine. It is recommended to use a machine with Ubuntu 16.04. -## 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 your machine that contains the pre-installed and configured emulator. The more complicated installation requires a freshly installed Ubuntu 16.04 LTS and is done by a ansible playbook. +### Manual installation -### Vagrant Installation +#### Option 1: Bare-metal 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. +```sh +sudo apt-get install ansible git aptitude +``` -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. +##### Step 1. Containernet installation -### Ansible Installation +```sh +cd +git clone https://github.com/containernet/containernet.git +cd ~/containernet/ansible +sudo ansible-playbook -i "localhost," -c local install.yml +``` -* Requires: Ubuntu 16.04 LTS -* `sudo apt-get install ansible git aptitude` -* `sudo vim /etc/ansible/hosts` -* Add: `localhost ansible_connection=local` +##### Step 2. vim-emu installation -#### 1. Containernet +```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` -* `git clone https://github.com/containernet/containernet.git` -* `cd ~/containernet/ansible` -* `sudo ansible-playbook install.yml` -* Wait (and have a coffee) ... +#### Option 2: Nested Docker Deployment +This option requires a Docker installation on the host machine on which the emulator should be deployed. -#### 2. Emulator +```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 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 +``` -* `cd` -* `git clone https://github.com/sonata-nfv/son-emu.git` -* `cd ~/son-emu/ansible` -* `sudo ansible-playbook install.yml` ## Usage -### Examples +### 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 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. * First terminal (start the emulation platform): - * `sudo python src/emuvim/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` + * `sudo python examples/default_single_dc_topology.py` +* Second terminal (use `docker exec vim-emu ` for nested Docker deployment): + * `vim-emu compute start -d dc1 -n vnf1` + * `vim-emu compute start -d dc1 -n vnf2` + * `vim-emu compute list` * First terminal: - * `containernet> vnf1 ifconfig` - * `containernet> vnf1 ping -c 2 vnf2` + * `containernet> vnf1 ifconfig` + * `containernet> vnf1 ping -c 2 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). +### Further documentation and useful links -### Further Documentation +* [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/REST-API-command-overview) +* [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) -## License +## Development -Son-emu is published under Apache 2.0 license. Please see the LICENSE file for more details. +### How to contribute? -## Useful Links +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. -* [Mininet](http://mininet.org) +### Testing ---- -#### Lead Developers +To run the unit tests do: -The following lead developers are responsible for this repository and have admin rights. They can, for example, merge pull requests. +* `cd ~/vim-emu` +* `sudo pytest -v` +* (To force Python2: `sudo python2 -m pytest -v`) + +## Seed code contributors: + +### Lead: * Manuel Peuster (https://github.com/mpeuster) * Steven Van Rossem (https://github.com/stevenvanrossem) -#### Contributors +### 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 emulation platform is published under Apache 2.0 license. Please see the LICENSE file for more details. + +## Contact -#### Feedback-Chanel +Manuel Peuster (Paderborn University) -* 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)