README.md

   1 # emulator-strawman
   2
   3 (c) 2015 by Manuel Peuster
   4
   5
   6 ## emu-vim
   7
   8 ### Requirements
   9 * needs the latest Dockernet to be installed in the system
  10  * the wrapper uses standard Python imports to use the Dockernet modules
  11 * Uses ZeroMQ based RPC to open a cloud-like interface that can be used by a demo CLI client
  12  * pip install import zerorpc
  13  * This will be replaced / extended by a REST API later
  14
  15 ### Project structure
  16 * **emuvim/** all emulator code
  17  * **api/** Data center API endpoint implementations (zerorpc, OpenStack REST, ...)
  18  * **cli/** CLI client to interact with a running emulator
  19  * **dcemulator/** Dockernet wrapper that introduces the notion of data centers and API endpoints
  20  * **test/** Unit tests
  21  * **example_topology.py** An example topology script to show how topologies can be specified
  22
  23 ### Installation
  24 Automatic installation is provide through an Ansible playbook.
  25 * Requires: Ubuntu 14.04 LTS
  26 * `sudo apt-get install ansible git`
  27 * `sudo vim /etc/ansible/hosts`
  28 * Add: `localhost ansible_connection=local`
  29
  30 #### 1. Dockernet
  31 * `git clone https://github.com/mpeuster/dockernet.git`
  32 * `cd dockernet/ansible`
  33 * `sudo ansible-playbook install.yml`
  34 * Wait (and have a coffee) ...
  35
  36 #### 2. Emulator
  37 * `cd`
  38 * `git clone https://github.com/mpeuster/emulator-strawman.git`
  39 * `cd emulator-strawman/ansible`
  40 * `sudo ansible-playbook install.yml`
  41
  42
  43 ### Run
  44 * First terminal:
  45  * `cd emulator-strawman/emuvim`
  46  * `sudo python example_topology.py`
  47 * Second terminal:
  48  * `cd emulator-strawman/emuvim/cli`
  49  * `./son-emu-cli compute start -d dc1 -n vnf1`
  50  * `./son-emu-cli compute start -d dc1 -n vnf2`
  51  * `./son-emu-cli compute list`
  52 * First terminal:
  53  * `dockernet> vnf1 ping -c 2 vnf2`
  54
  55
  56 ### TODO
  57 * DCemulator
  58  * ...
  59
  60 * Add resource constraints to datacenters
  61 * Check if we can use the Mininet GUI to visualize our DCs?
  62 * (Unit tests for zerorpc API endpoint)
  63
  64
  65 ### Features / Done
  66 * Define a topology (Python script)
  67  * Add data centers
  68  * Add switches and links between the,
  69 * Define API endpoints in topology
  70  * call startAPI from topology definition and start it in a own thread
  71  * make it possible to start different API endpoints for different DCs
  72 * DCemulator
  73  * correctly start and connect new compute resources at runtime
  74  * remove and disconnect compute resources at runtime
  75  * do IP management for new containers
  76  * list active compute resources
  77 * Cloud-like reference API with CLI for demonstrations
  78  * Write CLI client
  79  * Start compute
  80  * Stop compute
  81 * Create an Ansible-based automatic installation routine
  82 * Unit tests