README.md

   1 # Distributed Cloud Emulator
   2
   3 Contributors:
   4
   5 * Manuel Peuster <manuel.peuster@upb.de>
   6
   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 * Fork the repository.
  38 * `cd`
  39 * `git clone https://github.com/<user>/son-emu.git`
  40 * `cd son-emu/ansible`
  41 * `sudo ansible-playbook install.yml`
  42
  43
  44 ### Run
  45 * First terminal:
  46  * `cd son-emu/emuvim`
  47  * `sudo python example_topology.py`
  48 * Second terminal:
  49  * `cd emulator-strawman/emuvim/cli`
  50  * `./son-emu-cli compute start -d dc1 -n vnf1`
  51  * `./son-emu-cli compute start -d dc1 -n vnf2`
  52  * `./son-emu-cli compute list`
  53 * First terminal:
  54  * `dockernet> vnf1 ping -c 2 vnf2`
  55
  56
  57 ### TODO
  58 * DCemulator
  59  * Advanced network model
  60   * improve network management, multiple interfaces per container
  61   * API to create multiple networks (per DC?)
  62
  63
  64 * Add resource constraints to datacenters
  65 * Check if we can use the Mininet GUI to visualize our DCs?
  66 * (Unit tests for zerorpc API endpoint)
  67
  68
  69 ### Features / Done
  70 * Define a topology (Python script)
  71  * Add data centers
  72  * Add switches and links between the,
  73 * Define API endpoints in topology
  74  * call startAPI from topology definition and start it in a own thread
  75  * make it possible to start different API endpoints for different DCs
  76 * DCemulator
  77  * correctly start and connect new compute resources at runtime
  78  * remove and disconnect compute resources at runtime
  79  * do IP management for new containers
  80  * list active compute resources
  81 * Cloud-like reference API with CLI for demonstrations
  82  * Write CLI client
  83  * Start compute (name, DC, image, network)
  84  * Stop compute
  85 * Create an Ansible-based automatic installation routine
  86 * Unit tests
  87