X-Git-Url: https://osm.etsi.org/gitweb/?a=blobdiff_plain;f=README.md;h=a6b1de56cdb6389ba6fe085e79944943254f04e3;hb=7d3b58ecf115dc6dc5932f5f4ac406ba05e739fd;hp=2e2c70386258706f68a12990185146ee82fcc712;hpb=842b5741792543389b9cc77ee898cc8c412b9416;p=osm%2Fvim-emu.git diff --git a/README.md b/README.md index 2e2c703..a6b1de5 100755 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ This emulation platform was created to support network service developers to lo More details about the the emulator's architecture and concepts can be found in the following publication(s): -* Peuster, Manuel, Holger Karl, and Steven van Rossem. ["MeDICINE: Rapid Prototyping of Production-Ready Network Services in Multi-PoP Environments."](http://arxiv.org/abs/1606.05995) pre-print arXiv:1606.05995 (2016). +* Manuel Peuster, Holger Karl, and Steven van Rossem. ["MeDICINE: Rapid Prototyping of Production-Ready Network Services in Multi-PoP Environments."](http://arxiv.org/abs/1606.05995) pre-print arXiv:1606.05995 (2016). A short demo that showcases son-emu together with its dummy gatekeeper is available [here](https://youtu.be/BgWDp5CM0io). @@ -19,18 +19,18 @@ To install the emulator package in development mode, do: #### Folder Structure -* `ansible` -* `misc` +* `ansible` Install scripts +* `misc` Example packages and VNFs * `src` - * `emuvim` - * `api` - * `rest` REST API for son-emu-cli - * `sonata` Dummy gatekeeper API - * `cli` Command line client to control the emulator - * `dcemulator` Emulator core - * `resourcemodel` Resource limitation models - * `examples` Example topology scripts - * `test` Test scripts + * `emuvim` Emulator components + * `api` API endpoint implementations + * `rest` REST API for son-emu-cli + * `sonata` Dummy gatekeeper API + * `cli` Command line client to control the emulator + * `dcemulator` Emulator core + * `resourcemodel` Resource limitation models + * `examples` Example topology scripts + * `test` Test scripts * `utils` Helper scripts for SONATA's CI/CD setup @@ -55,7 +55,6 @@ Despite of this son-emu has the following dependencies: * [flask_restful](https://pypi.python.org/pypi/Flask-RESTful) >= 0.3 (BSD) * [networkx](https://pypi.python.org/pypi/networkx/) >= 1.11 (BSD) * [oslo.config](http://docs.openstack.org/developer/oslo.config/) >= 3.9.0 (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) * [pyaml](https://pypi.python.org/pypi/pyaml) >=15.8.2 (WTFPL) * [pytest-runner](https://pypi.python.org/pypi/pytest-runner) >= 2.8 (MIT) @@ -68,7 +67,7 @@ Despite of this son-emu has the following dependencies: * [zerorpc](http://www.zerorpc.io) >= 0.5.2 (MIT) ### Contributing -Contributing to the Gatekeeper is really easy. You must: +Contributing to the son-emu is really easy. You must: 1. Clone [this repository](http://github.com/sonata-nfv/son-emu); 2. Work on your proposed changes, preferably through submiting [issues](https://github.com/sonata-nfv/son-emu/issues); @@ -138,6 +137,8 @@ This example shows how to deploy a SONATA example package in the emulator using * Instantiate: `curl -X POST http://127.0.0.1:5000/instantiations -d "{}"` * Verify that service runs: `son-emu-cli compute list` +Note: The [son-push](https://github.com/mpeuster/son-cli) tool can be used instead of CURL. + ### CLI Commands * [Full CLI command documentation](https://github.com/sonata-nfv/son-emu/wiki/CLI-Command-Overview) @@ -158,7 +159,13 @@ The following lead developers are responsible for this repository and have admin * Manuel Peuster (https://github.com/mpeuster) * Steven Van Rossem (https://github.com/stevenvanrossem) +#### Contributors + +* Hadi Razzaghi Kouchaksaraei (https://github.com/hadik3r) +* Wouter Tavernier (https://github.com/wtaverni) +* Geoffroy Chollon (https://github.com/cgeoffroy) + #### Feedback-Chanel * You may use the mailing list [sonata-dev@lists.atosresearch.eu](mailto:sonata-dev@lists.atosresearch.eu) -* * [GitHub issues](https://github.com/sonata-nfv/son-emu/issues) +* [GitHub issues](https://github.com/sonata-nfv/son-emu/issues)