2 This module implements a simple REST API that behaves like SONATA's gatekeeper.
4 It is only used to support the development of SONATA's SDK tools and to demonstrate
5 the year 1 version of the emulator until the integration with WP4's orchestrator is done.
14 from docker
import Client
as DockerClient
15 from flask
import Flask
, request
16 import flask_restful
as fr
19 LOG
= logging
.getLogger("sonata-dummy-gatekeeper")
20 LOG
.setLevel(logging
.DEBUG
)
21 logging
.getLogger("werkzeug").setLevel(logging
.WARNING
)
23 GK_STORAGE
= "/tmp/son-dummy-gk/"
24 UPLOAD_FOLDER
= os
.path
.join(GK_STORAGE
, "uploads/")
25 CATALOG_FOLDER
= os
.path
.join(GK_STORAGE
, "catalog/")
27 # Enable Dockerfile build functionality
28 BUILD_DOCKERFILE
= False
30 # flag to indicate that we run without the emulator (only the bare API for integration testing)
31 GK_STANDALONE_MODE
= False
33 # should a new version of an image be pulled even if its available
37 class Gatekeeper(object):
40 self
.services
= dict()
42 self
.vnf_counter
= 0 # used to generate short names for VNFs (Mininet limitation)
43 LOG
.info("Create SONATA dummy gatekeeper.")
45 def register_service_package(self
, service_uuid
, service
):
47 register new service package
51 self
.services
[service_uuid
] = service
52 # lets perform all steps needed to onboard the service
55 def get_next_vnf_name(self
):
57 return "vnf%d" % self
.vnf_counter
60 class Service(object):
62 This class represents a NS uploaded as a *.son package to the
64 Can have multiple running instances of this service.
71 self
.uuid
= service_uuid
72 self
.package_file_hash
= package_file_hash
73 self
.package_file_path
= package_file_path
74 self
.package_content_path
= os
.path
.join(CATALOG_FOLDER
, "services/%s" % self
.uuid
)
78 self
.local_docker_files
= dict()
79 self
.remote_docker_image_urls
= dict()
80 self
.instances
= dict()
84 Do all steps to prepare this service to be instantiated
87 # 1. extract the contents of the package and store them in our catalog
88 self
._unpack
_service
_package
()
89 # 2. read in all descriptor files
90 self
._load
_package
_descriptor
()
93 # 3. prepare container images (e.g. download or build Dockerfile)
95 self
._load
_docker
_files
()
96 self
._build
_images
_from
_dockerfiles
()
98 self
._load
_docker
_urls
()
99 self
._pull
_predefined
_dockerimages
()
100 LOG
.info("On-boarded service: %r" % self
.manifest
.get("package_name"))
102 def start_service(self
):
104 This methods creates and starts a new service instance.
105 It computes placements, iterates over all VNFDs, and starts
106 each VNFD as a Docker container in the data center selected
107 by the placement algorithm.
110 LOG
.info("Starting service %r" % self
.uuid
)
112 # 1. each service instance gets a new uuid to identify it
113 instance_uuid
= str(uuid
.uuid4())
114 # build a instances dict (a bit like a NSR :))
115 self
.instances
[instance_uuid
] = dict()
116 self
.instances
[instance_uuid
]["vnf_instances"] = list()
118 # 2. compute placement of this service instance (adds DC names to VNFDs)
119 if not GK_STANDALONE_MODE
:
120 self
._calculate
_placement
(FirstDcPlacement
)
121 # iterate over all vnfds that we have to start
122 for vnfd
in self
.vnfds
.itervalues():
124 if not GK_STANDALONE_MODE
:
125 vnfi
= self
._start
_vnfd
(vnfd
)
126 self
.instances
[instance_uuid
]["vnf_instances"].append(vnfi
)
128 # 3. Configure the chaining of the network functions (currently only E-Line links supported)
129 vlinks
= self
.nsd
["virtual_links"]
130 fwd_links
= self
.nsd
["forwarding_graphs"][0]["constituent_virtual_links"]
131 eline_fwd_links
= [l
for l
in vlinks
if (l
["id"] in fwd_links
) and (l
["connectivity_type"] == "E-Line")]
133 for link
in eline_fwd_links
:
134 src_node
, src_port
= link
["connection_points_reference"][0].split(":")
135 dst_node
, dst_port
= link
["connection_points_reference"][1].split(":")
137 if src_node
in self
.vnfds
:
138 network
= self
.vnfds
[src_node
].get("dc").net
# there should be a cleaner way to find the DCNetwork
139 network
.setChain(src_node
, dst_node
, vnf_src_interface
=src_port
, vnf_dst_interface
=dst_port
)
141 LOG
.info("Service started. Instance id: %r" % instance_uuid
)
144 def _start_vnfd(self
, vnfd
):
146 Start a single VNFD of this service
147 :param vnfd: vnfd descriptor dict
150 # iterate over all deployment units within each VNFDs
151 for u
in vnfd
.get("virtual_deployment_units"):
152 # 1. get the name of the docker image to start and the assigned DC
153 vnf_name
= vnfd
.get("name")
154 if vnf_name
not in self
.remote_docker_image_urls
:
155 raise Exception("No image name for %r found. Abort." % vnf_name
)
156 docker_name
= self
.remote_docker_image_urls
.get(vnf_name
)
157 target_dc
= vnfd
.get("dc")
158 # 2. perform some checks to ensure we can start the container
159 assert(docker_name
is not None)
160 assert(target_dc
is not None)
161 if not self
._check
_docker
_image
_exists
(docker_name
):
162 raise Exception("Docker image %r not found. Abort." % docker_name
)
163 # 3. do the dc.startCompute(name="foobar") call to run the container
164 # TODO consider flavors, and other annotations
165 intfs
= vnfd
.get("connection_points")
166 vnfi
= target_dc
.startCompute(GK
.get_next_vnf_name(), network
=intfs
, image
=docker_name
, flavor_name
="small")
167 # 6. store references to the compute objects in self.instances
170 def _unpack_service_package(self
):
172 unzip *.son file and store contents in CATALOG_FOLDER/services/<service_uuid>/
174 LOG
.info("Unzipping: %r" % self
.package_file_path
)
175 with zipfile
.ZipFile(self
.package_file_path
, "r") as z
:
176 z
.extractall(self
.package_content_path
)
179 def _load_package_descriptor(self
):
181 Load the main package descriptor YAML and keep it as dict.
184 self
.manifest
= load_yaml(
186 self
.package_content_path
, "META-INF/MANIFEST.MF"))
190 Load the entry NSD YAML and keep it as dict.
193 if "entry_service_template" in self
.manifest
:
194 nsd_path
= os
.path
.join(
195 self
.package_content_path
,
196 make_relative_path(self
.manifest
.get("entry_service_template")))
197 self
.nsd
= load_yaml(nsd_path
)
198 LOG
.debug("Loaded NSD: %r" % self
.nsd
.get("name"))
200 def _load_vnfd(self
):
202 Load all VNFD YAML files referenced in MANIFEST.MF and keep them in dict.
205 if "package_content" in self
.manifest
:
206 for pc
in self
.manifest
.get("package_content"):
207 if pc
.get("content-type") == "application/sonata.function_descriptor":
208 vnfd_path
= os
.path
.join(
209 self
.package_content_path
,
210 make_relative_path(pc
.get("name")))
211 vnfd
= load_yaml(vnfd_path
)
212 self
.vnfds
[vnfd
.get("name")] = vnfd
213 LOG
.debug("Loaded VNFD: %r" % vnfd
.get("name"))
215 def _load_docker_files(self
):
217 Get all paths to Dockerfiles from VNFDs and store them in dict.
220 for k
, v
in self
.vnfds
.iteritems():
221 for vu
in v
.get("virtual_deployment_units"):
222 if vu
.get("vm_image_format") == "docker":
223 vm_image
= vu
.get("vm_image")
224 docker_path
= os
.path
.join(
225 self
.package_content_path
,
226 make_relative_path(vm_image
))
227 self
.local_docker_files
[k
] = docker_path
228 LOG
.debug("Found Dockerfile (%r): %r" % (k
, docker_path
))
230 def _load_docker_urls(self
):
232 Get all URLs to pre-build docker images in some repo.
235 for k
, v
in self
.vnfds
.iteritems():
236 for vu
in v
.get("virtual_deployment_units"):
237 if vu
.get("vm_image_format") == "docker":
238 url
= vu
.get("vm_image")
240 url
= url
.replace("http://", "")
241 self
.remote_docker_image_urls
[k
] = url
242 LOG
.debug("Found Docker image URL (%r): %r" % (k
, self
.remote_docker_image_urls
[k
]))
244 def _build_images_from_dockerfiles(self
):
246 Build Docker images for each local Dockerfile found in the package: self.local_docker_files
248 if GK_STANDALONE_MODE
:
249 return # do not build anything in standalone mode
251 LOG
.info("Building %d Docker images (this may take several minutes) ..." % len(self
.local_docker_files
))
252 for k
, v
in self
.local_docker_files
.iteritems():
253 for line
in dc
.build(path
=v
.replace("Dockerfile", ""), tag
=k
, rm
=False, nocache
=False):
254 LOG
.debug("DOCKER BUILD: %s" % line
)
255 LOG
.info("Docker image created: %s" % k
)
257 def _pull_predefined_dockerimages(self
):
259 If the package contains URLs to pre-build Docker images, we download them with this method.
262 for url
in self
.remote_docker_image_urls
.itervalues():
263 if not FORCE_PULL
: # only pull if not present (speedup for development)
264 if len(dc
.images(name
=url
)) > 0:
265 LOG
.debug("Image %r present. Skipping pull." % url
)
267 LOG
.info("Pulling image: %r" % url
)
269 insecure_registry
=True)
271 def _check_docker_image_exists(self
, image_name
):
273 Query the docker service and check if the given image exists
274 :param image_name: name of the docker image
277 return len(DockerClient().images(image_name
)) > 0
279 def _calculate_placement(self
, algorithm
):
281 Do placement by adding the a field "dc" to
282 each VNFD that points to one of our
283 data center objects known to the gatekeeper.
285 assert(len(self
.vnfds
) > 0)
286 assert(len(GK
.dcs
) > 0)
287 # instantiate algorithm an place
289 p
.place(self
.nsd
, self
.vnfds
, GK
.dcs
)
290 LOG
.info("Using placement algorithm: %r" % p
.__class
__.__name
__)
291 # lets print the placement result
292 for name
, vnfd
in self
.vnfds
.iteritems():
293 LOG
.info("Placed VNF %r on DC %r" % (name
, str(vnfd
.get("dc"))))
297 Some (simple) placement algorithms
301 class FirstDcPlacement(object):
303 Placement: Always use one and the same data center from the GK.dcs dict.
305 def place(self
, nsd
, vnfds
, dcs
):
306 for name
, vnfd
in vnfds
.iteritems():
307 vnfd
["dc"] = list(dcs
.itervalues())[0]
311 Resource definitions and API endpoints
315 class Packages(fr
.Resource
):
319 Upload a *.son service package to the dummy gatekeeper.
321 We expect request with a *.son file and store it in UPLOAD_FOLDER
327 # lets search for the package in the request
328 if "package" in request
.files
:
329 son_file
= request
.files
["package"]
330 # elif "file" in request.files:
331 # son_file = request.files["file"]
333 return {"service_uuid": None, "size": 0, "sha1": None, "error": "upload failed. file not found."}, 500
334 # generate a uuid to reference this package
335 service_uuid
= str(uuid
.uuid4())
336 file_hash
= hashlib
.sha1(str(son_file
)).hexdigest()
337 # ensure that upload folder exists
338 ensure_dir(UPLOAD_FOLDER
)
339 upload_path
= os
.path
.join(UPLOAD_FOLDER
, "%s.son" % service_uuid
)
340 # store *.son file to disk
341 son_file
.save(upload_path
)
342 size
= os
.path
.getsize(upload_path
)
343 # create a service object and register it
344 s
= Service(service_uuid
, file_hash
, upload_path
)
345 GK
.register_service_package(service_uuid
, s
)
346 # generate the JSON result
347 return {"service_uuid": service_uuid
, "size": size
, "sha1": file_hash
, "error": None}
348 except Exception as ex
:
349 LOG
.exception("Service package upload failed:")
350 return {"service_uuid": None, "size": 0, "sha1": None, "error": "upload failed"}, 500
354 Return a list of UUID's of uploaded service packages.
357 return {"service_uuid_list": list(GK
.services
.iterkeys())}
360 class Instantiations(fr
.Resource
):
364 Instantiate a service specified by its UUID.
365 Will return a new UUID to identify the running service instance.
368 # try to extract the service uuid from the request
369 json_data
= request
.get_json(force
=True)
370 service_uuid
= json_data
.get("service_uuid")
372 # lets be a bit fuzzy here to make testing easier
373 if service_uuid
is None and len(GK
.services
) > 0:
374 # if we don't get a service uuid, we simple start the first service in the list
375 service_uuid
= list(GK
.services
.iterkeys())[0]
377 if service_uuid
in GK
.services
:
378 # ok, we have a service uuid, lets start the service
379 service_instance_uuid
= GK
.services
.get(service_uuid
).start_service()
380 return {"service_instance_uuid": service_instance_uuid
}
381 return "Service not found", 404
385 Returns a list of UUIDs containing all running services.
388 return {"service_instance_list": [
389 list(s
.instances
.iterkeys()) for s
in GK
.services
.itervalues()]}
392 # create a single, global GK object
395 app
= Flask(__name__
)
396 app
.config
['MAX_CONTENT_LENGTH'] = 512 * 1024 * 1024 # 512 MB max upload
399 api
.add_resource(Packages
, '/packages')
400 api
.add_resource(Instantiations
, '/instantiations')
403 def start_rest_api(host
, port
, datacenters
=dict()):
405 # start the Flask server (not the best performance but ok for our use case)
409 use_reloader
=False # this is needed to run Flask in a non-main thread
413 def ensure_dir(name
):
414 if not os
.path
.exists(name
):
419 with
open(path
, "r") as f
:
422 except yaml
.YAMLError
as exc
:
423 LOG
.exception("YAML parse error")
428 def make_relative_path(path
):
429 if path
.startswith("file://"):
430 path
= path
.replace("file://", "", 1)
431 if path
.startswith("/"):
432 path
= path
.replace("/", "", 1)
436 if __name__
== '__main__':
438 Lets allow to run the API in standalone mode.
440 GK_STANDALONE_MODE
= True
441 logging
.getLogger("werkzeug").setLevel(logging
.INFO
)
442 start_rest_api("0.0.0.0", 8000)