From: peusterm Date: Fri, 19 May 2017 08:53:32 +0000 (+0200) Subject: Updated and polished README.md for v2.1 X-Git-Tag: v3.1~26^2~2 X-Git-Url: https://osm.etsi.org/gitweb/?a=commitdiff_plain;h=c090780685d58a15ac54f81193baddb5cb63ae84;p=osm%2Fvim-emu.git Updated and polished README.md for v2.1 --- diff --git a/README.md b/README.md index f144818..269a3a7 100755 --- a/README.md +++ b/README.md @@ -3,14 +3,16 @@ # 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. ### Cite this work If you use son-emu for your research and/or other publications, please cite the following paper to reference our work: -* Manuel Peuster, Holger Karl, and Steven van Rossem. "**MeDICINE: Rapid Prototyping of Production-Ready Network Services in Multi-PoP Environments.**" to appear in IEEE Conference on Network Function Virtualization and Software Defined Network (NFV-SDN), 2016. - * Pre-print online: http://arxiv.org/abs/1606.05995 +* M. Peuster, H. Karl and S. van Rossem, **"MeDICINE: Rapid prototyping of production-ready network services in multi-PoP environments,"** 2016 IEEE Conference on Network Function Virtualization and Software Defined Networks (NFV-SDN), Palo Alto, CA, USA, 2016, pp. 148-153. +doi: 10.1109/NFV-SDN.2016.7919490 + * Link: http://ieeexplore.ieee.org/document/7919490/ + * Pre-print: http://arxiv.org/abs/1606.05995 A short demo that showcases son-emu together with its dummy gatekeeper is available [here](https://www.youtube.com/watch?v=ZANz97pV9ao). @@ -28,12 +30,14 @@ To install the emulator package in development mode, do: * `emuvim` Emulator components * `api` API endpoint implementations * `rest` REST API for son-emu-cli - * `sonata` Dummy gatekeeper API + * `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 + * `examples` Example topology scripts + * `test` Test scripts * `utils` Helper scripts for SONATA's CI/CD setup @@ -78,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 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 @@ -92,7 +96,7 @@ Follow the MOTD in the VM to run the example topology and the dummy-gatekeeper. ### Ansible Installation -* Requires: Ubuntu 14.04 LTS +* Requires: Ubuntu 16.04 LTS * `sudo apt-get install ansible git aptitude` * `sudo vim /etc/ansible/hosts` * Add: `localhost ansible_connection=local` @@ -115,7 +119,6 @@ Follow the MOTD in the VM to run the example topology and the dummy-gatekeeper. ## 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. @@ -129,23 +132,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) * [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/REST-API-command-overview) ## License @@ -168,6 +159,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