X-Git-Url: https://osm.etsi.org/gitweb/?p=osm%2Fvim-emu.git;a=blobdiff_plain;f=README.md;h=6309f7c181664cdd5a2c00f20c12c9e999c24d97;hp=0dcf5a674da6d40c9994cce17ec5d3504f99f6d5;hb=7303abc38b4751466953c8db55815c63df6687ac;hpb=c68c68ea5d7439b5bdb9a18606e5444a3bc3a679 diff --git a/README.md b/README.md index 0dcf5a6..6309f7c 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@ -# emulator-strawman +# Distributed Cloud Emulator -(c) 2015 by Manuel Peuster +Contributors: +* Manuel Peuster -## emu-vim ### Requirements * needs the latest Dockernet to be installed in the system @@ -34,26 +34,36 @@ Automatic installation is provide through an Ansible playbook. * Wait (and have a coffee) ... #### 2. Emulator +* Fork the repository. * `cd` -* `git clone https://github.com/mpeuster/emulator-strawman.git` +* `git clone https://github.com//son-emu.git` * `cd emulator-strawman/ansible` * `sudo ansible-playbook install.yml` ### Run * First terminal: + * `cd emulator-strawman/emuvim` * `sudo python example_topology.py` * Second terminal: - * TODO add CLI commands here (e.g. request the start of a new compute resource) + * `cd emulator-strawman/emuvim/cli` + * `./son-emu-cli compute start -d dc1 -n vnf1` + * `./son-emu-cli compute start -d dc1 -n vnf2` + * `./son-emu-cli compute list` +* First terminal: + * `dockernet> vnf1 ping -c 2 vnf2` ### TODO * DCemulator - * ... -* Write unit tests -* Create an Ansible-based automatic installation routine + * Advanced network model + * improve network management, multiple interfaces per container + * API to create multiple networks (per DC?) + + * Add resource constraints to datacenters * Check if we can use the Mininet GUI to visualize our DCs? +* (Unit tests for zerorpc API endpoint) ### Features / Done @@ -70,5 +80,8 @@ Automatic installation is provide through an Ansible playbook. * list active compute resources * Cloud-like reference API with CLI for demonstrations * Write CLI client - * Start compute + * Start compute (name, DC, image, network) * Stop compute +* Create an Ansible-based automatic installation routine +* Unit tests +