src/emuvim/api/rest/rest_api_endpoint.py

   1 """
   2 Copyright (c) 2015 SONATA-NFV and Paderborn University
   3 ALL RIGHTS RESERVED.
   4
   5 Licensed under the Apache License, Version 2.0 (the "License");
   6 you may not use this file except in compliance with the License.
   7 You may obtain a copy of the License at
   8
   9     http://www.apache.org/licenses/LICENSE-2.0
  10
  11 Unless required by applicable law or agreed to in writing, software
  12 distributed under the License is distributed on an "AS IS" BASIS,
  13 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14 See the License for the specific language governing permissions and
  15 limitations under the License.
  16
  17 Neither the name of the SONATA-NFV [, ANY ADDITIONAL AFFILIATION]
  18 nor the names of its contributors may be used to endorse or promote
  19 products derived from this software without specific prior written
  20 permission.
  21
  22 This work has been performed in the framework of the SONATA project,
  23 funded by the European Commission under Grant number 671517 through
  24 the Horizon 2020 and 5G-PPP programmes. The authors would like to
  25 acknowledge the contributions of their colleagues of the SONATA
  26 partner consortium (www.sonata-nfv.eu).
  27 """
  28 import logging
  29 import threading
  30 from flask import Flask
  31 from flask_restful import Api
  32
  33 # need to import total module to set its global variable dcs
  34 import compute
  35 from compute import dcs, ComputeList, Compute, DatacenterList, DatacenterStatus
  36
  37 # need to import total module to set its global variable net
  38 import network
  39 from network import NetworkAction
  40
  41 import monitor
  42 from monitor import MonitorInterfaceAction, MonitorFlowAction, MonitorLinkAction, MonitorSkewAction
  43
  44 logging.basicConfig(level=logging.INFO)
  45
  46
  47 class RestApiEndpoint(object):
  48     """
  49     Simple API endpoint that offers a REST
  50     interface. This interface will be used by the
  51     default command line client.
  52     """
  53
  54     def __init__(self, listenip, port):
  55         self.ip = listenip
  56         self.port = port
  57
  58         # setup Flask
  59         self.app = Flask(__name__)
  60         self.api = Api(self.app)
  61
  62         # setup endpoints
  63
  64         # compute related actions (start/stop VNFs, get info)
  65         self.api.add_resource(Compute,
  66                               "/restapi/compute/<dc_label>/<compute_name>",
  67                               "/restapi/compute/<dc_label>/<compute_name>/<resource>/<value>")
  68         self.api.add_resource(ComputeList,
  69                       "/restapi/compute",
  70                       "/restapi/compute/<dc_label>")
  71
  72         self.api.add_resource(DatacenterStatus, "/restapi/datacenter/<dc_label>")
  73         self.api.add_resource(DatacenterList, "/restapi/datacenter")
  74
  75
  76         # network related actions (setup chaining between VNFs)
  77         self.api.add_resource(NetworkAction,
  78                               "/restapi/network/<vnf_src_name>/<vnf_dst_name>")
  79
  80
  81         # monitoring related actions
  82         # export a network interface traffic rate counter
  83         self.api.add_resource(MonitorInterfaceAction,
  84                               "/restapi/monitor/interface/<vnf_name>/<metric>",
  85                               "/restapi/monitor/interface/<vnf_name>/<vnf_interface>/<metric>",
  86                               "/restapi/monitor/interface/<vnf_name>/<vnf_interface>/<metric>/<cookie>")
  87         # export flow traffic counter, of a manually pre-installed flow entry, specified by its cookie
  88         self.api.add_resource(MonitorFlowAction,
  89                               "/restapi/monitor/flow/<vnf_name>/<metric>/<cookie>",
  90                               "/restapi/monitor/flow/<vnf_name>/<vnf_interface>/<metric>/<cookie>")
  91         # install monitoring of a specific flow on a pre-existing link in the service.
  92         # the traffic counters of the newly installed monitor flow are exported
  93         self.api.add_resource(MonitorLinkAction,
  94                               "/restapi/monitor/link/<vnf_src_name>/<vnf_dst_name>")
  95         # install skewness monitor of resource usage disribution
  96         # the skewness metric is exported
  97         self.api.add_resource(MonitorSkewAction,
  98                               "/restapi/monitor/skewness/<vnf_name>/<resource_name>")
  99
 100         logging.debug("Created API endpoint %s(%s:%d)" % (self.__class__.__name__, self.ip, self.port))
 101
 102     def connectDatacenter(self, dc):
 103         compute.dcs[dc.label] = dc
 104         logging.info(
 105             "Connected DC(%s) to API endpoint %s(%s:%d)" % (dc.label, self.__class__.__name__, self.ip, self.port))
 106
 107     def connectDCNetwork(self, DCnetwork):
 108         network.net = DCnetwork
 109         monitor.net = DCnetwork
 110
 111         logging.info("Connected DCNetwork to API endpoint %s(%s:%d)" % (
 112             self.__class__.__name__, self.ip, self.port))
 113
 114     def start(self):
 115         thread = threading.Thread(target=self._start_flask, args=())
 116         thread.daemon = True
 117         thread.start()
 118         logging.info("Started API endpoint @ http://%s:%d" % (self.ip, self.port))
 119
 120     def _start_flask(self):
 121         self.app.run(self.ip, self.port, debug=True, use_reloader=False)