Removed outdated zerorpc API.
[osm/vim-emu.git] / 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) NFV multi-PoP 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 emulation platform is based on [Containernet](https://containernet.github.io).
9
10 ### Cite this work
11
12 If you use the emulation platform 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
17 #### Folder Structure
18
19 * `ansible` Install scripts
20 * `misc` Example packages and VNFs
21 * `src` 
22     * `emuvim` Emulator components
23         * `api` API endpoint implementations
24             * `rest` REST API for son-emu-cli
25             * `sonata` SONATA dummy gatekeeper API
26             * `openstack` OpenStack-like APIs for MANO integration
27         * `cli` Command line client to control the emulator
28         * `dashboard` A web-based dashboard to display the emulator's state
29         * `dcemulator` Emulator core
30             * `resourcemodel` Resource limitation models
31         * `examples` Example topology scripts
32         * `test` Test scripts
33 * `utils` Helper scripts for CI/CD setup
34
35
36 #### Run Unit Tests
37 * `cd ~/son-emu`
38 * `sudo py.test -v src/emuvim/test/unittests`
39 (To force using Python2: `python2 -m  pytest -v src/emuvim/test/unittests`)
40
41
42 ### Building
43
44 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.
45
46 ### Dependencies
47
48 The emulation platform requires the latest version of [Containernet](https://containernet.github.io) to be installed on the system.
49
50 Despite of this, the emulation platform 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
68 ### Contributing
69 Contributing to the the emulator is really easy. You must:
70
71 1. Clone [this repository](http://github.com/sonata-nfv/son-emu);
72 2. Work on your proposed changes, preferably through submitting [issues](https://github.com/sonata-nfv/son-emu/issues);
73 3. Submit a Pull Request;
74 4. Follow/answer related [issues](https://github.com/sonata-nfv/son-emu/issues) (see Feedback-Chanel, below).
75
76 ## Installation
77 There are two 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.
78
79 ### Vagrant Installation
80
81 * Request VirtualBox and Vagrant to be installed on the system.
82 * `git clone https://github.com/sonata-nfv/son-emu.git`
83 * `cd ~/son-emu`
84 * `vagrant up`
85 * `vagrant ssh` to enter the new VM in which the emulator is installed.
86
87 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.
88
89 ### Ansible Installation
90
91 * Requires: Ubuntu 16.04 LTS
92 * `sudo apt-get install ansible git aptitude`
93
94 #### 1. Containernet
95
96 * `cd`
97 * `git clone https://github.com/containernet/containernet.git`
98 * `cd ~/containernet/ansible`
99 * `sudo ansible-playbook -i "localhost," -c local install.yml`
100
101 #### 2. Emulator
102
103 * `cd`
104 * `git clone https://github.com/sonata-nfv/son-emu.git`
105 * `cd ~/son-emu/ansible`
106 * `sudo ansible-playbook -i "localhost," -c local install.yml`
107
108 ## Usage
109
110 ### Examples
111
112 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.
113
114 * First terminal (start the emulation platform):
115  * `sudo python src/emuvim/examples/simple_topology.py`
116 * Second terminal:
117  * `son-emu-cli compute start -d datacenter1 -n vnf1`
118  * `son-emu-cli compute start -d datacenter1 -n vnf2`
119  * `son-emu-cli compute list`
120 * First terminal:
121  * `containernet> vnf1 ifconfig`
122  * `containernet> vnf1 ping -c 2 vnf2`
123
124
125 ### Further Documentation
126 * [Full CLI command documentation](https://github.com/sonata-nfv/son-emu/wiki/CLI-Command-Overview)
127 * [Requirements for Docker containers executed by the emulator](https://github.com/sonata-nfv/son-emu/wiki/Container-Requirements)
128 * [REST API](https://github.com/sonata-nfv/son-emu/wiki/APIs)
129
130 ## License
131
132 The emulation platform is published under Apache 2.0 license. Please see the LICENSE file for more details.
133
134 ## Useful Links
135
136 * [Mininet](http://mininet.org)
137 * [Containernet](https://containernet.github.io)
138 * [Maxinet](https://maxinet.github.io)
139
140 ---
141 #### Lead Developers
142
143 The following lead developers are responsible for this repository and have admin rights. They can, for example, merge pull requests.
144
145 * Manuel Peuster (https://github.com/mpeuster)
146 * Steven Van Rossem (https://github.com/stevenvanrossem)
147
148 #### Contributors
149
150 * Hadi Razzaghi Kouchaksaraei (https://github.com/hadik3r)
151 * Wouter Tavernier (https://github.com/wtaverni)
152 * Geoffroy Chollon (https://github.com/cgeoffroy)
153 * Eduard Maas (https://github.com/edmaas)
154
155 #### Feedback-Chanel
156
157 * You may use the mailing list [sonata-dev@lists.atosresearch.eu](mailto:sonata-dev@lists.atosresearch.eu)
158 * [GitHub issues](https://github.com/sonata-nfv/son-emu/issues)