VIM emulator - Revision history

Ramonsalguer at 17:17, 17 February 2021

2021-02-17T17:17:37Z

← Older revision		Revision as of 17:17, 17 February 2021
Line 1:		Line 1:
			'''THIS PAGE IS DEPRECATED'''. OSM User Guide has been moved to a new location: '''https://osm.etsi.org/docs/user-guide/'''

			---

	= Vim-emu: A NFV multi-PoP emulation platform =		= Vim-emu: A NFV multi-PoP emulation platform =

Peusterm at 08:51, 7 February 2020

2020-02-07T08:51:59Z

← Older revision		Revision as of 08:51, 7 February 2020
Line 55:		Line 55:

	=== Walkthrough ===		=== Walkthrough ===

			==== Step 0: Make sure Open vSwitch is installed ====

			Open vSwitch must be installed on the host on which you want to install OSM and vim-emu.

			$ sudo apt-get install openvswitch-switch

	==== Step 1: Install OSM and vim-emu ====		==== Step 1: Install OSM and vim-emu ====

Peusterm at 15:41, 19 December 2019

2019-12-19T15:41:12Z

← Older revision		Revision as of 15:41, 19 December 2019
Line 3:		Line 3:
	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 [https://containernet.github.io Containernet].		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 [https://containernet.github.io Containernet].

	~~The emulation platform <code>vim-emu</code>~~ was ~~previously~~ developed ~~as part of~~ the ~~EU H2020 project~~ [http://sonata-nfv.eu SONATA] and ~~is now developed as part of OSM's DevOps MDG~~.		This software was originally developed by the [http://www.sonata-nfv.eu SONATA project] and the [https://5gtango.eu/ 5GTANGO project], funded by the European Commission under grant number 671517 and 761493 through the Horizon 2020 and 5G-PPP programs.

	== Cite this work ==		== Cite this work ==
Line 69:		Line 69:
	If not, start it with the following command:		If not, start it with the following command:

	$ docker run --name vim-emu -t -d --rm --privileged --pid='host' --network=netosm -v /var/run/docker.sock:/var/run/docker.sock vim-emu-img ~~python~~ examples/osm_default_daemon_topology_2_pop.py		$ docker run --name vim-emu -t -d --rm --privileged --pid='host' --network=netosm -v /var/run/docker.sock:/var/run/docker.sock vim-emu-img python3 examples/osm_default_daemon_topology_2_pop.py


Line 208:		Line 208:
	=== Automated installation (with OSM) ===		=== Automated installation (with OSM) ===

	The following command will install OSM as well as the emulator (as a Docker container) on a local machine. It is recommended to use a machine with Ubuntu 16.04.		The following command will install OSM as well as the emulator (as a Docker container) on a local machine. It is recommended to use a machine with Ubuntu 18.04.

	$ ./install_osm.sh --vimemu		$ ./install_osm.sh --vimemu
Line 215:		Line 215:
	==== Option 1: Bare-metal installation ====		==== Option 1: Bare-metal installation ====

	* Requires: Ubuntu 16.04 LTS		* Requires: Ubuntu 18.04 LTS

	$ sudo apt-get install ansible git aptitude		$ sudo apt-get install ansible git aptitude
Line 232:		Line 232:
	$ cd ~/vim-emu/ansible		$ cd ~/vim-emu/ansible
	$ sudo ansible-playbook -i "localhost," -c local install.yml		$ sudo ansible-playbook -i "localhost," -c local install.yml
			$ cd ..
			$ sudo python3 setup.py develop

	==== Option 2: Nested Docker Deployment ====		==== Option 2: Nested Docker Deployment ====
Line 241:		Line 243:
	# build the container:		# build the container:
	$ docker build -t vim-emu-img .		$ docker build -t vim-emu-img .

	# run the (interactive) container:		# run the (interactive) container:
	$ docker run --name vim-emu -it --rm --privileged --pid='host' --network=netosm -v /var/run/docker.sock:/var/run/docker.sock vim-emu-img /bin/bash		$ docker run --name vim-emu -it --rm --privileged --pid='host' --network=netosm -v /var/run/docker.sock:/var/run/docker.sock vim-emu-img /bin/bash

	# alternative: run container with emulator in service mode		# alternative: run container with emulator in service mode
	$ docker run --name vim-emu -t -d --rm --privileged --pid='host' --network=netosm -v /var/run/docker.sock:/var/run/docker.sock vim-emu-img ~~python~~ examples/osm_default_daemon_topology_2_pop.py		$ docker run --name vim-emu -t -d --rm --privileged --pid='host' --network=netosm -v /var/run/docker.sock:/var/run/docker.sock vim-emu-img python3 examples/osm_default_daemon_topology_2_pop.py

	== Additional information and links ==		== Additional information and links ==

	* Main publication: M. Peuster, H. Karl, and S. v. Rossem: [http://ieeexplore.ieee.org/document/7919490/ '''MeDICINE: Rapid Prototyping of Production-Ready Network Services in Multi-PoP Environments''']. 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)		* Main publication: M. Peuster, H. Karl, and S. v. Rossem: [http://ieeexplore.ieee.org/document/7919490/ '''MeDICINE: Rapid Prototyping of Production-Ready Network Services in Multi-PoP Environments''']. 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)


			* [https://github.com/containernet/vim-emu Official vim-emu repository mirror on GitHub]
			* [https://osm.etsi.org/wikipub/index.php/VIM_emulator Official vim-emu documentation in the OSM wiki]
			* [https://github.com/containernet/vim-emu Full vim-emu documentation on GitHub]
			* [http://mininet.org Mininet]
	* [https://containernet.github.io Containernet]		* [https://containernet.github.io Containernet]
	* [http://sonata-nfv.eu SONATA NFV]
	* [https://github.com/sonata-nfv/son-emu/wiki SONATA wiki (more documentation)]
	* [https://youtu.be/pFL9wDNOBho Demo Video on YouTube]

	== Contact ==		== Contact ==

	If you have questions, please use the OSM TECH mailing list: [mailto:OSM_TECH@LIST.ETSI.ORG OSM_TECH@LIST.ETSI.ORG]		If you have questions, please use the OSM TECH mailing list: [mailto:OSM_TECH@LIST.ETSI.ORG OSM_TECH@LIST.ETSI.ORG].

	~~Direct contact:~~ Manuel Peuster (~~Paderborn University~~) <manuel@peuster.de>		Manuel Peuster (vim-emu lead developer)
			* Mail: <manuel (at) peuster (dot) de>
			* Twitter: [https://twitter.com/ManuelPeuster @ManuelPeuster]
			* GitHub: [https://github.com/mpeuster @mpeuster]
			* Website: [https://peuster.de]

Peusterm at 18:17, 15 January 2019

2019-01-15T18:17:04Z

← Older revision		Revision as of 18:17, 15 January 2019
Line 141:		Line 141:

	# connect to ping VNF container '''(in another terminal window)''':		# connect to ping VNF container '''(in another terminal window)''':
	$ sudo docker exec -it mn.dc1_test~~.ping.~~1.ubuntu /bin/bash		$ sudo docker exec -it mn.dc1_test-1-ubuntu-1 /bin/bash

	# show network config		# show network config
Line 162:		Line 162:

	# ping the pong VNF over the attached management network		# ping the pong VNF over the attached management network
	root@dc1_test-~~nsi~~:/# ping ~~-c2~~ 192.168.100.8		root@dc1_test-1-ubuntu-1:/# ping 192.168.100.4
	PING 192.168.100.4 (192.168.100.4) 56(84) bytes of data.		PING 192.168.100.4 (192.168.100.4) 56(84) bytes of data.
	64 bytes from 192.168.100.4: icmp_seq=1 ttl=64 time=0.~~070~~ ms		64 bytes from 192.168.100.4: icmp_seq=1 ttl=64 time=0.596 ms
	64 bytes from 192.168.100.4: icmp_seq=2 ttl=64 time=0.~~048~~ ms		64 bytes from 192.168.100.4: icmp_seq=2 ttl=64 time=0.070 ms
	--- 192.168.100.4 ping statistics ---		--- 192.168.100.4 ping statistics ---
	2 packets transmitted, 2 received, 0% packet loss, time 999ms		2 packets transmitted, 2 received, 0% packet loss, time 999ms

Peusterm at 11:13, 10 December 2018

2018-12-10T11:13:10Z

← Older revision		Revision as of 11:13, 10 December 2018
Line 69:		Line 69:
	If not, start it with the following command:		If not, start it with the following command:

	$ docker run --name vim-emu -t -d --rm --privileged --pid='host' --network=~~netOSM~~ -v /var/run/docker.sock:/var/run/docker.sock vim-emu-img python examples/osm_default_daemon_topology_2_pop.py		$ docker run --name vim-emu -t -d --rm --privileged --pid='host' --network=netosm -v /var/run/docker.sock:/var/run/docker.sock vim-emu-img python examples/osm_default_daemon_topology_2_pop.py


Line 242:		Line 242:
	$ docker build -t vim-emu-img .		$ docker build -t vim-emu-img .
	# run the (interactive) container:		# run the (interactive) container:
	$ docker run --name vim-emu -it --rm --privileged --pid='host' --network=~~netOSM~~ -v /var/run/docker.sock:/var/run/docker.sock vim-emu-img /bin/bash		$ docker run --name vim-emu -it --rm --privileged --pid='host' --network=netosm -v /var/run/docker.sock:/var/run/docker.sock vim-emu-img /bin/bash

	# alternative: run container with emulator in service mode		# alternative: run container with emulator in service mode
	$ docker run --name vim-emu -t -d --rm --privileged --pid='host' --network=~~netOSM~~ -v /var/run/docker.sock:/var/run/docker.sock vim-emu-img python examples/osm_default_daemon_topology_2_pop.py		$ docker run --name vim-emu -t -d --rm --privileged --pid='host' --network=netosm -v /var/run/docker.sock:/var/run/docker.sock vim-emu-img python examples/osm_default_daemon_topology_2_pop.py

	== Additional information and links ==		== Additional information and links ==

Peusterm at 19:40, 4 December 2018

2018-12-04T19:40:03Z

← Older revision		Revision as of 19:40, 4 December 2018
Line 30:		Line 30:
	[[File:Vim-emu-setup.png\|400px]]		[[File:Vim-emu-setup.png\|400px]]

	~~== Usage example ==~~		----

	This section gives an end-to-end usage example that ~~show~~ how to connect OSM to a vim-emu instance and how to on-board and instantiate an example network service with two VNFs on the emulated infrastructure. All given paths are relative to the vim-emu repository root. The same example is also available for the classic build of OSM: [[VIM_emulator_classic_build_walkthrough\|vim-emu classic build walkthrough]].		== Example: OSM using vim-emu ==

			This section gives an end-to-end usage example that shows how to connect OSM to a vim-emu instance and how to on-board and instantiate an example network service with two VNFs on the emulated infrastructure. All given paths are relative to the vim-emu repository root. The same example is also available for the classic build of OSM: [[VIM_emulator_classic_build_walkthrough\|vim-emu classic build walkthrough]].

	{{#evu:https://www.youtube.com/watch?v=Iji6FFIKL0w		{{#evu:https://www.youtube.com/watch?v=Iji6FFIKL0w
Line 197:		Line 199:
	\| dc1 \| dc1_test.pong.2.ubuntu \| ubuntu:trusty \| pong0-0 \| dc1.s1-eth3 \|		\| dc1 \| dc1_test.pong.2.ubuntu \| ubuntu:trusty \| pong0-0 \| dc1.s1-eth3 \|
	+--------------+----------------------------+---------------+------------------+-------------------------+		+--------------+----------------------------+---------------+------------------+-------------------------+


			----

	== Build & Installation ==		== Build & Installation ==

Peusterm at 19:36, 4 December 2018

2018-12-04T19:36:17Z

← Older revision		Revision as of 19:36, 4 December 2018
Line 54:		Line 54:
	=== Walkthrough ===		=== Walkthrough ===

	==== Step 1: Install OSM ~~rel. FOUR~~ and vim-emu ====		==== Step 1: Install OSM and vim-emu ====

	Install OSM ~~rel. FOUR~~ together with the emulator.		Install OSM together with the emulator.

	$ ./install_osm.sh --vimemu		$ ./install_osm.sh --vimemu

Peusterm at 06:00, 17 August 2018

2018-08-17T06:00:19Z

← Older revision		Revision as of 06:00, 17 August 2018
Line 60:		Line 60:
	$ ./install_osm.sh --vimemu		$ ./install_osm.sh --vimemu

	===== Step 1.1: Configure environment =====		===== Step 1.1: Start the emulator =====
			Check if the emulator is running:

			$ docker ps \| grep vim-emu

			If not, start it with the following command:

			$ docker run --name vim-emu -t -d --rm --privileged --pid='host' --network=netOSM -v /var/run/docker.sock:/var/run/docker.sock vim-emu-img python examples/osm_default_daemon_topology_2_pop.py


			===== Step 1.2: Configure environment =====

			You need to set the correct environment variables, i.e., you need to get the IP address of the vim-emu container to be able to add it as a VIM to your OSM installation:

	~~You need to set the correct environment variables (they are also printed at the end of the installation script).~~
	<nowiki>		<nowiki>
	$ export VIMEMU_HOSTNAME=$(sudo docker inspect -f '{{range .NetworkSettings.Networks}}{{.IPAddress}}{{end}}' vim-emu)		$ export VIMEMU_HOSTNAME=$(sudo docker inspect -f '{{range .NetworkSettings.Networks}}{{.IPAddress}}{{end}}' vim-emu)

Peusterm: /* Step 3: On-board example pingpong service */

2018-06-25T10:30:30Z

Step 3: On-board example pingpong service

← Older revision		Revision as of 10:30, 25 June 2018
Line 81:		Line 81:

	==== Step 3: On-board example ''pingpong'' service ====		==== Step 3: On-board example ''pingpong'' service ====

			The example can be found in the vim-emu git repository: https://osm.etsi.org/gitweb/?p=osm/vim-emu.git;a=summary.

	# Clone the vim-emu repository containing the pingpong example		# Clone the vim-emu repository containing the pingpong example
	$ git clone https://osm.etsi.org/gerrit/osm/vim-emu.git		$ git clone https://osm.etsi.org/gerrit/osm/vim-emu.git

Peusterm: /* Walkthrough */

2018-05-24T11:27:22Z

Walkthrough

← Older revision		Revision as of 11:27, 24 May 2018
Line 54:		Line 54:
	=== Walkthrough ===		=== Walkthrough ===

	==== Step 1: Install OSM rel. ~~THREE~~ and vim-emu ====		==== Step 1: Install OSM rel. FOUR and vim-emu ====

	Install OSM rel. FOUR together with the emulator.		Install OSM rel. FOUR together with the emulator.