X-Git-Url: https://osm.etsi.org/gitweb/?a=blobdiff_plain;f=src%2Femuvim%2Fapi%2Fsonata%2Fdummygatekeeper.py;h=eda2b962249180853dea6491ea4a6a4dba0451ca;hb=92237dc0bc0a724210453c2e10445f8d6f68b06c;hp=f258e492119496315c4d69f50a6659c7d5bbc9a0;hpb=a541a3b3cfa1aa3e0a73c680773db9e78736afd3;p=osm%2Fvim-emu.git diff --git a/src/emuvim/api/sonata/dummygatekeeper.py b/src/emuvim/api/sonata/dummygatekeeper.py index f258e49..eda2b96 100644 --- a/src/emuvim/api/sonata/dummygatekeeper.py +++ b/src/emuvim/api/sonata/dummygatekeeper.py @@ -9,36 +9,251 @@ import logging import os import uuid import hashlib -import json +import zipfile +import yaml +from docker import Client as DockerClient from flask import Flask, request import flask_restful as fr +logging.basicConfig() +LOG = logging.getLogger("sonata-dummy-gatekeeper") +LOG.setLevel(logging.DEBUG) logging.getLogger("werkzeug").setLevel(logging.WARNING) +GK_STORAGE = "/tmp/son-dummy-gk/" +UPLOAD_FOLDER = os.path.join(GK_STORAGE, "uploads/") +CATALOG_FOLDER = os.path.join(GK_STORAGE, "catalog/") -UPLOAD_FOLDER = "/tmp/son-dummy-gk/uploads/" -CATALOG_FOLDER = "/tmp/son-dummy-gk/catalog/" +# flag to indicate that we run without the emulator (only the bare API for integration testing) +GK_STANDALONE_MODE = False class Gatekeeper(object): def __init__(self): - self.packages = dict() - self.instantiations = dict() - logging.info("Create SONATA dummy gatekeeper.") + self.services = dict() + self.dcs = dict() + self.vnf_counter = 0 # used to generate short names for VNFs (Mininet limitation) + LOG.info("Create SONATA dummy gatekeeper.") - def unpack_service_package(self, service_uuid): - # TODO implement method - # 1. unzip *.son file and store contents in CATALOG_FOLDER/services// - pass + def register_service_package(self, service_uuid, service): + """ + register new service package + :param service_uuid + :param service object + """ + self.services[service_uuid] = service + # lets perform all steps needed to onboard the service + service.onboard() + + def get_next_vnf_name(self): + self.vnf_counter += 1 + return "vnf%d" % self.vnf_counter + + +class Service(object): + """ + This class represents a NS uploaded as a *.son package to the + dummy gatekeeper. + Can have multiple running instances of this service. + """ + + def __init__(self, + service_uuid, + package_file_hash, + package_file_path): + self.uuid = service_uuid + self.package_file_hash = package_file_hash + self.package_file_path = package_file_path + self.package_content_path = os.path.join(CATALOG_FOLDER, "services/%s" % self.uuid) + self.manifest = None + self.nsd = None + self.vnfds = dict() + self.local_docker_files = dict() + self.instances = dict() - def start_service(self, service_uuid): - # TODO implement method - # 1. parse descriptors - # 2. do the corresponding dc.startCompute(name="foobar") calls - # 3. store references to the compute objects in self.instantiations + def onboard(self): + """ + Do all steps to prepare this service to be instantiated + :return: + """ + # 1. extract the contents of the package and store them in our catalog + self._unpack_service_package() + # 2. read in all descriptor files + self._load_package_descriptor() + self._load_nsd() + self._load_vnfd() + self._load_docker_files() + # 3. prepare container images (e.g. download or build Dockerfile) + self._build_images_from_dockerfiles() + self._download_predefined_dockerimages() + + LOG.info("On-boarded service: %r" % self.manifest.get("package_name")) + + def start_service(self): + """ + This methods creates and starts a new service instance. + It computes placements, iterates over all VNFDs, and starts + each VNFD as a Docker container in the data center selected + by the placement algorithm. + :return: + """ + LOG.info("Starting service %r" % self.uuid) + # 1. each service instance gets a new uuid to identify it + instance_uuid = str(uuid.uuid4()) + # build a instances dict (a bit like a NSR :)) + self.instances[instance_uuid] = dict() + self.instances[instance_uuid]["vnf_instances"] = list() + # 2. compute placement of this service instance (adds DC names to VNFDs) + if not GK_STANDALONE_MODE: + self._calculate_placement(FirstDcPlacement) + # iterate over all vnfds that we have to start + for vnfd in self.vnfds.itervalues(): + vnfi = None + if not GK_STANDALONE_MODE: + vnfi = self._start_vnfd(vnfd) + self.instances[instance_uuid]["vnf_instances"].append(vnfi) + LOG.info("Service started. Instance id: %r" % instance_uuid) + return instance_uuid + + def _start_vnfd(self, vnfd): + """ + Start a single VNFD of this service + :param vnfd: vnfd descriptor dict + :return: + """ + # iterate over all deployment units within each VNFDs + for u in vnfd.get("virtual_deployment_units"): + # 1. get the name of the docker image to start and the assigned DC + docker_name = u.get("vm_image") + target_dc = vnfd.get("dc") + # 2. perform some checks to ensure we can start the container + assert(docker_name is not None) + assert(target_dc is not None) + if not self._check_docker_image_exists(docker_name): + raise Exception("Docker image %r not found. Abort." % docker_name) + # 3. do the dc.startCompute(name="foobar") call to run the container + # TODO consider flavors, and other annotations + vnfi = target_dc.startCompute(GK.get_next_vnf_name(), image=docker_name, flavor_name="small") + # 6. store references to the compute objects in self.instances + return vnfi + + def _unpack_service_package(self): + """ + unzip *.son file and store contents in CATALOG_FOLDER/services// + """ + with zipfile.ZipFile(self.package_file_path, "r") as z: + z.extractall(self.package_content_path) + + 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) + LOG.debug("Loaded NSD: %r" % self.nsd.get("ns_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("vnf_name")] = vnfd + LOG.debug("Loaded VNFD: %r" % vnfd.get("vnf_name")) + + def _load_docker_files(self): + """ + Get all paths to Dockerfiles from MANIFEST.MF and store them in dict. + :return: + """ + if "package_content" in self.manifest: + for df in self.manifest.get("package_content"): + if df.get("content-type") == "application/sonata.docker_files": + docker_path = os.path.join( + self.package_content_path, + make_relative_path(df.get("name"))) + # FIXME: Mapping to docker image names is hardcoded because of the missing mapping in the example package + self.local_docker_files[helper_map_docker_name(df.get("name"))] = docker_path + LOG.debug("Found Dockerfile: %r" % docker_path) + + 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 _download_predefined_dockerimages(self): + """ + If the package contains URLs to pre-build Docker images, we download them with this method. + """ + # TODO implement this if we want to be able to download docker images instead of building them pass + 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(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, 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")))) + + +""" +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, dcs): + for name, vnfd in vnfds.iteritems(): + vnfd["dc"] = list(dcs.itervalues())[0] + """ Resource definitions and API endpoints @@ -56,22 +271,23 @@ class Packages(fr.Resource): """ try: # get file contents - file = request.files['file'] + son_file = request.files['file'] # generate a uuid to reference this package service_uuid = str(uuid.uuid4()) - hash = hashlib.sha1(str(file)).hexdigest() + file_hash = hashlib.sha1(str(son_file)).hexdigest() # ensure that upload folder exists ensure_dir(UPLOAD_FOLDER) upload_path = os.path.join(UPLOAD_FOLDER, "%s.son" % service_uuid) # store *.son file to disk - file.save(upload_path) + son_file.save(upload_path) size = os.path.getsize(upload_path) - # store a reference to the uploaded package in our gatekeeper - GK.packages[service_uuid] = upload_path + # create a service object and register it + s = Service(service_uuid, file_hash, upload_path) + GK.register_service_package(service_uuid, s) # generate the JSON result - return {"service_uuid": service_uuid, "size": size, "sha1": hash, "error": None} + return {"service_uuid": service_uuid, "size": size, "sha1": file_hash, "error": None} except Exception as ex: - logging.exception("Service package upload failed:") + LOG.exception("Service package upload failed:") return {"service_uuid": None, "size": 0, "sha1": None, "error": "upload failed"} def get(self): @@ -79,7 +295,7 @@ class Packages(fr.Resource): Return a list of UUID's of uploaded service packages. :return: dict/list """ - return {"service_uuid_list": list(GK.packages.iterkeys())} + return {"service_uuid_list": list(GK.services.iterkeys())} class Instantiations(fr.Resource): @@ -90,23 +306,29 @@ class Instantiations(fr.Resource): Will return a new UUID to identify the running service instance. :return: UUID """ - # TODO implement method (start real service) + # try to extract the service uuid from the request json_data = request.get_json(force=True) service_uuid = json_data.get("service_uuid") - if service_uuid is not None: - service_instance_uuid = str(uuid.uuid4()) - GK.instantiations[service_instance_uuid] = service_uuid - logging.info("Starting service %r" % service_uuid) + + # lets be a bit fuzzy here to make testing easier + if service_uuid is None and len(GK.services) > 0: + # if we don't get a service uuid, we simple start the first service in the list + service_uuid = list(GK.services.iterkeys())[0] + + if service_uuid in GK.services: + # ok, we have a service uuid, lets start the service + service_instance_uuid = GK.services.get(service_uuid).start_service() return {"service_instance_uuid": service_instance_uuid} - return None + return "Service not found", 404 def get(self): """ Returns a list of UUIDs containing all running services. :return: dict / list """ - # TODO implement method - return {"service_instance_uuid_list": list(GK.instantiations.iterkeys())} + return {"service_instance_list": [ + list(s.instances.iterkeys()) for s in GK.services.itervalues()]} + # create a single, global GK object GK = Gatekeeper() @@ -115,11 +337,12 @@ app = Flask(__name__) app.config['MAX_CONTENT_LENGTH'] = 512 * 1024 * 1024 # 512 MB max upload api = fr.Api(app) # define endpoints -api.add_resource(Packages, '/api/packages/uploads') +api.add_resource(Packages, '/api/packages') api.add_resource(Instantiations, '/api/instantiations') -def start_rest_api(host, port): +def start_rest_api(host, port, datacenters=dict()): + GK.dcs = datacenters # start the Flask server (not the best performance but ok for our use case) app.run(host=host, port=port, @@ -130,13 +353,43 @@ def start_rest_api(host, port): def ensure_dir(name): if not os.path.exists(name): - os.makedirs(name) + os.makedirs(name) + + +def load_yaml(path): + with open(path, "r") as f: + try: + r = yaml.load(f) + except yaml.YAMLError as exc: + LOG.exception("YAML parse error") + r = dict() + return r + + +def make_relative_path(path): + if path.startswith("/"): + return path.replace("/", "", 1) + return path + + +def helper_map_docker_name(name): + """ + Quick hack to fix missing dependency in example package. + """ + # FIXME remove this when package description is fixed + mapping = { + "/docker_files/iperf/Dockerfile": "iperf_docker", + "/docker_files/firewall/Dockerfile": "fw_docker", + "/docker_files/tcpdump/Dockerfile": "tcpdump_docker" + } + return mapping.get(name) if __name__ == '__main__': """ Lets allow to run the API in standalone mode. """ + GK_STANDALONE_MODE = True logging.getLogger("werkzeug").setLevel(logging.INFO) start_rest_api("0.0.0.0", 8000)