X-Git-Url: https://osm.etsi.org/gitweb/?a=blobdiff_plain;f=README.md;h=e0f3cfae11f22c23cf1793f45e58194efa29ed9c;hb=8676a1f0ad7a2200d3398af026358b15064dc8ba;hp=1042a7ff9f1a5e56158343cc6e6b5b04dc1b06e1;hpb=b9f32098318beced115e831c5b1540fe30c63572;p=osm%2Fvim-emu.git diff --git a/README.md b/README.md index 1042a7f..e0f3cfa 100755 --- a/README.md +++ b/README.md @@ -2,29 +2,35 @@ # Distributed Cloud Emulator -## Lead Developers +### Lead Developers The following lead developers are responsible for this repository and have admin rights. They can, for example, merge pull requests. - * Manuel Peuster (mpeuster) * Steven Van Rossem (stevenvanrossem) +### Environment +* Python 2.7 +* Latest [Containernet](https://github.com/mpeuster/containernet) installed on the system + ### Dependencies -* needs the latest [Dockernet](https://github.com/mpeuster/dockernet) to be installed on the system -* pyaml -* zerorpc -* tabulate -* argparse -* networkx -* six>=1.9 -* ryu -* oslo.config -* pytest -* pytest-runner -* Flask -* flask_restful -* requests -* docker-py +* pyaml (public domain) +* zerorpc (MIT) +* tabulate (public domain) +* argparse (Python software foundation license) +* networkx (BSD) +* six>=1.9 (MIT) +* ryu (Apache 2.0) +* oslo.config (Apache 2.0) +* pytest (MIT) +* pytest-runner (MIT) +* Flask (BSD) +* flask_restful (BSD) +* requests (Apache 2.0) +* docker-py (Apache 2.0) +* paramiko (LGPL) + +### 3rd-party code used +* (none) ### Project structure @@ -32,7 +38,7 @@ The following lead developers are responsible for this repository and have admin * **src/emuvim/** all emulator code * **api/** Data center API endpoint implementations (zerorpc, OpenStack REST, ...) * **cli/** CLI client to interact with a running emulator - * **dcemulator/** Dockernet wrapper that introduces the notion of data centers and API endpoints + * **dcemulator/** Containernet wrapper that introduces the notion of data centers and API endpoints * **examples/** Example topology scripts * **test/** Unit tests * **ansible/** Ansible install scripts @@ -46,10 +52,10 @@ Automatic installation is provide through Ansible playbooks. * `sudo vim /etc/ansible/hosts` * Add: `localhost ansible_connection=local` -#### 1. Dockernet +#### 1. Containernet * `cd` -* `git clone -b dockernet-sonata https://github.com/mpeuster/dockernet.git` -* `cd ~/dockernet/ansible` +* `git clone https://github.com/mpeuster/containernet.git` +* `cd ~/containernet/ansible` * `sudo ansible-playbook install.yml` * Wait (and have a coffee) ... @@ -60,7 +66,6 @@ Automatic installation is provide through Ansible playbooks. * `cd ~/son-emu/ansible` * `sudo ansible-playbook install.yml` - ### Run In the `~/son-emu` directory: @@ -77,14 +82,13 @@ In the `~/son-emu` directory: * `son-emu-cli compute start -d datacenter1 -n vnf2` * `son-emu-cli compute list` * First terminal: - * `dockernet> vnf1 ping -c 2 vnf2` + * `containernet> vnf1 ping -c 2 vnf2` * Second terminal: * `son-emu-cli monitor get_rate -vnf vnf1` ### Run Unit Tests * `cd ~/son-emu` -* `sudo py.test -v src/emuvim` (equivalent to `python setup.py test -v --addopts 'src/emuvim'` but with direct access to the commandline arguments) +* `sudo py.test -v src/emuvim/test/unittests` ### CLI * [Full CLI command documentation](https://github.com/sonata-nfv/son-emu/wiki/CLI-Command-Overview) -