X-Git-Url: https://osm.etsi.org/gitweb/?p=osm%2Fvim-emu.git;a=blobdiff_plain;f=README.md;h=5c172c340c49c4f412c968c812424679226097f0;hp=31ba421ba06aa626a0eb156a756e6540a890194c;hb=5b23e365fd3f93fb4a4a3c353b92bb6acd40321c;hpb=add3f7934df417328a936cbf6ad643beec6f2ab9 diff --git a/README.md b/README.md index 31ba421..5c172c3 100755 --- a/README.md +++ b/README.md @@ -1,15 +1,19 @@ -[![Build Status](http://jenkins.sonata-nfv.eu/buildStatus/icon?job=son-emu)](http://jenkins.sonata-nfv.eu/job/son-emu) +[![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) # son-emu This is the repository of [SONATA's](http://sonata-nfv.eu) 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. +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. -More details about the the emulator's architecture and concepts can be found in the following publication(s): +The platform is based on [Containernet](https://containernet.github.io). -* 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). +### Cite this work -A short demo that showcases son-emu together with its dummy gatekeeper is available [here](https://youtu.be/BgWDp5CM0io). +If you use son-emu for your research and/or other publications, please cite the following paper to reference our work: + +* 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) + +A short demo that showcases son-emu together with its dummy gatekeeper is available [here](https://www.youtube.com/watch?v=ZANz97pV9ao). ### Development @@ -22,21 +26,24 @@ To install the emulator package in development mode, do: * `ansible` Install scripts * `misc` Example packages and VNFs * `src` - * `emuvim` Emulator components - * `api` API endpoint implementations - * `rest` REST API for son-emu-cli - * `sonata` Dummy gatekeeper API - * `cli` Command line client to control the emulator - * `dcemulator` Emulator core - * `resourcemodel` Resource limitation models - * `examples` Example topology scripts - * `test` Test scripts + * `emuvim` Emulator components + * `api` API endpoint implementations + * `rest` REST API for son-emu-cli + * `sonata` Dummy gatekeeper API + * `openstack` OpenStack-like APIs for MANO integration + * `cli` Command line client to control the emulator + * `dashboard` A web-based dashboard to display the emulator's state + * `dcemulator` Emulator core + * `resourcemodel` Resource limitation models + * `examples` Example topology scripts + * `test` Test scripts * `utils` Helper scripts for SONATA's CI/CD setup #### Run Unit Tests * `cd ~/son-emu` * `sudo py.test -v src/emuvim/test/unittests` +(To force using Python2: `python2 -m pytest -v src/emuvim/test/unittests`) ### Building @@ -45,7 +52,7 @@ Son-emu is entirely written in Python and does not require a special build proce ### Dependencies -Son-emu requires the latest version of [Containernet](https://github.com/mpeuster/containernet) to be installed on the system. +Son-emu requires the latest version of [Containernet](https://containernet.github.io) to be installed on the system. Despite of this son-emu has the following dependencies: @@ -75,7 +82,7 @@ Contributing to the son-emu is really easy. You must: 4. Follow/answer related [issues](https://github.com/sonata-nfv/son-emu/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. +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. ### Vagrant Installation @@ -89,30 +96,26 @@ Follow the MOTD in the VM to run the example topology and the dummy-gatekeeper. ### 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` +* Requires: Ubuntu 16.04 LTS +* `sudo apt-get install ansible git aptitude` #### 1. Containernet * `cd` -* `git clone https://github.com/mpeuster/containernet.git` +* `git clone https://github.com/containernet/containernet.git` * `cd ~/containernet/ansible` -* `sudo ansible-playbook install.yml` -* Wait (and have a coffee) ... +* `sudo ansible-playbook -i "localhost," -c local install.yml` #### 2. Emulator * `cd` * `git clone https://github.com/sonata-nfv/son-emu.git` * `cd ~/son-emu/ansible` -* `sudo ansible-playbook install.yml` +* `sudo ansible-playbook -i "localhost," -c local install.yml` ## Usage ### Examples -#### Manual Usage Example: 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. @@ -126,23 +129,11 @@ This simple example shows how to start the emulator with a simple topology (term * `containernet> vnf1 ifconfig` * `containernet> vnf1 ping -c 2 vnf2` -#### Dummy Gatekeeper Example: - -This example shows how to deploy a SONATA example package in the emulator using the dummy gatekeeper. - -* First terminal (start the emulation platform): - * `sudo python src/emuvim/examples/sonata_y1_demo_topology_1.py` -* Second terminal (deploy the example package): - * Upload: `curl -i -X POST -F package=@sonata-demo-docker.son http://127.0.0.1:5000/packages` - * Instantiate: `curl -X POST http://127.0.0.1:5000/instantiations -d "{}"` - * Verify that service runs: `son-emu-cli compute list` - -Note: The [son-push](https://github.com/mpeuster/son-cli) tool can be used instead of CURL. - ### Further Documentation -* [Full CLI command documentation](https://github.com/sonata-nfv/son-emu/wiki/CLI-Command-Overview) +* [Full CLI command documentation]https://github.com/sonata-nfv/son-emu/wiki/CLI-Command-Overview) * [Requirements for Docker containers executed by the emulator](https://github.com/sonata-nfv/son-emu/wiki/Container-Requirements) +* [REST API](https://github.com/sonata-nfv/son-emu/wiki/APIs) ## License @@ -151,6 +142,8 @@ Son-emu is published under Apache 2.0 license. Please see the LICENSE file for m ## Useful Links * [Mininet](http://mininet.org) +* [Containernet](https://containernet.github.io) +* [Maxinet](https://maxinet.github.io) --- #### Lead Developers @@ -165,6 +158,7 @@ The following lead developers are responsible for this repository and have admin * Hadi Razzaghi Kouchaksaraei (https://github.com/hadik3r) * Wouter Tavernier (https://github.com/wtaverni) * Geoffroy Chollon (https://github.com/cgeoffroy) +* Eduard Maas (https://github.com/edmaas) #### Feedback-Chanel