X-Git-Url: https://osm.etsi.org/gitweb/?p=osm%2Fvim-emu.git;a=blobdiff_plain;f=README.md;h=5fdccffb635089da45cd6b9c9c329235a5b25a4c;hp=6d54ca5ba7256d9da4cf1f4004988d4d5b4d6697;hb=c3d1e25f455b70ac944d1d668aaad1b8e74eb61b;hpb=5ddd8f817f58c12d52ae1601cc4483f46f28fa06 diff --git a/README.md b/README.md index 6d54ca5..5fdccff 100755 --- a/README.md +++ b/README.md @@ -1,96 +1,162 @@ -[![Build Status](http://jenkins.sonata-nfv.eu/buildStatus/icon?job=son-emu)](http://jenkins.sonata-nfv.eu/job/son-emu) - -# Distributed Cloud Emulator - -### 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) - -### Environment -* Python 2.7 -* Latest [Containernet](https://github.com/mpeuster/containernet) installed on the system - -### Dependencies -* pyaml (public domain) -* zerorpc (MIT) -* tabulate (public domain) -* argparse (Python software foundation license) -* networkx (BSD) -* six>=1.9 (MIT) -* ryu (Apache 2.0) -* oslo.config (Apache 2.0) -* pytest (MIT) -* pytest-runner (MIT) -* Flask (BSD) -* flask_restful (BSD) -* requests (Apache 2.0) -* docker-py (Apache 2.0) -* paramiko (LGPL) - -### 3rd-party code used -* (none) - - -### Project structure - -* **src/emuvim/** all emulator code - * **api/** Data center API endpoint implementations (zerorpc, OpenStack REST, ...) - * **cli/** CLI client to interact with a running emulator - * **dcemulator/** Containernet wrapper that introduces the notion of data centers and API endpoints - * **examples/** Example topology scripts - * **test/** Unit tests -* **ansible/** Ansible install scripts -* **util/** helper scripts - -### Installation -Automatic installation is provide through Ansible playbooks. - -* Requires: Ubuntu 14.04 LTS -* `sudo apt-get install ansible git` -* `sudo vim /etc/ansible/hosts` -* Add: `localhost ansible_connection=local` - -#### 1. Containernet -* `cd` -* `git clone https://github.com/mpeuster/containernet.git` -* `cd ~/containernet/ansible` -* `sudo ansible-playbook install.yml` -* Wait (and have a coffee) ... - -#### 2. Emulator -* Fork the repository. -* `cd` -* `git clone https://github.com//son-emu.git` -* `cd ~/son-emu/ansible` -* `sudo ansible-playbook install.yml` - - -### Run - -In the `~/son-emu` directory: - -* During development: - * `python setup.py develop` -* Otherwise, for a classic installation: - * `python setup.py install` -* First terminal: - * `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` + + +# 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 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 + +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. + +### Automated installation (recommended) + +```sh +./install_osm.sh --lxdimages --vimemu +``` + +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. + +### Manual installation + +#### Option 1: Bare-metal installation + +```sh +sudo apt-get install ansible git aptitude +``` + +##### Step 1. Containernet installation + +```sh +cd +git clone https://github.com/containernet/containernet.git +cd ~/containernet/ansible +sudo ansible-playbook -i "localhost," -c local install.yml +``` + +##### 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 +``` + +#### Option 2: Nested Docker Deployment +This option requires a Docker installation on the host machine on which the emulator should be deployed. + +```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 +``` + + +## Usage + +### 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 vim-emu CLI. + +* First terminal (start the emulation platform): + * `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 ping -c 2 vnf2` -* Second terminal: - * `son-emu-cli monitor get_rate -vnf vnf1` + * `containernet> vnf1 ifconfig` + * `containernet> vnf1 ping -c 2 vnf2` -### Run Unit Tests -* `cd ~/son-emu` -* `sudo py.test -v src/emuvim` (equivalent to `python setup.py test -v --addopts 'src/emuvim'` but with direct access to the commandline arguments) +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). -### CLI +### 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) +* [Mininet](http://mininet.org) +* [Containernet](https://containernet.github.io) +* [Maxinet](https://maxinet.github.io) + +## 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 ~/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 + +* 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) + +## License + +The emulation platform is published under Apache 2.0 license. Please see the LICENSE file for more details. + +## Contact + +Manuel Peuster (Paderborn University)