From e6b2b30a7666e24a349cc1920d99a1b07fc2ea5f Mon Sep 17 00:00:00 2001 From: peusterm Date: Wed, 9 Mar 2016 13:03:37 +0100 Subject: [PATCH] Cleanup and README.md update based on inputs of WP5 call today. --- README.md | 38 ++++++++++++------- setup.py | 2 +- start_dcnetwork | 7 ---- .../start_example_chain.sh | 0 utils/start_example_topology.sh | 7 ++++ 5 files changed, 33 insertions(+), 21 deletions(-) delete mode 100755 start_dcnetwork rename start_example_chain => utils/start_example_chain.sh (100%) create mode 100755 utils/start_example_topology.sh diff --git a/README.md b/README.md index eefb97c..8c306d4 100755 --- a/README.md +++ b/README.md @@ -1,28 +1,44 @@ +[![Build Status](http://jenkins.sonata-nfv.eu/buildStatus/icon?job=son-emu)](http://jenkins.sonata-nfv.eu/job/son-emu) + # Distributed Cloud Emulator -Lead developers (able to merge pull requests): +## Lead Developers +The following lead developers are responsible for this repository and have admin rights. They can, for example, merge pull requests. + -* Manuel Peuster -* Steven Van Rossem +* Manuel Peuster (mpeuster) +* Steven Van Rossem (stevenvanrossem) -### Requirements +### Dependencies * needs the latest [Dockernet](https://github.com/mpeuster/dockernet) to be installed on the system - * the emulator is implemented against Dockernet's APIs -* The emulator uses ZeroMQ based RPC to for communication between demo CLI client and cloud-like APIs - * `pip install zerorpc` - * (This will be replaced / extended by a REST API later) +* pyaml +* zerorpc +* tabulate +* argparse +* networkx +* six>=1.9 +* ryu +* oslo.config +* pytest +* pytest-runner +* Flask +* flask_restful ### Project structure + * **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 + * **examples/** Example topology scripts * **test/** Unit tests - * **example_topology.py** An example topology script to show how topologies can be specified +* **ansible/** Ansible install scripts +* **util/** helper scripts ### Installation Automatic installation is provide through Ansible playbooks. + * Requires: Ubuntu 14.04 LTS * `sudo apt-get install ansible git` * `sudo vim /etc/ansible/hosts` @@ -63,10 +79,6 @@ In the `~/son-emu` directory: * Second terminal: * `son-emu-cli monitor get_rate -vnf vnf1` -#### Example scripts: - * `./start_dcnetwork` starts an example datacenter network with monitoring api endpoint - * `./start_example_chain` sets up an example service chain, using the example docker container from `package_samples` https://github.com/sonata-nfv/packaging_samples/tree/master/VNFs - ### 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) diff --git a/setup.py b/setup.py index 1973326..cde045b 100644 --- a/setup.py +++ b/setup.py @@ -17,7 +17,7 @@ setup(name='emuvim', 'networkx', 'six>=1.9', 'ryu', - 'oslo.config', + 'ryu', 'pytest', 'Flask', 'flask_restful' diff --git a/start_dcnetwork b/start_dcnetwork deleted file mode 100755 index 7280054..0000000 --- a/start_dcnetwork +++ /dev/null @@ -1,7 +0,0 @@ -#!/bin/bash - -# start DC Network -python src/emuvim/examples/simple_topology.py - - - diff --git a/start_example_chain b/utils/start_example_chain.sh similarity index 100% rename from start_example_chain rename to utils/start_example_chain.sh diff --git a/utils/start_example_topology.sh b/utils/start_example_topology.sh new file mode 100755 index 0000000..eca74e1 --- /dev/null +++ b/utils/start_example_topology.sh @@ -0,0 +1,7 @@ +#!/bin/bash + +# start DC Network +python ../src/emuvim/examples/simple_topology.py + + + -- 2.17.1