README.md

   1 [![Build Status](http://jenkins.sonata-nfv.eu/buildStatus/icon?job=son-emu)](http://jenkins.sonata-nfv.eu/job/son-emu)
   2
   3 # son-emu
   4 This is the repository of [SONATA's](http://sonata-nfv.eu) emulation platform.
   5
   6 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.
   7
   8 More details about the the emulator's architecture and concepts can be found in the following publication(s):
   9
  10 * Peuster, Manuel, Holger Karl, and Steven van Rossem. ["MeDICINE: Rapid Prototyping of Production-Ready Network Services in Multi-PoP Environments."](http://arxiv.org/abs/1606.05995) pre-print arXiv:1606.05995 (2016).
  11
  12 ## Development
  13 (if applicable)
  14
  15 ### Building
  16 Describe briefly how to build the software.
  17
  18 ### Dependencies
  19
  20 * [argparse](https://pypi.python.org/pypi/argparse) >= 1.4.0 (Python software foundation License)
  21 * [docker-py](https://pypi.python.org/pypi/docker-py) == 1.7.1(Apache 2.0)
  22 * [Flask](https://pypi.python.org/pypi/Flask) >= 0.11 (BSD)
  23 * [flask_restful](https://pypi.python.org/pypi/Flask-RESTful) >= 0.3 (BSD)
  24 * [networkx](https://pypi.python.org/pypi/networkx/) >= 1.11  (BSD)
  25 * [oslo.config](http://docs.openstack.org/developer/oslo.config/) >= 3.9.0  (Apache 2.0)
  26 * [paramiko](https://pypi.python.org/pypi/paramiko/1.16.0) >= 1.6 (LGPL)
  27 * [prometheus_client](https://pypi.python.org/pypi/prometheus_client) >= 0.0.13 (Apache 2.0)
  28 * [pyaml](https://pypi.python.org/pypi/pyaml) >=15.8.2 (WTFPL)
  29 * [pytest-runner](https://pypi.python.org/pypi/pytest-runner) >= 2.8 (MIT)
  30 * [pytest](https://pypi.python.org/pypi/pytest) >= 2.9 (MIT)
  31 * [requests](https://pypi.python.org/pypi/requests) >= 2.10 (Apache 2.0)
  32 * [ryu](https://pypi.python.org/pypi/ryu/4.4) >= 4.4 (Apache 2.0)
  33 * [six](https://pypi.python.org/pypi/six/) >=1.9 (MIT)
  34 * [tabulate](https://pypi.python.org/pypi/tabulate) >= 0.7.5 (public domain)
  35 * [urllib3](https://pypi.python.org/pypi/urllib3) >= 1.15 (MIT)
  36 * [zerorpc](http://www.zerorpc.io) >= 0.5.2 (MIT)
  37
  38 ### Contributing
  39 Contributing to the Gatekeeper is really easy. You must:
  40
  41 1. Clone [this repository](http://github.com/sonata-nfv/son-emu);
  42 2. Work on your proposed changes, preferably through submiting [issues](https://github.com/sonata-nfv/son-emu/issues);
  43 3. Submit a Pull Request;
  44 4. Follow/answer related [issues](https://github.com/sonata-nfv/son-emu/issues) (see Feedback-Chanel, below).
  45
  46 ## Installation
  47 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.
  48
  49 ### Vagrant Installation
  50
  51 * Request VirtualBox and Vagrant to be installed on the system.
  52 * `git clone https://github.com/sonata-nfv/son-emu.git`
  53 * `cd ~/son-emu`
  54 * `vagrant up`
  55 * `vagrant ssh` to enter the new VM in which the emulator is installed.
  56
  57 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.
  58
  59 ### Ansible Installation
  60
  61 * Requires: Ubuntu 14.04 LTS or 16.04 LTS
  62 * `sudo apt-get install ansible git`
  63 * `sudo vim /etc/ansible/hosts`
  64 * Add: `localhost ansible_connection=local`
  65
  66 #### 1. Containernet
  67 * `cd`
  68 * `git clone https://github.com/mpeuster/containernet.git`
  69 * `cd ~/containernet/ansible`
  70 * `sudo ansible-playbook install.yml`
  71 * Wait (and have a coffee) ...
  72
  73 #### 2. Emulator
  74 * `cd`
  75 * `git clone https://github.com/sonata-nfv/son-emu.git`
  76 * `cd ~/son-emu/ansible`
  77 * `sudo ansible-playbook install.yml`
  78
  79 ## Usage
  80 (if applicable) Describe briefly how to use the software.
  81
  82 ### CLI
  83 * [Full CLI command documentation](https://github.com/sonata-nfv/son-emu/wiki/CLI-Command-Overview)
  84
  85 ## License
  86
  87 Son-emu is published under Apache 2.0 license. Please see the LICENSE file for more details.
  88
  89 ## Useful Links
  90
  91 * Any useful link and brief description. For example:
  92 * http://www.google/ Don't be evil.
  93
  94 ---
  95 #### Lead Developers
  96
  97 The following lead developers are responsible for this repository and have admin rights. They can, for example, merge pull requests.
  98
  99 * Manuel Peuster (https://github.com/mpeuster)
 100 * Steven Van Rossem (https://github.com/stevenvanrossem)
 101
 102 #### Feedback-Chanel
 103
 104 * You may use the mailing list [sonata-dev@lists.atosresearch.eu](mailto:sonata-dev@lists.atosresearch.eu)
 105 * * [GitHub issues](https://github.com/sonata-nfv/son-emu/issues)