X-Git-Url: https://osm.etsi.org/gitweb/?a=blobdiff_plain;f=src%2Femuvim%2Fapi%2Fsonata%2FREADME.md;h=5fc1be0721bb5cea275e5ee14c62132852cbb1c4;hb=92237dc0bc0a724210453c2e10445f8d6f68b06c;hp=d44ed27c445be0b5a863c66cae6f09bfb2a76b08;hpb=786cd5487fb74d3e91bdf8b316c2e64e2fc9c575;p=osm%2Fvim-emu.git diff --git a/src/emuvim/api/sonata/README.md b/src/emuvim/api/sonata/README.md index d44ed27..5fc1be0 100644 --- a/src/emuvim/api/sonata/README.md +++ b/src/emuvim/api/sonata/README.md @@ -1,5 +1,23 @@ # 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: @@ -12,7 +30,8 @@ To list all uploaded packages do: 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:8000/api/instantiations -d "{\"service_uuid\":\"59446b64-f941-40a8-b511-effb0512c21b\"}"` +* Last uploaded service (makes manual tests easier): `curl -X POST http://127.0.0.1:8000/api/instantiations -d "{}"` To list all running services do: @@ -62,14 +81,24 @@ _Note: This API should converge to the API of the original GK as much as possibl