2 Copyright (c) 2015 SONATA-NFV and Paderborn University
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
9 http://www.apache.org/licenses/LICENSE-2.0
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.
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
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).
30 from flask
import Flask
31 from flask_restful
import Api
33 # need to import total module to set its global variable dcs
35 from compute
import dcs
, ComputeList
, Compute
, ComputeResources
, DatacenterList
, DatacenterStatus
37 # need to import total module to set its global variable net
39 from network
import NetworkAction
42 from monitor
import MonitorInterfaceAction
, MonitorFlowAction
, MonitorLinkAction
, MonitorSkewAction
44 logging
.basicConfig(level
=logging
.INFO
)
47 class RestApiEndpoint(object):
49 Simple API endpoint that offers a REST
50 interface. This interface will be used by the
51 default command line client.
54 def __init__(self
, listenip
, port
):
59 self
.app
= Flask(__name__
)
60 self
.api
= Api(self
.app
)
64 # compute related actions (start/stop VNFs, get info)
65 self
.api
.add_resource(Compute
, "/restapi/compute/<dc_label>/<compute_name>")
66 self
.api
.add_resource(ComputeList
,
68 "/restapi/compute/<dc_label>")
69 self
.api
.add_resource(ComputeResources
, "/restapi/compute/resources/<dc_label>/<compute_name>")
71 self
.api
.add_resource(DatacenterStatus
, "/restapi/datacenter/<dc_label>")
72 self
.api
.add_resource(DatacenterList
, "/restapi/datacenter")
75 # network related actions (setup chaining between VNFs)
76 self
.api
.add_resource(NetworkAction
,
80 # monitoring related actions
81 # export a network interface traffic rate counter
82 self
.api
.add_resource(MonitorInterfaceAction
,
83 "/restapi/monitor/interface")
84 # export flow traffic counter, of a manually pre-installed flow entry, specified by its cookie
85 self
.api
.add_resource(MonitorFlowAction
,
86 "/restapi/monitor/flow")
87 # install monitoring of a specific flow on a pre-existing link in the service.
88 # the traffic counters of the newly installed monitor flow are exported
89 self
.api
.add_resource(MonitorLinkAction
,
90 "/restapi/monitor/link")
91 # install skewness monitor of resource usage disribution
92 # the skewness metric is exported
93 self
.api
.add_resource(MonitorSkewAction
,
94 "/restapi/monitor/skewness")
96 logging
.debug("Created API endpoint %s(%s:%d)" % (self
.__class
__.__name
__, self
.ip
, self
.port
))
98 def connectDatacenter(self
, dc
):
99 compute
.dcs
[dc
.label
] = dc
101 "Connected DC(%s) to API endpoint %s(%s:%d)" % (dc
.label
, self
.__class
__.__name
__, self
.ip
, self
.port
))
103 def connectDCNetwork(self
, DCnetwork
):
104 network
.net
= DCnetwork
105 monitor
.net
= DCnetwork
107 logging
.info("Connected DCNetwork to API endpoint %s(%s:%d)" % (
108 self
.__class
__.__name
__, self
.ip
, self
.port
))
111 thread
= threading
.Thread(target
=self
._start
_flask
, args
=())
114 logging
.info("Started API endpoint @ http://%s:%d" % (self
.ip
, self
.port
))
116 def _start_flask(self
):
117 self
.app
.run(self
.ip
, self
.port
, debug
=True, use_reloader
=False)