+<!--
+# 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).
#### 2. vim-emu
* `cd`
-* `git clone https://github.com/sonata-nfv/son-emu.git`
-* `cd ~/son-emu/ansible`
+* `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 3: Nested Docker Deployment
+### Option 2: Nested Docker Deployment
This option requires a Docker installation on the host machine on which the emulator should be deployed.
-* `git clone https://github.com/sonata-nfv/son-emu.git`
-* `cd ~/son-emu`
-* Build the container: `docker build -t son-emu-img .`
-* Run the (interactive) container: `docker run --name son-emu -it --rm --privileged --pid='host' -v /var/run/docker.sock:/var/run/docker.sock son-emu-img /bin/bash`
+* `git clone https://osm.etsi.org/gerrit/osm/vim-emu.git`
+* `cd ~/vim-emu`
+* 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`
### Option 3: Vagrant Installation
* Request VirtualBox and Vagrant to be installed on the system.
-* `git clone https://github.com/sonata-nfv/son-emu.git`
-* `cd ~/son-emu`
+* `git clone https://osm.etsi.org/gerrit/osm/vim-emu.git`
+* `cd ~/vim-emu`
* `vagrant up`
* `vagrant ssh` to enter the new VM in which the emulator is installed.
### 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.
+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.
* First terminal (start the emulation platform):
- * `sudo python examples/simple_topology.py`
-* Second terminal:
- * `son-emu-cli compute start -d datacenter1 -n vnf1`
- * `son-emu-cli compute start -d datacenter1 -n vnf2`
- * `son-emu-cli compute list`
+ * `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`
+ * `containernet> vnf1 ifconfig`
+ * `containernet> vnf1 ping -c 2 vnf2`
### Further documentation and useful links
To run the unit tests do:
-* `cd ~/son-emu`
+* `cd ~/vim-emu`
* `sudo py.test -v src/emuvim/test/unittests`
(To force Python2: `python2 -m pytest -v src/emuvim/test/unittests`)
projects / osm / vim-emu.git / blobdiff