Merge remote-tracking branch 'upstream/master'

[osm/vim-emu.git] / README.md

diff --git a/README.md b/README.md
index aedc685..f144818 100755 (executable)
--- a/README.md
+++ b/README.md
@@ -5,11 +5,14 @@ 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 direct 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):
+### Cite this work

 
 

-* 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).
+If you use son-emu for your research and/or other publications, please cite the following paper to reference our work:

 
 

-A short demo that showcases son-emu together with its dummy gatekeeper is available [here](https://youtu.be/BgWDp5CM0io).
+* 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
+
+A short demo that showcases son-emu together with its dummy gatekeeper is available [here](https://www.youtube.com/watch?v=ZANz97pV9ao).

 
 ### Development
 
 
 ### Development
 


@@ -55,7 +58,6 @@ Despite of this son-emu has the following dependencies:
 * [flask_restful](https://pypi.python.org/pypi/Flask-RESTful) >= 0.3 (BSD)
 * [networkx](https://pypi.python.org/pypi/networkx/) >= 1.11  (BSD)
 * [oslo.config](http://docs.openstack.org/developer/oslo.config/) >= 3.9.0  (Apache 2.0)
 * [flask_restful](https://pypi.python.org/pypi/Flask-RESTful) >= 0.3 (BSD)
 * [networkx](https://pypi.python.org/pypi/networkx/) >= 1.11  (BSD)
 * [oslo.config](http://docs.openstack.org/developer/oslo.config/) >= 3.9.0  (Apache 2.0)

-* [paramiko](https://pypi.python.org/pypi/paramiko/1.16.0) >= 1.6 (LGPL)

 * [prometheus_client](https://pypi.python.org/pypi/prometheus_client) >= 0.0.13 (Apache 2.0)
 * [pyaml](https://pypi.python.org/pypi/pyaml) >=15.8.2 (WTFPL)
 * [pytest-runner](https://pypi.python.org/pypi/pytest-runner) >= 2.8 (MIT)
 * [prometheus_client](https://pypi.python.org/pypi/prometheus_client) >= 0.0.13 (Apache 2.0)
 * [pyaml](https://pypi.python.org/pypi/pyaml) >=15.8.2 (WTFPL)
 * [pytest-runner](https://pypi.python.org/pypi/pytest-runner) >= 2.8 (MIT)


@@ -68,7 +70,7 @@ Despite of this son-emu has the following dependencies:
 * [zerorpc](http://www.zerorpc.io) >= 0.5.2 (MIT)
 
 ### Contributing
 * [zerorpc](http://www.zerorpc.io) >= 0.5.2 (MIT)
 
 ### Contributing

-Contributing to the Gatekeeper is really easy. You must:
+Contributing to the son-emu is really easy. You must:

 
 1. Clone [this repository](http://github.com/sonata-nfv/son-emu);
 2. Work on your proposed changes, preferably through submiting [issues](https://github.com/sonata-nfv/son-emu/issues);
 
 1. Clone [this repository](http://github.com/sonata-nfv/son-emu);
 2. Work on your proposed changes, preferably through submiting [issues](https://github.com/sonata-nfv/son-emu/issues);


@@ -76,7 +78,7 @@ Contributing to the Gatekeeper is really easy. You must:
 4. Follow/answer related [issues](https://github.com/sonata-nfv/son-emu/issues) (see Feedback-Chanel, below).
 
 ## Installation
 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 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.

 
 ### Vagrant Installation
 
 
 ### Vagrant Installation
 


@@ -90,15 +92,15 @@ Follow the MOTD in the VM to run the example topology and the dummy-gatekeeper.
 
 ### Ansible Installation
 
 
 ### Ansible Installation
 

-* Requires: Ubuntu 14.04 LTS or 16.04 LTS
-* `sudo apt-get install ansible git`
+* Requires: Ubuntu 14.04 LTS
+* `sudo apt-get install ansible git aptitude`

 * `sudo vim /etc/ansible/hosts`
 * Add: `localhost ansible_connection=local`
 
 #### 1. Containernet
 
 * `cd`
 * `sudo vim /etc/ansible/hosts`
 * Add: `localhost ansible_connection=local`
 
 #### 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) ...
 * `cd ~/containernet/ansible`
 * `sudo ansible-playbook install.yml`
 * Wait (and have a coffee) ...


@@ -141,8 +143,9 @@ This example shows how to deploy a SONATA example package in the emulator using
 Note: The [son-push](https://github.com/mpeuster/son-cli) tool can be used instead of CURL.
 
 
 Note: The [son-push](https://github.com/mpeuster/son-cli) tool can be used instead of CURL.
 
 

-### CLI Commands
+### 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)

 
 ## License
 
 
 ## License
 


@@ -160,7 +163,13 @@ The following lead developers are responsible for this repository and have admin
 * Manuel Peuster (https://github.com/mpeuster)
 * Steven Van Rossem (https://github.com/stevenvanrossem)
 
 * Manuel Peuster (https://github.com/mpeuster)
 * Steven Van Rossem (https://github.com/stevenvanrossem)
 

+#### Contributors
+
+* Hadi Razzaghi Kouchaksaraei (https://github.com/hadik3r)
+* Wouter Tavernier (https://github.com/wtaverni)
+* Geoffroy Chollon (https://github.com/cgeoffroy)
+

 #### Feedback-Chanel
 
 * You may use the mailing list [sonata-dev@lists.atosresearch.eu](mailto:sonata-dev@lists.atosresearch.eu)
 #### Feedback-Chanel
 
 * You may use the mailing list [sonata-dev@lists.atosresearch.eu](mailto:sonata-dev@lists.atosresearch.eu)

-* * [GitHub issues](https://github.com/sonata-nfv/son-emu/issues)
+* [GitHub issues](https://github.com/sonata-nfv/son-emu/issues)