Build Status

Distributed Cloud Emulator

Lead Developers

The following lead developers are responsible for this repository and have admin rights. They can, for example, merge pull requests.

  • Manuel Peuster (mpeuster)
  • Steven Van Rossem (stevenvanrossem)

Environment

Dependencies

  • pyaml (public domain)
  • zerorpc (MIT)
  • tabulate (public domain)
  • argparse (Python software foundation license)
  • networkx (BSD)
  • six>=1.9 (MIT)
  • ryu (Apache 2.0)
  • oslo.config (Apache 2.0)
  • pytest (MIT)
  • pytest-runner (MIT)
  • Flask (BSD)
  • flask_restful (BSD)
  • requests (Apache 2.0)
  • docker-py (Apache 2.0)
  • paramiko (LGPL)

3rd-party code used

  • (none)

Project structure

  • src/emuvim/ all emulator code
  • api/ Data center API endpoint implementations (zerorpc, OpenStack REST, ...)
  • cli/ CLI client to interact with a running emulator
  • dcemulator/ Containernet wrapper that introduces the notion of data centers and API endpoints
  • examples/ Example topology scripts
  • test/ Unit tests
  • ansible/ Ansible install scripts
  • util/ helper scripts

Installation

Automatic installation is provide through Ansible playbooks.

  • Requires: Ubuntu 14.04 LTS
  • sudo apt-get install ansible git
  • sudo vim /etc/ansible/hosts
  • Add: localhost ansible_connection=local

1. Containernet

  • cd
  • git clone https://github.com/mpeuster/containernet.git
  • cd ~/containernet/ansible
  • sudo ansible-playbook install.yml
  • Wait (and have a coffee) ...

2. Emulator

  • Fork the repository.
  • cd
  • git clone https://github.com/<user>/son-emu.git
  • cd ~/son-emu/ansible
  • sudo ansible-playbook install.yml

Run

In the ~/son-emu directory:

  • During development:
  • python setup.py develop
  • Otherwise, for a classic installation:
  • python setup.py install
  • First terminal:
  • sudo python src/emuvim/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
  • First terminal:
  • containernet> vnf1 ping -c 2 vnf2

Run Unit Tests

  • cd ~/son-emu
  • sudo py.test -v src/emuvim/test/unittests

CLI

Vagrant VM creation

A Vagrantfile allows to automatically create and provision a VM in which son-emu is installed and ready to be used.

  • cd ~/son-emu
  • vagrant up
  • vagrant ssh to enter the new VM in which the emulator is installed.

Follow the MOTD in the VM to run the example topology and the fake-gatekeeper. The fake-gatekeeper's default port 5000 is forwarded to the host machine and can be accessed from it by using, e.g., curl http://127.0.0.1:5000/packages.