son-emu

This is the repository of SONATA's 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 direct execution of real network functions, packaged as Docker containers, in emulated network topologies running locally on the network service developer's machine.

More details about the the emulator's architecture and concepts can be found in the following publication(s):

• Peuster, Manuel, Holger Karl, and Steven van Rossem. "MeDICINE: Rapid Prototyping of Production-Ready Network Services in Multi-PoP Environments." pre-print arXiv:1606.05995 (2016).

Development

(if applicable)

Building

Describe briefly how to build the software.

Dependencies

• argparse >= 1.4.0 (Python software foundation License)
• docker-py == 1.7.1(Apache 2.0)
• Flask >= 0.11 (BSD)
• flask_restful >= 0.3 (BSD)
• networkx >= 1.11 (BSD)
• oslo.config >= 3.9.0 (Apache 2.0)
• paramiko >= 1.6 (LGPL)
• prometheus_client >= 0.0.13 (Apache 2.0)
• pyaml >=15.8.2 (WTFPL)
• pytest-runner >= 2.8 (MIT)
• pytest >= 2.9 (MIT)
• requests >= 2.10 (Apache 2.0)
• ryu >= 4.4 (Apache 2.0)
• six >=1.9 (MIT)
• tabulate >= 0.7.5 (public domain)
• urllib3 >= 1.15 (MIT)
• zerorpc >= 0.5.2 (MIT)

Contributing

Contributing to the Gatekeeper is really easy. You must:

1. Clone this repository;
2. Work on your proposed changes, preferably through submiting issues;
3. Submit a Pull Request;
4. Follow/answer related 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 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

• 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.

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

• 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

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

• cd
• git clone https://github.com/sonata-nfv/son-emu.git
• cd ~/son-emu/ansible
• sudo ansible-playbook install.yml

Usage

(if applicable) Describe briefly how to use the software.

CLI

• Full CLI command documentation

License

Son-emu is published under Apache 2.0 license. Please see the LICENSE file for more details.

Useful Links

• Any useful link and brief description. For example:
• http://www.google/ Don't be evil.

---

Lead Developers

The following lead developers are responsible for this repository and have admin rights. They can, for example, merge pull requests.

• Manuel Peuster (https://github.com/mpeuster)
• Steven Van Rossem (https://github.com/stevenvanrossem)

Feedback-Chanel

• You may use the mailing list sonata-dev@lists.atosresearch.eu
• • GitHub issues