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
52 LOG
= logging
.getLogger("sonata-dummy-gatekeeper")
53 LOG
.setLevel(logging
.DEBUG
)
54 logging
.getLogger("werkzeug").setLevel(logging
.WARNING
)
56 GK_STORAGE
= "/tmp/son-dummy-gk/"
57 UPLOAD_FOLDER
= os
.path
.join(GK_STORAGE
, "uploads/")
58 CATALOG_FOLDER
= os
.path
.join(GK_STORAGE
, "catalog/")
60 # Enable Dockerfile build functionality
61 BUILD_DOCKERFILE
= False
63 # flag to indicate that we run without the emulator (only the bare API for integration testing)
64 GK_STANDALONE_MODE
= False
66 # should a new version of an image be pulled even if its available
69 # Automatically deploy SAPs (endpoints) of the service as new containers
70 # Attention: This is not a configuration switch but a global variable! Don't change its default value.
73 # flag to indicate if we use bidirectional forwarding rules in the automatic chaining process
74 BIDIRECTIONAL_CHAIN
= False
76 # override the management interfaces in the descriptors with default docker0 interfaces in the containers
77 USE_DOCKER_MGMT
= True
79 def generate_subnets(prefix
, base
, subnet_size
=50, mask
=24):
80 # Generate a list of ipaddress in subnets
82 for net
in range(base
, base
+ subnet_size
):
83 subnet
= "{0}.{1}.0/{2}".format(prefix
, net
, mask
)
84 r
.append(ipaddress
.ip_network(unicode(subnet
)))
86 # private subnet definitions for the generated interfaces
88 SAP_SUBNETS
= generate_subnets('10.10', 0, subnet_size
=50, mask
=24)
90 ELAN_SUBNETS
= generate_subnets('10.20', 0, subnet_size
=50, mask
=24)
92 ELINE_SUBNETS
= generate_subnets('10.30', 0, subnet_size
=50, mask
=30)
95 class Gatekeeper(object):
98 self
.services
= dict()
101 self
.vnf_counter
= 0 # used to generate short names for VNFs (Mininet limitation)
102 LOG
.info("Create SONATA dummy gatekeeper.")
104 def register_service_package(self
, service_uuid
, service
):
106 register new service package
108 :param service object
110 self
.services
[service_uuid
] = service
111 # lets perform all steps needed to onboard the service
114 def get_next_vnf_name(self
):
115 self
.vnf_counter
+= 1
116 return "vnf%d" % self
.vnf_counter
119 class Service(object):
121 This class represents a NS uploaded as a *.son package to the
123 Can have multiple running instances of this service.
130 self
.uuid
= service_uuid
131 self
.package_file_hash
= package_file_hash
132 self
.package_file_path
= package_file_path
133 self
.package_content_path
= os
.path
.join(CATALOG_FOLDER
, "services/%s" % self
.uuid
)
138 self
.saps_ext
= list()
139 self
.saps_int
= list()
140 self
.local_docker_files
= dict()
141 self
.remote_docker_image_urls
= dict()
142 self
.instances
= dict()
143 self
.vnf_name2docker_name
= dict()
144 self
.vnf_id2vnf_name
= dict()
148 Do all steps to prepare this service to be instantiated
151 # 1. extract the contents of the package and store them in our catalog
152 self
._unpack
_service
_package
()
153 # 2. read in all descriptor files
154 self
._load
_package
_descriptor
()
159 # create dict to translate vnf names
160 self
.vnf_id2vnf_name
= defaultdict(lambda: "NotExistingNode",
161 reduce(lambda x
, y
: dict(x
, **y
),
162 map(lambda d
: {d
["vnf_id"]: d
["vnf_name"]},
163 self
.nsd
["network_functions"])))
164 # 3. prepare container images (e.g. download or build Dockerfile)
166 self
._load
_docker
_files
()
167 self
._build
_images
_from
_dockerfiles
()
169 self
._load
_docker
_urls
()
170 self
._pull
_predefined
_dockerimages
()
171 LOG
.info("On-boarded service: %r" % self
.manifest
.get("name"))
173 def start_service(self
):
175 This methods creates and starts a new service instance.
176 It computes placements, iterates over all VNFDs, and starts
177 each VNFD as a Docker container in the data center selected
178 by the placement algorithm.
181 LOG
.info("Starting service %r" % self
.uuid
)
183 # 1. each service instance gets a new uuid to identify it
184 instance_uuid
= str(uuid
.uuid4())
185 # build a instances dict (a bit like a NSR :))
186 self
.instances
[instance_uuid
] = dict()
187 self
.instances
[instance_uuid
]["vnf_instances"] = list()
189 # 2. compute placement of this service instance (adds DC names to VNFDs)
190 if not GK_STANDALONE_MODE
:
191 #self._calculate_placement(FirstDcPlacement)
192 self
._calculate
_placement
(RoundRobinDcPlacementWithSAPs
)
194 # 3. start all vnfds that we have in the service (except SAPs)
195 for vnfd
in self
.vnfds
.itervalues():
197 if not GK_STANDALONE_MODE
:
198 vnfi
= self
._start
_vnfd
(vnfd
)
199 self
.instances
[instance_uuid
]["vnf_instances"].append(vnfi
)
201 # 4. start all SAPs in the service
202 for sap
in self
.saps
:
203 self
._start
_sap
(self
.saps
[sap
], instance_uuid
)
205 # 5. Deploy E-Line and E_LAN links
206 if "virtual_links" in self
.nsd
:
207 vlinks
= self
.nsd
["virtual_links"]
208 # constituent virtual links are not checked
209 #fwd_links = self.nsd["forwarding_graphs"][0]["constituent_virtual_links"]
210 eline_fwd_links
= [l
for l
in vlinks
if (l
["connectivity_type"] == "E-Line")]
211 elan_fwd_links
= [l
for l
in vlinks
if (l
["connectivity_type"] == "E-LAN")]
213 GK
.net
.deployed_elines
.extend(eline_fwd_links
)
214 GK
.net
.deployed_elans
.extend(elan_fwd_links
)
216 # 5a. deploy E-Line links
217 self
._connect
_elines
(eline_fwd_links
, instance_uuid
)
219 # 5b. deploy E-LAN links
220 self
._connect
_elans
(elan_fwd_links
, instance_uuid
)
222 # 6. run the emulator specific entrypoint scripts in the VNFIs of this service instance
223 self
._trigger
_emulator
_start
_scripts
_in
_vnfis
(self
.instances
[instance_uuid
]["vnf_instances"])
225 LOG
.info("Service started. Instance id: %r" % instance_uuid
)
228 def stop_service(self
, instance_uuid
):
230 This method stops a running service instance.
231 It iterates over all VNF instances, stopping them each
232 and removing them from their data center.
234 :param instance_uuid: the uuid of the service instance to be stopped
236 LOG
.info("Stopping service %r" % self
.uuid
)
237 # get relevant information
238 # instance_uuid = str(self.uuid.uuid4())
239 vnf_instances
= self
.instances
[instance_uuid
]["vnf_instances"]
241 for v
in vnf_instances
:
244 if not GK_STANDALONE_MODE
:
246 # self._remove_placement(RoundRobinPlacement)
249 # last step: remove the instance from the list of all instances
250 del self
.instances
[instance_uuid
]
252 def _start_vnfd(self
, vnfd
):
254 Start a single VNFD of this service
255 :param vnfd: vnfd descriptor dict
258 # iterate over all deployment units within each VNFDs
259 for u
in vnfd
.get("virtual_deployment_units"):
260 # 1. get the name of the docker image to start and the assigned DC
261 vnf_name
= vnfd
.get("name")
262 if vnf_name
not in self
.remote_docker_image_urls
:
263 raise Exception("No image name for %r found. Abort." % vnf_name
)
264 docker_name
= self
.remote_docker_image_urls
.get(vnf_name
)
265 target_dc
= vnfd
.get("dc")
266 # 2. perform some checks to ensure we can start the container
267 assert(docker_name
is not None)
268 assert(target_dc
is not None)
269 if not self
._check
_docker
_image
_exists
(docker_name
):
270 raise Exception("Docker image %r not found. Abort." % docker_name
)
272 # 3. get the resource limits
273 res_req
= u
.get("resource_requirements")
274 cpu_list
= res_req
.get("cpu").get("cores")
275 if not cpu_list
or len(cpu_list
)==0:
277 cpu_bw
= res_req
.get("cpu").get("cpu_bw")
280 mem_num
= str(res_req
.get("memory").get("size"))
283 mem_unit
= str(res_req
.get("memory").get("size_unit"))
286 mem_limit
= float(mem_num
)
288 mem_limit
=mem_limit
*1024*1024*1024
290 mem_limit
=mem_limit
*1024*1024
292 mem_limit
=mem_limit
*1024
293 mem_lim
= int(mem_limit
)
294 cpu_period
, cpu_quota
= self
._calculate
_cpu
_cfs
_values
(float(cpu_bw
))
296 vnf_name2id
= defaultdict(lambda: "NotExistingNode",
297 reduce(lambda x
, y
: dict(x
, **y
),
298 map(lambda d
: {d
["vnf_name"]: d
["vnf_id"]},
299 self
.nsd
["network_functions"])))
301 # check if we need to deploy the management ports (defined as type:management both on in the vnfd and nsd)
302 intfs
= vnfd
.get("connection_points", [])
304 vnf_id
= vnf_name2id
[vnf_name
]
305 mgmt_intfs
= [vnf_id
+ ':' + intf
['id'] for intf
in intfs
if intf
.get('type') == 'management']
306 # check if any of these management interfaces are used in a management-type network in the nsd
307 for nsd_intf_name
in mgmt_intfs
:
308 vlinks
= [ l
["connection_points_reference"] for l
in self
.nsd
.get("virtual_links", [])]
310 if nsd_intf_name
in link
and self
.check_mgmt_interface(link
):
311 # this is indeed a management interface and can be skipped
312 vnf_id
, vnf_interface
, vnf_sap_docker_name
= parse_interface(nsd_intf_name
)
313 found_interfaces
= [intf
for intf
in intfs
if intf
.get('id') == vnf_interface
]
314 intfs
.remove(found_interfaces
[0])
316 # 4. do the dc.startCompute(name="foobar") call to run the container
317 # TODO consider flavors, and other annotations
318 # TODO: get all vnf id's from the nsd for this vnfd and use those as dockername
319 # use the vnf_id in the nsd as docker name
320 # so deployed containers can be easily mapped back to the nsd
322 self
.vnf_name2docker_name
[vnf_name
] = vnf_name2id
[vnf_name
]
324 LOG
.info("Starting %r as %r in DC %r" % (vnf_name
, self
.vnf_name2docker_name
[vnf_name
], vnfd
.get("dc")))
325 LOG
.debug("Interfaces for %r: %r" % (vnf_name
, intfs
))
326 vnfi
= target_dc
.startCompute(self
.vnf_name2docker_name
[vnf_name
], network
=intfs
, image
=docker_name
, flavor_name
="small",
327 cpu_quota
=cpu_quota
, cpu_period
=cpu_period
, cpuset
=cpu_list
, mem_limit
=mem_lim
)
329 # rename the docker0 interfaces (eth0) to 'docker_mgmt' in the VNFs
331 self
._vnf
_reconfigure
_network
(vnfi
, 'eth0', new_name
='docker_mgmt')
335 def _stop_vnfi(self
, vnfi
):
339 :param vnfi: vnf instance to be stopped
341 # Find the correct datacenter
342 status
= vnfi
.getStatus()
345 LOG
.info("Stopping the vnf instance contained in %r in DC %r" % (status
["name"], dc
))
346 dc
.stopCompute(status
["name"])
348 def _get_vnf_instance(self
, instance_uuid
, name
):
350 Returns the Docker object for the given VNF name (or Docker name).
351 :param instance_uuid: UUID of the service instance to search in.
352 :param name: VNF name or Docker name. We are fuzzy here.
356 if name
in self
.vnf_name2docker_name
:
357 dn
= self
.vnf_name2docker_name
[name
]
358 for vnfi
in self
.instances
[instance_uuid
]["vnf_instances"]:
361 LOG
.warning("No container with name: {0} found.".format(dn
))
365 def _vnf_reconfigure_network(vnfi
, if_name
, net_str
=None, new_name
=None):
367 Reconfigure the network configuration of a specific interface
368 of a running container.
369 :param vnfi: container instance
370 :param if_name: interface name
371 :param net_str: network configuration string, e.g., 1.2.3.4/24
375 # assign new ip address
376 if net_str
is not None:
377 intf
= vnfi
.intf(intf
=if_name
)
380 LOG
.debug("Reconfigured network of %s:%s to %r" % (vnfi
.name
, if_name
, net_str
))
382 LOG
.warning("Interface not found: %s:%s. Network reconfiguration skipped." % (vnfi
.name
, if_name
))
384 if new_name
is not None:
385 vnfi
.cmd('ip link set', if_name
, 'down')
386 vnfi
.cmd('ip link set', if_name
, 'name', new_name
)
387 vnfi
.cmd('ip link set', new_name
, 'up')
388 LOG
.debug("Reconfigured interface name of %s:%s to %s" % (vnfi
.name
, if_name
, new_name
))
392 def _trigger_emulator_start_scripts_in_vnfis(self
, vnfi_list
):
393 for vnfi
in vnfi_list
:
394 config
= vnfi
.dcinfo
.get("Config", dict())
395 env
= config
.get("Env", list())
397 var
, cmd
= map(str.strip
, map(str, env_var
.split('=', 1)))
398 LOG
.debug("%r = %r" % (var
, cmd
))
399 if var
=="SON_EMU_CMD":
400 LOG
.info("Executing entry point script in %r: %r" % (vnfi
.name
, cmd
))
401 # execute command in new thread to ensure that GK is not blocked by VNF
402 t
= threading
.Thread(target
=vnfi
.cmdPrint
, args
=(cmd
,))
406 def _unpack_service_package(self
):
408 unzip *.son file and store contents in CATALOG_FOLDER/services/<service_uuid>/
410 LOG
.info("Unzipping: %r" % self
.package_file_path
)
411 with zipfile
.ZipFile(self
.package_file_path
, "r") as z
:
412 z
.extractall(self
.package_content_path
)
415 def _load_package_descriptor(self
):
417 Load the main package descriptor YAML and keep it as dict.
420 self
.manifest
= load_yaml(
422 self
.package_content_path
, "META-INF/MANIFEST.MF"))
426 Load the entry NSD YAML and keep it as dict.
429 if "entry_service_template" in self
.manifest
:
430 nsd_path
= os
.path
.join(
431 self
.package_content_path
,
432 make_relative_path(self
.manifest
.get("entry_service_template")))
433 self
.nsd
= load_yaml(nsd_path
)
434 GK
.net
.deployed_nsds
.append(self
.nsd
)
436 LOG
.debug("Loaded NSD: %r" % self
.nsd
.get("name"))
438 def _load_vnfd(self
):
440 Load all VNFD YAML files referenced in MANIFEST.MF and keep them in dict.
443 if "package_content" in self
.manifest
:
444 for pc
in self
.manifest
.get("package_content"):
445 if pc
.get("content-type") == "application/sonata.function_descriptor":
446 vnfd_path
= os
.path
.join(
447 self
.package_content_path
,
448 make_relative_path(pc
.get("name")))
449 vnfd
= load_yaml(vnfd_path
)
450 self
.vnfds
[vnfd
.get("name")] = vnfd
451 LOG
.debug("Loaded VNFD: %r" % vnfd
.get("name"))
453 def _load_saps(self
):
454 # create list of all SAPs
455 # check if we need to deploy management ports
457 SAPs
= [p
for p
in self
.nsd
["connection_points"] if 'management' not in p
.get('type')]
459 SAPs
= [p
for p
in self
.nsd
["connection_points"]]
462 # endpoint needed in this service
463 sap_id
, sap_interface
, sap_docker_name
= parse_interface(sap
['id'])
464 # make sure SAP has type set (default internal)
465 sap
["type"] = sap
.get("type", 'internal')
467 # Each Service Access Point (connection_point) in the nsd is an IP address on the host
468 if sap
["type"] == "external":
469 # add to vnfds to calculate placement later on
470 sap_net
= SAP_SUBNETS
.pop(0)
471 self
.saps
[sap_docker_name
] = {"name": sap_docker_name
, "type": "external", "net": sap_net
}
472 # add SAP vnf to list in the NSD so it is deployed later on
473 # each SAP get a unique VNFD and vnf_id in the NSD and custom type (only defined in the dummygatekeeper)
474 self
.nsd
["network_functions"].append(
475 {"vnf_id": sap_docker_name
, "vnf_name": sap_docker_name
, "vnf_type": "sap_ext"})
477 # Each Service Access Point (connection_point) in the nsd is getting its own container (default)
478 elif sap
["type"] == "internal" or sap
["type"] == "management":
479 # add SAP to self.vnfds
480 sapfile
= pkg_resources
.resource_filename(__name__
, "sap_vnfd.yml")
481 sap_vnfd
= load_yaml(sapfile
)
482 sap_vnfd
["connection_points"][0]["id"] = sap_interface
483 sap_vnfd
["name"] = sap_docker_name
484 sap_vnfd
["type"] = "internal"
485 # add to vnfds to calculate placement later on and deploy
486 self
.saps
[sap_docker_name
] = sap_vnfd
487 # add SAP vnf to list in the NSD so it is deployed later on
488 # each SAP get a unique VNFD and vnf_id in the NSD
489 self
.nsd
["network_functions"].append(
490 {"vnf_id": sap_docker_name
, "vnf_name": sap_docker_name
, "vnf_type": "sap_int"})
492 LOG
.debug("Loaded SAP: name: {0}, type: {1}".format(sap_docker_name
, sap
['type']))
495 self
.saps_ext
= [self
.saps
[sap
]['name'] for sap
in self
.saps
if self
.saps
[sap
]["type"] == "external"]
496 self
.saps_int
= [self
.saps
[sap
]['name'] for sap
in self
.saps
if self
.saps
[sap
]["type"] == "internal"]
498 def _start_sap(self
, sap
, instance_uuid
):
502 LOG
.info('start SAP: {0} ,type: {1}'.format(sap
['name'],sap
['type']))
503 if sap
["type"] == "internal":
505 if not GK_STANDALONE_MODE
:
506 vnfi
= self
._start
_vnfd
(sap
)
507 self
.instances
[instance_uuid
]["vnf_instances"].append(vnfi
)
509 elif sap
["type"] == "external":
510 target_dc
= sap
.get("dc")
511 # add interface to dc switch
512 target_dc
.attachExternalSAP(sap
['name'], str(sap
['net']))
514 def _connect_elines(self
, eline_fwd_links
, instance_uuid
):
516 Connect all E-LINE links in the NSD
517 :param eline_fwd_links: list of E-LINE links in the NSD
518 :param: instance_uuid of the service
521 # cookie is used as identifier for the flowrules installed by the dummygatekeeper
522 # eg. different services get a unique cookie for their flowrules
524 for link
in eline_fwd_links
:
525 # check if we need to deploy this link when its a management link:
527 if self
.check_mgmt_interface(link
["connection_points_reference"]):
530 src_id
, src_if_name
, src_sap_id
= parse_interface(link
["connection_points_reference"][0])
531 dst_id
, dst_if_name
, dst_sap_id
= parse_interface(link
["connection_points_reference"][1])
534 # check if there is a SAP in the link and chain everything together
535 if src_sap_id
in self
.saps
and dst_sap_id
in self
.saps
:
536 LOG
.info('2 SAPs cannot be chained together : {0} - {1}'.format(src_sap_id
, dst_sap_id
))
539 elif src_sap_id
in self
.saps_ext
:
541 src_if_name
= src_sap_id
542 src_name
= self
.vnf_id2vnf_name
[src_id
]
543 dst_name
= self
.vnf_id2vnf_name
[dst_id
]
544 dst_vnfi
= self
._get
_vnf
_instance
(instance_uuid
, dst_name
)
545 if dst_vnfi
is not None:
546 # choose first ip address in sap subnet
547 sap_net
= self
.saps
[src_sap_id
]['net']
548 sap_ip
= "{0}/{1}".format(str(sap_net
[1]), sap_net
.prefixlen
)
549 self
._vnf
_reconfigure
_network
(dst_vnfi
, dst_if_name
, sap_ip
)
552 elif dst_sap_id
in self
.saps_ext
:
554 dst_if_name
= dst_sap_id
555 src_name
= self
.vnf_id2vnf_name
[src_id
]
556 dst_name
= self
.vnf_id2vnf_name
[dst_id
]
557 src_vnfi
= self
._get
_vnf
_instance
(instance_uuid
, src_name
)
558 if src_vnfi
is not None:
559 sap_net
= self
.saps
[dst_sap_id
]['net']
560 sap_ip
= "{0}/{1}".format(str(sap_net
[1]), sap_net
.prefixlen
)
561 self
._vnf
_reconfigure
_network
(src_vnfi
, src_if_name
, sap_ip
)
564 # Link between 2 VNFs
566 # make sure we use the correct sap vnf name
567 if src_sap_id
in self
.saps_int
:
569 if dst_sap_id
in self
.saps_int
:
571 src_name
= self
.vnf_id2vnf_name
[src_id
]
572 dst_name
= self
.vnf_id2vnf_name
[dst_id
]
573 # re-configure the VNFs IP assignment and ensure that a new subnet is used for each E-Link
574 src_vnfi
= self
._get
_vnf
_instance
(instance_uuid
, src_name
)
575 dst_vnfi
= self
._get
_vnf
_instance
(instance_uuid
, dst_name
)
576 if src_vnfi
is not None and dst_vnfi
is not None:
577 eline_net
= ELINE_SUBNETS
.pop(0)
578 ip1
= "{0}/{1}".format(str(eline_net
[1]), eline_net
.prefixlen
)
579 ip2
= "{0}/{1}".format(str(eline_net
[2]), eline_net
.prefixlen
)
580 self
._vnf
_reconfigure
_network
(src_vnfi
, src_if_name
, ip1
)
581 self
._vnf
_reconfigure
_network
(dst_vnfi
, dst_if_name
, ip2
)
586 ret
= GK
.net
.setChain(
588 vnf_src_interface
=src_if_name
, vnf_dst_interface
=dst_if_name
,
589 bidirectional
=BIDIRECTIONAL_CHAIN
, cmd
="add-flow", cookie
=cookie
, priority
=10)
591 "Setting up E-Line link. %s(%s:%s) -> %s(%s:%s)" % (
592 src_name
, src_id
, src_if_name
, dst_name
, dst_id
, dst_if_name
))
595 def _connect_elans(self
, elan_fwd_links
, instance_uuid
):
597 Connect all E-LAN links in the NSD
598 :param elan_fwd_links: list of E-LAN links in the NSD
599 :param: instance_uuid of the service
602 for link
in elan_fwd_links
:
603 # check if we need to deploy this link when its a management link:
605 if self
.check_mgmt_interface(link
["connection_points_reference"]):
609 # check if an external SAP is in the E-LAN (then a subnet is already defined)
610 intfs_elan
= [intf
for intf
in link
["connection_points_reference"]]
611 lan_sap
= self
.check_ext_saps(intfs_elan
)
613 lan_net
= self
.saps
[lan_sap
]['net']
614 lan_hosts
= list(lan_net
.hosts())
615 sap_ip
= str(lan_hosts
.pop(0))
617 lan_net
= ELAN_SUBNETS
.pop(0)
618 lan_hosts
= list(lan_net
.hosts())
620 # generate lan ip address for all interfaces except external SAPs
621 for intf
in link
["connection_points_reference"]:
623 # skip external SAPs, they already have an ip
624 vnf_id
, vnf_interface
, vnf_sap_docker_name
= parse_interface(intf
)
625 if vnf_sap_docker_name
in self
.saps_ext
:
626 elan_vnf_list
.append({'name': vnf_sap_docker_name
, 'interface': vnf_interface
})
629 ip_address
= "{0}/{1}".format(str(lan_hosts
.pop(0)), lan_net
.prefixlen
)
630 vnf_id
, intf_name
, vnf_sap_id
= parse_interface(intf
)
632 # make sure we use the correct sap vnf name
633 src_docker_name
= vnf_id
634 if vnf_sap_id
in self
.saps_int
:
635 src_docker_name
= vnf_sap_id
638 vnf_name
= self
.vnf_id2vnf_name
[vnf_id
]
640 "Setting up E-LAN interface. %s(%s:%s) -> %s" % (
641 vnf_name
, vnf_id
, intf_name
, ip_address
))
643 if vnf_name
in self
.vnfds
:
644 # re-configure the VNFs IP assignment and ensure that a new subnet is used for each E-LAN
645 # E-LAN relies on the learning switch capability of Ryu which has to be turned on in the topology
646 # (DCNetwork(controller=RemoteController, enable_learning=True)), so no explicit chaining is necessary.
647 vnfi
= self
._get
_vnf
_instance
(instance_uuid
, vnf_name
)
649 self
._vnf
_reconfigure
_network
(vnfi
, intf_name
, ip_address
)
650 # add this vnf and interface to the E-LAN for tagging
651 elan_vnf_list
.append({'name': src_docker_name
, 'interface': intf_name
})
653 # install the VLAN tags for this E-LAN
654 GK
.net
.setLAN(elan_vnf_list
)
657 def _load_docker_files(self
):
659 Get all paths to Dockerfiles from VNFDs and store them in dict.
662 for k
, v
in self
.vnfds
.iteritems():
663 for vu
in v
.get("virtual_deployment_units"):
664 if vu
.get("vm_image_format") == "docker":
665 vm_image
= vu
.get("vm_image")
666 docker_path
= os
.path
.join(
667 self
.package_content_path
,
668 make_relative_path(vm_image
))
669 self
.local_docker_files
[k
] = docker_path
670 LOG
.debug("Found Dockerfile (%r): %r" % (k
, docker_path
))
672 def _load_docker_urls(self
):
674 Get all URLs to pre-build docker images in some repo.
677 # also merge sap dicts, because internal saps also need a docker container
678 all_vnfs
= self
.vnfds
.copy()
679 all_vnfs
.update(self
.saps
)
681 for k
, v
in all_vnfs
.iteritems():
682 for vu
in v
.get("virtual_deployment_units", {}):
683 if vu
.get("vm_image_format") == "docker":
684 url
= vu
.get("vm_image")
686 url
= url
.replace("http://", "")
687 self
.remote_docker_image_urls
[k
] = url
688 LOG
.debug("Found Docker image URL (%r): %r" % (k
, self
.remote_docker_image_urls
[k
]))
690 def _build_images_from_dockerfiles(self
):
692 Build Docker images for each local Dockerfile found in the package: self.local_docker_files
694 if GK_STANDALONE_MODE
:
695 return # do not build anything in standalone mode
697 LOG
.info("Building %d Docker images (this may take several minutes) ..." % len(self
.local_docker_files
))
698 for k
, v
in self
.local_docker_files
.iteritems():
699 for line
in dc
.build(path
=v
.replace("Dockerfile", ""), tag
=k
, rm
=False, nocache
=False):
700 LOG
.debug("DOCKER BUILD: %s" % line
)
701 LOG
.info("Docker image created: %s" % k
)
703 def _pull_predefined_dockerimages(self
):
705 If the package contains URLs to pre-build Docker images, we download them with this method.
708 for url
in self
.remote_docker_image_urls
.itervalues():
709 if not FORCE_PULL
: # only pull if not present (speedup for development)
710 if len(dc
.images
.list(name
=url
)) > 0:
711 LOG
.debug("Image %r present. Skipping pull." % url
)
713 LOG
.info("Pulling image: %r" % url
)
714 # this seems to fail with latest docker api version 2.0.2
715 # dc.images.pull(url,
716 # insecure_registry=True)
717 #using docker cli instead
727 def _check_docker_image_exists(self
, image_name
):
729 Query the docker service and check if the given image exists
730 :param image_name: name of the docker image
733 return len(DockerClient().images
.list(name
=image_name
)) > 0
735 def _calculate_placement(self
, algorithm
):
737 Do placement by adding the a field "dc" to
738 each VNFD that points to one of our
739 data center objects known to the gatekeeper.
741 assert(len(self
.vnfds
) > 0)
742 assert(len(GK
.dcs
) > 0)
743 # instantiate algorithm an place
745 p
.place(self
.nsd
, self
.vnfds
, self
.saps
, GK
.dcs
)
746 LOG
.info("Using placement algorithm: %r" % p
.__class
__.__name
__)
747 # lets print the placement result
748 for name
, vnfd
in self
.vnfds
.iteritems():
749 LOG
.info("Placed VNF %r on DC %r" % (name
, str(vnfd
.get("dc"))))
750 for sap
in self
.saps
:
751 sap_dict
= self
.saps
[sap
]
752 LOG
.info("Placed SAP %r on DC %r" % (sap
, str(sap_dict
.get("dc"))))
755 def _calculate_cpu_cfs_values(self
, cpu_time_percentage
):
757 Calculate cpu period and quota for CFS
758 :param cpu_time_percentage: percentage of overall CPU to be used
759 :return: cpu_period, cpu_quota
761 if cpu_time_percentage
is None:
763 if cpu_time_percentage
< 0:
765 # (see: https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt)
766 # Attention minimum cpu_quota is 1ms (micro)
767 cpu_period
= 1000000 # lets consider a fixed period of 1000000 microseconds for now
768 LOG
.debug("cpu_period is %r, cpu_percentage is %r" % (cpu_period
, cpu_time_percentage
))
769 cpu_quota
= cpu_period
* cpu_time_percentage
# calculate the fraction of cpu time for this container
770 # ATTENTION >= 1000 to avoid a invalid argument system error ... no idea why
772 LOG
.debug("cpu_quota before correcting: %r" % cpu_quota
)
774 LOG
.warning("Increased CPU quota to avoid system error.")
775 LOG
.debug("Calculated: cpu_period=%f / cpu_quota=%f" % (cpu_period
, cpu_quota
))
776 return int(cpu_period
), int(cpu_quota
)
778 def check_ext_saps(self
, intf_list
):
779 # check if the list of interfacs contains an externl SAP
780 saps_ext
= [self
.saps
[sap
]['name'] for sap
in self
.saps
if self
.saps
[sap
]["type"] == "external"]
781 for intf_name
in intf_list
:
782 vnf_id
, vnf_interface
, vnf_sap_docker_name
= parse_interface(intf_name
)
783 if vnf_sap_docker_name
in saps_ext
:
784 return vnf_sap_docker_name
786 def check_mgmt_interface(self
, intf_list
):
787 SAPs_mgmt
= [p
.get('id') for p
in self
.nsd
["connection_points"] if 'management' in p
.get('type')]
788 for intf_name
in intf_list
:
789 if intf_name
in SAPs_mgmt
:
793 Some (simple) placement algorithms
797 class FirstDcPlacement(object):
799 Placement: Always use one and the same data center from the GK.dcs dict.
801 def place(self
, nsd
, vnfds
, saps
, dcs
):
802 for name
, vnfd
in vnfds
.iteritems():
803 vnfd
["dc"] = list(dcs
.itervalues())[0]
806 class RoundRobinDcPlacement(object):
808 Placement: Distribute VNFs across all available DCs in a round robin fashion.
810 def place(self
, nsd
, vnfds
, saps
, dcs
):
812 dcs_list
= list(dcs
.itervalues())
813 for name
, vnfd
in vnfds
.iteritems():
814 vnfd
["dc"] = dcs_list
[c
% len(dcs_list
)]
815 c
+= 1 # inc. c to use next DC
817 class RoundRobinDcPlacementWithSAPs(object):
819 Placement: Distribute VNFs across all available DCs in a round robin fashion,
820 every SAP is instantiated on the same DC as the connected VNF.
822 def place(self
, nsd
, vnfds
, saps
, dcs
):
826 dcs_list
= list(dcs
.itervalues())
827 for name
, vnfd
in vnfds
.iteritems():
828 vnfd
["dc"] = dcs_list
[c
% len(dcs_list
)]
829 c
+= 1 # inc. c to use next DC
832 vlinks
= nsd
.get("virtual_links", [])
833 eline_fwd_links
= [l
for l
in vlinks
if (l
["connectivity_type"] == "E-Line")]
834 elan_fwd_links
= [l
for l
in vlinks
if (l
["connectivity_type"] == "E-LAN")]
836 vnf_id2vnf_name
= defaultdict(lambda: "NotExistingNode",
837 reduce(lambda x
, y
: dict(x
, **y
),
838 map(lambda d
: {d
["vnf_id"]: d
["vnf_name"]},
839 nsd
["network_functions"])))
841 # SAPs on E-Line links are placed on the same DC as the VNF on the E-Line
842 for link
in eline_fwd_links
:
843 src_id
, src_if_name
, src_sap_id
= parse_interface(link
["connection_points_reference"][0])
844 dst_id
, dst_if_name
, dst_sap_id
= parse_interface(link
["connection_points_reference"][1])
846 # check if there is a SAP in the link
847 if src_sap_id
in saps
:
848 dst_vnf_name
= vnf_id2vnf_name
[dst_id
]
849 # get dc where connected vnf is mapped to
850 dc
= vnfds
[dst_vnf_name
]['dc']
851 saps
[src_sap_id
]['dc'] = dc
853 if dst_sap_id
in saps
:
854 src_vnf_name
= vnf_id2vnf_name
[src_id
]
855 # get dc where connected vnf is mapped to
856 dc
= vnfds
[src_vnf_name
]['dc']
857 saps
[dst_sap_id
]['dc'] = dc
859 # SAPs on E-LANs are placed on a random DC
860 dcs_list
= list(dcs
.itervalues())
861 dc_len
= len(dcs_list
)
862 for link
in elan_fwd_links
:
863 for intf
in link
["connection_points_reference"]:
864 # find SAP interfaces
865 intf_id
, intf_name
, intf_sap_id
= parse_interface(intf
)
866 if intf_sap_id
in saps
:
867 dc
= dcs_list
[randint(0, dc_len
-1)]
868 saps
[intf_sap_id
]['dc'] = dc
873 Resource definitions and API endpoints
877 class Packages(fr
.Resource
):
881 Upload a *.son service package to the dummy gatekeeper.
883 We expect request with a *.son file and store it in UPLOAD_FOLDER
888 LOG
.info("POST /packages called")
889 # lets search for the package in the request
890 is_file_object
= False # make API more robust: file can be in data or in files field
891 if "package" in request
.files
:
892 son_file
= request
.files
["package"]
893 is_file_object
= True
894 elif len(request
.data
) > 0:
895 son_file
= request
.data
897 return {"service_uuid": None, "size": 0, "sha1": None, "error": "upload failed. file not found."}, 500
898 # generate a uuid to reference this package
899 service_uuid
= str(uuid
.uuid4())
900 file_hash
= hashlib
.sha1(str(son_file
)).hexdigest()
901 # ensure that upload folder exists
902 ensure_dir(UPLOAD_FOLDER
)
903 upload_path
= os
.path
.join(UPLOAD_FOLDER
, "%s.son" % service_uuid
)
904 # store *.son file to disk
906 son_file
.save(upload_path
)
908 with
open(upload_path
, 'wb') as f
:
910 size
= os
.path
.getsize(upload_path
)
911 # create a service object and register it
912 s
= Service(service_uuid
, file_hash
, upload_path
)
913 GK
.register_service_package(service_uuid
, s
)
914 # generate the JSON result
915 return {"service_uuid": service_uuid
, "size": size
, "sha1": file_hash
, "error": None}, 201
916 except Exception as ex
:
917 LOG
.exception("Service package upload failed:")
918 return {"service_uuid": None, "size": 0, "sha1": None, "error": "upload failed"}, 500
922 Return a list of UUID's of uploaded service packages.
925 LOG
.info("GET /packages")
926 return {"service_uuid_list": list(GK
.services
.iterkeys())}
929 class Instantiations(fr
.Resource
):
933 Instantiate a service specified by its UUID.
934 Will return a new UUID to identify the running service instance.
937 LOG
.info("POST /instantiations (or /reqeusts) called")
938 # try to extract the service uuid from the request
939 json_data
= request
.get_json(force
=True)
940 service_uuid
= json_data
.get("service_uuid")
942 # lets be a bit fuzzy here to make testing easier
943 if (service_uuid
is None or service_uuid
=="latest") and len(GK
.services
) > 0:
944 # if we don't get a service uuid, we simple start the first service in the list
945 service_uuid
= list(GK
.services
.iterkeys())[0]
946 if service_uuid
in GK
.services
:
947 # ok, we have a service uuid, lets start the service
948 service_instance_uuid
= GK
.services
.get(service_uuid
).start_service()
949 return {"service_instance_uuid": service_instance_uuid
}, 201
950 return "Service not found", 404
954 Returns a list of UUIDs containing all running services.
957 LOG
.info("GET /instantiations")
958 return {"service_instantiations_list": [
959 list(s
.instances
.iterkeys()) for s
in GK
.services
.itervalues()]}
963 Stops a running service specified by its service and instance UUID.
965 # try to extract the service and instance UUID from the request
966 json_data
= request
.get_json(force
=True)
967 service_uuid
= json_data
.get("service_uuid")
968 instance_uuid
= json_data
.get("service_instance_uuid")
971 if service_uuid
is None and len(GK
.services
) > 0:
972 #if we don't get a service uuid, we simply stop the last service in the list
973 service_uuid
= list(GK
.services
.iterkeys())[0]
974 if instance_uuid
is None and len(GK
.services
[service_uuid
].instances
) > 0:
975 instance_uuid
= list(GK
.services
[service_uuid
].instances
.iterkeys())[0]
977 if service_uuid
in GK
.services
and instance_uuid
in GK
.services
[service_uuid
].instances
:
978 # valid service and instance UUID, stop service
979 GK
.services
.get(service_uuid
).stop_service(instance_uuid
)
980 return "service instance with uuid %r stopped." % instance_uuid
,200
981 return "Service not found", 404
983 class Exit(fr
.Resource
):
987 Stop the running Containernet instance regardless of data transmitted
989 list(GK
.dcs
.values())[0].net
.stop()
998 # create a single, global GK object
1002 app
= Flask(__name__
)
1003 app
.config
['MAX_CONTENT_LENGTH'] = 512 * 1024 * 1024 # 512 MB max upload
1006 api
.add_resource(Packages
, '/packages', '/api/v2/packages')
1007 api
.add_resource(Instantiations
, '/instantiations', '/api/v2/instantiations', '/api/v2/requests')
1008 api
.add_resource(Exit
, '/emulator/exit')
1011 #def initialize_GK():
1016 def start_rest_api(host
, port
, datacenters
=dict()):
1017 GK
.dcs
= datacenters
1018 GK
.net
= get_dc_network()
1019 # start the Flask server (not the best performance but ok for our use case)
1023 use_reloader
=False # this is needed to run Flask in a non-main thread
1027 def ensure_dir(name
):
1028 if not os
.path
.exists(name
):
1032 def load_yaml(path
):
1033 with
open(path
, "r") as f
:
1036 except yaml
.YAMLError
as exc
:
1037 LOG
.exception("YAML parse error")
1042 def make_relative_path(path
):
1043 if path
.startswith("file://"):
1044 path
= path
.replace("file://", "", 1)
1045 if path
.startswith("/"):
1046 path
= path
.replace("/", "", 1)
1050 def get_dc_network():
1052 retrieve the DCnetwork where this dummygatekeeper (GK) connects to.
1053 Assume at least 1 datacenter is connected to this GK, and that all datacenters belong to the same DCNetwork
1056 assert (len(GK
.dcs
) > 0)
1057 return GK
.dcs
.values()[0].net
1060 def parse_interface(interface_name
):
1062 convert the interface name in the nsd to the according vnf_id, vnf_interface names
1063 :param interface_name:
1067 if ':' in interface_name
:
1068 vnf_id
, vnf_interface
= interface_name
.split(':')
1069 vnf_sap_docker_name
= interface_name
.replace(':', '_')
1071 vnf_id
= interface_name
1072 vnf_interface
= interface_name
1073 vnf_sap_docker_name
= interface_name
1075 return vnf_id
, vnf_interface
, vnf_sap_docker_name
1077 if __name__
== '__main__':
1079 Lets allow to run the API in standalone mode.
1081 GK_STANDALONE_MODE
= True
1082 logging
.getLogger("werkzeug").setLevel(logging
.INFO
)
1083 start_rest_api("0.0.0.0", 8000)