X-Git-Url: https://osm.etsi.org/gitweb/?p=osm%2Fvim-emu.git;a=blobdiff_plain;f=README.md;h=e471c9e28081a473bbcc71efc592301b43db5fe2;hp=b01ed190906d401c9eed3e6d761f3b0ad7e4ffed;hb=102d7268b0f64ecdf9c88c0a8b93c54dea1dd908;hpb=2921ffdcb0fd66dd48170fc5c22d3d7f3c007ada diff --git a/README.md b/README.md index b01ed19..e471c9e 100755 --- a/README.md +++ b/README.md @@ -1,3 +1,31 @@ + + # 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). @@ -16,60 +44,76 @@ If you use the emulation platform for your research and/or other publications, p ## Installation -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. +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. + +### Automated installation (recommended) + +```sh +./install_osm.sh --lxdimages --vimemu +``` -### Option 1: Bare-metal installation +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. -* Requires: Ubuntu 16.04 LTS -* `sudo apt-get install ansible git aptitude` +### Manual installation -#### 1. Containernet +#### Option 1: Bare-metal installation -* `cd` -* `git clone https://github.com/containernet/containernet.git` -* `cd ~/containernet/ansible` -* `sudo ansible-playbook -i "localhost," -c local install.yml` +```sh +sudo apt-get install ansible git aptitude +``` -#### 2. vim-emu +##### Step 1. Containernet installation -* `cd` -* `git clone https://github.com/sonata-nfv/son-emu.git` -* `cd ~/son-emu/ansible` -* `sudo ansible-playbook -i "localhost," -c local install.yml` +```sh +cd +git clone https://github.com/containernet/containernet.git +cd ~/containernet/ansible +sudo ansible-playbook -i "localhost," -c local install.yml +``` -### Option 3: Nested Docker Deployment +##### 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. -* `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` +```sh +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` -* `vagrant up` -* `vagrant ssh` to enter the new VM in which the emulator is installed. ## Usage ### 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 ` 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` + +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). ### 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) @@ -87,9 +131,9 @@ Please check [this OSM wiki page](https://osm.etsi.org/wikipub/index.php/Workflo To run the unit tests do: -* `cd ~/son-emu` -* `sudo py.test -v src/emuvim/test/unittests` -(To force Python2: `python2 -m pytest -v src/emuvim/test/unittests`) +* `cd ~/vim-emu` +* `sudo pytest -v` +* (To force Python2: `sudo python2 -m pytest -v`) ## Seed code contributors: