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