bug 687 fixing pre and post scaling actions
[osm/LCM.git] / osm_lcm / ns.py
index d6318ad..b172c2f 100644 (file)
@@ -867,11 +867,13 @@ class NsLcm(LcmBase):
             number_to_configure = 0
 
             def deploy_charm(vnf_index, vdu_id, vdu_name, vdu_count_index, charm_params, n2vc_info):
-                """An inner function to deploy the charm from either vnf or vdu
-                vnf_index is mandatory. vdu_id can be None for a vnf configuration or the id for vdu configuration
+                """An inner function to deploy the charm from either ns, vnf or vdu
+                For ns both vnf_index and vdu_id are None.
+                For vnf only vdu_id is None
+                For vdu both vnf_index and vdu_id contain a value
                 """
-                if not charm_params["rw_mgmt_ip"]:
-                    raise LcmException("vnfd/vdu has not management ip address to configure it")
+                if not charm_params.get("rw_mgmt_ip") and vnf_index:  # if NS skip mgmt_ip checking
+                    raise LcmException("ns/vnfd/vdu has not management ip address to configure it")
                 # Login to the VCA.
                 # if number_to_configure == 0:
                 #     self.logger.debug("Logging into N2VC...")
@@ -883,7 +885,8 @@ class NsLcm(LcmBase):
 
                 # Note: The charm needs to exist on disk at the location
                 # specified by charm_path.
-                base_folder = vnfd["_admin"]["storage"]
+                descriptor = vnfd if vnf_index else nsd
+                base_folder = descriptor["_admin"]["storage"]
                 storage_params = self.fs.get_params()
                 charm_path = "{}{}/{}/charms/{}".format(
                     storage_params["path"],
@@ -895,11 +898,9 @@ class NsLcm(LcmBase):
                 # ns_name will be ignored in the current version of N2VC
                 # but will be implemented for the next point release.
                 model_name = nsr_id
-                if vdu_id:
-                    vdu_id_text = vdu_id + "-"
-                else:
-                    vdu_id_text = "-"
-                application_name = self.n2vc.FormatApplicationName(nsr_name, vnf_index, vdu_id_text)
+                vdu_id_text = (str(vdu_id) if vdu_id else "") + "-"
+                vnf_index_text = (str(vnf_index) if vnf_index else "") + "-"
+                application_name = self.n2vc.FormatApplicationName(nsr_name, vnf_index_text, vdu_id_text)
 
                 vca_index = len(vca_deployed_list)
                 # trunk name and add two char index at the end to ensure that it is unique. It is assumed no more than
@@ -934,7 +935,7 @@ class NsLcm(LcmBase):
                     self.n2vc.DeployCharms(
                         model_name,          # The network service name
                         application_name,    # The application name
-                        vnfd,                # The vnf descriptor
+                        descriptor,          # The vnf/nsd descriptor
                         charm_path,          # Path to charm
                         charm_params,        # Runtime params, like mgmt ip
                         {},                  # for native charms only
@@ -1023,6 +1024,37 @@ class NsLcm(LcmBase):
                                          charm_params, n2vc_info)
                             number_to_configure += 1
 
+            # Check if this NS has a charm configuration
+
+            ns_config = nsd.get("ns-configuration")
+            if ns_config and ns_config.get("juju"):
+                proxy_charm = ns_config["juju"]["charm"]
+
+                if proxy_charm:
+                    step = "connecting to N2VC to configure ns"
+                    # TODO is NS magmt IP address needed?
+
+                    # Get additional parameters
+                    additional_params = {}
+                    if db_nsr.get("additionalParamsForNs"):
+                        additional_params = db_nsr["additionalParamsForNs"].copy()
+                    for k, v in additional_params.items():
+                        if isinstance(v, str) and v.startswith("!!yaml "):
+                            additional_params[k] = yaml.safe_load(v[7:])
+
+                    # additional_params["rw_mgmt_ip"] = db_nsr["ip-address"]
+                    charm_params = {
+                        "user_values": additional_params,
+                        # "rw_mgmt_ip": db_nsr["ip-address"],
+                        "initial-config-primitive": ns_config.get('initial-config-primitive') or {}
+                    }
+
+                    # Login to the VCA. If there are multiple calls to login(),
+                    # subsequent calls will be a nop and return immediately.
+                    await self.n2vc.login()
+                    deploy_charm(None, None, None, None, charm_params, n2vc_info)
+                    number_to_configure += 1
+
             db_nsr_update["operational-status"] = "running"
             configuration_failed = False
             if number_to_configure:
@@ -1171,6 +1203,112 @@ class NsLcm(LcmBase):
             await asyncio.sleep(10)
             timeout -= 10
 
+    # Check if this VNFD has a configured terminate action
+    def _has_terminate_config_primitive(self, vnfd):
+        vnf_config = vnfd.get("vnf-configuration")
+        if vnf_config and vnf_config.get("terminate-config-primitive"):
+            return True
+        else:
+            return False
+
+    # Get a numerically sorted list of the sequences for this VNFD's terminate action
+    def _get_terminate_config_primitive_seq_list(self, vnfd):
+        # No need to check for existing primitive twice, already done before
+        vnf_config = vnfd.get("vnf-configuration")
+        seq_list = vnf_config.get("terminate-config-primitive")
+        # Get all 'seq' tags in seq_list, order sequences numerically, ascending.
+        seq_list_sorted = sorted(seq_list, key=lambda x: int(x['seq']))
+        return seq_list_sorted
+
+    @staticmethod
+    def _create_nslcmop(nsr_id, operation, params):
+        """
+        Creates a ns-lcm-opp content to be stored at database.
+        :param nsr_id: internal id of the instance
+        :param operation: instantiate, terminate, scale, action, ...
+        :param params: user parameters for the operation
+        :return: dictionary following SOL005 format
+        """
+        # Raise exception if invalid arguments
+        if not (nsr_id and operation and params):
+            raise LcmException(
+                "Parameters 'nsr_id', 'operation' and 'params' needed to create primitive not provided")
+        now = time()
+        _id = str(uuid4())
+        nslcmop = {
+            "id": _id,
+            "_id": _id,
+            # COMPLETED,PARTIALLY_COMPLETED,FAILED_TEMP,FAILED,ROLLING_BACK,ROLLED_BACK
+            "operationState": "PROCESSING",
+            "statusEnteredTime": now,
+            "nsInstanceId": nsr_id,
+            "lcmOperationType": operation,
+            "startTime": now,
+            "isAutomaticInvocation": False,
+            "operationParams": params,
+            "isCancelPending": False,
+            "links": {
+                "self": "/osm/nslcm/v1/ns_lcm_op_occs/" + _id,
+                "nsInstance": "/osm/nslcm/v1/ns_instances/" + nsr_id,
+            }
+        }
+        return nslcmop
+
+    # Create a primitive with params from VNFD
+    # - Called from terminate() before deleting instance
+    # - Calls action() to execute the primitive
+    async def _terminate_action(self, db_nslcmop, nslcmop_id, nsr_id):
+        logging_text = "Task ns={} _terminate_action={} ".format(nsr_id, nslcmop_id)
+        db_vnfds = {}
+        db_vnfrs_list = self.db.get_list("vnfrs", {"nsr-id-ref": nsr_id})
+        # Loop over VNFRs
+        for vnfr in db_vnfrs_list:
+            vnfd_id = vnfr["vnfd-id"]
+            vnf_index = vnfr["member-vnf-index-ref"]
+            if vnfd_id not in db_vnfds:
+                step = "Getting vnfd={} id='{}' from db".format(vnfd_id, vnfd_id)
+                vnfd = self.db.get_one("vnfds", {"_id": vnfd_id})
+                db_vnfds[vnfd_id] = vnfd
+            vnfd = db_vnfds[vnfd_id]
+            if not self._has_terminate_config_primitive(vnfd):
+                continue
+            # Get the primitive's sorted sequence list
+            seq_list = self._get_terminate_config_primitive_seq_list(vnfd)
+            for seq in seq_list:
+                # For each sequence in list, call terminate action
+                step = "Calling terminate action for vnf_member_index={} primitive={}".format(
+                    vnf_index, seq.get("name"))
+                self.logger.debug(logging_text + step)
+                # Create the primitive for each sequence
+                operation = "action"
+                # primitive, i.e. "primitive": "touch"
+                primitive = seq.get('name')
+                primitive_params = {}
+                params = {
+                    "member_vnf_index": vnf_index,
+                    "primitive": primitive,
+                    "primitive_params": primitive_params,
+                }
+                nslcmop_primitive = self._create_nslcmop(nsr_id, operation, params)
+                # Get a copy of db_nslcmop 'admin' part
+                db_nslcmop_action = {"_admin": deepcopy(db_nslcmop["_admin"])}
+                # Update db_nslcmop with the primitive data
+                db_nslcmop_action.update(nslcmop_primitive)
+                # Create a new db entry for the created primitive, returns the new ID.
+                # (The ID is normally obtained from Kafka.)
+                nslcmop_terminate_action_id = self.db.create(
+                    "nslcmops", db_nslcmop_action)
+                # Execute the primitive
+                nslcmop_operation_state, nslcmop_operation_state_detail = await self.action(
+                    nsr_id, nslcmop_terminate_action_id)
+                # Launch Exception if action() returns other than ['COMPLETED', 'PARTIALLY_COMPLETED']
+                nslcmop_operation_states_ok = ['COMPLETED', 'PARTIALLY_COMPLETED']
+                if (nslcmop_operation_state not in nslcmop_operation_states_ok):
+                    raise LcmException(
+                        "terminate_primitive_action for vnf_member_index={}",
+                        " primitive={} fails with error {}".format(
+                            vnf_index, seq.get("name"), nslcmop_operation_state_detail))
+
     async def terminate(self, nsr_id, nslcmop_id):
         logging_text = "Task ns={} terminate={} ".format(nsr_id, nslcmop_id)
         self.logger.debug(logging_text + "Enter")
@@ -1194,6 +1332,8 @@ class NsLcm(LcmBase):
                 return
             # #TODO check if VIM is creating and wait
             # RO_vim_id = db_vim["_admin"]["deployed"]["RO"]
+            # Call internal terminate action
+            await self._terminate_action(db_nslcmop, nslcmop_id, nsr_id)
 
             db_nsr_update["operational-status"] = "terminating"
             db_nsr_update["config-status"] = "terminating"
@@ -1381,7 +1521,7 @@ class NsLcm(LcmBase):
                 if db_nslcmop["operationParams"].get("autoremove"):
                     autoremove = True
 
-        except (ROclient.ROClientException, DbException) as e:
+        except (ROclient.ROClientException, DbException, LcmException) as e:
             self.logger.error(logging_text + "Exit Exception {}".format(e))
             exc = e
         except asyncio.CancelledError:
@@ -1514,6 +1654,7 @@ class NsLcm(LcmBase):
         db_nsr_update = {"_admin.nslcmop": nslcmop_id}
         db_nslcmop_update = {}
         nslcmop_operation_state = None
+        nslcmop_operation_state_detail = None
         exc = None
         try:
             step = "Getting information from database"
@@ -1521,15 +1662,22 @@ class NsLcm(LcmBase):
             db_nsr = self.db.get_one("nsrs", {"_id": nsr_id})
 
             nsr_deployed = db_nsr["_admin"].get("deployed")
-            vnf_index = db_nslcmop["operationParams"]["member_vnf_index"]
+            vnf_index = db_nslcmop["operationParams"].get("member_vnf_index")
             vdu_id = db_nslcmop["operationParams"].get("vdu_id")
             vdu_count_index = db_nslcmop["operationParams"].get("vdu_count_index")
             vdu_name = db_nslcmop["operationParams"].get("vdu_name")
 
-            step = "Getting vnfr from database"
-            db_vnfr = self.db.get_one("vnfrs", {"member-vnf-index-ref": vnf_index, "nsr-id-ref": nsr_id})
-            step = "Getting vnfd from database"
-            db_vnfd = self.db.get_one("vnfds", {"_id": db_vnfr["vnfd-id"]})
+            if vnf_index:
+                step = "Getting vnfr from database"
+                db_vnfr = self.db.get_one("vnfrs", {"member-vnf-index-ref": vnf_index, "nsr-id-ref": nsr_id})
+                step = "Getting vnfd from database"
+                db_vnfd = self.db.get_one("vnfds", {"_id": db_vnfr["vnfd-id"]})
+            else:
+                if db_nsr.get("nsd"):
+                    db_nsd = db_nsr.get("nsd")    # TODO this will be removed
+                else:
+                    step = "Getting nsd from database"
+                    db_nsd = self.db.get_one("nsds", {"_id": db_nsr["nsd-id"]})
 
             # look if previous tasks in process
             task_name, task_dependency = self.lcm_tasks.lookfor_related("ns", nsr_id, nslcmop_id)
@@ -1560,23 +1708,34 @@ class NsLcm(LcmBase):
                             if config_primitive["name"] == primitive:
                                 config_primitive_desc = config_primitive
                                 break
-            for config_primitive in db_vnfd.get("vnf-configuration", {}).get("config-primitive", ()):
-                if config_primitive["name"] == primitive:
-                    config_primitive_desc = config_primitive
-                    break
+            elif vnf_index:
+                for config_primitive in db_vnfd.get("vnf-configuration", {}).get("config-primitive", ()):
+                    if config_primitive["name"] == primitive:
+                        config_primitive_desc = config_primitive
+                        break
+            else:
+                for config_primitive in db_nsd.get("ns-configuration", {}).get("config-primitive", ()):
+                    if config_primitive["name"] == primitive:
+                        config_primitive_desc = config_primitive
+                        break
+
             if not config_primitive_desc:
-                raise LcmException("Primitive {} not found at vnf-configuration:config-primitive or vdu:"
-                                   "vdu-configuration:config-primitive".format(primitive))
+                raise LcmException("Primitive {} not found at [ns|vnf|vdu]-configuration:config-primitive ".
+                                   format(primitive))
 
-            vnfr_params = {}
-            if db_vnfr.get("additionalParamsForVnf"):
-                vnfr_params.update(db_vnfr["additionalParamsForVnf"])
+            desc_params = {}
+            if vnf_index:
+                if db_vnfr.get("additionalParamsForVnf"):
+                    desc_params.update(db_vnfr["additionalParamsForVnf"])
+            else:
+                if db_nsr.get("additionalParamsForVnf"):
+                    desc_params.update(db_nsr["additionalParamsForNs"])
 
             # TODO check if ns is in a proper status
             result, result_detail = await self._ns_execute_primitive(
                 nsr_deployed, vnf_index, vdu_id, vdu_name, vdu_count_index, primitive,
-                self._map_primitive_params(config_primitive_desc, primitive_params, vnfr_params))
-            db_nslcmop_update["detailed-status"] = result_detail
+                self._map_primitive_params(config_primitive_desc, primitive_params, desc_params))
+            db_nslcmop_update["detailed-status"] = nslcmop_operation_state_detail = result_detail
             db_nslcmop_update["operationState"] = nslcmop_operation_state = result
             db_nslcmop_update["statusEnteredTime"] = time()
             self.logger.debug(logging_text + " task Done with result {} {}".format(result, result_detail))
@@ -1593,7 +1752,8 @@ class NsLcm(LcmBase):
             self.logger.critical(logging_text + "Exit Exception {} {}".format(type(e).__name__, e), exc_info=True)
         finally:
             if exc and db_nslcmop:
-                db_nslcmop_update["detailed-status"] = "FAILED {}: {}".format(step, exc)
+                db_nslcmop_update["detailed-status"] = nslcmop_operation_state_detail = \
+                    "FAILED {}: {}".format(step, exc)
                 db_nslcmop_update["operationState"] = nslcmop_operation_state = "FAILED"
                 db_nslcmop_update["statusEnteredTime"] = time()
             try:
@@ -1614,6 +1774,7 @@ class NsLcm(LcmBase):
                     self.logger.error(logging_text + "kafka_write notification Exception {}".format(e))
             self.logger.debug(logging_text + "Exit")
             self.lcm_tasks.remove("ns", nsr_id, nslcmop_id, "ns_action")
+            return nslcmop_operation_state, nslcmop_operation_state_detail
 
     async def scale(self, nsr_id, nslcmop_id):
         logging_text = "Task ns={} scale={} ".format(nsr_id, nslcmop_id)
@@ -1769,7 +1930,7 @@ class NsLcm(LcmBase):
                                 "[vnf-config-primitive-name-ref='{}'] does not match any vnf-configuration:config-"
                                 "primitive".format(scaling_group, config_primitive))
 
-                        vnfr_params = {"<VDU_SCALE_INFO>": vdu_scaling_info}
+                        vnfr_params = {"VDU_SCALE_INFO": vdu_scaling_info}
                         if db_vnfr.get("additionalParamsForVnf"):
                             vnfr_params.update(db_vnfr["additionalParamsForVnf"])