X-Git-Url: https://osm.etsi.org/gitweb/?a=blobdiff_plain;f=src%2Femuvim%2Fapi%2Fsonata%2FREADME.md;h=72531310f871370d5da8b7737034e50aaf3d8186;hb=3bb8b25b4584b62a56303404a39b085c4298529a;hp=d44ed27c445be0b5a863c66cae6f09bfb2a76b08;hpb=fd692374280e8e0a936fa5064582f79a47b0560a;p=osm%2Fvim-emu.git diff --git a/src/emuvim/api/sonata/README.md b/src/emuvim/api/sonata/README.md old mode 100644 new mode 100755 index d44ed27..7253131 --- a/src/emuvim/api/sonata/README.md +++ b/src/emuvim/api/sonata/README.md @@ -1,23 +1,79 @@ + + # SONATA dummy gatekeeper API: +## Requirements + +* uuid +* hashlib +* zipfile +* yaml +* docker-py +* flask +* flask_restful + +## Run REST API in standalone mode (without emulator): +* `python src/emuvim/api/sonata/dummygatekeeper.py` + +## Run emulator example with active SONATA dummy gatekeeper: +The example starts a small network with two data centers. + +* `sudo python src/emuvim/examples/sonata_y1_demo_topology_1.py` + ## Upload a package (*.son) file: -To upload the file `sonata-demo.son` (from son-schema repo) do: +To upload the file `sonata-demo-docker.son` (can be found in `son-emu/misc/`) do: -* `curl -i -X POST -F file=@sonata-demo.son http://127.0.0.1:8000/api/packages` +* `curl -i -X POST -F package=@sonata-demo-docker.son http://127.0.0.1:5000/packages` To list all uploaded packages do: -* `curl http://127.0.0.1:8000/api/packages` +* `curl http://127.0.0.1:5000/packages` To instantiate (start) a service do: -* `curl -X POST http://127.0.0.1:8000/api/instantiations -d "{\"service_uuid\":\"59446b64-f941-40a8-b511-effb0512c21b\"}"` +* Specific service: `curl -X POST http://127.0.0.1:5000/instantiations -d "{\"service_uuid\":\"59446b64-f941-40a8-b511-effb0512c21b\"}"` +* Last uploaded service (makes manual tests easier): `curl -X POST http://127.0.0.1:5000/instantiations -d "{}"` To list all running services do: -* `curl http://127.0.0.1:8000/api/instantiations` +* `curl http://127.0.0.1:5000/instantiations` +## VNF Requirements + +A VNF container that is used with the dummy gatekeeper should specify a emulator specific entrypoint script in its Dockerfile: + +* `ENV SON_EMU_CMD ./start.sh` + +This script is called by the dummy gatekeeper after a VNF was started and the chaining was done. The script can then be used to trigger the execution of individual VNF software. + +ATTENTION: The specified script must not block! ## API definition @@ -37,39 +93,49 @@ _Note: This API should converge to the API of the original GK as much as possibl