installation

[osm/vim-emu.git] / README.md

diff --git a/README.md b/README.md
index 93e8049..0dcf5a6 100644 (file)
--- a/README.md
+++ b/README.md
@@ -20,6 +20,26 @@
  * **test/** Unit tests
  * **example_topology.py** An example topology script to show how topologies can be specified
 
+### Installation
+Automatic installation is provide through an Ansible playbook.
+* Requires: Ubuntu 14.04 LTS
+* `sudo apt-get install ansible git`
+* `sudo vim /etc/ansible/hosts`
+* Add: `localhost ansible_connection=local`
+
+#### 1. Dockernet
+* `git clone https://github.com/mpeuster/dockernet.git`
+* `cd dockernet/ansible`
+* `sudo ansible-playbook install.yml`
+* Wait (and have a coffee) ...
+
+#### 2. Emulator
+* `cd`
+* `git clone https://github.com/mpeuster/emulator-strawman.git`
+* `cd emulator-strawman/ansible`
+* `sudo ansible-playbook install.yml`
+
+
 ### Run
 * First terminal:
  * `sudo python example_topology.py`
@@ -29,23 +49,26 @@
 
 ### TODO
 * DCemulator
- * correctly start and connect new compute resources at runtime
- * remove and disconnect compute resources at runtime
- * list active compute resources
-* Cloud-like reference API with CLI for demonstrations
- * Write CLI client
- * Start compute
- * Stop compute
-* 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)
+ * ...
+* Write unit tests
 * Create an Ansible-based automatic installation routine
 * Add resource constraints to datacenters
 * Check if we can use the Mininet GUI to visualize our DCs?
 
 
-### Features
+### Features / Done
 * Define a topology (Python script)
  * Add data centers
  * Add switches and links between the,
 * Define API endpoints in topology
  * call startAPI from topology definition and start it in a own thread
  * make it possible to start different API endpoints for different DCs
+* DCemulator
+ * correctly start and connect new compute resources at runtime
+ * remove and disconnect compute resources at runtime
+ * do IP management for new containers
+ * list active compute resources
+* Cloud-like reference API with CLI for demonstrations
+ * Write CLI client
+ * Start compute
+ * Stop compute