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 * Manuel Peuster, 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 A short demo that showcases son-emu together with its dummy gatekeeper is available [here](https://youtu.be/BgWDp5CM0io).
  13
  14 ### Development
  15
  16 To install the emulator package in development mode, do:
  17
  18 * `python setup.py develop`
  19
  20 #### Folder Structure
  21
  22 * `ansible` Install scripts
  23 * `misc` Example packages and VNFs
  24 * `src`
  25         * `emuvim` Emulator components
  26                 * `api` API endpoint implementations
  27                         * `rest` REST API for son-emu-cli
  28                 * `sonata` Dummy gatekeeper API
  29                 * `cli` Command line client to control the emulator
  30                 * `dcemulator` Emulator core
  31                         * `resourcemodel` Resource limitation models
  32         * `examples` Example topology scripts
  33         * `test` Test scripts
  34 * `utils` Helper scripts for SONATA's CI/CD setup
  35
  36
  37 #### Run Unit Tests
  38 * `cd ~/son-emu`
  39 * `sudo py.test -v src/emuvim/test/unittests`
  40
  41
  42 ### Building
  43
  44 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.
  45
  46 ### Dependencies
  47
  48 Son-emu requires the latest version of [Containernet](https://github.com/mpeuster/containernet) to be installed on the system.
  49
  50 Despite of this son-emu has the following dependencies:
  51
  52 * [argparse](https://pypi.python.org/pypi/argparse) >= 1.4.0 (Python software foundation License)
  53 * [docker-py](https://pypi.python.org/pypi/docker-py) == 1.7.1(Apache 2.0)
  54 * [Flask](https://pypi.python.org/pypi/Flask) >= 0.11 (BSD)
  55 * [flask_restful](https://pypi.python.org/pypi/Flask-RESTful) >= 0.3 (BSD)
  56 * [networkx](https://pypi.python.org/pypi/networkx/) >= 1.11  (BSD)
  57 * [oslo.config](http://docs.openstack.org/developer/oslo.config/) >= 3.9.0  (Apache 2.0)
  58 * [prometheus_client](https://pypi.python.org/pypi/prometheus_client) >= 0.0.13 (Apache 2.0)
  59 * [pyaml](https://pypi.python.org/pypi/pyaml) >=15.8.2 (WTFPL)
  60 * [pytest-runner](https://pypi.python.org/pypi/pytest-runner) >= 2.8 (MIT)
  61 * [pytest](https://pypi.python.org/pypi/pytest) >= 2.9 (MIT)
  62 * [requests](https://pypi.python.org/pypi/requests) >= 2.10 (Apache 2.0)
  63 * [ryu](https://pypi.python.org/pypi/ryu/4.4) >= 4.4 (Apache 2.0)
  64 * [six](https://pypi.python.org/pypi/six/) >=1.9 (MIT)
  65 * [tabulate](https://pypi.python.org/pypi/tabulate) >= 0.7.5 (public domain)
  66 * [urllib3](https://pypi.python.org/pypi/urllib3) >= 1.15 (MIT)
  67 * [zerorpc](http://www.zerorpc.io) >= 0.5.2 (MIT)
  68
  69 ### Contributing
  70 Contributing to the son-emu is really easy. You must:
  71
  72 1. Clone [this repository](http://github.com/sonata-nfv/son-emu);
  73 2. Work on your proposed changes, preferably through submiting [issues](https://github.com/sonata-nfv/son-emu/issues);
  74 3. Submit a Pull Request;
  75 4. Follow/answer related [issues](https://github.com/sonata-nfv/son-emu/issues) (see Feedback-Chanel, below).
  76
  77 ## Installation
  78 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.
  79
  80 ### Vagrant Installation
  81
  82 * Request VirtualBox and Vagrant to be installed on the system.
  83 * `git clone https://github.com/sonata-nfv/son-emu.git`
  84 * `cd ~/son-emu`
  85 * `vagrant up`
  86 * `vagrant ssh` to enter the new VM in which the emulator is installed.
  87
  88 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.
  89
  90 ### Ansible Installation
  91
  92 * Requires: Ubuntu 14.04 LTS or 16.04 LTS
  93 * `sudo apt-get install ansible git`
  94 * `sudo vim /etc/ansible/hosts`
  95 * Add: `localhost ansible_connection=local`
  96
  97 #### 1. Containernet
  98
  99 * `cd`
 100 * `git clone https://github.com/mpeuster/containernet.git`
 101 * `cd ~/containernet/ansible`
 102 * `sudo ansible-playbook install.yml`
 103 * Wait (and have a coffee) ...
 104
 105 #### 2. Emulator
 106
 107 * `cd`
 108 * `git clone https://github.com/sonata-nfv/son-emu.git`
 109 * `cd ~/son-emu/ansible`
 110 * `sudo ansible-playbook install.yml`
 111
 112 ## Usage
 113
 114 ### Examples
 115 #### Manual Usage Example:
 116
 117 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.
 118
 119 * First terminal (start the emulation platform):
 120  * `sudo python src/emuvim/examples/simple_topology.py`
 121 * Second terminal:
 122  * `son-emu-cli compute start -d datacenter1 -n vnf1`
 123  * `son-emu-cli compute start -d datacenter1 -n vnf2`
 124  * `son-emu-cli compute list`
 125 * First terminal:
 126  * `containernet> vnf1 ifconfig`
 127  * `containernet> vnf1 ping -c 2 vnf2`
 128
 129 #### Dummy Gatekeeper Example:
 130
 131 This example shows how to deploy a SONATA example package in the emulator using the dummy gatekeeper.
 132
 133 * First terminal (start the emulation platform):
 134  * `sudo python src/emuvim/examples/sonata_y1_demo_topology_1.py`
 135 * Second terminal (deploy the example package):
 136  * Upload: `curl -i -X POST -F package=@sonata-demo-docker.son http://127.0.0.1:5000/packages`
 137  * Instantiate: `curl -X POST http://127.0.0.1:5000/instantiations -d "{}"`
 138  * Verify that service runs: `son-emu-cli compute list`
 139
 140 Note: The [son-push](https://github.com/mpeuster/son-cli) tool can be used instead of CURL.
 141
 142
 143 ### Further Documentation
 144 * [Full CLI command documentation](https://github.com/sonata-nfv/son-emu/wiki/CLI-Command-Overview)
 145 * [Requirements for Docker containers executed by the emulator](https://github.com/sonata-nfv/son-emu/wiki/Container-Requirements)
 146
 147 ## License
 148
 149 Son-emu is published under Apache 2.0 license. Please see the LICENSE file for more details.
 150
 151 ## Useful Links
 152
 153 * [Mininet](http://mininet.org)
 154
 155 ---
 156 #### Lead Developers
 157
 158 The following lead developers are responsible for this repository and have admin rights. They can, for example, merge pull requests.
 159
 160 * Manuel Peuster (https://github.com/mpeuster)
 161 * Steven Van Rossem (https://github.com/stevenvanrossem)
 162
 163 #### Contributors
 164
 165 * Hadi Razzaghi Kouchaksaraei (https://github.com/hadik3r)
 166 * Wouter Tavernier (https://github.com/wtaverni)
 167 * Geoffroy Chollon (https://github.com/cgeoffroy)
 168
 169 #### Feedback-Chanel
 170
 171 * You may use the mailing list [sonata-dev@lists.atosresearch.eu](mailto:sonata-dev@lists.atosresearch.eu)
 172 * [GitHub issues](https://github.com/sonata-nfv/son-emu/issues)