src/emuvim/api/sonata/dummygatekeeper.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 """
  29 This module implements a simple REST API that behaves like SONATA's gatekeeper.
  30
  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.
  33 """
  34
  35 import logging
  36 import os
  37 import uuid
  38 import hashlib
  39 import zipfile
  40 import yaml
  41 import threading
  42 from docker import DockerClient, APIClient
  43 from flask import Flask, request
  44 import flask_restful as fr
  45 from collections import defaultdict
  46 import pkg_resources
  47 from subprocess import Popen
  48 from random import randint
  49 import ipaddress
  50
  51 logging.basicConfig()
  52 LOG = logging.getLogger("sonata-dummy-gatekeeper")
  53 LOG.setLevel(logging.DEBUG)
  54 logging.getLogger("werkzeug").setLevel(logging.WARNING)
  55
  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/")
  59
  60 # Enable Dockerfile build functionality
  61 BUILD_DOCKERFILE = False
  62
  63 # flag to indicate that we run without the emulator (only the bare API for integration testing)
  64 GK_STANDALONE_MODE = False
  65
  66 # should a new version of an image be pulled even if its available
  67 FORCE_PULL = False
  68
  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.
  71 DEPLOY_SAP = False
  72
  73 # flag to indicate if we use bidirectional forwarding rules in the automatic chaining process
  74 BIDIRECTIONAL_CHAIN = False
  75
  76 # override the management interfaces in the descriptors with default docker0 interfaces in the containers
  77 USE_DOCKER_MGMT = True
  78
  79 def generate_subnets(prefix, base, subnet_size=50, mask=24):
  80     # Generate a list of ipaddress in subnets
  81     r = list()
  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)))
  85     return r
  86 # private subnet definitions for the generated interfaces
  87 # 10.10.xxx.0/24
  88 SAP_SUBNETS = generate_subnets('10.10', 0, subnet_size=50, mask=24)
  89 # 10.20.xxx.0/24
  90 ELAN_SUBNETS = generate_subnets('10.20', 0, subnet_size=50, mask=24)
  91 # 10.30.xxx.0/30
  92 ELINE_SUBNETS = generate_subnets('10.30', 0, subnet_size=50, mask=30)
  93
  94
  95 class Gatekeeper(object):
  96
  97     def __init__(self):
  98         self.services = dict()
  99         self.dcs = dict()
 100         self.net = None
 101         self.vnf_counter = 0  # used to generate short names for VNFs (Mininet limitation)
 102         LOG.info("Create SONATA dummy gatekeeper.")
 103
 104     def register_service_package(self, service_uuid, service):
 105         """
 106         register new service package
 107         :param service_uuid
 108         :param service object
 109         """
 110         self.services[service_uuid] = service
 111         # lets perform all steps needed to onboard the service
 112         service.onboard()
 113
 114     def get_next_vnf_name(self):
 115         self.vnf_counter += 1
 116         return "vnf%d" % self.vnf_counter
 117
 118
 119 class Service(object):
 120     """
 121     This class represents a NS uploaded as a *.son package to the
 122     dummy gatekeeper.
 123     Can have multiple running instances of this service.
 124     """
 125
 126     def __init__(self,
 127                  service_uuid,
 128                  package_file_hash,
 129                  package_file_path):
 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)
 134         self.manifest = None
 135         self.nsd = None
 136         self.vnfds = dict()
 137         self.saps = dict()
 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()
 145
 146     def onboard(self):
 147         """
 148         Do all steps to prepare this service to be instantiated
 149         :return:
 150         """
 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()
 155         self._load_nsd()
 156         self._load_vnfd()
 157         if DEPLOY_SAP:
 158             self._load_saps()
 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)
 165         if BUILD_DOCKERFILE:
 166             self._load_docker_files()
 167             self._build_images_from_dockerfiles()
 168         else:
 169             self._load_docker_urls()
 170             self._pull_predefined_dockerimages()
 171         LOG.info("On-boarded service: %r" % self.manifest.get("name"))
 172
 173     def start_service(self):
 174         """
 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.
 179         :return:
 180         """
 181         LOG.info("Starting service %r" % self.uuid)
 182
 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()
 188
 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)
 193
 194         # 3. start all vnfds that we have in the service (except SAPs)
 195         for vnfd in self.vnfds.itervalues():
 196             vnfi = None
 197             if not GK_STANDALONE_MODE:
 198                 vnfi = self._start_vnfd(vnfd)
 199             self.instances[instance_uuid]["vnf_instances"].append(vnfi)
 200
 201         # 4. start all SAPs in the service
 202         for sap in self.saps:
 203             self._start_sap(self.saps[sap], instance_uuid)
 204
 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")]
 212
 213             GK.net.deployed_elines.extend(eline_fwd_links)
 214             GK.net.deployed_elans.extend(elan_fwd_links)
 215
 216             # 5a. deploy E-Line links
 217             self._connect_elines(eline_fwd_links, instance_uuid)
 218
 219             # 5b. deploy E-LAN links
 220             self._connect_elans(elan_fwd_links, instance_uuid)
 221
 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"])
 224
 225         LOG.info("Service started. Instance id: %r" % instance_uuid)
 226         return instance_uuid
 227
 228     def stop_service(self, instance_uuid):
 229         """
 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.
 233
 234         :param instance_uuid: the uuid of the service instance to be stopped
 235         """
 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"]
 240
 241         for v in vnf_instances:
 242             self._stop_vnfi(v)
 243
 244         if not GK_STANDALONE_MODE:
 245             # remove placement?
 246             # self._remove_placement(RoundRobinPlacement)
 247             None
 248
 249         # last step: remove the instance from the list of all instances
 250         del self.instances[instance_uuid]
 251
 252     def _start_vnfd(self, vnfd):
 253         """
 254         Start a single VNFD of this service
 255         :param vnfd: vnfd descriptor dict
 256         :return:
 257         """
 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)
 271
 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:
 276                 cpu_list="1"
 277             cpu_bw = res_req.get("cpu").get("cpu_bw")
 278             if not cpu_bw:
 279                 cpu_bw=1
 280             mem_num = str(res_req.get("memory").get("size"))
 281             if len(mem_num)==0:
 282                 mem_num="2"
 283             mem_unit = str(res_req.get("memory").get("size_unit"))
 284             if str(mem_unit)==0:
 285                 mem_unit="GB"
 286             mem_limit = float(mem_num)
 287             if mem_unit=="GB":
 288                 mem_limit=mem_limit*1024*1024*1024
 289             elif mem_unit=="MB":
 290                 mem_limit=mem_limit*1024*1024
 291             elif mem_unit=="KB":
 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))
 295
 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"])))
 300
 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", [])
 303             mgmt_intf_names = []
 304             if USE_DOCKER_MGMT:
 305                 vnf_id = vnf_name2id[vnf_name]
 306                 mgmt_intfs = [vnf_id + ':' + intf['id'] for intf in intfs if intf.get('type') == 'management']
 307                 # check if any of these management interfaces are used in a management-type network in the nsd
 308                 for nsd_intf_name in mgmt_intfs:
 309                     vlinks = [ l["connection_points_reference"] for l in self.nsd.get("virtual_links", [])]
 310                     for link in vlinks:
 311                         if nsd_intf_name in link and self.check_mgmt_interface(link):
 312                             # this is indeed a management interface and can be skipped
 313                             vnf_id, vnf_interface, vnf_sap_docker_name = parse_interface(nsd_intf_name)
 314                             found_interfaces = [intf for intf in intfs if intf.get('id') == vnf_interface]
 315                             intfs.remove(found_interfaces[0])
 316                             mgmt_intf_names.append(vnf_interface)
 317
 318             # 4. do the dc.startCompute(name="foobar") call to run the container
 319             # TODO consider flavors, and other annotations
 320             # TODO: get all vnf id's from the nsd for this vnfd and use those as dockername
 321             # use the vnf_id in the nsd as docker name
 322             # so deployed containers can be easily mapped back to the nsd
 323
 324             self.vnf_name2docker_name[vnf_name] = vnf_name2id[vnf_name]
 325
 326             LOG.info("Starting %r as %r in DC %r" % (vnf_name, self.vnf_name2docker_name[vnf_name], vnfd.get("dc")))
 327             LOG.debug("Interfaces for %r: %r" % (vnf_name, intfs))
 328             vnfi = target_dc.startCompute(self.vnf_name2docker_name[vnf_name], network=intfs, image=docker_name, flavor_name="small",
 329                     cpu_quota=cpu_quota, cpu_period=cpu_period, cpuset=cpu_list, mem_limit=mem_lim)
 330
 331             # rename the docker0 interfaces (eth0) to the management port name defined in the VNFD
 332             if USE_DOCKER_MGMT:
 333                 for intf_name in mgmt_intf_names:
 334                     self._vnf_reconfigure_network(vnfi, 'eth0', new_name=intf_name)
 335
 336             return vnfi
 337
 338     def _stop_vnfi(self, vnfi):
 339         """
 340         Stop a VNF instance.
 341
 342         :param vnfi: vnf instance to be stopped
 343         """
 344         # Find the correct datacenter
 345         status = vnfi.getStatus()
 346         dc = vnfi.datacenter
 347         # stop the vnfi
 348         LOG.info("Stopping the vnf instance contained in %r in DC %r" % (status["name"], dc))
 349         dc.stopCompute(status["name"])
 350
 351     def _get_vnf_instance(self, instance_uuid, name):
 352         """
 353         Returns the Docker object for the given VNF name (or Docker name).
 354         :param instance_uuid: UUID of the service instance to search in.
 355         :param name: VNF name or Docker name. We are fuzzy here.
 356         :return:
 357         """
 358         dn = name
 359         if name in self.vnf_name2docker_name:
 360             dn = self.vnf_name2docker_name[name]
 361         for vnfi in self.instances[instance_uuid]["vnf_instances"]:
 362             if vnfi.name == dn:
 363                 return vnfi
 364         LOG.warning("No container with name: {0} found.".format(dn))
 365         return None
 366
 367     @staticmethod
 368     def _vnf_reconfigure_network(vnfi, if_name, net_str=None, new_name=None):
 369         """
 370         Reconfigure the network configuration of a specific interface
 371         of a running container.
 372         :param vnfi: container instance
 373         :param if_name: interface name
 374         :param net_str: network configuration string, e.g., 1.2.3.4/24
 375         :return:
 376         """
 377
 378         # assign new ip address
 379         if net_str is not None:
 380             intf = vnfi.intf(intf=if_name)
 381             if intf is not None:
 382                 intf.setIP(net_str)
 383                 LOG.debug("Reconfigured network of %s:%s to %r" % (vnfi.name, if_name, net_str))
 384             else:
 385                 LOG.warning("Interface not found: %s:%s. Network reconfiguration skipped." % (vnfi.name, if_name))
 386
 387         if new_name is not None:
 388             vnfi.cmd('ip link set', if_name, 'down')
 389             vnfi.cmd('ip link set', if_name, 'name', new_name)
 390             vnfi.cmd('ip link set', new_name, 'up')
 391             LOG.debug("Reconfigured interface name of %s:%s to %s" % (vnfi.name, if_name, new_name))
 392
 393
 394
 395     def _trigger_emulator_start_scripts_in_vnfis(self, vnfi_list):
 396         for vnfi in vnfi_list:
 397             config = vnfi.dcinfo.get("Config", dict())
 398             env = config.get("Env", list())
 399             for env_var in env:
 400                 var, cmd = map(str.strip, map(str, env_var.split('=', 1)))
 401                 LOG.debug("%r = %r" % (var , cmd))
 402                 if var=="SON_EMU_CMD":
 403                     LOG.info("Executing entry point script in %r: %r" % (vnfi.name, cmd))
 404                     # execute command in new thread to ensure that GK is not blocked by VNF
 405                     t = threading.Thread(target=vnfi.cmdPrint, args=(cmd,))
 406                     t.daemon = True
 407                     t.start()
 408
 409     def _unpack_service_package(self):
 410         """
 411         unzip *.son file and store contents in CATALOG_FOLDER/services/<service_uuid>/
 412         """
 413         LOG.info("Unzipping: %r" % self.package_file_path)
 414         with zipfile.ZipFile(self.package_file_path, "r") as z:
 415             z.extractall(self.package_content_path)
 416
 417
 418     def _load_package_descriptor(self):
 419         """
 420         Load the main package descriptor YAML and keep it as dict.
 421         :return:
 422         """
 423         self.manifest = load_yaml(
 424             os.path.join(
 425                 self.package_content_path, "META-INF/MANIFEST.MF"))
 426
 427     def _load_nsd(self):
 428         """
 429         Load the entry NSD YAML and keep it as dict.
 430         :return:
 431         """
 432         if "entry_service_template" in self.manifest:
 433             nsd_path = os.path.join(
 434                 self.package_content_path,
 435                 make_relative_path(self.manifest.get("entry_service_template")))
 436             self.nsd = load_yaml(nsd_path)
 437             GK.net.deployed_nsds.append(self.nsd)
 438
 439             LOG.debug("Loaded NSD: %r" % self.nsd.get("name"))
 440
 441     def _load_vnfd(self):
 442         """
 443         Load all VNFD YAML files referenced in MANIFEST.MF and keep them in dict.
 444         :return:
 445         """
 446         if "package_content" in self.manifest:
 447             for pc in self.manifest.get("package_content"):
 448                 if pc.get("content-type") == "application/sonata.function_descriptor":
 449                     vnfd_path = os.path.join(
 450                         self.package_content_path,
 451                         make_relative_path(pc.get("name")))
 452                     vnfd = load_yaml(vnfd_path)
 453                     self.vnfds[vnfd.get("name")] = vnfd
 454                     LOG.debug("Loaded VNFD: %r" % vnfd.get("name"))
 455
 456     def _load_saps(self):
 457         # create list of all SAPs
 458         # check if we need to deploy management ports
 459         if USE_DOCKER_MGMT:
 460             LOG.debug("nsd: {0}".format(self.nsd))
 461             SAPs = [p for p in self.nsd["connection_points"] if 'management' not in p.get('type')]
 462         else:
 463             SAPs = [p for p in self.nsd["connection_points"]]
 464
 465         for sap in SAPs:
 466             # endpoint needed in this service
 467             sap_id, sap_interface, sap_docker_name = parse_interface(sap['id'])
 468             # make sure SAP has type set (default internal)
 469             sap["type"] = sap.get("type", 'internal')
 470
 471             # Each Service Access Point (connection_point) in the nsd is an IP address on the host
 472             if sap["type"] == "external":
 473                 # add to vnfds to calculate placement later on
 474                 sap_net = SAP_SUBNETS.pop(0)
 475                 self.saps[sap_docker_name] = {"name": sap_docker_name , "type": "external", "net": sap_net}
 476                 # add SAP vnf to list in the NSD so it is deployed later on
 477                 # each SAP get a unique VNFD and vnf_id in the NSD and custom type (only defined in the dummygatekeeper)
 478                 self.nsd["network_functions"].append(
 479                     {"vnf_id": sap_docker_name, "vnf_name": sap_docker_name, "vnf_type": "sap_ext"})
 480
 481             # Each Service Access Point (connection_point) in the nsd is getting its own container (default)
 482             elif sap["type"] == "internal" or sap["type"] == "management":
 483                 # add SAP to self.vnfds
 484                 sapfile = pkg_resources.resource_filename(__name__, "sap_vnfd.yml")
 485                 sap_vnfd = load_yaml(sapfile)
 486                 sap_vnfd["connection_points"][0]["id"] = sap_interface
 487                 sap_vnfd["name"] = sap_docker_name
 488                 sap_vnfd["type"] = "internal"
 489                 # add to vnfds to calculate placement later on and deploy
 490                 self.saps[sap_docker_name] = sap_vnfd
 491                 # add SAP vnf to list in the NSD so it is deployed later on
 492                 # each SAP get a unique VNFD and vnf_id in the NSD
 493                 self.nsd["network_functions"].append(
 494                     {"vnf_id": sap_docker_name, "vnf_name": sap_docker_name, "vnf_type": "sap_int"})
 495
 496             LOG.debug("Loaded SAP: name: {0}, type: {1}".format(sap_docker_name, sap['type']))
 497
 498         # create sap lists
 499         self.saps_ext = [self.saps[sap]['name'] for sap in self.saps if self.saps[sap]["type"] == "external"]
 500         self.saps_int = [self.saps[sap]['name'] for sap in self.saps if self.saps[sap]["type"] == "internal"]
 501
 502     def _start_sap(self, sap, instance_uuid):
 503         if not DEPLOY_SAP:
 504             return
 505
 506         LOG.info('start SAP: {0} ,type: {1}'.format(sap['name'],sap['type']))
 507         if sap["type"] == "internal":
 508             vnfi = None
 509             if not GK_STANDALONE_MODE:
 510                 vnfi = self._start_vnfd(sap)
 511             self.instances[instance_uuid]["vnf_instances"].append(vnfi)
 512
 513         elif sap["type"] == "external":
 514             target_dc = sap.get("dc")
 515             # add interface to dc switch
 516             target_dc.attachExternalSAP(sap['name'], str(sap['net']))
 517
 518     def _connect_elines(self, eline_fwd_links, instance_uuid):
 519         """
 520         Connect all E-LINE links in the NSD
 521         :param eline_fwd_links: list of E-LINE links in the NSD
 522         :param: instance_uuid of the service
 523         :return:
 524         """
 525         # cookie is used as identifier for the flowrules installed by the dummygatekeeper
 526         # eg. different services get a unique cookie for their flowrules
 527         cookie = 1
 528         for link in eline_fwd_links:
 529             # check if we need to deploy this link when its a management link:
 530             if USE_DOCKER_MGMT:
 531                 if self.check_mgmt_interface(link["connection_points_reference"]):
 532                     continue
 533
 534             src_id, src_if_name, src_sap_id = parse_interface(link["connection_points_reference"][0])
 535             dst_id, dst_if_name, dst_sap_id = parse_interface(link["connection_points_reference"][1])
 536
 537             setChaining = False
 538             # check if there is a SAP in the link and chain everything together
 539             if src_sap_id in self.saps and dst_sap_id in self.saps:
 540                 LOG.info('2 SAPs cannot be chained together : {0} - {1}'.format(src_sap_id, dst_sap_id))
 541                 continue
 542
 543             elif src_sap_id in self.saps_ext:
 544                 src_id = src_sap_id
 545                 src_if_name = src_sap_id
 546                 src_name = self.vnf_id2vnf_name[src_id]
 547                 dst_name = self.vnf_id2vnf_name[dst_id]
 548                 dst_vnfi = self._get_vnf_instance(instance_uuid, dst_name)
 549                 if dst_vnfi is not None:
 550                     # choose first ip address in sap subnet
 551                     sap_net = self.saps[src_sap_id]['net']
 552                     sap_ip = "{0}/{1}".format(str(sap_net[1]), sap_net.prefixlen)
 553                     self._vnf_reconfigure_network(dst_vnfi, dst_if_name, sap_ip)
 554                     setChaining = True
 555
 556             elif dst_sap_id in self.saps_ext:
 557                 dst_id = dst_sap_id
 558                 dst_if_name = dst_sap_id
 559                 src_name = self.vnf_id2vnf_name[src_id]
 560                 dst_name = self.vnf_id2vnf_name[dst_id]
 561                 src_vnfi = self._get_vnf_instance(instance_uuid, src_name)
 562                 if src_vnfi is not None:
 563                     sap_net = self.saps[dst_sap_id]['net']
 564                     sap_ip = "{0}/{1}".format(str(sap_net[1]), sap_net.prefixlen)
 565                     self._vnf_reconfigure_network(src_vnfi, src_if_name, sap_ip)
 566                     setChaining = True
 567
 568             # Link between 2 VNFs
 569             else:
 570                 # make sure we use the correct sap vnf name
 571                 if src_sap_id in self.saps_int:
 572                     src_id = src_sap_id
 573                 if dst_sap_id in self.saps_int:
 574                     dst_id = dst_sap_id
 575                 src_name = self.vnf_id2vnf_name[src_id]
 576                 dst_name = self.vnf_id2vnf_name[dst_id]
 577                 # re-configure the VNFs IP assignment and ensure that a new subnet is used for each E-Link
 578                 src_vnfi = self._get_vnf_instance(instance_uuid, src_name)
 579                 dst_vnfi = self._get_vnf_instance(instance_uuid, dst_name)
 580                 if src_vnfi is not None and dst_vnfi is not None:
 581                     eline_net = ELINE_SUBNETS.pop(0)
 582                     ip1 = "{0}/{1}".format(str(eline_net[1]), eline_net.prefixlen)
 583                     ip2 = "{0}/{1}".format(str(eline_net[2]), eline_net.prefixlen)
 584                     self._vnf_reconfigure_network(src_vnfi, src_if_name, ip1)
 585                     self._vnf_reconfigure_network(dst_vnfi, dst_if_name, ip2)
 586                     setChaining = True
 587
 588             # Set the chaining
 589             if setChaining:
 590                 ret = GK.net.setChain(
 591                     src_id, dst_id,
 592                     vnf_src_interface=src_if_name, vnf_dst_interface=dst_if_name,
 593                     bidirectional=BIDIRECTIONAL_CHAIN, cmd="add-flow", cookie=cookie, priority=10)
 594                 LOG.debug(
 595                     "Setting up E-Line link. %s(%s:%s) -> %s(%s:%s)" % (
 596                         src_name, src_id, src_if_name, dst_name, dst_id, dst_if_name))
 597
 598
 599     def _connect_elans(self, elan_fwd_links, instance_uuid):
 600         """
 601         Connect all E-LAN links in the NSD
 602         :param elan_fwd_links: list of E-LAN links in the NSD
 603         :param: instance_uuid of the service
 604         :return:
 605         """
 606         for link in elan_fwd_links:
 607             # check if we need to deploy this link when its a management link:
 608             if USE_DOCKER_MGMT:
 609                 if self.check_mgmt_interface(link["connection_points_reference"]):
 610                     continue
 611
 612             elan_vnf_list = []
 613             # check if an external SAP is in the E-LAN (then a subnet is already defined)
 614             intfs_elan = [intf for intf in link["connection_points_reference"]]
 615             lan_sap = self.check_ext_saps(intfs_elan)
 616             if lan_sap:
 617                 lan_net = self.saps[lan_sap]['net']
 618                 lan_hosts = list(lan_net.hosts())
 619                 sap_ip = str(lan_hosts.pop(0))
 620             else:
 621                 lan_net = ELAN_SUBNETS.pop(0)
 622                 lan_hosts = list(lan_net.hosts())
 623
 624             # generate lan ip address for all interfaces except external SAPs
 625             for intf in link["connection_points_reference"]:
 626
 627                 # skip external SAPs, they already have an ip
 628                 vnf_id, vnf_interface, vnf_sap_docker_name = parse_interface(intf)
 629                 if vnf_sap_docker_name in self.saps_ext:
 630                     elan_vnf_list.append({'name': vnf_sap_docker_name, 'interface': vnf_interface})
 631                     continue
 632
 633                 ip_address = "{0}/{1}".format(str(lan_hosts.pop(0)), lan_net.prefixlen)
 634                 vnf_id, intf_name, vnf_sap_id = parse_interface(intf)
 635
 636                 # make sure we use the correct sap vnf name
 637                 src_docker_name = vnf_id
 638                 if vnf_sap_id in self.saps_int:
 639                     src_docker_name = vnf_sap_id
 640                     vnf_id = vnf_sap_id
 641
 642                 vnf_name = self.vnf_id2vnf_name[vnf_id]
 643                 LOG.debug(
 644                     "Setting up E-LAN interface. %s(%s:%s) -> %s" % (
 645                         vnf_name, vnf_id, intf_name, ip_address))
 646
 647                 if vnf_name in self.vnfds:
 648                     # re-configure the VNFs IP assignment and ensure that a new subnet is used for each E-LAN
 649                     # E-LAN relies on the learning switch capability of Ryu which has to be turned on in the topology
 650                     # (DCNetwork(controller=RemoteController, enable_learning=True)), so no explicit chaining is necessary.
 651                     vnfi = self._get_vnf_instance(instance_uuid, vnf_name)
 652                     if vnfi is not None:
 653                         self._vnf_reconfigure_network(vnfi, intf_name, ip_address)
 654                         # add this vnf and interface to the E-LAN for tagging
 655                         elan_vnf_list.append({'name': src_docker_name, 'interface': intf_name})
 656
 657             # install the VLAN tags for this E-LAN
 658             GK.net.setLAN(elan_vnf_list)
 659
 660
 661     def _load_docker_files(self):
 662         """
 663         Get all paths to Dockerfiles from VNFDs and store them in dict.
 664         :return:
 665         """
 666         for k, v in self.vnfds.iteritems():
 667             for vu in v.get("virtual_deployment_units"):
 668                 if vu.get("vm_image_format") == "docker":
 669                     vm_image = vu.get("vm_image")
 670                     docker_path = os.path.join(
 671                         self.package_content_path,
 672                         make_relative_path(vm_image))
 673                     self.local_docker_files[k] = docker_path
 674                     LOG.debug("Found Dockerfile (%r): %r" % (k, docker_path))
 675
 676     def _load_docker_urls(self):
 677         """
 678         Get all URLs to pre-build docker images in some repo.
 679         :return:
 680         """
 681         # also merge sap dicts, because internal saps also need a docker container
 682         all_vnfs = self.vnfds.copy()
 683         all_vnfs.update(self.saps)
 684
 685         for k, v in all_vnfs.iteritems():
 686             for vu in v.get("virtual_deployment_units", {}):
 687                 if vu.get("vm_image_format") == "docker":
 688                     url = vu.get("vm_image")
 689                     if url is not None:
 690                         url = url.replace("http://", "")
 691                         self.remote_docker_image_urls[k] = url
 692                         LOG.debug("Found Docker image URL (%r): %r" % (k, self.remote_docker_image_urls[k]))
 693
 694     def _build_images_from_dockerfiles(self):
 695         """
 696         Build Docker images for each local Dockerfile found in the package: self.local_docker_files
 697         """
 698         if GK_STANDALONE_MODE:
 699             return  # do not build anything in standalone mode
 700         dc = DockerClient()
 701         LOG.info("Building %d Docker images (this may take several minutes) ..." % len(self.local_docker_files))
 702         for k, v in self.local_docker_files.iteritems():
 703             for line in dc.build(path=v.replace("Dockerfile", ""), tag=k, rm=False, nocache=False):
 704                 LOG.debug("DOCKER BUILD: %s" % line)
 705             LOG.info("Docker image created: %s" % k)
 706
 707     def _pull_predefined_dockerimages(self):
 708         """
 709         If the package contains URLs to pre-build Docker images, we download them with this method.
 710         """
 711         dc = DockerClient()
 712         for url in self.remote_docker_image_urls.itervalues():
 713             if not FORCE_PULL:  # only pull if not present (speedup for development)
 714                 if len(dc.images.list(name=url)) > 0:
 715                     LOG.debug("Image %r present. Skipping pull." % url)
 716                     continue
 717             LOG.info("Pulling image: %r" % url)
 718             # this seems to fail with latest docker api version 2.0.2
 719             # dc.images.pull(url,
 720             #        insecure_registry=True)
 721             #using docker cli instead
 722             cmd = ["docker",
 723                    "pull",
 724                    url,
 725                    ]
 726             Popen(cmd).wait()
 727
 728
 729
 730
 731     def _check_docker_image_exists(self, image_name):
 732         """
 733         Query the docker service and check if the given image exists
 734         :param image_name: name of the docker image
 735         :return:
 736         """
 737         return len(DockerClient().images.list(name=image_name)) > 0
 738
 739     def _calculate_placement(self, algorithm):
 740         """
 741         Do placement by adding the a field "dc" to
 742         each VNFD that points to one of our
 743         data center objects known to the gatekeeper.
 744         """
 745         assert(len(self.vnfds) > 0)
 746         assert(len(GK.dcs) > 0)
 747         # instantiate algorithm an place
 748         p = algorithm()
 749         p.place(self.nsd, self.vnfds, self.saps, GK.dcs)
 750         LOG.info("Using placement algorithm: %r" % p.__class__.__name__)
 751         # lets print the placement result
 752         for name, vnfd in self.vnfds.iteritems():
 753             LOG.info("Placed VNF %r on DC %r" % (name, str(vnfd.get("dc"))))
 754         for sap in self.saps:
 755             sap_dict = self.saps[sap]
 756             LOG.info("Placed SAP %r on DC %r" % (sap, str(sap_dict.get("dc"))))
 757
 758
 759     def _calculate_cpu_cfs_values(self, cpu_time_percentage):
 760         """
 761         Calculate cpu period and quota for CFS
 762         :param cpu_time_percentage: percentage of overall CPU to be used
 763         :return: cpu_period, cpu_quota
 764         """
 765         if cpu_time_percentage is None:
 766             return -1, -1
 767         if cpu_time_percentage < 0:
 768             return -1, -1
 769         # (see: https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt)
 770         # Attention minimum cpu_quota is 1ms (micro)
 771         cpu_period = 1000000  # lets consider a fixed period of 1000000 microseconds for now
 772         LOG.debug("cpu_period is %r, cpu_percentage is %r" % (cpu_period, cpu_time_percentage))
 773         cpu_quota = cpu_period * cpu_time_percentage  # calculate the fraction of cpu time for this container
 774         # ATTENTION >= 1000 to avoid a invalid argument system error ... no idea why
 775         if cpu_quota < 1000:
 776             LOG.debug("cpu_quota before correcting: %r" % cpu_quota)
 777             cpu_quota = 1000
 778             LOG.warning("Increased CPU quota to avoid system error.")
 779         LOG.debug("Calculated: cpu_period=%f / cpu_quota=%f" % (cpu_period, cpu_quota))
 780         return int(cpu_period), int(cpu_quota)
 781
 782     def check_ext_saps(self, intf_list):
 783         # check if the list of interfacs contains an externl SAP
 784         saps_ext = [self.saps[sap]['name'] for sap in self.saps if self.saps[sap]["type"] == "external"]
 785         for intf_name in intf_list:
 786             vnf_id, vnf_interface, vnf_sap_docker_name = parse_interface(intf_name)
 787             if vnf_sap_docker_name in saps_ext:
 788                 return vnf_sap_docker_name
 789
 790     def check_mgmt_interface(self, intf_list):
 791         SAPs_mgmt = [p.get('id') for p in self.nsd["connection_points"] if 'management' in p.get('type')]
 792         for intf_name in intf_list:
 793             if intf_name in SAPs_mgmt:
 794                 return True
 795
 796 """
 797 Some (simple) placement algorithms
 798 """
 799
 800
 801 class FirstDcPlacement(object):
 802     """
 803     Placement: Always use one and the same data center from the GK.dcs dict.
 804     """
 805     def place(self, nsd, vnfds, saps, dcs):
 806         for name, vnfd in vnfds.iteritems():
 807             vnfd["dc"] = list(dcs.itervalues())[0]
 808
 809
 810 class RoundRobinDcPlacement(object):
 811     """
 812     Placement: Distribute VNFs across all available DCs in a round robin fashion.
 813     """
 814     def place(self, nsd, vnfds, saps, dcs):
 815         c = 0
 816         dcs_list = list(dcs.itervalues())
 817         for name, vnfd in vnfds.iteritems():
 818             vnfd["dc"] = dcs_list[c % len(dcs_list)]
 819             c += 1  # inc. c to use next DC
 820
 821 class RoundRobinDcPlacementWithSAPs(object):
 822     """
 823     Placement: Distribute VNFs across all available DCs in a round robin fashion,
 824     every SAP is instantiated on the same DC as the connected VNF.
 825     """
 826     def place(self, nsd, vnfds, saps, dcs):
 827
 828         # place vnfs
 829         c = 0
 830         dcs_list = list(dcs.itervalues())
 831         for name, vnfd in vnfds.iteritems():
 832             vnfd["dc"] = dcs_list[c % len(dcs_list)]
 833             c += 1  # inc. c to use next DC
 834
 835         # place SAPs
 836         vlinks = nsd.get("virtual_links", [])
 837         eline_fwd_links = [l for l in vlinks if (l["connectivity_type"] == "E-Line")]
 838         elan_fwd_links = [l for l in vlinks if  (l["connectivity_type"] == "E-LAN")]
 839
 840         vnf_id2vnf_name = defaultdict(lambda: "NotExistingNode",
 841                                       reduce(lambda x, y: dict(x, **y),
 842                                              map(lambda d: {d["vnf_id"]: d["vnf_name"]},
 843                                                  nsd["network_functions"])))
 844
 845         # SAPs on E-Line links are placed on the same DC as the VNF on the E-Line
 846         for link in eline_fwd_links:
 847             src_id, src_if_name, src_sap_id = parse_interface(link["connection_points_reference"][0])
 848             dst_id, dst_if_name, dst_sap_id = parse_interface(link["connection_points_reference"][1])
 849
 850             # check if there is a SAP in the link
 851             if src_sap_id in saps:
 852                 dst_vnf_name = vnf_id2vnf_name[dst_id]
 853                 # get dc where connected vnf is mapped to
 854                 dc = vnfds[dst_vnf_name]['dc']
 855                 saps[src_sap_id]['dc'] = dc
 856
 857             if dst_sap_id in saps:
 858                 src_vnf_name = vnf_id2vnf_name[src_id]
 859                 # get dc where connected vnf is mapped to
 860                 dc = vnfds[src_vnf_name]['dc']
 861                 saps[dst_sap_id]['dc'] = dc
 862
 863         # SAPs on E-LANs are placed on a random DC
 864         dcs_list = list(dcs.itervalues())
 865         dc_len = len(dcs_list)
 866         for link in elan_fwd_links:
 867             for intf in link["connection_points_reference"]:
 868                 # find SAP interfaces
 869                 intf_id, intf_name, intf_sap_id = parse_interface(intf)
 870                 if intf_sap_id in saps:
 871                     dc = dcs_list[randint(0, dc_len-1)]
 872                     saps[intf_sap_id]['dc'] = dc
 873
 874
 875
 876 """
 877 Resource definitions and API endpoints
 878 """
 879
 880
 881 class Packages(fr.Resource):
 882
 883     def post(self):
 884         """
 885         Upload a *.son service package to the dummy gatekeeper.
 886
 887         We expect request with a *.son file and store it in UPLOAD_FOLDER
 888         :return: UUID
 889         """
 890         try:
 891             # get file contents
 892             LOG.info("POST /packages called")
 893             # lets search for the package in the request
 894             is_file_object = False  # make API more robust: file can be in data or in files field
 895             if "package" in request.files:
 896                 son_file = request.files["package"]
 897                 is_file_object = True
 898             elif len(request.data) > 0:
 899                 son_file = request.data
 900             else:
 901                 return {"service_uuid": None, "size": 0, "sha1": None, "error": "upload failed. file not found."}, 500
 902             # generate a uuid to reference this package
 903             service_uuid = str(uuid.uuid4())
 904             file_hash = hashlib.sha1(str(son_file)).hexdigest()
 905             # ensure that upload folder exists
 906             ensure_dir(UPLOAD_FOLDER)
 907             upload_path = os.path.join(UPLOAD_FOLDER, "%s.son" % service_uuid)
 908             # store *.son file to disk
 909             if is_file_object:
 910                 son_file.save(upload_path)
 911             else:
 912                 with open(upload_path, 'wb') as f:
 913                     f.write(son_file)
 914             size = os.path.getsize(upload_path)
 915             # create a service object and register it
 916             s = Service(service_uuid, file_hash, upload_path)
 917             GK.register_service_package(service_uuid, s)
 918             # generate the JSON result
 919             return {"service_uuid": service_uuid, "size": size, "sha1": file_hash, "error": None}, 201
 920         except Exception as ex:
 921             LOG.exception("Service package upload failed:")
 922             return {"service_uuid": None, "size": 0, "sha1": None, "error": "upload failed"}, 500
 923
 924     def get(self):
 925         """
 926         Return a list of UUID's of uploaded service packages.
 927         :return: dict/list
 928         """
 929         LOG.info("GET /packages")
 930         return {"service_uuid_list": list(GK.services.iterkeys())}
 931
 932
 933 class Instantiations(fr.Resource):
 934
 935     def post(self):
 936         """
 937         Instantiate a service specified by its UUID.
 938         Will return a new UUID to identify the running service instance.
 939         :return: UUID
 940         """
 941         LOG.info("POST /instantiations (or /reqeusts) called")
 942         # try to extract the service uuid from the request
 943         json_data = request.get_json(force=True)
 944         service_uuid = json_data.get("service_uuid")
 945
 946         # lets be a bit fuzzy here to make testing easier
 947         if (service_uuid is None or service_uuid=="latest") and len(GK.services) > 0:
 948             # if we don't get a service uuid, we simple start the first service in the list
 949             service_uuid = list(GK.services.iterkeys())[0]
 950         if service_uuid in GK.services:
 951             # ok, we have a service uuid, lets start the service
 952             service_instance_uuid = GK.services.get(service_uuid).start_service()
 953             return {"service_instance_uuid": service_instance_uuid}, 201
 954         return "Service not found", 404
 955
 956     def get(self):
 957         """
 958         Returns a list of UUIDs containing all running services.
 959         :return: dict / list
 960         """
 961         LOG.info("GET /instantiations")
 962         return {"service_instantiations_list": [
 963             list(s.instances.iterkeys()) for s in GK.services.itervalues()]}
 964
 965     def delete(self):
 966         """
 967         Stops a running service specified by its service and instance UUID.
 968         """
 969         # try to extract the service  and instance UUID from the request
 970         json_data = request.get_json(force=True)
 971         service_uuid = json_data.get("service_uuid")
 972         instance_uuid = json_data.get("service_instance_uuid")
 973
 974         # try to be fuzzy
 975         if service_uuid is None and len(GK.services) > 0:
 976             #if we don't get a service uuid, we simply stop the last service in the list
 977             service_uuid = list(GK.services.iterkeys())[0]
 978         if instance_uuid is None and len(GK.services[service_uuid].instances) > 0:
 979             instance_uuid = list(GK.services[service_uuid].instances.iterkeys())[0]
 980
 981         if service_uuid in GK.services and instance_uuid in GK.services[service_uuid].instances:
 982             # valid service and instance UUID, stop service
 983             GK.services.get(service_uuid).stop_service(instance_uuid)
 984             return "service instance with uuid %r stopped." % instance_uuid,200
 985         return "Service not found", 404
 986
 987 class Exit(fr.Resource):
 988
 989     def put(self):
 990         """
 991         Stop the running Containernet instance regardless of data transmitted
 992         """
 993         list(GK.dcs.values())[0].net.stop()
 994
 995
 996 def initialize_GK():
 997     global GK
 998     GK = Gatekeeper()
 999
