X-Git-Url: https://osm.etsi.org/gitweb/?a=blobdiff_plain;f=src%2Femuvim%2Fapi%2Fsonata%2FREADME.md;h=30586e7771d214a4444e270e5175c948c100cb85;hb=392f09dc670ec4f2662f3859e2b9a0f7aed6c818;hp=6ecb5deee4ff3760ff3017c15ee89e9f6e27bc8f;hpb=4282d1a5e61b04fbfa9e2a1e0226c97c85668583;p=osm%2Fvim-emu.git diff --git a/src/emuvim/api/sonata/README.md b/src/emuvim/api/sonata/README.md index 6ecb5de..30586e7 100644 --- a/src/emuvim/api/sonata/README.md +++ b/src/emuvim/api/sonata/README.md @@ -1,22 +1,41 @@ # 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 `simplest-example.son` do: +To upload the file `sonata-demo.son` (from son-schema repo) do: -* `curl -i -X POST -F file=@simplest-example.son http://127.0.0.1:8000/api/packages/uploads` +* `curl -i -X POST -F package=@sonata-demo.son http://127.0.0.1:5000/packages` To list all uploaded packages do: -* `curl http://127.0.0.1:8000/api/packages/uploads` +* `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` ## API definition @@ -37,39 +56,49 @@ _Note: This API should converge to the API of the original GK as much as possibl