add extra startup arg for cadvisor and reset subnets in dummygatekeeper
[osm/vim-emu.git] / src / emuvim / api / sonata / dummygatekeeper.py
index 6ec5a65..5214146 100755 (executable)
@@ -47,6 +47,7 @@ import pkg_resources
 from subprocess import Popen
 from random import randint
 import ipaddress
+import copy
 
 logging.basicConfig()
 LOG = logging.getLogger("sonata-dummy-gatekeeper")
@@ -73,7 +74,14 @@ DEPLOY_SAP = False
 # flag to indicate if we use bidirectional forwarding rules in the automatic chaining process
 BIDIRECTIONAL_CHAIN = False
 
+# override the management interfaces in the descriptors with default docker0 interfaces in the containers
+USE_DOCKER_MGMT = False
 
+# automatically deploy uploaded packages (no need to execute son-access deploy --latest separately)
+AUTO_DEPLOY = False
+
+# and also automatically terminate any other running services
+AUTO_DELETE = False
 
 def generate_subnets(prefix, base, subnet_size=50, mask=24):
     # Generate a list of ipaddress in subnets
@@ -83,15 +91,15 @@ def generate_subnets(prefix, base, subnet_size=50, mask=24):
         r.append(ipaddress.ip_network(unicode(subnet)))
     return r
 # private subnet definitions for the generated interfaces
-# 10.0.xx.0/24
-SAP_SUBNETS = generate_subnets('10.10', 0, subnet_size=50, mask=24)
-# 10.1.xx.0/24
+# 10.10.xxx.0/24
+SAP_SUBNETS = generate_subnets('10.10', 0, subnet_size=50, mask=30)
+# 10.20.xxx.0/30
 ELAN_SUBNETS = generate_subnets('10.20', 0, subnet_size=50, mask=24)
-# 10.2.xx.0/30
+# 10.30.xxx.0/30
 ELINE_SUBNETS = generate_subnets('10.30', 0, subnet_size=50, mask=30)
 
-
-
+# path to the VNFD for the SAP VNF that is deployed as internal SAP point
+SAP_VNFD=None
 
 class Gatekeeper(object):
 
@@ -242,6 +250,12 @@ class Service(object):
         for v in vnf_instances:
             self._stop_vnfi(v)
 
+        for sap_name in self.saps_ext:
+            ext_sap = self.saps[sap_name]
+            target_dc = ext_sap.get("dc")
+            target_dc.removeExternalSAP(sap_name, ext_sap['net'])
+            LOG.info("Stopping the SAP instance: %r in DC %r" % (sap_name, target_dc))
+
         if not GK_STANDALONE_MODE:
             # remove placement?
             # self._remove_placement(RoundRobinPlacement)
@@ -294,23 +308,66 @@ class Service(object):
             mem_lim = int(mem_limit)
             cpu_period, cpu_quota = self._calculate_cpu_cfs_values(float(cpu_bw))
 
-            # 4. do the dc.startCompute(name="foobar") call to run the container
+            vnf_name2id = defaultdict(lambda: "NotExistingNode",
+                                      reduce(lambda x, y: dict(x, **y),
+                                             map(lambda d: {d["vnf_name"]: d["vnf_id"]},
+                                                 self.nsd["network_functions"])))
+
+            # check if we need to deploy the management ports (defined as type:management both on in the vnfd and nsd)
+            intfs = vnfd.get("connection_points", [])
+            mgmt_intf_names = []
+            if USE_DOCKER_MGMT:
+                vnf_id = vnf_name2id[vnf_name]
+                mgmt_intfs = [vnf_id + ':' + intf['id'] for intf in intfs if intf.get('type') == 'management']
+                # check if any of these management interfaces are used in a management-type network in the nsd
+                for nsd_intf_name in mgmt_intfs:
+                    vlinks = [ l["connection_points_reference"] for l in self.nsd.get("virtual_links", [])]
+                    for link in vlinks:
+                        if nsd_intf_name in link and self.check_mgmt_interface(link):
+                            # this is indeed a management interface and can be skipped
+                            vnf_id, vnf_interface, vnf_sap_docker_name = parse_interface(nsd_intf_name)
+                            found_interfaces = [intf for intf in intfs if intf.get('id') == vnf_interface]
+                            intfs.remove(found_interfaces[0])
+                            mgmt_intf_names.append(vnf_interface)
+
+            # 4. generate the volume paths for the docker container
+            volumes=list()
+            # a volume to extract log files
+            docker_log_path = "/tmp/results/%s/%s"%(self.uuid,vnf_name)
+            LOG.debug("LOG path for vnf %s is %s."%(vnf_name,docker_log_path))
+            if not os.path.exists(docker_log_path):
+                LOG.debug("Creating folder %s"%docker_log_path)
+                os.makedirs(docker_log_path)
+
+            volumes.append(docker_log_path+":/mnt/share/")
+
+
+            # 5. do the dc.startCompute(name="foobar") call to run the container
             # TODO consider flavors, and other annotations
