X-Git-Url: https://osm.etsi.org/gitweb/?a=blobdiff_plain;f=README.md;h=43cfa9134d28ff22b93bd27ca319d9dc075377d9;hb=968ffece3ba6bd05ed695696207ca1341fc8273a;hp=ebc6f6c94266d823adead9eeab7b5b33c3985fe8;hpb=d7cb443596657a5c0a54e9c8230e441ad36a0cca;p=osm%2Fvim-emu.git diff --git a/README.md b/README.md index ebc6f6c..43cfa91 100755 --- a/README.md +++ b/README.md @@ -1,99 +1,64 @@ -# Distributed Cloud Emulator - -Contributors: - -* Manuel Peuster - - -### Requirements -* 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) - -### Project structure -* **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 - * **test/** Unit tests - * **example_topology.py** An example topology script to show how topologies can be specified - -### Installation -Automatic installation is provide through Ansible playbooks. -* Requires: Ubuntu 14.04 LTS -* `sudo apt-get install ansible git` -* `sudo vim /etc/ansible/hosts` -* Add: `localhost ansible_connection=local` - -#### 1. Dockernet -* `cd` -* `git clone https://github.com/mpeuster/dockernet.git` -* `cd ~/dockernet/ansible` -* `sudo ansible-playbook install.yml` -* Wait (and have a coffee) ... - -#### 2. Emulator -* Fork the repository. -* `cd` -* `git clone https://github.com//son-emu.git` -* `cd ~/son-emu/ansible` -* `sudo ansible-playbook install.yml` - - -### Run -* First terminal: - * `cd ~/son-emu/emuvim` - * `sudo python example_topology.py` -* Second terminal: - * `cd ~/son-emu/emuvim/cli` - * `./son-emu-cli compute start -d datacenter1 -n vnf1` - * `./son-emu-cli compute start -d datacenter1 -n vnf2` - * `./son-emu-cli compute list` -* First terminal: - * `dockernet> vnf1 ping -c 2 vnf2` - -#### 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/emuvim` -* `sudo python test` or `sudo python test -v` for more outputs - -### CLI -* [Full CLI command documentation](https://github.com/sonata-nfv/son-emu/wiki/CLI-Command-Overview) - - -### TODO -* DCemulator - * Advanced network model - * improve network management, multiple interfaces per container - * API to create multiple networks (per DC?) -* SDN Controller - * simple API to chain running VNFs -* Add resource constraints to datacenters -* Check if we can use the Mininet GUI to visualize our DCs? -* (Unit tests for zerorpc API endpoint, and any other new endpoint) - - -### 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 (name, DC, image, network) - * Stop compute -* Create an Ansible-based automatic installation routine -* Unit tests +[![Build Status](http://jenkins.sonata-nfv.eu/buildStatus/icon?job=son-emu)](http://jenkins.sonata-nfv.eu/job/son-emu) +# son-emu +Here comes a brief description of the repository and the code inside. + +## Development +(if applicable) + +### Building +Describe briefly how to build the software. + +### Dependencies +Name all the dependencies needed by the software, including version, license (!), and a link. For example + +* [pyaml](https://pypi.python.org/pypi/pyaml) >=15.8.2 (WTFPL) +* [zerorpc](http://www.zerorpc.io) >= 0.5.2 (MIT) +* [tabulate](https://pypi.python.org/pypi/tabulate) >= 0.7.5 (public domain) +* [argparse](https://pypi.python.org/pypi/argparse) >= 1.4.0 (Python software foundation License) +* [networkx](https://pypi.python.org/pypi/networkx/) >= 1.11 (BSD) +* [six](https://pypi.python.org/pypi/six/) >=1.9 (MIT) +* [ryu](https://pypi.python.org/pypi/ryu/4.4) >= 4.4 (Apache 2.0) +* [oslo.config](http://docs.openstack.org/developer/oslo.config/) >= 3.9.0 (Apache 2.0) +* [pytest](https://pypi.python.org/pypi/pytest) >= 2.9 (MIT) +* [pytest-runner](https://pypi.python.org/pypi/pytest-runner) >= 2.8 (MIT) +* [Flask](https://pypi.python.org/pypi/Flask) >= 0.11 (BSD) +* [flask_restful](https://pypi.python.org/pypi/Flask-RESTful) >= 0.3 (BSD) +* [requests](https://pypi.python.org/pypi/requests) >= 2.10 (Apache 2.0) +* [docker-py](https://pypi.python.org/pypi/docker-py) == 1.7.1(Apache 2.0) +* [paramiko](https://pypi.python.org/pypi/paramiko/1.16.0) >= 1.6 (LGPL) +* [prometheus_client](https://pypi.python.org/pypi/prometheus_client) >= 0.0.13 (Apache 2.0) +* [urllib3](https://pypi.python.org/pypi/urllib3) >= 1.15 (MIT) + +### Contributing +(if applicable) Description (encouraging) how to contribute to this project/repository. + +## Installation +(if applicable) Describe briefly how to install the software. You may want to put a link to son-install instead: + +The installation of this component can be done using the [son-install](https://github.com/sonata-nfv/son-install) script. + +## Usage +(if applicable) Describe briefly how to use the software. + +## License + +This [SOFTWARE] is published under Apache 2.0 license. Please see the LICENSE file for more details. + +## Useful Links + +* Any useful link and brief description. For example: +* http://www.google/ Don't be evil. + +--- +#### 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) + +#### Feedback-Chanel + +* You may use the mailing list sonata-dev@lists.atosresearch.eu +* Please use the GitHub issues to report bugs.