7b8fe6041a5806153c95a77257622154475f3eef
[osm/vim-emu.git] / 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 ### TODO
16 * DCemulator
17  * correctly start and connect new compute resources at runtime
18  * remove and disconnect compute resources at runtime
19  * list active compute resources
20 * Cloud-like reference API with CLI for demonstrations
21  * Write CLI client
22  * Start compute
23  * Stop compute
24 * 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)
25 * Create an Ansible-based automatic installation routine
26 * Add resource constraints to datacenters
27 * Check if we can use the Mininet GUI to visualize our DCs?
28
29
30 ### Features
31 * Define a topology (Python script)
32  * Add data centers
33  * Add switches and links between the,
34 * Define API endpoints in topology
35  * call startAPI from topology definition and start it in a own thread
36  * make it possible to start different API endpoints for different DCs