1000
1001
1002 # create a single, global GK object
1003 GK = None
1004 initialize_GK()
1005 # setup Flask
1006 app = Flask(__name__)
1007 app.config['MAX_CONTENT_LENGTH'] = 512 * 1024 * 1024  # 512 MB max upload
1008 api = fr.Api(app)
1009 # define endpoints
1010 api.add_resource(Packages, '/packages', '/api/v2/packages')
1011 api.add_resource(Instantiations, '/instantiations', '/api/v2/instantiations', '/api/v2/requests')
1012 api.add_resource(Exit, '/emulator/exit')
1013
1014
1015
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)
1020     app.run(host=host,
1021             port=port,
1022             debug=True,
1023             use_reloader=False  # this is needed to run Flask in a non-main thread
1024             )
1025
1026
1027 def ensure_dir(name):
1028     if not os.path.exists(name):
1029         os.makedirs(name)
1030
1031
1032 def load_yaml(path):
1033     with open(path, "r") as f:
1034         try:
1035             r = yaml.load(f)
1036         except yaml.YAMLError as exc:
1037             LOG.exception("YAML parse error")
1038             r = dict()
1039     return r
1040
1041
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)
1047     return path
1048
1049
1050 def get_dc_network():
1051     """
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
1054     :return:
1055     """
1056     assert (len(GK.dcs) > 0)
1057     return GK.dcs.values()[0].net
1058
1059
1060 def parse_interface(interface_name):
1061     """
1062     convert the interface name in the nsd to the according vnf_id, vnf_interface names
1063     :param interface_name:
1064     :return:
1065     """
1066
1067     if ':' in interface_name:
1068         vnf_id, vnf_interface = interface_name.split(':')
1069         vnf_sap_docker_name = interface_name.replace(':', '_')
1070     else:
1071         vnf_id = interface_name
1072         vnf_interface = interface_name
1073         vnf_sap_docker_name = interface_name
1074
1075     return vnf_id, vnf_interface, vnf_sap_docker_name
1076
1077 if __name__ == '__main__':
1078     """
1079     Lets allow to run the API in standalone mode.
1080     """
1081     GK_STANDALONE_MODE = True
1082     logging.getLogger("werkzeug").setLevel(logging.INFO)
1083     start_rest_api("0.0.0.0", 8000)
1084