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")
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):
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):
"""
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()
-
+ 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):
: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)
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
# 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 = vnfd.get("vnf_name")
+ 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)
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
+ 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.
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"))
+ LOG.debug("Loaded NSD: %r" % self.nsd.get("name"))
def _load_vnfd(self):
"""
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"))
+ self.vnfds[vnfd.get("name")] = vnfd
+ LOG.debug("Loaded VNFD: %r" % vnfd.get("name"))
def _load_docker_files(self):
"""
self.package_content_path,
make_relative_path(vm_image))
self.local_docker_files[k] = docker_path
- LOG.debug("Found Dockerfile: %r" % 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):
"""
LOG.debug("DOCKER BUILD: %s" % line)
LOG.info("Docker image created: %s" % k)
- def _download_predefined_dockerimages(self):
+ def _pull_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
+ 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):
"""