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 ### Run
  24 * First terminal:
  25  * `sudo python example_topology.py`
  26 * Second terminal:
  27  * TODO add CLI commands here (e.g. request the start of a new compute resource)
  28
  29
  30 ### TODO
  31 * DCemulator
  32  * correctly start and connect new compute resources at runtime
  33  * remove and disconnect compute resources at runtime
  34  * list active compute resources
  35 * Cloud-like reference API with CLI for demonstrations
  36  * Write CLI client
  37  * Start compute
  38  * Stop compute
  39 * Re-factor endpoint API so that API objects can be more or less statless (ask DCEmulator for available DCs instead of maintaining a own list)
  40 * Create an Ansible-based automatic installation routine
  41 * Add resource constraints to datacenters
  42 * Check if we can use the Mininet GUI to visualize our DCs?
  43
  44
  45 ### Features
  46 * Define a topology (Python script)
  47  * Add data centers
  48  * Add switches and links between the,
  49 * Define API endpoints in topology
  50  * call startAPI from topology definition and start it in a own thread
  51  * make it possible to start different API endpoints for different DCs