-            intfs = vnfd.get("connection_points")
-
             # TODO: get all vnf id's from the nsd for this vnfd and use those as dockername
             # use the vnf_id in the nsd as docker name
             # so deployed containers can be easily mapped back to the nsd
-            vnf_name2id = defaultdict(lambda: "NotExistingNode",
-                                          reduce(lambda x, y: dict(x, **y),
-                                                 map(lambda d: {d["vnf_name"]: d["vnf_id"]},
-                                                     self.nsd["network_functions"])))
+
             self.vnf_name2docker_name[vnf_name] = vnf_name2id[vnf_name]
 
             LOG.info("Starting %r as %r in DC %r" % (vnf_name, self.vnf_name2docker_name[vnf_name], vnfd.get("dc")))
             LOG.debug("Interfaces for %r: %r" % (vnf_name, intfs))
-            vnfi = target_dc.startCompute(self.vnf_name2docker_name[vnf_name], network=intfs, image=docker_name, flavor_name="small",
-                    cpu_quota=cpu_quota, cpu_period=cpu_period, cpuset=cpu_list, mem_limit=mem_lim)
+            vnfi = target_dc.startCompute(
+                    self.vnf_name2docker_name[vnf_name],
+                    network=intfs,
+                    image=docker_name,
+                    flavor_name="small",
+                    cpu_quota=cpu_quota,
+                    cpu_period=cpu_period,
+                    cpuset=cpu_list,
+                    mem_limit=mem_lim,
+                    volumes=volumes)
+
+            # rename the docker0 interfaces (eth0) to the management port name defined in the VNFD
+            if USE_DOCKER_MGMT:
+                for intf_name in mgmt_intf_names:
+                    self._vnf_reconfigure_network(vnfi, 'eth0', new_name=intf_name)
+
             return vnfi
 
     def _stop_vnfi(self, vnfi):
@@ -322,6 +379,7 @@ class Service(object):
         # Find the correct datacenter
         status = vnfi.getStatus()
         dc = vnfi.datacenter
+
         # stop the vnfi
         LOG.info("Stopping the vnf instance contained in %r in DC %r" % (status["name"], dc))
         dc.stopCompute(status["name"])
@@ -343,7 +401,7 @@ class Service(object):
         return None
 
     @staticmethod
-    def _vnf_reconfigure_network(vnfi, if_name, net_str):
+    def _vnf_reconfigure_network(vnfi, if_name, net_str=None, new_name=None):
         """
         Reconfigure the network configuration of a specific interface
         of a running container.
@@ -352,12 +410,22 @@ class Service(object):
         :param net_str: network configuration string, e.g., 1.2.3.4/24
         :return:
         """
-        intf = vnfi.intf(intf=if_name)
-        if intf is not None:
-            intf.setIP(net_str)
-            LOG.debug("Reconfigured network of %s:%s to %r" % (vnfi.name, if_name, net_str))
-        else:
-            LOG.warning("Interface not found: %s:%s. Network reconfiguration skipped." % (vnfi.name, if_name))
+
+        # assign new ip address
+        if net_str is not None:
+            intf = vnfi.intf(intf=if_name)
+            if intf is not None:
+                intf.setIP(net_str)
+                LOG.debug("Reconfigured network of %s:%s to %r" % (vnfi.name, if_name, net_str))
+            else:
+                LOG.warning("Interface not found: %s:%s. Network reconfiguration skipped." % (vnfi.name, if_name))
+
+        if new_name is not None:
+            vnfi.cmd('ip link set', if_name, 'down')
+            vnfi.cmd('ip link set', if_name, 'name', new_name)
+            vnfi.cmd('ip link set', new_name, 'up')
+            LOG.debug("Reconfigured interface name of %s:%s to %s" % (vnfi.name, if_name, new_name))
+
 
 
     def _trigger_emulator_start_scripts_in_vnfis(self, vnfi_list):
@@ -423,7 +491,11 @@ class Service(object):
 
     def _load_saps(self):
         # create list of all SAPs
-        SAPs = [p for p in self.nsd["connection_points"]]
+        # 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
@@ -432,7 +504,7 @@ class Service(object):
             sap["type"] = sap.get("type", 'internal')
 
             # Each Service Access Point (connection_point) in the nsd is an IP address on the host
