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).
29 This module implements a simple REST API that behaves like SONATA's gatekeeper.
31 It is only used to support the development of SONATA's SDK tools and to demonstrate
32 the year 1 version of the emulator until the integration with WP4's orchestrator is done.
42 from docker
import DockerClient
, APIClient
43 from flask
import Flask
, request
44 import flask_restful
as fr
45 from collections
import defaultdict
47 from subprocess
import Popen
48 from random
import randint
53 LOG
= logging
.getLogger("sonata-dummy-gatekeeper")
54 LOG
.setLevel(logging
.DEBUG
)
55 logging
.getLogger("werkzeug").setLevel(logging
.WARNING
)
57 GK_STORAGE
= "/tmp/son-dummy-gk/"
58 UPLOAD_FOLDER
= os
.path
.join(GK_STORAGE
, "uploads/")
59 CATALOG_FOLDER
= os
.path
.join(GK_STORAGE
, "catalog/")
61 # Enable Dockerfile build functionality
62 BUILD_DOCKERFILE
= False
64 # flag to indicate that we run without the emulator (only the bare API for integration testing)
65 GK_STANDALONE_MODE
= False
67 # should a new version of an image be pulled even if its available
70 # Automatically deploy SAPs (endpoints) of the service as new containers
71 # Attention: This is not a configuration switch but a global variable! Don't change its default value.
74 # flag to indicate if we use bidirectional forwarding rules in the automatic chaining process
75 BIDIRECTIONAL_CHAIN
= False
77 # override the management interfaces in the descriptors with default docker0 interfaces in the containers
78 USE_DOCKER_MGMT
= False
80 # automatically deploy uploaded packages (no need to execute son-access deploy --latest separately)
83 # and also automatically terminate any other running services
86 def generate_subnets(prefix
, base
, subnet_size
=50, mask
=24):
87 # Generate a list of ipaddress in subnets
89 for net
in range(base
, base
+ subnet_size
):
90 subnet
= "{0}.{1}.0/{2}".format(prefix
, net
, mask
)
91 r
.append(ipaddress
.ip_network(unicode(subnet
)))
93 # private subnet definitions for the generated interfaces
95 SAP_SUBNETS
= generate_subnets('10.10', 0, subnet_size
=50, mask
=30)
97 ELAN_SUBNETS
= generate_subnets('10.20', 0, subnet_size
=50, mask
=24)
99 ELINE_SUBNETS
= generate_subnets('10.30', 0, subnet_size
=50, mask
=30)
101 # path to the VNFD for the SAP VNF that is deployed as internal SAP point
104 class Gatekeeper(object):
107 self
.services
= dict()
110 self
.vnf_counter
= 0 # used to generate short names for VNFs (Mininet limitation)
111 LOG
.info("Create SONATA dummy gatekeeper.")
113 def register_service_package(self
, service_uuid
, service
):
115 register new service package
117 :param service object
119 self
.services
[service_uuid
] = service
120 # lets perform all steps needed to onboard the service
123 def get_next_vnf_name(self
):
124 self
.vnf_counter
+= 1
125 return "vnf%d" % self
.vnf_counter
128 class Service(object):
130 This class represents a NS uploaded as a *.son package to the
132 Can have multiple running instances of this service.
139 self
.uuid
= service_uuid
140 self
.package_file_hash
= package_file_hash
141 self
.package_file_path
= package_file_path
142 self
.package_content_path
= os
.path
.join(CATALOG_FOLDER
, "services/%s" % self
.uuid
)
147 self
.saps_ext
= list()
148 self
.saps_int
= list()
149 self
.local_docker_files
= dict()
150 self
.remote_docker_image_urls
= dict()
151 self
.instances
= dict()
152 # dict to find the vnf_name for any vnf id
153 self
.vnf_id2vnf_name
= dict()
157 Do all steps to prepare this service to be instantiated
160 # 1. extract the contents of the package and store them in our catalog
161 self
._unpack
_service
_package
()
162 # 2. read in all descriptor files
163 self
._load
_package
_descriptor
()
168 # 3. prepare container images (e.g. download or build Dockerfile)
170 self
._load
_docker
_files
()
171 self
._build
_images
_from
_dockerfiles
()
173 self
._load
_docker
_urls
()
174 self
._pull
_predefined
_dockerimages
()
175 LOG
.info("On-boarded service: %r" % self
.manifest
.get("name"))
177 def start_service(self
):
179 This methods creates and starts a new service instance.
180 It computes placements, iterates over all VNFDs, and starts
181 each VNFD as a Docker container in the data center selected
182 by the placement algorithm.
185 LOG
.info("Starting service %r" % self
.uuid
)
187 # 1. each service instance gets a new uuid to identify it
188 instance_uuid
= str(uuid
.uuid4())
189 # build a instances dict (a bit like a NSR :))
190 self
.instances
[instance_uuid
] = dict()
191 self
.instances
[instance_uuid
]["vnf_instances"] = list()
193 # 2. compute placement of this service instance (adds DC names to VNFDs)
194 if not GK_STANDALONE_MODE
:
195 #self._calculate_placement(FirstDcPlacement)
196 self
._calculate
_placement
(RoundRobinDcPlacementWithSAPs
)
197 # 3. start all vnfds that we have in the service (except SAPs)
198 for vnf_id
in self
.vnfds
:
199 vnfd
= self
.vnfds
[vnf_id
]
201 if not GK_STANDALONE_MODE
:
202 vnfi
= self
._start
_vnfd
(vnfd
, vnf_id
)
203 self
.instances
[instance_uuid
]["vnf_instances"].append(vnfi
)
205 # 4. start all SAPs in the service
206 for sap
in self
.saps
:
207 self
._start
_sap
(self
.saps
[sap
], instance_uuid
)
209 # 5. Deploy E-Line and E_LAN links
210 if "virtual_links" in self
.nsd
:
211 vlinks
= self
.nsd
["virtual_links"]
212 # constituent virtual links are not checked
213 #fwd_links = self.nsd["forwarding_graphs"][0]["constituent_virtual_links"]
214 eline_fwd_links
= [l
for l
in vlinks
if (l
["connectivity_type"] == "E-Line")]
215 elan_fwd_links
= [l
for l
in vlinks
if (l
["connectivity_type"] == "E-LAN")]
217 GK
.net
.deployed_elines
.extend(eline_fwd_links
)
218 GK
.net
.deployed_elans
.extend(elan_fwd_links
)
220 # 5a. deploy E-Line links
221 self
._connect
_elines
(eline_fwd_links
, instance_uuid
)
223 # 5b. deploy E-LAN links
224 self
._connect
_elans
(elan_fwd_links
, instance_uuid
)
226 # 6. run the emulator specific entrypoint scripts in the VNFIs of this service instance
227 self
._trigger
_emulator
_start
_scripts
_in
_vnfis
(self
.instances
[instance_uuid
]["vnf_instances"])
229 LOG
.info("Service started. Instance id: %r" % instance_uuid
)
232 def stop_service(self
, instance_uuid
):
234 This method stops a running service instance.
235 It iterates over all VNF instances, stopping them each
236 and removing them from their data center.
238 :param instance_uuid: the uuid of the service instance to be stopped
240 LOG
.info("Stopping service %r" % self
.uuid
)
241 # get relevant information
242 # instance_uuid = str(self.uuid.uuid4())
243 vnf_instances
= self
.instances
[instance_uuid
]["vnf_instances"]
245 for v
in vnf_instances
:
248 for sap_name
in self
.saps_ext
:
249 ext_sap
= self
.saps
[sap_name
]
250 target_dc
= ext_sap
.get("dc")
251 target_dc
.removeExternalSAP(sap_name
)
252 LOG
.info("Stopping the SAP instance: %r in DC %r" % (sap_name
, target_dc
))
254 if not GK_STANDALONE_MODE
:
256 # self._remove_placement(RoundRobinPlacement)
259 # last step: remove the instance from the list of all instances
260 del self
.instances
[instance_uuid
]
262 def _start_vnfd(self
, vnfd
, vnf_id
, **kwargs
):
264 Start a single VNFD of this service
265 :param vnfd: vnfd descriptor dict
266 :param vnf_id: unique id of this vnf in the nsd
269 # the vnf_name refers to the container image to be deployed
270 vnf_name
= vnfd
.get("name")
272 # iterate over all deployment units within each VNFDs
273 for u
in vnfd
.get("virtual_deployment_units"):
274 # 1. get the name of the docker image to start and the assigned DC
275 if vnf_id
not in self
.remote_docker_image_urls
:
276 raise Exception("No image name for %r found. Abort." % vnf_id
)
277 docker_name
= self
.remote_docker_image_urls
.get(vnf_id
)
278 target_dc
= vnfd
.get("dc")
279 # 2. perform some checks to ensure we can start the container
280 assert(docker_name
is not None)
281 assert(target_dc
is not None)
282 if not self
._check
_docker
_image
_exists
(docker_name
):
283 raise Exception("Docker image %r not found. Abort." % docker_name
)
285 # 3. get the resource limits
286 res_req
= u
.get("resource_requirements")
287 cpu_list
= res_req
.get("cpu").get("cores")
289 cpu_list
= res_req
.get("cpu").get("vcpus")
292 cpu_bw
= res_req
.get("cpu").get("cpu_bw")
295 mem_num
= str(res_req
.get("memory").get("size"))
298 mem_unit
= str(res_req
.get("memory").get("size_unit"))
301 mem_limit
= float(mem_num
)
303 mem_limit
=mem_limit
*1024*1024*1024
305 mem_limit
=mem_limit
*1024*1024
307 mem_limit
=mem_limit
*1024
308 mem_lim
= int(mem_limit
)
309 cpu_period
, cpu_quota
= self
._calculate
_cpu
_cfs
_values
(float(cpu_bw
))
311 # check if we need to deploy the management ports (defined as type:management both on in the vnfd and nsd)
312 intfs
= vnfd
.get("connection_points", [])
315 mgmt_intfs
= [vnf_id
+ ':' + intf
['id'] for intf
in intfs
if intf
.get('type') == 'management']
316 # check if any of these management interfaces are used in a management-type network in the nsd
317 for nsd_intf_name
in mgmt_intfs
:
318 vlinks
= [ l
["connection_points_reference"] for l
in self
.nsd
.get("virtual_links", [])]
320 if nsd_intf_name
in link
and self
.check_mgmt_interface(link
):
321 # this is indeed a management interface and can be skipped
322 vnf_id
, vnf_interface
, vnf_sap_docker_name
= parse_interface(nsd_intf_name
)
323 found_interfaces
= [intf
for intf
in intfs
if intf
.get('id') == vnf_interface
]
324 intfs
.remove(found_interfaces
[0])
325 mgmt_intf_names
.append(vnf_interface
)
327 # 4. generate the volume paths for the docker container
329 # a volume to extract log files
330 docker_log_path
= "/tmp/results/%s/%s"%(self
.uuid
,vnf_id
)
331 LOG
.debug("LOG path for vnf %s is %s."%(vnf_id
,docker_log_path
))
332 if not os
.path
.exists(docker_log_path
):
333 LOG
.debug("Creating folder %s"%docker
_log
_path
)
334 os
.makedirs(docker_log_path
)
336 volumes
.append(docker_log_path
+":/mnt/share/")
339 # 5. do the dc.startCompute(name="foobar") call to run the container
340 # TODO consider flavors, and other annotations
341 # TODO: get all vnf id's from the nsd for this vnfd and use those as dockername
342 # use the vnf_id in the nsd as docker name
343 # so deployed containers can be easily mapped back to the nsd
344 LOG
.info("Starting %r as %r in DC %r" % (vnf_name
, vnf_id
, vnfd
.get("dc")))
345 LOG
.debug("Interfaces for %r: %r" % (vnf_id
, intfs
))
346 vnfi
= target_dc
.startCompute(
352 cpu_period
=cpu_period
,
356 type=kwargs
.get('type','docker'))
358 # rename the docker0 interfaces (eth0) to the management port name defined in the VNFD
360 for intf_name
in mgmt_intf_names
:
361 self
._vnf
_reconfigure
_network
(vnfi
, 'eth0', new_name
=intf_name
)
365 def _stop_vnfi(self
, vnfi
):
369 :param vnfi: vnf instance to be stopped
371 # Find the correct datacenter
372 status
= vnfi
.getStatus()
376 LOG
.info("Stopping the vnf instance contained in %r in DC %r" % (status
["name"], dc
))
377 dc
.stopCompute(status
["name"])
379 def _get_vnf_instance(self
, instance_uuid
, vnf_id
):
381 Returns the Docker object for the given VNF id (or Docker name).
382 :param instance_uuid: UUID of the service instance to search in.
383 :param name: VNF name or Docker name. We are fuzzy here.
387 for vnfi
in self
.instances
[instance_uuid
]["vnf_instances"]:
390 LOG
.warning("No container with name: {0} found.".format(dn
))
394 def _vnf_reconfigure_network(vnfi
, if_name
, net_str
=None, new_name
=None):
396 Reconfigure the network configuration of a specific interface
397 of a running container.
398 :param vnfi: container instance
399 :param if_name: interface name
400 :param net_str: network configuration string, e.g., 1.2.3.4/24
404 # assign new ip address
405 if net_str
is not None:
406 intf
= vnfi
.intf(intf
=if_name
)
409 LOG
.debug("Reconfigured network of %s:%s to %r" % (vnfi
.name
, if_name
, net_str
))
411 LOG
.warning("Interface not found: %s:%s. Network reconfiguration skipped." % (vnfi
.name
, if_name
))
413 if new_name
is not None:
414 vnfi
.cmd('ip link set', if_name
, 'down')
415 vnfi
.cmd('ip link set', if_name
, 'name', new_name
)
416 vnfi
.cmd('ip link set', new_name
, 'up')
417 LOG
.debug("Reconfigured interface name of %s:%s to %s" % (vnfi
.name
, if_name
, new_name
))
421 def _trigger_emulator_start_scripts_in_vnfis(self
, vnfi_list
):
422 for vnfi
in vnfi_list
:
423 config
= vnfi
.dcinfo
.get("Config", dict())
424 env
= config
.get("Env", list())
426 var
, cmd
= map(str.strip
, map(str, env_var
.split('=', 1)))
427 LOG
.debug("%r = %r" % (var
, cmd
))
428 if var
=="SON_EMU_CMD":
429 LOG
.info("Executing entry point script in %r: %r" % (vnfi
.name
, cmd
))
430 # execute command in new thread to ensure that GK is not blocked by VNF
431 t
= threading
.Thread(target
=vnfi
.cmdPrint
, args
=(cmd
,))
435 def _unpack_service_package(self
):
437 unzip *.son file and store contents in CATALOG_FOLDER/services/<service_uuid>/
439 LOG
.info("Unzipping: %r" % self
.package_file_path
)
440 with zipfile
.ZipFile(self
.package_file_path
, "r") as z
:
441 z
.extractall(self
.package_content_path
)
444 def _load_package_descriptor(self
):
446 Load the main package descriptor YAML and keep it as dict.
449 self
.manifest
= load_yaml(
451 self
.package_content_path
, "META-INF/MANIFEST.MF"))
455 Load the entry NSD YAML and keep it as dict.
458 if "entry_service_template" in self
.manifest
:
459 nsd_path
= os
.path
.join(
460 self
.package_content_path
,
461 make_relative_path(self
.manifest
.get("entry_service_template")))
462 self
.nsd
= load_yaml(nsd_path
)
463 GK
.net
.deployed_nsds
.append(self
.nsd
)
464 # create dict to find the vnf_name for any vnf id
465 self
.vnf_id2vnf_name
= defaultdict(lambda: "NotExistingNode",
466 reduce(lambda x
, y
: dict(x
, **y
),
467 map(lambda d
: {d
["vnf_id"]: d
["vnf_name"]},
468 self
.nsd
["network_functions"])))
470 LOG
.debug("Loaded NSD: %r" % self
.nsd
.get("name"))
472 def _load_vnfd(self
):
474 Load all VNFD YAML files referenced in MANIFEST.MF and keep them in dict.
478 # first make a list of all the vnfds in the package
480 if "package_content" in self
.manifest
:
481 for pc
in self
.manifest
.get("package_content"):
482 if pc
.get("content-type") == "application/sonata.function_descriptor":
483 vnfd_path
= os
.path
.join(
484 self
.package_content_path
,
485 make_relative_path(pc
.get("name")))
486 vnfd
= load_yaml(vnfd_path
)
487 vnfd_set
[vnfd
.get("name")] = vnfd
488 # then link each vnf_id in the nsd to its vnfd
489 for vnf_id
in self
.vnf_id2vnf_name
:
490 vnf_name
= self
.vnf_id2vnf_name
[vnf_id
]
491 self
.vnfds
[vnf_id
] = vnfd_set
[vnf_name
]
492 LOG
.debug("Loaded VNFD: {0} id: {1}".format(vnf_name
, vnf_id
))
494 def _load_saps(self
):
495 # create list of all SAPs
496 # check if we need to deploy management ports
498 SAPs
= [p
for p
in self
.nsd
["connection_points"] if 'management' not in p
.get('type')]
500 SAPs
= [p
for p
in self
.nsd
["connection_points"]]
503 # endpoint needed in this service
504 sap_id
, sap_interface
, sap_docker_name
= parse_interface(sap
['id'])
505 # make sure SAP has type set (default internal)
506 sap
["type"] = sap
.get("type", 'internal')
508 # Each Service Access Point (connection_point) in the nsd is an IP address on the host
509 if sap
["type"] == "external":
510 # add to vnfds to calculate placement later on
511 sap_net
= SAP_SUBNETS
.pop(0)
512 self
.saps
[sap_docker_name
] = {"name": sap_docker_name
, "type": "external", "net": sap_net
}
513 # add SAP vnf to list in the NSD so it is deployed later on
514 # each SAP gets a unique VNFD and vnf_id in the NSD and custom type (only defined in the dummygatekeeper)
515 self
.nsd
["network_functions"].append(
516 {"vnf_id": sap_docker_name
, "vnf_name": sap_docker_name
, "vnf_type": "sap_ext"})
518 # Each Service Access Point (connection_point) in the nsd is getting its own container (default)
519 elif sap
["type"] == "internal" or sap
["type"] == "management":
520 # add SAP to self.vnfds
522 sapfile
= pkg_resources
.resource_filename(__name__
, "sap_vnfd.yml")
525 sap_vnfd
= load_yaml(sapfile
)
526 sap_vnfd
["connection_points"][0]["id"] = sap_interface
527 sap_vnfd
["name"] = sap_docker_name
528 sap_vnfd
["type"] = "internal"
529 # add to vnfds to calculate placement later on and deploy
530 self
.saps
[sap_docker_name
] = sap_vnfd
531 # add SAP vnf to list in the NSD so it is deployed later on
532 # each SAP get a unique VNFD and vnf_id in the NSD
533 self
.nsd
["network_functions"].append(
534 {"vnf_id": sap_docker_name
, "vnf_name": sap_docker_name
, "vnf_type": "sap_int"})
536 LOG
.debug("Loaded SAP: name: {0}, type: {1}".format(sap_docker_name
, sap
['type']))
539 self
.saps_ext
= [self
.saps
[sap
]['name'] for sap
in self
.saps
if self
.saps
[sap
]["type"] == "external"]
540 self
.saps_int
= [self
.saps
[sap
]['name'] for sap
in self
.saps
if self
.saps
[sap
]["type"] == "internal"]
542 def _start_sap(self
, sap
, instance_uuid
):
546 LOG
.info('start SAP: {0} ,type: {1}'.format(sap
['name'],sap
['type']))
547 if sap
["type"] == "internal":
549 if not GK_STANDALONE_MODE
:
550 vnfi
= self
._start
_vnfd
(sap
, sap
['name'], type='sap_int')
551 self
.instances
[instance_uuid
]["vnf_instances"].append(vnfi
)
553 elif sap
["type"] == "external":
554 target_dc
= sap
.get("dc")
555 # add interface to dc switch
556 target_dc
.attachExternalSAP(sap
['name'], sap
['net'])
558 def _connect_elines(self
, eline_fwd_links
, instance_uuid
):
560 Connect all E-LINE links in the NSD
561 :param eline_fwd_links: list of E-LINE links in the NSD
562 :param: instance_uuid of the service
565 # cookie is used as identifier for the flowrules installed by the dummygatekeeper
566 # eg. different services get a unique cookie for their flowrules
568 for link
in eline_fwd_links
:
569 # check if we need to deploy this link when its a management link:
571 if self
.check_mgmt_interface(link
["connection_points_reference"]):
574 src_id
, src_if_name
, src_sap_id
= parse_interface(link
["connection_points_reference"][0])
575 dst_id
, dst_if_name
, dst_sap_id
= parse_interface(link
["connection_points_reference"][1])
578 # check if there is a SAP in the link and chain everything together
579 if src_sap_id
in self
.saps
and dst_sap_id
in self
.saps
:
580 LOG
.info('2 SAPs cannot be chained together : {0} - {1}'.format(src_sap_id
, dst_sap_id
))
583 elif src_sap_id
in self
.saps_ext
:
585 # set intf name to None so the chaining function will choose the first one
587 dst_vnfi
= self
._get
_vnf
_instance
(instance_uuid
, dst_id
)
588 if dst_vnfi
is not None:
589 # choose first ip address in sap subnet
590 sap_net
= self
.saps
[src_sap_id
]['net']
591 sap_ip
= "{0}/{1}".format(str(sap_net
[2]), sap_net
.prefixlen
)
592 self
._vnf
_reconfigure
_network
(dst_vnfi
, dst_if_name
, sap_ip
)
595 elif dst_sap_id
in self
.saps_ext
:
597 # set intf name to None so the chaining function will choose the first one
599 src_vnfi
= self
._get
_vnf
_instance
(instance_uuid
, src_id
)
600 if src_vnfi
is not None:
601 sap_net
= self
.saps
[dst_sap_id
]['net']
602 sap_ip
= "{0}/{1}".format(str(sap_net
[2]), sap_net
.prefixlen
)
603 self
._vnf
_reconfigure
_network
(src_vnfi
, src_if_name
, sap_ip
)
606 # Link between 2 VNFs
608 # make sure we use the correct sap vnf name
609 if src_sap_id
in self
.saps_int
:
611 if dst_sap_id
in self
.saps_int
:
613 # re-configure the VNFs IP assignment and ensure that a new subnet is used for each E-Link
614 src_vnfi
= self
._get
_vnf
_instance
(instance_uuid
, src_id
)
615 dst_vnfi
= self
._get
_vnf
_instance
(instance_uuid
, dst_id
)
616 if src_vnfi
is not None and dst_vnfi
is not None:
617 eline_net
= ELINE_SUBNETS
.pop(0)
618 ip1
= "{0}/{1}".format(str(eline_net
[1]), eline_net
.prefixlen
)
619 ip2
= "{0}/{1}".format(str(eline_net
[2]), eline_net
.prefixlen
)
620 self
._vnf
_reconfigure
_network
(src_vnfi
, src_if_name
, ip1
)
621 self
._vnf
_reconfigure
_network
(dst_vnfi
, dst_if_name
, ip2
)
626 ret
= GK
.net
.setChain(
628 vnf_src_interface
=src_if_name
, vnf_dst_interface
=dst_if_name
,
629 bidirectional
=BIDIRECTIONAL_CHAIN
, cmd
="add-flow", cookie
=cookie
, priority
=10)
631 "Setting up E-Line link. (%s:%s) -> (%s:%s)" % (
632 src_id
, src_if_name
, dst_id
, dst_if_name
))
635 def _connect_elans(self
, elan_fwd_links
, instance_uuid
):
637 Connect all E-LAN links in the NSD
638 :param elan_fwd_links: list of E-LAN links in the NSD
639 :param: instance_uuid of the service
642 for link
in elan_fwd_links
:
643 # check if we need to deploy this link when its a management link:
645 if self
.check_mgmt_interface(link
["connection_points_reference"]):
649 # check if an external SAP is in the E-LAN (then a subnet is already defined)
650 intfs_elan
= [intf
for intf
in link
["connection_points_reference"]]
651 lan_sap
= self
.check_ext_saps(intfs_elan
)
653 lan_net
= self
.saps
[lan_sap
]['net']
654 lan_hosts
= list(lan_net
.hosts())
655 sap_ip
= str(lan_hosts
.pop(0))
657 lan_net
= ELAN_SUBNETS
.pop(0)
658 lan_hosts
= list(lan_net
.hosts())
660 # generate lan ip address for all interfaces except external SAPs
661 for intf
in link
["connection_points_reference"]:
663 # skip external SAPs, they already have an ip
664 vnf_id
, vnf_interface
, vnf_sap_docker_name
= parse_interface(intf
)
665 if vnf_sap_docker_name
in self
.saps_ext
:
666 elan_vnf_list
.append({'name': vnf_sap_docker_name
, 'interface': vnf_interface
})
669 ip_address
= "{0}/{1}".format(str(lan_hosts
.pop(0)), lan_net
.prefixlen
)
670 vnf_id
, intf_name
, vnf_sap_id
= parse_interface(intf
)
672 # make sure we use the correct sap vnf name
673 src_docker_name
= vnf_id
674 if vnf_sap_id
in self
.saps_int
:
675 src_docker_name
= vnf_sap_id
679 "Setting up E-LAN interface. (%s:%s) -> %s" % (
680 vnf_id
, intf_name
, ip_address
))
682 # re-configure the VNFs IP assignment and ensure that a new subnet is used for each E-LAN
683 # E-LAN relies on the learning switch capability of Ryu which has to be turned on in the topology
684 # (DCNetwork(controller=RemoteController, enable_learning=True)), so no explicit chaining is necessary.
685 vnfi
= self
._get
_vnf
_instance
(instance_uuid
, vnf_id
)
687 self
._vnf
_reconfigure
_network
(vnfi
, intf_name
, ip_address
)
688 # add this vnf and interface to the E-LAN for tagging
689 elan_vnf_list
.append({'name': src_docker_name
, 'interface': intf_name
})
691 # install the VLAN tags for this E-LAN
692 GK
.net
.setLAN(elan_vnf_list
)
695 def _load_docker_files(self
):
697 Get all paths to Dockerfiles from VNFDs and store them in dict.
700 for k
, v
in self
.vnfds
.iteritems():
701 for vu
in v
.get("virtual_deployment_units"):
702 if vu
.get("vm_image_format") == "docker":
703 vm_image
= vu
.get("vm_image")
704 docker_path
= os
.path
.join(
705 self
.package_content_path
,
706 make_relative_path(vm_image
))
707 self
.local_docker_files
[k
] = docker_path
708 LOG
.debug("Found Dockerfile (%r): %r" % (k
, docker_path
))
710 def _load_docker_urls(self
):
712 Get all URLs to pre-build docker images in some repo.
715 # also merge sap dicts, because internal saps also need a docker container
716 all_vnfs
= self
.vnfds
.copy()
717 all_vnfs
.update(self
.saps
)
719 for k
, v
in all_vnfs
.iteritems():
720 for vu
in v
.get("virtual_deployment_units", {}):
721 if vu
.get("vm_image_format") == "docker":
722 url
= vu
.get("vm_image")
724 url
= url
.replace("http://", "")
725 self
.remote_docker_image_urls
[k
] = url
726 LOG
.debug("Found Docker image URL (%r): %r" % (k
, self
.remote_docker_image_urls
[k
]))
728 def _build_images_from_dockerfiles(self
):
730 Build Docker images for each local Dockerfile found in the package: self.local_docker_files
732 if GK_STANDALONE_MODE
:
733 return # do not build anything in standalone mode
735 LOG
.info("Building %d Docker images (this may take several minutes) ..." % len(self
.local_docker_files
))
736 for k
, v
in self
.local_docker_files
.iteritems():
737 for line
in dc
.build(path
=v
.replace("Dockerfile", ""), tag
=k
, rm
=False, nocache
=False):
738 LOG
.debug("DOCKER BUILD: %s" % line
)
739 LOG
.info("Docker image created: %s" % k
)
741 def _pull_predefined_dockerimages(self
):
743 If the package contains URLs to pre-build Docker images, we download them with this method.
746 for url
in self
.remote_docker_image_urls
.itervalues():
747 if not FORCE_PULL
: # only pull if not present (speedup for development)
748 if len(dc
.images
.list(name
=url
)) > 0:
749 LOG
.debug("Image %r present. Skipping pull." % url
)
751 LOG
.info("Pulling image: %r" % url
)
752 # this seems to fail with latest docker api version 2.0.2
753 # dc.images.pull(url,
754 # insecure_registry=True)
755 #using docker cli instead
765 def _check_docker_image_exists(self
, image_name
):
767 Query the docker service and check if the given image exists
768 :param image_name: name of the docker image
771 return len(DockerClient().images
.list(name
=image_name
)) > 0
773 def _calculate_placement(self
, algorithm
):
775 Do placement by adding the a field "dc" to
776 each VNFD that points to one of our
777 data center objects known to the gatekeeper.
779 assert(len(self
.vnfds
) > 0)
780 assert(len(GK
.dcs
) > 0)
781 # instantiate algorithm an place
783 p
.place(self
.nsd
, self
.vnfds
, self
.saps
, GK
.dcs
)
784 LOG
.info("Using placement algorithm: %r" % p
.__class
__.__name
__)
785 # lets print the placement result
786 for name
, vnfd
in self
.vnfds
.iteritems():
787 LOG
.info("Placed VNF %r on DC %r" % (name
, str(vnfd
.get("dc"))))
788 for sap
in self
.saps
:
789 sap_dict
= self
.saps
[sap
]
790 LOG
.info("Placed SAP %r on DC %r" % (sap
, str(sap_dict
.get("dc"))))
793 def _calculate_cpu_cfs_values(self
, cpu_time_percentage
):
795 Calculate cpu period and quota for CFS
796 :param cpu_time_percentage: percentage of overall CPU to be used
797 :return: cpu_period, cpu_quota
799 if cpu_time_percentage
is None:
801 if cpu_time_percentage
< 0:
803 # (see: https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt)
804 # Attention minimum cpu_quota is 1ms (micro)
805 cpu_period
= 1000000 # lets consider a fixed period of 1000000 microseconds for now
806 LOG
.debug("cpu_period is %r, cpu_percentage is %r" % (cpu_period
, cpu_time_percentage
))
807 cpu_quota
= cpu_period
* cpu_time_percentage
# calculate the fraction of cpu time for this container
808 # ATTENTION >= 1000 to avoid a invalid argument system error ... no idea why
810 LOG
.debug("cpu_quota before correcting: %r" % cpu_quota
)
812 LOG
.warning("Increased CPU quota to avoid system error.")
813 LOG
.debug("Calculated: cpu_period=%f / cpu_quota=%f" % (cpu_period
, cpu_quota
))
814 return int(cpu_period
), int(cpu_quota
)
816 def check_ext_saps(self
, intf_list
):
817 # check if the list of interfacs contains an external SAP
818 saps_ext
= [self
.saps
[sap
]['name'] for sap
in self
.saps
if self
.saps
[sap
]["type"] == "external"]
819 for intf_name
in intf_list
:
820 vnf_id
, vnf_interface
, vnf_sap_docker_name
= parse_interface(intf_name
)
821 if vnf_sap_docker_name
in saps_ext
:
822 return vnf_sap_docker_name
824 def check_mgmt_interface(self
, intf_list
):
825 SAPs_mgmt
= [p
.get('id') for p
in self
.nsd
["connection_points"] if 'management' in p
.get('type')]
826 for intf_name
in intf_list
:
827 if intf_name
in SAPs_mgmt
:
831 Some (simple) placement algorithms
835 class FirstDcPlacement(object):
837 Placement: Always use one and the same data center from the GK.dcs dict.
839 def place(self
, nsd
, vnfds
, saps
, dcs
):
840 for id, vnfd
in vnfds
.iteritems():
841 vnfd
["dc"] = list(dcs
.itervalues())[0]
844 class RoundRobinDcPlacement(object):
846 Placement: Distribute VNFs across all available DCs in a round robin fashion.
848 def place(self
, nsd
, vnfds
, saps
, dcs
):
850 dcs_list
= list(dcs
.itervalues())
851 for id, vnfd
in vnfds
.iteritems():
852 vnfd
["dc"] = dcs_list
[c
% len(dcs_list
)]
853 c
+= 1 # inc. c to use next DC
855 class RoundRobinDcPlacementWithSAPs(object):
857 Placement: Distribute VNFs across all available DCs in a round robin fashion,
858 every SAP is instantiated on the same DC as the connected VNF.
860 def place(self
, nsd
, vnfds
, saps
, dcs
):
864 dcs_list
= list(dcs
.itervalues())
865 for id, vnfd
in vnfds
.iteritems():
866 vnfd
["dc"] = dcs_list
[c
% len(dcs_list
)]
867 c
+= 1 # inc. c to use next DC
870 vlinks
= nsd
.get("virtual_links", [])
871 eline_fwd_links
= [l
for l
in vlinks
if (l
["connectivity_type"] == "E-Line")]
872 elan_fwd_links
= [l
for l
in vlinks
if (l
["connectivity_type"] == "E-LAN")]
874 # SAPs on E-Line links are placed on the same DC as the VNF on the E-Line
875 for link
in eline_fwd_links
:
876 src_id
, src_if_name
, src_sap_id
= parse_interface(link
["connection_points_reference"][0])
877 dst_id
, dst_if_name
, dst_sap_id
= parse_interface(link
["connection_points_reference"][1])
879 # check if there is a SAP in the link
880 if src_sap_id
in saps
:
881 # get dc where connected vnf is mapped to
882 dc
= vnfds
[dst_id
]['dc']
883 saps
[src_sap_id
]['dc'] = dc
885 if dst_sap_id
in saps
:
886 # get dc where connected vnf is mapped to
887 dc
= vnfds
[src_id
]['dc']
888 saps
[dst_sap_id
]['dc'] = dc
890 # SAPs on E-LANs are placed on a random DC
891 dcs_list
= list(dcs
.itervalues())
892 dc_len
= len(dcs_list
)
893 for link
in elan_fwd_links
:
894 for intf
in link
["connection_points_reference"]:
895 # find SAP interfaces
896 intf_id
, intf_name
, intf_sap_id
= parse_interface(intf
)
897 if intf_sap_id
in saps
:
898 dc
= dcs_list
[randint(0, dc_len
-1)]
899 saps
[intf_sap_id
]['dc'] = dc
904 Resource definitions and API endpoints
908 class Packages(fr
.Resource
):
912 Upload a *.son service package to the dummy gatekeeper.
914 We expect request with a *.son file and store it in UPLOAD_FOLDER
919 LOG
.info("POST /packages called")
920 # lets search for the package in the request
921 is_file_object
= False # make API more robust: file can be in data or in files field
922 if "package" in request
.files
:
923 son_file
= request
.files
["package"]
924 is_file_object
= True
925 elif len(request
.data
) > 0:
926 son_file
= request
.data
928 return {"service_uuid": None, "size": 0, "sha1": None, "error": "upload failed. file not found."}, 500
929 # generate a uuid to reference this package
930 service_uuid
= str(uuid
.uuid4())
931 file_hash
= hashlib
.sha1(str(son_file
)).hexdigest()
932 # ensure that upload folder exists
933 ensure_dir(UPLOAD_FOLDER
)
934 upload_path
= os
.path
.join(UPLOAD_FOLDER
, "%s.son" % service_uuid
)
935 # store *.son file to disk
937 son_file
.save(upload_path
)
939 with
open(upload_path
, 'wb') as f
:
941 size
= os
.path
.getsize(upload_path
)
943 # first stop and delete any other running services
945 service_list
= copy
.copy(GK
.services
)
946 for service_uuid
in service_list
:
947 instances_list
= copy
.copy(GK
.services
[service_uuid
].instances
)
948 for instance_uuid
in instances_list
:
949 # valid service and instance UUID, stop service
950 GK
.services
.get(service_uuid
).stop_service(instance_uuid
)
951 LOG
.info("service instance with uuid %r stopped." % instance_uuid
)
953 # create a service object and register it
954 s
= Service(service_uuid
, file_hash
, upload_path
)
955 GK
.register_service_package(service_uuid
, s
)
957 # automatically deploy the service
959 # ok, we have a service uuid, lets start the service
961 service_instance_uuid
= GK
.services
.get(service_uuid
).start_service()
963 # generate the JSON result
964 return {"service_uuid": service_uuid
, "size": size
, "sha1": file_hash
, "error": None}, 201
965 except Exception as ex
:
966 LOG
.exception("Service package upload failed:")
967 return {"service_uuid": None, "size": 0, "sha1": None, "error": "upload failed"}, 500
971 Return a list of UUID's of uploaded service packages.
974 LOG
.info("GET /packages")
975 return {"service_uuid_list": list(GK
.services
.iterkeys())}
978 class Instantiations(fr
.Resource
):
982 Instantiate a service specified by its UUID.
983 Will return a new UUID to identify the running service instance.
986 LOG
.info("POST /instantiations (or /requests) called")
987 # try to extract the service uuid from the request
988 json_data
= request
.get_json(force
=True)
989 service_uuid
= json_data
.get("service_uuid")
991 # lets be a bit fuzzy here to make testing easier
992 if (service_uuid
is None or service_uuid
=="latest") and len(GK
.services
) > 0:
993 # if we don't get a service uuid, we simple start the first service in the list
994 service_uuid
= list(GK
.services
.iterkeys())[0]
995 if service_uuid
in GK
.services
:
996 # ok, we have a service uuid, lets start the service
997 service_instance_uuid
= GK
.services
.get(service_uuid
).start_service()
998 return {"service_instance_uuid": service_instance_uuid
}, 201
999 return "Service not found", 404
1003 Returns a list of UUIDs containing all running services.
1004 :return: dict / list
1006 LOG
.info("GET /instantiations")
1007 return {"service_instantiations_list": [
1008 list(s
.instances
.iterkeys()) for s
in GK
.services
.itervalues()]}
1012 Stops a running service specified by its service and instance UUID.
1014 # try to extract the service and instance UUID from the request
1015 json_data
= request
.get_json(force
=True)
1016 service_uuid
= json_data
.get("service_uuid")
1017 instance_uuid
= json_data
.get("service_instance_uuid")
1020 if service_uuid
is None and len(GK
.services
) > 0:
1021 #if we don't get a service uuid, we simply stop the last service in the list
1022 service_uuid
= list(GK
.services
.iterkeys())[0]
1023 if instance_uuid
is None and len(GK
.services
[service_uuid
].instances
) > 0:
1024 instance_uuid
= list(GK
.services
[service_uuid
].instances
.iterkeys())[0]
1026 if service_uuid
in GK
.services
and instance_uuid
in GK
.services
[service_uuid
].instances
:
1027 # valid service and instance UUID, stop service
1028 GK
.services
.get(service_uuid
).stop_service(instance_uuid
)
1029 return "service instance with uuid %r stopped." % instance_uuid
,200
1030 return "Service not found", 404
1032 class Exit(fr
.Resource
):
1036 Stop the running Containernet instance regardless of data transmitted
1038 list(GK
.dcs
.values())[0].net
.stop()
1041 def initialize_GK():
1047 # create a single, global GK object
1051 app
= Flask(__name__
)
1052 app
.config
['MAX_CONTENT_LENGTH'] = 512 * 1024 * 1024 # 512 MB max upload
1055 api
.add_resource(Packages
, '/packages', '/api/v2/packages')
1056 api
.add_resource(Instantiations
, '/instantiations', '/api/v2/instantiations', '/api/v2/requests')
1057 api
.add_resource(Exit
, '/emulator/exit')
1061 def start_rest_api(host
, port
, datacenters
=dict()):
1062 GK
.dcs
= datacenters
1063 GK
.net
= get_dc_network()
1064 # start the Flask server (not the best performance but ok for our use case)
1068 use_reloader
=False # this is needed to run Flask in a non-main thread
1072 def ensure_dir(name
):
1073 if not os
.path
.exists(name
):
1077 def load_yaml(path
):
1078 with
open(path
, "r") as f
:
1081 except yaml
.YAMLError
as exc
:
1082 LOG
.exception("YAML parse error")
1087 def make_relative_path(path
):
1088 if path
.startswith("file://"):
1089 path
= path
.replace("file://", "", 1)
1090 if path
.startswith("/"):
1091 path
= path
.replace("/", "", 1)
1095 def get_dc_network():
1097 retrieve the DCnetwork where this dummygatekeeper (GK) connects to.
1098 Assume at least 1 datacenter is connected to this GK, and that all datacenters belong to the same DCNetwork
1101 assert (len(GK
.dcs
) > 0)
1102 return GK
.dcs
.values()[0].net
1105 def parse_interface(interface_name
):
1107 convert the interface name in the nsd to the according vnf_id, vnf_interface names
1108 :param interface_name:
1112 if ':' in interface_name
:
1113 vnf_id
, vnf_interface
= interface_name
.split(':')
1114 vnf_sap_docker_name
= interface_name
.replace(':', '_')
1116 vnf_id
= interface_name
1117 vnf_interface
= interface_name
1118 vnf_sap_docker_name
= interface_name
1120 return vnf_id
, vnf_interface
, vnf_sap_docker_name
1122 def reset_subnets():
1123 # private subnet definitions for the generated interfaces
1126 SAP_SUBNETS
= generate_subnets('10.10', 0, subnet_size
=50, mask
=30)
1129 ELAN_SUBNETS
= generate_subnets('10.20', 0, subnet_size
=50, mask
=24)
1131 global ELINE_SUBNETS
1132 ELINE_SUBNETS
= generate_subnets('10.30', 0, subnet_size
=50, mask
=30)
1134 if __name__
== '__main__':
1136 Lets allow to run the API in standalone mode.
1138 GK_STANDALONE_MODE
= True
1139 logging
.getLogger("werkzeug").setLevel(logging
.INFO
)
1140 start_rest_api("0.0.0.0", 8000)