| """ |
| Copyright (c) 2015 SONATA-NFV and Paderborn University |
| ALL RIGHTS RESERVED. |
| |
| Licensed under the Apache License, Version 2.0 (the "License"); |
| you may not use this file except in compliance with the License. |
| You may obtain a copy of the License at |
| |
| http://www.apache.org/licenses/LICENSE-2.0 |
| |
| Unless required by applicable law or agreed to in writing, software |
| distributed under the License is distributed on an "AS IS" BASIS, |
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| See the License for the specific language governing permissions and |
| limitations under the License. |
| |
| Neither the name of the SONATA-NFV [, ANY ADDITIONAL AFFILIATION] |
| nor the names of its contributors may be used to endorse or promote |
| products derived from this software without specific prior written |
| permission. |
| |
| This work has been performed in the framework of the SONATA project, |
| funded by the European Commission under Grant number 671517 through |
| the Horizon 2020 and 5G-PPP programmes. The authors would like to |
| acknowledge the contributions of their colleagues of the SONATA |
| partner consortium (www.sonata-nfv.eu). |
| """ |
| """ |
| This module implements a simple REST API that behaves like SONATA's gatekeeper. |
| |
| It is only used to support the development of SONATA's SDK tools and to demonstrate |
| the year 1 version of the emulator until the integration with WP4's orchestrator is done. |
| """ |
| |
| import logging |
| import os |
| import uuid |
| import hashlib |
| import zipfile |
| import yaml |
| from docker import Client as DockerClient |
| from flask import Flask, request |
| import flask_restful as fr |
| from collections import defaultdict |
| |
| 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/") |
| |
| # Enable Dockerfile build functionality |
| BUILD_DOCKERFILE = False |
| |
| # flag to indicate that we run without the emulator (only the bare API for integration testing) |
| GK_STANDALONE_MODE = False |
| |
| # should a new version of an image be pulled even if its available |
| FORCE_PULL = False |
| |
| class Gatekeeper(object): |
| |
| def __init__(self): |
| 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 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.remote_docker_image_urls = dict() |
| self.instances = dict() |
| self.vnfname2num = dict() |
| |
| 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() |
| # 3. prepare container images (e.g. download or build Dockerfile) |
| if BUILD_DOCKERFILE: |
| self._load_docker_files() |
| self._build_images_from_dockerfiles() |
| else: |
| self._load_docker_urls() |
| self._pull_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) |
| |
| # 3. Configure the chaining of the network functions (currently only E-Line links supported) |
| nfid2name = defaultdict(lambda :"NotExistingNode", |
| reduce(lambda x,y: dict(x, **y), |
| map(lambda d:{d["vnf_id"]:d["vnf_name"]}, |
| self.nsd["network_functions"]))) |
| |
| vlinks = self.nsd["virtual_links"] |
| fwd_links = self.nsd["forwarding_graphs"][0]["constituent_virtual_links"] |
| eline_fwd_links = [l for l in vlinks if (l["id"] in fwd_links) and (l["connectivity_type"] == "E-Line")] |
| |
| cookie = 1 # not clear why this is needed - to check with Steven |
| for link in eline_fwd_links: |
| src_node, src_port = link["connection_points_reference"][0].split(":") |
| dst_node, dst_port = link["connection_points_reference"][1].split(":") |
| |
| srcname = nfid2name[src_node] |
| dstname = nfid2name[dst_node] |
| LOG.debug("src name: "+srcname+" dst name: "+dstname) |
| |
| if (srcname in self.vnfds) and (dstname in self.vnfds) : |
| network = self.vnfds[srcname].get("dc").net # there should be a cleaner way to find the DCNetwork |
| src_vnf = self.vnfname2num[srcname] |
| dst_vnf = self.vnfname2num[dstname] |
| ret = network.setChain(src_vnf, dst_vnf, vnf_src_interface=src_port, vnf_dst_interface=dst_port, bidirectional = True, cmd="add-flow", cookie = cookie) |
| cookie += 1 |
| |
| # 4. run the emulator specific entrypoint scripts in the VNFIs of this service instance |
| self._trigger_emulator_start_scripts_in_vnfis(self.instances[instance_uuid]["vnf_instances"]) |
| |
| 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 |
| vnf_name = vnfd.get("name") |
| if vnf_name not in self.remote_docker_image_urls: |
| raise Exception("No image name for %r found. Abort." % vnf_name) |
| docker_name = self.remote_docker_image_urls.get(vnf_name) |
| 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 |
| intfs = vnfd.get("connection_points") |
| self.vnfname2num[vnf_name] = GK.get_next_vnf_name() |
| LOG.info("VNF "+vnf_name+" mapped to "+self.vnfname2num[vnf_name]+" on dc "+str(vnfd.get("dc"))) |
| vnfi = target_dc.startCompute(self.vnfname2num[vnf_name], network=intfs, image=docker_name, flavor_name="small") |
| return vnfi |
| |
| def _trigger_emulator_start_scripts_in_vnfis(self, vnfi_list): |
| for vnfi in vnfi_list: |
| config = vnfi.dcinfo.get("Config", dict()) |
| env = config.get("Env", list()) |
| for env_var in env: |
| if "SON_EMU_CMD=" in env_var: |
| cmd = str(env_var.split("=")[1]) |
| LOG.info("Executing entrypoint script in %r: %r" % (vnfi.name, cmd)) |
| vnfi.cmdPrint(cmd) |
| |
| def _unpack_service_package(self): |
| """ |
| unzip *.son file and store contents in CATALOG_FOLDER/services/<service_uuid>/ |
| """ |
| LOG.info("Unzipping: %r" % self.package_file_path) |
| 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("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_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: |
| """ |
| for k, v in self.vnfds.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(name=url)) > 0: |
| LOG.debug("Image %r present. Skipping pull." % url) |
| continue |
| LOG.info("Pulling image: %r" % url) |
| dc.pull(url, |
| insecure_registry=True) |
| |
| 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 |
| """ |
| |
| |
| class Packages(fr.Resource): |
| |
| def post(self): |
| """ |
| Upload a *.son service package to the dummy gatekeeper. |
| |
| We expect request with a *.son file and store it in UPLOAD_FOLDER |
| :return: UUID |
| """ |
| try: |
| # get file contents |
| print(request.files) |
| # lets search for the package in the request |
| if "package" in request.files: |
| son_file = request.files["package"] |
| # elif "file" in request.files: |
| # son_file = request.files["file"] |
| else: |
| return {"service_uuid": None, "size": 0, "sha1": None, "error": "upload failed. file not found."}, 500 |
| # generate a uuid to reference this package |
| service_uuid = str(uuid.uuid4()) |
| 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 |
| son_file.save(upload_path) |
| size = os.path.getsize(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": file_hash, "error": None} |
| except Exception as ex: |
| LOG.exception("Service package upload failed:") |
| return {"service_uuid": None, "size": 0, "sha1": None, "error": "upload failed"}, 500 |
| |
| def get(self): |
| """ |
| Return a list of UUID's of uploaded service packages. |
| :return: dict/list |
| """ |
| return {"service_uuid_list": list(GK.services.iterkeys())} |
| |
| |
| class Instantiations(fr.Resource): |
| |
| def post(self): |
| """ |
| Instantiate a service specified by its UUID. |
| Will return a new UUID to identify the running service instance. |
| :return: UUID |
| """ |
| # try to extract the service uuid from the request |
| json_data = request.get_json(force=True) |
| service_uuid = json_data.get("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 "Service not found", 404 |
| |
| def get(self): |
| """ |
| Returns a list of UUIDs containing all running services. |
| :return: dict / list |
| """ |
| return {"service_instance_list": [ |
| list(s.instances.iterkeys()) for s in GK.services.itervalues()]} |
| |
| |
| # create a single, global GK object |
| GK = Gatekeeper() |
| # setup Flask |
| 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, '/packages') |
| api.add_resource(Instantiations, '/instantiations') |
| |
| |
| 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, |
| debug=True, |
| use_reloader=False # this is needed to run Flask in a non-main thread |
| ) |
| |
| |
| def ensure_dir(name): |
| if not os.path.exists(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("file://"): |
| path = path.replace("file://", "", 1) |
| if path.startswith("/"): |
| path = path.replace("/", "", 1) |
| return path |
| |
| |
| 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) |
| |