-            if sap.get["type"] == "external":
+            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}
@@ -442,9 +514,12 @@ class Service(object):
                     {"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":
+            elif sap["type"] == "internal" or sap["type"] == "management":
                 # add SAP to self.vnfds
-                sapfile = pkg_resources.resource_filename(__name__, "sap_vnfd.yml")
+                if SAP_VNFD is None:
+                    sapfile = pkg_resources.resource_filename(__name__, "sap_vnfd.yml")
+                else:
+                    sapfile = SAP_VNFD
                 sap_vnfd = load_yaml(sapfile)
                 sap_vnfd["connection_points"][0]["id"] = sap_interface
                 sap_vnfd["name"] = sap_docker_name
@@ -463,6 +538,9 @@ class Service(object):
         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
@@ -473,7 +551,7 @@ class Service(object):
         elif sap["type"] == "external":
             target_dc = sap.get("dc")
             # add interface to dc switch
-            target_dc.attachExternalSAP(sap['name'], str(sap['net']))
+            target_dc.attachExternalSAP(sap['name'], sap['net'])
 
     def _connect_elines(self, eline_fwd_links, instance_uuid):
         """
@@ -486,11 +564,15 @@ class Service(object):
         # 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))
@@ -498,26 +580,28 @@ class Service(object):
 
             elif src_sap_id in self.saps_ext:
                 src_id = src_sap_id
-                src_if_name = 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[1]), sap_net.prefixlen)
+                    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
-                dst_if_name = 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[1]), sap_net.prefixlen)
+                    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
 
@@ -560,9 +644,12 @@ class Service(object):
         :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)
@@ -594,7 +681,7 @@ class Service(object):
 
                 vnf_name = self.vnf_id2vnf_name[vnf_id]
                 LOG.debug(
-                    "Setting up E-LAN link. %s(%s:%s) -> %s" % (
+                    "Setting up E-LAN interface. %s(%s:%s) -> %s" % (
                         vnf_name, vnf_id, intf_name, ip_address))
 
                 if vnf_name in self.vnfds:
@@ -740,6 +827,12 @@ class Service(object):
             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
 """
@@ -816,7 +909,7 @@ class RoundRobinDcPlacementWithSAPs(object):
                 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_id]['dc'] = dc
+                    saps[intf_sap_id]['dc'] = dc
 
 
 
@@ -859,9 +952,27 @@ class Packages(fr.Resource):
                 with open(upload_path, 'wb') as f:
                     f.write(son_file)
             size = os.path.getsize(upload_path)
+
+            # first stop and delete any other running services
+            if AUTO_DELETE:
+                service_list = copy.copy(GK.services)
+                for service_uuid in service_list:
+                    instances_list = copy.copy(GK.services[service_uuid].instances)
+                    for instance_uuid in instances_list:
+                        # valid service and instance UUID, stop service
+                        GK.services.get(service_uuid).stop_service(instance_uuid)
+                        LOG.info("service instance with uuid %r stopped." % instance_uuid)
+
             # create a service object and register it
             s = Service(service_uuid, file_hash, upload_path)
             GK.register_service_package(service_uuid, s)
+
+            # automatically deploy the service
+            if AUTO_DEPLOY:
+                # ok, we have a service uuid, lets start the service
+                reset_subnets()
+                service_instance_uuid = GK.services.get(service_uuid).start_service()
+
             # generate the JSON result
             return {"service_uuid": service_uuid, "size": size, "sha1": file_hash, "error": None}, 201
         except Exception as ex:
@@ -885,7 +996,7 @@ class Instantiations(fr.Resource):
         Will return a new UUID to identify the running service instance.
         :return: UUID
         """
-        LOG.info("POST /instantiations (or /reqeusts) called")
+        LOG.info("POST /instantiations (or /requests) called")
         # try to extract the service uuid from the request
         json_data = request.get_json(force=True)
         service_uuid = json_data.get("service_uuid")
@@ -959,10 +1070,6 @@ api.add_resource(Instantiations, '/instantiations', '/api/v2/instantiations', '/
 api.add_resource(Exit, '/emulator/exit')
 
 
-#def initialize_GK():
-#    global GK
-#    GK = Gatekeeper()
-
 
 def start_rest_api(host, port, datacenters=dict()):
     GK.dcs = datacenters
@@ -1025,6 +1132,18 @@ def parse_interface(interface_name):
 
     return vnf_id, vnf_interface, vnf_sap_docker_name
 
+def reset_subnets():
+    # private subnet definitions for the generated interfaces
+    # 10.10.xxx.0/24
+    global SAP_SUBNETS
+    SAP_SUBNETS = generate_subnets('10.10', 0, subnet_size=50, mask=30)
+    # 10.20.xxx.0/30
+    global ELAN_SUBNETS
+    ELAN_SUBNETS = generate_subnets('10.20', 0, subnet_size=50, mask=24)
+    # 10.30.xxx.0/30
+    global ELINE_SUBNETS
+    ELINE_SUBNETS = generate_subnets('10.30', 0, subnet_size=50, mask=30)
+
 if __name__ == '__main__':
     """
     Lets allow to run the API in standalone mode.