+
+ def _load_package_descriptor(self):
+ """
+ Load the main package descriptor YAML and keep it as dict.
+ :return:
+ """
+ self.manifest = load_yaml(
+ os.path.join(
+ self.package_content_path, "META-INF/MANIFEST.MF"))
+
+ def _load_nsd(self):
+ """
+ Load the entry NSD YAML and keep it as dict.
+ :return:
+ """
+ if "entry_service_template" in self.manifest:
+ nsd_path = os.path.join(
+ self.package_content_path,
+ make_relative_path(self.manifest.get("entry_service_template")))
+ self.nsd = load_yaml(nsd_path)
+ GK.net.deployed_nsds.append(self.nsd)
+
+ LOG.debug("Loaded NSD: %r" % self.nsd.get("name"))
+
+ def _load_vnfd(self):
+ """
+ Load all VNFD YAML files referenced in MANIFEST.MF and keep them in dict.
+ :return:
+ """
+ if "package_content" in self.manifest:
+ for pc in self.manifest.get("package_content"):
+ if pc.get("content-type") == "application/sonata.function_descriptor":
+ vnfd_path = os.path.join(
+ self.package_content_path,
+ make_relative_path(pc.get("name")))
+ vnfd = load_yaml(vnfd_path)
+ self.vnfds[vnfd.get("name")] = vnfd
+ LOG.debug("Loaded VNFD: %r" % vnfd.get("name"))
+
+ def _load_saps(self):
+ # create list of all SAPs
+ # check if we need to deploy management ports
+ if USE_DOCKER_MGMT:
+ SAPs = [p for p in self.nsd["connection_points"] if 'management' not in p.get('type')]
+ else:
+ SAPs = [p for p in self.nsd["connection_points"]]
+
+ for sap in SAPs:
+ # endpoint needed in this service
+ sap_id, sap_interface, sap_docker_name = parse_interface(sap['id'])
+ # make sure SAP has type set (default internal)
+ sap["type"] = sap.get("type", 'internal')
+
+ # Each Service Access Point (connection_point) in the nsd is an IP address on the host
+ if sap["type"] == "external":
+ # add to vnfds to calculate placement later on
+ sap_net = SAP_SUBNETS.pop(0)
+ self.saps[sap_docker_name] = {"name": sap_docker_name , "type": "external", "net": sap_net}
+ # add SAP vnf to list in the NSD so it is deployed later on
+ # each SAP get a unique VNFD and vnf_id in the NSD and custom type (only defined in the dummygatekeeper)
+ self.nsd["network_functions"].append(
+ {"vnf_id": sap_docker_name, "vnf_name": sap_docker_name, "vnf_type": "sap_ext"})
+
+ # Each Service Access Point (connection_point) in the nsd is getting its own container (default)
+ elif sap["type"] == "internal" or sap["type"] == "management":
+ # add SAP to self.vnfds
+ sapfile = pkg_resources.resource_filename(__name__, "sap_vnfd.yml")
+ sap_vnfd = load_yaml(sapfile)
+ sap_vnfd["connection_points"][0]["id"] = sap_interface
+ sap_vnfd["name"] = sap_docker_name
+ sap_vnfd["type"] = "internal"
+ # add to vnfds to calculate placement later on and deploy
+ self.saps[sap_docker_name] = sap_vnfd
+ # add SAP vnf to list in the NSD so it is deployed later on
+ # each SAP get a unique VNFD and vnf_id in the NSD
+ self.nsd["network_functions"].append(
+ {"vnf_id": sap_docker_name, "vnf_name": sap_docker_name, "vnf_type": "sap_int"})
+
+ LOG.debug("Loaded SAP: name: {0}, type: {1}".format(sap_docker_name, sap['type']))
+
+ # create sap lists
+ self.saps_ext = [self.saps[sap]['name'] for sap in self.saps if self.saps[sap]["type"] == "external"]
+ self.saps_int = [self.saps[sap]['name'] for sap in self.saps if self.saps[sap]["type"] == "internal"]
+
+ def _start_sap(self, sap, instance_uuid):
+ if not DEPLOY_SAP:
+ return
+
+ LOG.info('start SAP: {0} ,type: {1}'.format(sap['name'],sap['type']))
+ if sap["type"] == "internal":
+ vnfi = None
+ if not GK_STANDALONE_MODE:
+ vnfi = self._start_vnfd(sap)
+ self.instances[instance_uuid]["vnf_instances"].append(vnfi)
+
+ elif sap["type"] == "external":
+ target_dc = sap.get("dc")
+ # add interface to dc switch
+ target_dc.attachExternalSAP(sap['name'], sap['net'])
+
+ def _connect_elines(self, eline_fwd_links, instance_uuid):
+ """
+ Connect all E-LINE links in the NSD
+ :param eline_fwd_links: list of E-LINE links in the NSD
+ :param: instance_uuid of the service
+ :return:
+ """
+ # cookie is used as identifier for the flowrules installed by the dummygatekeeper
+ # eg. different services get a unique cookie for their flowrules
+ cookie = 1
+ for link in eline_fwd_links:
+ # check if we need to deploy this link when its a management link:
+ if USE_DOCKER_MGMT:
+ if self.check_mgmt_interface(link["connection_points_reference"]):
+ continue
+
+ src_id, src_if_name, src_sap_id = parse_interface(link["connection_points_reference"][0])
+ dst_id, dst_if_name, dst_sap_id = parse_interface(link["connection_points_reference"][1])
+
+ setChaining = False
+ # check if there is a SAP in the link and chain everything together
+ if src_sap_id in self.saps and dst_sap_id in self.saps:
+ LOG.info('2 SAPs cannot be chained together : {0} - {1}'.format(src_sap_id, dst_sap_id))
+ continue
+
+ elif src_sap_id in self.saps_ext:
+ src_id = src_sap_id
+ # set intf name to None so the chaining function will choose the first one
+ src_if_name = None
+ src_name = self.vnf_id2vnf_name[src_id]
+ dst_name = self.vnf_id2vnf_name[dst_id]
+ dst_vnfi = self._get_vnf_instance(instance_uuid, dst_name)
+ if dst_vnfi is not None:
+ # choose first ip address in sap subnet
+ sap_net = self.saps[src_sap_id]['net']
+ sap_ip = "{0}/{1}".format(str(sap_net[2]), sap_net.prefixlen)
+ self._vnf_reconfigure_network(dst_vnfi, dst_if_name, sap_ip)
+ setChaining = True
+
+ elif dst_sap_id in self.saps_ext:
+ dst_id = dst_sap_id
+ # set intf name to None so the chaining function will choose the first one
+ dst_if_name = None
+ src_name = self.vnf_id2vnf_name[src_id]
+ dst_name = self.vnf_id2vnf_name[dst_id]
+ src_vnfi = self._get_vnf_instance(instance_uuid, src_name)
+ if src_vnfi is not None:
+ sap_net = self.saps[dst_sap_id]['net']
+ sap_ip = "{0}/{1}".format(str(sap_net[2]), sap_net.prefixlen)
+ self._vnf_reconfigure_network(src_vnfi, src_if_name, sap_ip)
+ setChaining = True
+
+ # Link between 2 VNFs
+ else:
+ # make sure we use the correct sap vnf name
+ if src_sap_id in self.saps_int:
+ src_id = src_sap_id
+ if dst_sap_id in self.saps_int:
+ dst_id = dst_sap_id
+ src_name = self.vnf_id2vnf_name[src_id]
+ dst_name = self.vnf_id2vnf_name[dst_id]
+ # re-configure the VNFs IP assignment and ensure that a new subnet is used for each E-Link
+ src_vnfi = self._get_vnf_instance(instance_uuid, src_name)
+ dst_vnfi = self._get_vnf_instance(instance_uuid, dst_name)
+ if src_vnfi is not None and dst_vnfi is not None:
+ eline_net = ELINE_SUBNETS.pop(0)
+ ip1 = "{0}/{1}".format(str(eline_net[1]), eline_net.prefixlen)
+ ip2 = "{0}/{1}".format(str(eline_net[2]), eline_net.prefixlen)
+ self._vnf_reconfigure_network(src_vnfi, src_if_name, ip1)
+ self._vnf_reconfigure_network(dst_vnfi, dst_if_name, ip2)
+ setChaining = True
+
+ # Set the chaining
+ if setChaining:
+ ret = GK.net.setChain(
+ src_id, dst_id,
+ vnf_src_interface=src_if_name, vnf_dst_interface=dst_if_name,
+ bidirectional=BIDIRECTIONAL_CHAIN, cmd="add-flow", cookie=cookie, priority=10)
+ LOG.debug(
+ "Setting up E-Line link. %s(%s:%s) -> %s(%s:%s)" % (
+ src_name, src_id, src_if_name, dst_name, dst_id, dst_if_name))
+
+
+ def _connect_elans(self, elan_fwd_links, instance_uuid):
+ """
+ Connect all E-LAN links in the NSD
+ :param elan_fwd_links: list of E-LAN links in the NSD
+ :param: instance_uuid of the service
+ :return:
+ """
+ for link in elan_fwd_links:
+ # check if we need to deploy this link when its a management link:
+ if USE_DOCKER_MGMT:
+ if self.check_mgmt_interface(link["connection_points_reference"]):
+ continue
+
+ elan_vnf_list = []
+ # check if an external SAP is in the E-LAN (then a subnet is already defined)
+ intfs_elan = [intf for intf in link["connection_points_reference"]]
+ lan_sap = self.check_ext_saps(intfs_elan)
+ if lan_sap:
+ lan_net = self.saps[lan_sap]['net']
+ lan_hosts = list(lan_net.hosts())
+ sap_ip = str(lan_hosts.pop(0))
+ else:
+ lan_net = ELAN_SUBNETS.pop(0)
+ lan_hosts = list(lan_net.hosts())
+
+ # generate lan ip address for all interfaces except external SAPs
+ for intf in link["connection_points_reference"]:
+
+ # skip external SAPs, they already have an ip
+ vnf_id, vnf_interface, vnf_sap_docker_name = parse_interface(intf)
+ if vnf_sap_docker_name in self.saps_ext:
+ elan_vnf_list.append({'name': vnf_sap_docker_name, 'interface': vnf_interface})
+ continue
+
+ ip_address = "{0}/{1}".format(str(lan_hosts.pop(0)), lan_net.prefixlen)
+ vnf_id, intf_name, vnf_sap_id = parse_interface(intf)
+
+ # make sure we use the correct sap vnf name
+ src_docker_name = vnf_id
+ if vnf_sap_id in self.saps_int:
+ src_docker_name = vnf_sap_id
+ vnf_id = vnf_sap_id
+
+ vnf_name = self.vnf_id2vnf_name[vnf_id]
+ LOG.debug(
+ "Setting up E-LAN interface. %s(%s:%s) -> %s" % (
+ vnf_name, vnf_id, intf_name, ip_address))
+
+ if vnf_name in self.vnfds:
+ # re-configure the VNFs IP assignment and ensure that a new subnet is used for each E-LAN
+ # E-LAN relies on the learning switch capability of Ryu which has to be turned on in the topology
+ # (DCNetwork(controller=RemoteController, enable_learning=True)), so no explicit chaining is necessary.
+ vnfi = self._get_vnf_instance(instance_uuid, vnf_name)
+ if vnfi is not None:
+ self._vnf_reconfigure_network(vnfi, intf_name, ip_address)
+ # add this vnf and interface to the E-LAN for tagging
+ elan_vnf_list.append({'name': src_docker_name, 'interface': intf_name})
+
+ # install the VLAN tags for this E-LAN
+ GK.net.setLAN(elan_vnf_list)
+
+
+ def _load_docker_files(self):
+ """
+ Get all paths to Dockerfiles from VNFDs and store them in dict.
+ :return:
+ """
+ for k, v in self.vnfds.iteritems():
+ for vu in v.get("virtual_deployment_units"):
+ if vu.get("vm_image_format") == "docker":
+ vm_image = vu.get("vm_image")
+ docker_path = os.path.join(
+ self.package_content_path,
+ make_relative_path(vm_image))
+ self.local_docker_files[k] = docker_path
+ LOG.debug("Found Dockerfile (%r): %r" % (k, docker_path))
+
+ def _load_docker_urls(self):
+ """
+ Get all URLs to pre-build docker images in some repo.
+ :return:
+ """
+ # also merge sap dicts, because internal saps also need a docker container
+ all_vnfs = self.vnfds.copy()
+ all_vnfs.update(self.saps)
+
+ for k, v in all_vnfs.iteritems():
+ for vu in v.get("virtual_deployment_units", {}):
+ if vu.get("vm_image_format") == "docker":
+ url = vu.get("vm_image")
+ if url is not None:
+ url = url.replace("http://", "")
+ self.remote_docker_image_urls[k] = url
+ LOG.debug("Found Docker image URL (%r): %r" % (k, self.remote_docker_image_urls[k]))
+
+ def _build_images_from_dockerfiles(self):
+ """
+ Build Docker images for each local Dockerfile found in the package: self.local_docker_files
+ """
+ if GK_STANDALONE_MODE:
+ return # do not build anything in standalone mode
+ dc = DockerClient()
+ LOG.info("Building %d Docker images (this may take several minutes) ..." % len(self.local_docker_files))
+ for k, v in self.local_docker_files.iteritems():
+ for line in dc.build(path=v.replace("Dockerfile", ""), tag=k, rm=False, nocache=False):
+ LOG.debug("DOCKER BUILD: %s" % line)
+ LOG.info("Docker image created: %s" % k)
+
+ def _pull_predefined_dockerimages(self):
+ """
+ If the package contains URLs to pre-build Docker images, we download them with this method.
+ """
+ dc = DockerClient()
+ for url in self.remote_docker_image_urls.itervalues():
+ if not FORCE_PULL: # only pull if not present (speedup for development)
+ if len(dc.images.list(name=url)) > 0:
+ LOG.debug("Image %r present. Skipping pull." % url)
+ continue
+ LOG.info("Pulling image: %r" % url)
+ # this seems to fail with latest docker api version 2.0.2
+ # dc.images.pull(url,
+ # insecure_registry=True)
+ #using docker cli instead
+ cmd = ["docker",
+ "pull",
+ url,
+ ]
+ Popen(cmd).wait()
+
+
+
+
+ def _check_docker_image_exists(self, image_name):
+ """
+ Query the docker service and check if the given image exists
+ :param image_name: name of the docker image
+ :return:
+ """
+ return len(DockerClient().images.list(name=image_name)) > 0
+
+ def _calculate_placement(self, algorithm):
+ """
+ Do placement by adding the a field "dc" to
+ each VNFD that points to one of our
+ data center objects known to the gatekeeper.
+ """
+ assert(len(self.vnfds) > 0)
+ assert(len(GK.dcs) > 0)
+ # instantiate algorithm an place
+ p = algorithm()
+ p.place(self.nsd, self.vnfds, self.saps, GK.dcs)
+ LOG.info("Using placement algorithm: %r" % p.__class__.__name__)
+ # lets print the placement result
+ for name, vnfd in self.vnfds.iteritems():
+ LOG.info("Placed VNF %r on DC %r" % (name, str(vnfd.get("dc"))))
+ for sap in self.saps:
+ sap_dict = self.saps[sap]
+ LOG.info("Placed SAP %r on DC %r" % (sap, str(sap_dict.get("dc"))))
+
+
+ def _calculate_cpu_cfs_values(self, cpu_time_percentage):
+ """
+ Calculate cpu period and quota for CFS
+ :param cpu_time_percentage: percentage of overall CPU to be used
+ :return: cpu_period, cpu_quota
+ """
+ if cpu_time_percentage is None:
+ return -1, -1
+ if cpu_time_percentage < 0:
+ return -1, -1
+ # (see: https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt)
+ # Attention minimum cpu_quota is 1ms (micro)
+ cpu_period = 1000000 # lets consider a fixed period of 1000000 microseconds for now
+ LOG.debug("cpu_period is %r, cpu_percentage is %r" % (cpu_period, cpu_time_percentage))
+ cpu_quota = cpu_period * cpu_time_percentage # calculate the fraction of cpu time for this container
+ # ATTENTION >= 1000 to avoid a invalid argument system error ... no idea why
+ if cpu_quota < 1000:
+ LOG.debug("cpu_quota before correcting: %r" % cpu_quota)
+ cpu_quota = 1000
+ LOG.warning("Increased CPU quota to avoid system error.")
+ LOG.debug("Calculated: cpu_period=%f / cpu_quota=%f" % (cpu_period, cpu_quota))
+ return int(cpu_period), int(cpu_quota)
+
+ def check_ext_saps(self, intf_list):
+ # check if the list of interfacs contains an externl SAP
+ saps_ext = [self.saps[sap]['name'] for sap in self.saps if self.saps[sap]["type"] == "external"]
+ for intf_name in intf_list:
+ vnf_id, vnf_interface, vnf_sap_docker_name = parse_interface(intf_name)
+ if vnf_sap_docker_name in saps_ext:
+ return vnf_sap_docker_name
+
+ def check_mgmt_interface(self, intf_list):
+ SAPs_mgmt = [p.get('id') for p in self.nsd["connection_points"] if 'management' in p.get('type')]
+ for intf_name in intf_list:
+ if intf_name in SAPs_mgmt:
+ return True
+
+"""
+Some (simple) placement algorithms
+"""
+
+
+class FirstDcPlacement(object):
+ """
+ Placement: Always use one and the same data center from the GK.dcs dict.
+ """
+ def place(self, nsd, vnfds, saps, dcs):
+ for name, vnfd in vnfds.iteritems():
+ vnfd["dc"] = list(dcs.itervalues())[0]
+
+
+class RoundRobinDcPlacement(object):
+ """
+ Placement: Distribute VNFs across all available DCs in a round robin fashion.
+ """
+ def place(self, nsd, vnfds, saps, dcs):
+ c = 0
+ dcs_list = list(dcs.itervalues())
+ for name, vnfd in vnfds.iteritems():
+ vnfd["dc"] = dcs_list[c % len(dcs_list)]
+ c += 1 # inc. c to use next DC
+
+class RoundRobinDcPlacementWithSAPs(object):
+ """
+ Placement: Distribute VNFs across all available DCs in a round robin fashion,
+ every SAP is instantiated on the same DC as the connected VNF.
+ """
+ def place(self, nsd, vnfds, saps, dcs):
+
+ # place vnfs
+ c = 0
+ dcs_list = list(dcs.itervalues())
+ for name, vnfd in vnfds.iteritems():
+ vnfd["dc"] = dcs_list[c % len(dcs_list)]
+ c += 1 # inc. c to use next DC
+
+ # place SAPs
+ vlinks = nsd.get("virtual_links", [])
+ eline_fwd_links = [l for l in vlinks if (l["connectivity_type"] == "E-Line")]
+ elan_fwd_links = [l for l in vlinks if (l["connectivity_type"] == "E-LAN")]
+
+ vnf_id2vnf_name = defaultdict(lambda: "NotExistingNode",
+ reduce(lambda x, y: dict(x, **y),
+ map(lambda d: {d["vnf_id"]: d["vnf_name"]},
+ nsd["network_functions"])))
+
+ # SAPs on E-Line links are placed on the same DC as the VNF on the E-Line
+ for link in eline_fwd_links:
+ src_id, src_if_name, src_sap_id = parse_interface(link["connection_points_reference"][0])
+ dst_id, dst_if_name, dst_sap_id = parse_interface(link["connection_points_reference"][1])
+
+ # check if there is a SAP in the link
+ if src_sap_id in saps:
+ dst_vnf_name = vnf_id2vnf_name[dst_id]
+ # get dc where connected vnf is mapped to
+ dc = vnfds[dst_vnf_name]['dc']
+ saps[src_sap_id]['dc'] = dc
+
+ if dst_sap_id in saps:
+ src_vnf_name = vnf_id2vnf_name[src_id]
+ # get dc where connected vnf is mapped to
+ dc = vnfds[src_vnf_name]['dc']
+ saps[dst_sap_id]['dc'] = dc
+
+ # SAPs on E-LANs are placed on a random DC
+ dcs_list = list(dcs.itervalues())
+ dc_len = len(dcs_list)
+ for link in elan_fwd_links:
+ for intf in link["connection_points_reference"]:
+ # find SAP interfaces
+ intf_id, intf_name, intf_sap_id = parse_interface(intf)
+ if intf_sap_id in saps:
+ dc = dcs_list[randint(0, dc_len-1)]
+ saps[intf_sap_id]['dc'] = dc
+