README.md

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