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
  30 # vim-emu: A NFV multi-PoP emulation platform
  31
  32 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).
  33
  34 The emulation platform `vim-emu` is developed as part of OSM's DevOps MDG.
  35
  36 ### Acknowledgments
  37
  38 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.
  39
  40 ### Cite this work
  41
  42 If you use the emulation platform for your research and/or other publications, please cite the following paper to reference our work:
  43
  44 * 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)
  45
  46 Bibtex:
  47
  48 ```bibtex
  49 @inproceedings{peuster2016medicine,
  50     author={M. Peuster and H. Karl and S. van Rossem},
  51     booktitle={2016 IEEE Conference on Network Function Virtualization and Software Defined Networks (NFV-SDN)},
  52     title={MeDICINE: Rapid prototyping of production-ready network services in multi-PoP environments},
  53     year={2016},
  54     volume={},
  55     number={},
  56     pages={148-153},
  57     doi={10.1109/NFV-SDN.2016.7919490},
  58     month={Nov}
  59 }
  60 ```
  61
  62 ## Installation
  63
  64 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.
  65
  66 ### Automated installation (recommended)
  67
  68 ```sh
  69 ./install_osm.sh --lxdimages --vimemu
  70 ```
  71
  72 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.
  73
  74 ### Manual installation
  75
  76 #### Option 1: Bare-metal installation
  77
  78 ```sh
  79 sudo apt-get install ansible git aptitude
  80 ```
  81
  82 ##### Step 1. Containernet installation
  83
  84 ```sh
  85 cd
  86 git clone https://github.com/containernet/containernet.git
  87 cd ~/containernet/ansible
  88 sudo ansible-playbook -i "localhost," -c local install.yml
  89 cd ..
  90 sudo python setup.py install
  91 ```
  92
  93 ##### Step 2. vim-emu installation
  94
  95 ```sh
  96 cd
  97 git clone https://osm.etsi.org/gerrit/osm/vim-emu.git
  98 cd ~/vim-emu/ansible
  99 sudo ansible-playbook -i "localhost," -c local install.yml
 100 cd ..
 101 sudo python setup.py install
 102 ```
 103
 104 #### Option 2: Nested Docker Deployment
 105 This option requires a Docker installation on the host machine on which the emulator should be deployed.
 106
 107 ```sh
 108 git clone https://osm.etsi.org/gerrit/osm/vim-emu.git</code>
 109 cd ~/vim-emu</code>
 110 # build the container:
 111 docker build -t vim-emu-img .
 112 # run the (interactive) container:
 113 docker run --name vim-emu -it --rm --privileged --pid='host' -v /var/run/docker.sock:/var/run/docker.sock vim-emu-img /bin/bash
 114 ```
 115
 116
 117 ## Usage
 118
 119 ### Example
 120
 121 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.
 122
 123 * First terminal (start the emulation platform):
 124     * `sudo python examples/default_single_dc_topology.py`
 125 * Second terminal (use `docker exec vim-emu <command>` for nested Docker deployment):
 126     * `vim-emu compute start -d dc1 -n vnf1`
 127     * `vim-emu compute start -d dc1 -n vnf2`
 128     * `vim-emu compute list`
 129 * First terminal:
 130     * `containernet> vnf1 ifconfig`
 131     * `containernet> vnf1 ping -c 2 vnf2`
 132
 133 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).
 134
 135 ### Further documentation and useful links
 136
 137 * [Official vim-emu documentation in the OSM wiki](https://osm.etsi.org/wikipub/index.php/VIM_emulator)
 138 * [Full vim-emu documentation on GitHub](https://github.com/containernet/vim-emu)
 139 * [Mininet](http://mininet.org)
 140 * [Containernet](https://containernet.github.io)
 141 * [Maxinet](https://maxinet.github.io)
 142
 143 ## Development
 144
 145 ### How to contribute?
 146
 147 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.
 148
 149 ### Testing
 150
 151 To run the unit tests do:
 152
 153 * `cd ~/vim-emu`
 154 * `sudo pytest -v`
 155 * (To force Python2: `sudo python2 -m  pytest -v`)
 156
 157 ## Seed code contributors:
 158
 159 ### Lead:
 160
 161 * Manuel Peuster (https://github.com/mpeuster)
 162 * Steven Van Rossem (https://github.com/stevenvanrossem)
 163
 164 ### Contributors
 165
 166 * Hadi Razzaghi Kouchaksaraei (https://github.com/hadik3r)
 167 * Wouter Tavernier (https://github.com/wtaverni)
 168 * Geoffroy Chollon (https://github.com/cgeoffroy)
 169 * Eduard Maas (https://github.com/edmaas)
 170 * Malte Splietker (https://github.com/splietker)
 171 * Johannes Kampmeyer (https://github.com/xschlef)
 172 * Stefan Schneider (https://github.com/StefanUPB)
 173
 174 ## License
 175
 176 The emulation platform is published under Apache 2.0 license. Please see the LICENSE file for more details.
 177
 178 ## Contact
 179
 180 Manuel Peuster (Paderborn University) <manuel@peuster.de>
 181