src/emuvim/api/sonata/README.md

   1 # SONATA dummy gatekeeper API:
   2
   3 ## Requirements
   4
   5 * uuid
   6 * hashlib
   7 * zipfile
   8 * yaml
   9 * docker-py
  10 * flask
  11 * flask_restful
  12
  13 ## Run emulator example with active SONATA dummy gatekeeper:
  14 The example starts a small network with two data centers.
  15
  16 * `sudo python src/emuvim/examples/sonata_y1_demo_topology_1.py`
  17
  18 ## Upload a package (*.son) file:
  19
  20 To upload the file `sonata-demo.son` (from son-schema repo) do:
  21
  22 * `curl -i -X POST -F file=@sonata-demo.son http://127.0.0.1:8000/api/packages`
  23
  24 To list all uploaded packages do:
  25
  26 * `curl http://127.0.0.1:8000/api/packages`
  27
  28 To instantiate (start) a service do:
  29
  30 * Specific service: `curl -X POST http://127.0.0.1:8000/api/instantiations -d "{\"service_uuid\":\"59446b64-f941-40a8-b511-effb0512c21b\"}"`
  31 * Last uploaded service (makes manual tests easier): `curl -X POST http://127.0.0.1:8000/api/instantiations -d "{}"`
  32
  33 To list all running services do:
  34
  35 * `curl http://127.0.0.1:8000/api/instantiations`
  36
  37
  38 ## API definition
  39
  40 This page describes the dummy gatekeeper API. This gatekeeper fakes the original platform gatekeeper during development SDK tools like son-push.
  41
  42 It is also able to deploy our example service package (not any arbitrary service package!) in the emulator for the Y1 demo.
  43
  44 _Note: This API should converge to the API of the original GK as much as possible!_
  45
  46 ## REST API:
  47 <table>
  48 <tr>
  49 <th>Endpoint:</th>
  50 <th>Method:</th>
  51 <th>Header:</th>
  52 <th>Body:</th>
  53 <th>Response:</th>
  54 </tr>
  55 <tr>
  56 <td>/api/packages</td>
  57 <td>POST</td>
  58 <td>-</td>
  59 <td>{file-content} as enctype=multipart/form-data</td>
  60 <td>{"service_uuid": "c880aaab-f3b9-43ac-ac6b-3d27b46146b7", size=456, sha1=49ee6468dfa4ecbad440d669b249d523a38651be, error: null}</td>
  61 </tr>
  62 <tr>
  63 <td>/api/packages</td>
  64 <td>GET</td>
  65 <td>-</td>
  66 <td></td>
  67 <td>{service_uuid_list: ["c880aaab-f3b9-43ac-ac6b-3d27b46146b7", "c880aaab-f3b9-43ac-ac6b-3d27b46146b8", "c880aaab-f3b9-43ac-ac6b-3d27b46146b9"]}</td>
  68 </tr>
  69 <tr>
  70 <td>/api/instantiations</td>
  71 <td>POST</td>
  72 <td>-</td>
  73 <td>{service_uuid: "c880aaab-f3b9-43ac-ac6b-3d27b46146b7"}</td>
  74 <td>{service_instance_uuid: "de4567-f3b9-43ac-ac6b-3d27b461123"}</td>
  75 </tr>
  76 <tr>
  77 <td>/api/instantiations</td>
  78 <td>GET</td>
  79 <td>-</td>
  80 <td></td>
  81 <td>
  82 {
  83     "service_instance_list": [
  84         [
  85             "9da044b3-1f7a-40e6-a9b3-9e83a9834249",
  86             "9371df14-a595-436a-92b5-fc243b74a9d7"
  87         ]
  88     ]
  89 }
  90 </td>
  91 </tr>
  92 </table>
  93
  94
  95 ## Run REST API in standalone mode (without emulator):
  96 This is not working yet!!!
  97 * `python src/emuvim/api/sonata/dummygatekeeper.py`