README.md

   1 <!--
   2 # Copyright (c) 2017 SONATA-NFV and Paderborn University
   3 # ALL RIGHTS RESERVED.
   4 #
   5 # Licensed under the Apache License, Version 2.0 (the "License");
   6 # you may not use this file except in compliance with the License.
   7 # You may obtain a copy of the License at
   8 #
   9 #    http://www.apache.org/licenses/LICENSE-2.0
  10 #
  11 # Unless required by applicable law or agreed to in writing, software
  12 # distributed under the License is distributed on an "AS IS" BASIS,
  13 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14 # See the License for the specific language governing permissions and
  15 # limitations under the License.
  16 #
  17 # Neither the name of the SONATA-NFV, Paderborn University
  18 # nor the names of its contributors may be used to endorse or promote
  19 # products derived from this software without specific prior written
  20 # permission.
  21 #
  22 # This work has been performed in the framework of the SONATA project,
  23 # funded by the European Commission under Grant number 671517 through
  24 # the Horizon 2020 and 5G-PPP programmes. The authors would like to
  25 # acknowledge the contributions of their colleagues of the SONATA
  26 # partner consortium (www.sonata-nfv.eu).
  27 -->
  28
  29 # vim-emu: A NFV multi-PoP emulation platform
  30
  31 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).
  32
  33 The emulation platform `vim-emu` is developed as part of OSM's DevOps MDG.
  34
  35 ### Acknowledgments
  36
  37 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.
  38
  39 ### Cite this work
  40
  41 If you use the emulation platform for your research and/or other publications, please cite the following paper to reference our work:
  42
  43 * 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)
  44
  45 ## Installation
  46
  47 There are three ways to install and use the emulation platform. The bare-metal installation requires a freshly installed Ubuntu 16.04 LTS and is done by an ansible playbook. The second option is to use a nested Docker environment to run the emulator inside a Docker container. The third option is to use Vagrant to create a VirtualBox-based VM on your machine that contains the pre-installed and configured emulator.
  48
  49 ### Option 1: Bare-metal installation
  50
  51 * Requires: Ubuntu 16.04 LTS
  52 * `sudo apt-get install ansible git aptitude`
  53
  54 #### 1. Containernet
  55
  56 * `cd`
  57 * `git clone https://github.com/containernet/containernet.git`
  58 * `cd ~/containernet/ansible`
  59 * `sudo ansible-playbook -i "localhost," -c local install.yml`
  60
  61 #### 2. vim-emu
  62
  63 * `cd`
  64 * `git clone https://osm.etsi.org/gerrit/osm/vim-emu.git`
  65 * `cd ~/vim-emu/ansible`
  66 * `sudo ansible-playbook -i "localhost," -c local install.yml`
  67
  68 ### Option 2: Nested Docker Deployment
  69 This option requires a Docker installation on the host machine on which the emulator should be deployed.
  70
  71 * `git clone https://osm.etsi.org/gerrit/osm/vim-emu.git`
  72 * `cd ~/vim-emu`
  73 * Build the container: `docker build -t vim-emu-img .`
  74 * 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`
  75
  76 ### Option 3: Vagrant Installation
  77 * Request VirtualBox and Vagrant to be installed on the system.
  78 * `git clone https://osm.etsi.org/gerrit/osm/vim-emu.git`
  79 * `cd ~/vim-emu`
  80 * `vagrant up`
  81 * `vagrant ssh` to enter the new VM in which the emulator is installed.
  82
  83 ## Usage
  84
  85 ### Example
  86
  87 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.
  88
  89 * First terminal (start the emulation platform):
  90     * `sudo python examples/default_single_dc_topology.py`
  91 * Second terminal (use `docker exec vim-emu <command>` for nested Docker deployment):
  92     * `vim-emu compute start -d dc1 -n vnf1`
  93     * `vim-emu compute start -d dc1 -n vnf2`
  94     * `vim-emu compute list`
  95 * First terminal:
  96     * `containernet> vnf1 ifconfig`
  97     * `containernet> vnf1 ping -c 2 vnf2`
  98
  99 ### Further documentation and useful links
 100
 101 * [Full CLI command documentation](https://github.com/sonata-nfv/son-emu/wiki/CLI-Command-Overview)
 102 * [Requirements for Docker containers executed by the emulator](https://github.com/sonata-nfv/son-emu/wiki/Container-Requirements)
 103 * [REST API](https://github.com/sonata-nfv/son-emu/wiki/APIs)
 104 * [Mininet](http://mininet.org)
 105 * [Containernet](https://containernet.github.io)
 106 * [Maxinet](https://maxinet.github.io)
 107
 108 ## Development
 109
 110 ### How to contribute?
 111
 112 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.
 113
 114 ### Testing
 115
 116 To run the unit tests do:
 117
 118 * `cd ~/vim-emu`
 119 * `sudo py.test -v src/emuvim/test/unittests`
 120 (To force Python2: `python2 -m  pytest -v src/emuvim/test/unittests`)
 121
 122 ## Seed code contributors:
 123
 124 ### Lead:
 125
 126 * Manuel Peuster (https://github.com/mpeuster)
 127 * Steven Van Rossem (https://github.com/stevenvanrossem)
 128
 129 ### Contributors
 130
 131 * Hadi Razzaghi Kouchaksaraei (https://github.com/hadik3r)
 132 * Wouter Tavernier (https://github.com/wtaverni)
 133 * Geoffroy Chollon (https://github.com/cgeoffroy)
 134 * Eduard Maas (https://github.com/edmaas)
 135 * Malte Splietker (https://github.com/splietker)
 136 * Johannes Kampmeyer (https://github.com/xschlef)
 137
 138 ## License
 139
 140 The emulation platform is published under Apache 2.0 license. Please see the LICENSE file for more details.
 141
 142 ## Contact
 143
 144 Manuel Peuster (Paderborn University) <manuel@peuster.de>
 145