X-Git-Url: https://osm.etsi.org/gitweb/?p=osm%2Fvim-emu.git;a=blobdiff_plain;f=README.md;h=0c59264888d54e10e549156238502f7cdda3aa6f;hp=43cfa9134d28ff22b93bd27ca319d9dc075377d9;hb=3e16acbebd2c6669c1bbe5a7e3bb313aa1494e20;hpb=968ffece3ba6bd05ed695696207ca1341fc8273a

diff --git a/README.md b/README.md
index 43cfa91..0c59264 100755
--- a/README.md
+++ b/README.md
@@ -1,64 +1,161 @@
-[![Build Status](http://jenkins.sonata-nfv.eu/buildStatus/icon?job=son-emu)](http://jenkins.sonata-nfv.eu/job/son-emu)
+<!--
+# Copyright (c) 2017 SONATA-NFV and Paderborn University
+# ALL RIGHTS RESERVED.
+# 
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# Neither the name of the SONATA-NFV, Paderborn University
+# nor the names of its contributors may be used to endorse or promote
+# products derived from this software without specific prior written
+# permission.
+#
+# This work has been performed in the framework of the SONATA project,
+# funded by the European Commission under Grant number 671517 through
+# the Horizon 2020 and 5G-PPP programmes. The authors would like to
+# acknowledge the contributions of their colleagues of the SONATA
+# partner consortium (www.sonata-nfv.eu).
+-->
+
+# vim-emu: A NFV multi-PoP emulation platform
+
+This emulation platform was created to support network service developers to locally prototype and test their network services 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 developer's machine. The emulation platform also offers OpenStack-like APIs for each emulated PoP so that it can integrate with MANO solutions, like OSM. The core of the emulation platform is based on [Containernet](https://containernet.github.io).
+
+The emulation platform `vim-emu` is developed as part of OSM's DevOps MDG.
+
+### Acknowledgments
+
+This software was originally developed by the [SONATA project](http://www.sonata-nfv.eu), funded by the European Commission under grant number 671517 through the Horizon 2020 and 5G-PPP programs.
+
+### Cite this work
+
+If you use the emulation platform 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)
 
-# son-emu
-Here comes a brief description of the repository and the code inside.
+## Installation
 
-## Development
-(if applicable)
-
-### Building
-Describe briefly how to build the software.
-
-### Dependencies
-Name all the dependencies needed by the software, including version, license (!), and a link. For example
-
-* [pyaml](https://pypi.python.org/pypi/pyaml) >=15.8.2 (WTFPL)
-* [zerorpc](http://www.zerorpc.io) >= 0.5.2 (MIT)
-* [tabulate](https://pypi.python.org/pypi/tabulate) >= 0.7.5 (public domain)
-* [argparse](https://pypi.python.org/pypi/argparse) >= 1.4.0 (Python software foundation License)
-* [networkx](https://pypi.python.org/pypi/networkx/) >= 1.11  (BSD)
-* [six](https://pypi.python.org/pypi/six/) >=1.9 (MIT)
-* [ryu](https://pypi.python.org/pypi/ryu/4.4) >= 4.4 (Apache 2.0)
-* [oslo.config](http://docs.openstack.org/developer/oslo.config/) >= 3.9.0  (Apache 2.0)
-* [pytest](https://pypi.python.org/pypi/pytest) >= 2.9 (MIT)
-* [pytest-runner](https://pypi.python.org/pypi/pytest-runner) >= 2.8 (MIT)
-* [Flask](https://pypi.python.org/pypi/Flask) >= 0.11 (BSD)
-* [flask_restful](https://pypi.python.org/pypi/Flask-RESTful) >= 0.3 (BSD)
-* [requests](https://pypi.python.org/pypi/requests) >= 2.10 (Apache 2.0)
-* [docker-py](https://pypi.python.org/pypi/docker-py) == 1.7.1(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)
-* [urllib3](https://pypi.python.org/pypi/urllib3) >= 1.15 (MIT)
-
-### Contributing
-(if applicable) Description (encouraging) how to contribute to this project/repository.
+There are multiple ways to install and use the emulation platform. The easiest way is the automated installation using the OSM installer. The bare-metal installation requires a freshly installed Ubuntu 16.04 LTS and is done by an ansible playbook. Another option is to use a nested Docker environment to run the emulator inside a Docker container.
 
-## Installation
-(if applicable) Describe briefly how to install the software. You may want to put a link to son-install instead:
+### Automated installation (recommended)
+
+```sh
+./install_osm.sh --lxdimages --vimemu
+```
+
+This command will install OSM (as LXC containers) as well as the emulator (as a Docker container) on a local machine. It is recommended to use a machine with Ubuntu 16.04.
+
+### Manual installation
+
+#### Option 1: Bare-metal installation
+
+```sh
+sudo apt-get install ansible git aptitude
+```
+
+##### Step 1. Containernet installation
+
+```sh
+cd
+git clone https://github.com/containernet/containernet.git
+cd ~/containernet/ansible
+sudo ansible-playbook -i "localhost," -c local install.yml
+```
+
+##### Step 2. vim-emu installation
+
+```sh
+cd
+git clone https://osm.etsi.org/gerrit/osm/vim-emu.git
+cd ~/vim-emu/ansible
+sudo ansible-playbook -i "localhost," -c local install.yml
+```
+
+#### Option 2: Nested Docker Deployment
+This option requires a Docker installation on the host machine on which the emulator should be deployed.
+
+```sh
+git clone https://osm.etsi.org/gerrit/osm/vim-emu.git</code>
+cd ~/vim-emu</code>
+# build the container:
+docker build -t vim-emu-img .
+# run the (interactive) container:
+docker run --name vim-emu -it --rm --privileged --pid='host' -v /var/run/docker.sock:/var/run/docker.sock vim-emu-img /bin/bash
+```
 
-The installation of this component can be done using the [son-install](https://github.com/sonata-nfv/son-install) script.
 
 ## Usage
-(if applicable) Describe briefly how to use the software.
 
-## License
+### Example
 
-This [SOFTWARE] is published under Apache 2.0 license. Please see the LICENSE file for more details.
+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 vim-emu CLI.
 
-## Useful Links
+* First terminal (start the emulation platform):
+    * `sudo python examples/default_single_dc_topology.py`
+* Second terminal (use `docker exec vim-emu <command>` for nested Docker deployment):
+    * `vim-emu compute start -d dc1 -n vnf1`
+    * `vim-emu compute start -d dc1 -n vnf2`
+    * `vim-emu compute list`
+* First terminal:
+    * `containernet> vnf1 ifconfig`
+    * `containernet> vnf1 ping -c 2 vnf2`
 
-* Any useful link and brief description. For example:
-* http://www.google/ Don't be evil.
+A more advanced example that includes OSM can be found in the [official vim-emu documentation in the OSM wiki](https://osm.etsi.org/wikipub/index.php/VIM_emulator).
 
----
-#### Lead Developers
+### Further documentation and useful links
+
+* [Official vim-emu documentation in the OSM wiki](https://osm.etsi.org/wikipub/index.php/VIM_emulator)
+* [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)
+* [Mininet](http://mininet.org)
+* [Containernet](https://containernet.github.io)
+* [Maxinet](https://maxinet.github.io)
+
+## Development
+
+### How to contribute?
+
+Please check [this OSM wiki page](https://osm.etsi.org/wikipub/index.php/Workflow_with_OSM_tools) to learn how to contribute to a OSM module.
+
+### Testing
+
+To run the unit tests do:
+
+* `cd ~/vim-emu`
+* `sudo py.test -v src/emuvim/test/unittests`
+(To force Python2: `python2 -m  pytest -v src/emuvim/test/unittests`)
+
+## Seed code contributors:
+
+### Lead:
+
+* 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)
+* Eduard Maas (https://github.com/edmaas)
+* Malte Splietker (https://github.com/splietker)
+* Johannes Kampmeyer (https://github.com/xschlef)
+
+## License
 
-The following lead developers are responsible for this repository and have admin rights. They can, for example, merge pull requests.
+The emulation platform is published under Apache 2.0 license. Please see the LICENSE file for more details.
 
-* Manuel Peuster (mpeuster)
-* Steven Van Rossem (stevenvanrossem)
+## Contact
 
-#### Feedback-Chanel
+Manuel Peuster (Paderborn University) <manuel@peuster.de>
 
-* You may use the mailing list sonata-dev@lists.atosresearch.eu
-* Please use the GitHub issues to report bugs.