-[](http://jenkins.sonata-nfv.eu/job/son-emu)
+[](https://gitter.im/containernet/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [](http://jenkins.sonata-nfv.eu/job/son-emu)
# son-emu
-This is the repository of [SONATA's](http://sonata-nfv.eu) emulation platform.
+This is the repository of [SONATA's](http://sonata-nfv.eu) NFV multi-PoP 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.
+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.
-### 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
+The emulation platform is based on [Containernet](https://containernet.github.io).
-A short demo that showcases son-emu together with its dummy gatekeeper is available [here](https://www.youtube.com/watch?v=ZANz97pV9ao).
+### Cite this work
-### Development
+If you use the emulation platform for your research and/or other publications, please cite the following paper to reference our work:
-To install the emulator package in development mode, do:
+* 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)
-* `python setup.py develop`
#### Folder Structure
* `emuvim` Emulator components
* `api` API endpoint implementations
* `rest` REST API for son-emu-cli
- * `sonata` Dummy gatekeeper API
+ * `sonata` 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
* `resourcemodel` Resource limitation models
* `examples` Example topology scripts
* `test` Test scripts
-* `utils` Helper scripts for SONATA's CI/CD setup
+* `utils` Helper scripts for CI/CD setup
#### Run Unit Tests
### Building
-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.
+The emulation platform 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 the emulator.
### Dependencies
-Son-emu requires the latest version of [Containernet](https://github.com/mpeuster/containernet) to be installed on the system.
+The emulation platform requires the latest version of [Containernet](https://containernet.github.io) to be installed on the system.
-Despite of this son-emu has the following dependencies:
+Despite of this, the emulation platform has the following 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)
* [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 son-emu is really easy. You must:
+Contributing to the the emulator 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);
+2. Work on your proposed changes, preferably through submitting [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).
## 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.
+There are three ways to install and use the emulation platform. 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 an ansible playbook. The third option is to use a nested Docker environment to run the emulator inside a Docker container.
-### Vagrant Installation
+### Option 1: Vagrant Installation
* Request VirtualBox and Vagrant to be installed on the system.
* `git clone https://github.com/sonata-nfv/son-emu.git`
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.
-### Ansible Installation
+### Option 2: Ansible Installation
* Requires: Ubuntu 16.04 LTS
* `sudo apt-get install ansible git aptitude`
-* `sudo vim /etc/ansible/hosts`
-* Add: `localhost ansible_connection=local`
#### 1. Containernet
* `cd`
* `git clone https://github.com/containernet/containernet.git`
* `cd ~/containernet/ansible`
-* `sudo ansible-playbook install.yml`
-* Wait (and have a coffee) ...
+* `sudo ansible-playbook -i "localhost," -c local install.yml`
#### 2. Emulator
* `cd`
* `git clone https://github.com/sonata-nfv/son-emu.git`
* `cd ~/son-emu/ansible`
-* `sudo ansible-playbook install.yml`
+* `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`
+
## Usage
### Further Documentation
* [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)
## License
-Son-emu is published under Apache 2.0 license. Please see the LICENSE file for more details.
+The emulation platform is published under Apache 2.0 license. Please see the LICENSE file for more details.
## Useful Links
* [Mininet](http://mininet.org)
+* [Containernet](https://containernet.github.io)
+* [Maxinet](https://maxinet.github.io)
---
#### Lead Developers
projects / osm / vim-emu.git / blobdiff