feature 5669 provide machine_spec for full charm support
[osm/LCM.git] / osm_lcm / ns.py
index 92b6406..359bf11 100644 (file)
@@ -866,7 +866,7 @@ class NsLcm(LcmBase):
             # The parameters we'll need to deploy a charm
             number_to_configure = 0
 
-            def deploy_charm(vnf_index, vdu_id, vdu_name, vdu_count_index, charm_params, n2vc_info):
+            def deploy_charm(vnf_index, vdu_id, vdu_name, vdu_count_index, charm_params, n2vc_info, native_charm):
                 """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
@@ -874,6 +874,12 @@ class NsLcm(LcmBase):
                 """
                 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")
+
+                machine_spec = {}
+                if native_charm:
+                    machine_spec["username"] = charm_params.get("username"),
+                    machine_spec["username"] = charm_params.get("rw_mgmt_ip")
+
                 # Login to the VCA.
                 # if number_to_configure == 0:
                 #     self.logger.debug("Logging into N2VC...")
@@ -938,7 +944,7 @@ class NsLcm(LcmBase):
                         descriptor,          # The vnf/nsd descriptor
                         charm_path,          # Path to charm
                         charm_params,        # Runtime params, like mgmt ip
-                        {},                  # for native charms only
+                        machine_spec,        # for native charms only
                         self.n2vc_callback,  # Callback for status changes
                         n2vc_info,           # Callback parameter
                         None,                # Callback parameter (task)
@@ -968,8 +974,9 @@ class NsLcm(LcmBase):
                 vnf_config = vnfd.get("vnf-configuration")
                 if vnf_config and vnf_config.get("juju"):
                     proxy_charm = vnf_config["juju"]["charm"]
+                    native_charm = vnf_config["juju"].get("proxy") is False
 
-                    if proxy_charm:
+                    if proxy_charm or native_charm:
                         if not vca_model_name:
                             step = "creating VCA model name '{}'".format(nsr_id)
                             self.logger.debug(logging_text + step)
@@ -982,25 +989,38 @@ class NsLcm(LcmBase):
                         charm_params = {
                             "user_values": vnfr_params,
                             "rw_mgmt_ip": db_vnfrs[vnf_index]["ip-address"],
-                            "initial-config-primitive": vnf_config.get('initial-config-primitive') or {}
+                            "initial-config-primitive": vnf_config.get('initial-config-primitive') or {},
                         }
 
+                        # get username
+                        # TODO remove this when changes on IM regarding config-access:ssh-access:default-user were
+                        #  merged. Meanwhile let's get username from initial-config-primitive
+                        if vnf_config.get("initial-config-primitive"):
+                            for param in vnf_config["initial-config-primitive"][0].get("parameter", ()):
+                                if param["name"] == "ssh-username":
+                                    charm_params["username"] = param["value"]
+                        if vnf_config.get("config-access") and vnf_config["config-access"].get("ssh-access"):
+                            if vnf_config["config-access"]["ssh-access"].get("required"):
+                                charm_params["username"] = vnf_config["config-access"]["ssh-access"].get("default-user")
+
                         # 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(vnf_index, None, None, None, charm_params, n2vc_info)
+                        deploy_charm(vnf_index, None, None, None, charm_params, n2vc_info, native_charm)
                         number_to_configure += 1
 
                 # Deploy charms for each VDU that supports one.
                 for vdu_index, vdu in enumerate(get_iterable(vnfd, 'vdu')):
                     vdu_config = vdu.get('vdu-configuration')
                     proxy_charm = None
+                    native_charm = None
 
                     if vdu_config and vdu_config.get("juju"):
                         proxy_charm = vdu_config["juju"]["charm"]
+                        native_charm = vdu_config["juju"].get("proxy") is False
 
-                        if proxy_charm:
+                        if proxy_charm or native_charm:
                             if not vca_model_name:
                                 step = "creating VCA model name"
                                 await self.n2vc.CreateNetworkService(nsr_id)
@@ -1020,8 +1040,21 @@ class NsLcm(LcmBase):
                                 "rw_mgmt_ip": vdur["ip-address"],
                                 "initial-config-primitive": vdu_config.get('initial-config-primitive') or {}
                             }
+
+                            # get username
+                            # TODO remove this when changes on IM regarding config-access:ssh-access:default-user were
+                            #  merged. Meanwhile let's get username from initial-config-primitive
+                            if vdu_config.get("initial-config-primitive"):
+                                for param in vdu_config["initial-config-primitive"][0].get("parameter", ()):
+                                    if param["name"] == "ssh-username":
+                                        charm_params["username"] = param["value"]
+                            if vdu_config.get("config-access") and vdu_config["config-access"].get("ssh-access"):
+                                if vdu_config["config-access"]["ssh-access"].get("required"):
+                                    charm_params["username"] = vdu_config["config-access"]["ssh-access"].get(
+                                        "default-user")
+
                             deploy_charm(vnf_index, vdu["id"], vdur.get("name"), vdur["count-index"],
-                                         charm_params, n2vc_info)
+                                         charm_params, n2vc_info, native_charm)
                             number_to_configure += 1
 
             # Check if this NS has a charm configuration
@@ -1029,8 +1062,9 @@ class NsLcm(LcmBase):
             ns_config = nsd.get("ns-configuration")
             if ns_config and ns_config.get("juju"):
                 proxy_charm = ns_config["juju"]["charm"]
+                native_charm = ns_config["juju"].get("proxy") is False
 
-                if proxy_charm:
+                if proxy_charm or native_charm:
                     step = "connecting to N2VC to configure ns"
                     # TODO is NS magmt IP address needed?
 
@@ -1045,14 +1079,25 @@ class NsLcm(LcmBase):
                     # additional_params["rw_mgmt_ip"] = db_nsr["ip-address"]
                     charm_params = {
                         "user_values": additional_params,
-                        # "rw_mgmt_ip": db_nsr["ip-address"],
+                        "rw_mgmt_ip": db_nsr.get("ip-address"),
                         "initial-config-primitive": ns_config.get('initial-config-primitive') or {}
                     }
 
+                    # get username
+                    # TODO remove this when changes on IM regarding config-access:ssh-access:default-user were
+                    #  merged. Meanwhile let's get username from initial-config-primitive
+                    if ns_config.get("initial-config-primitive"):
+                        for param in ns_config["initial-config-primitive"][0].get("parameter", ()):
+                            if param["name"] == "ssh-username":
+                                charm_params["username"] = param["value"]
+                    if ns_config.get("config-access") and ns_config["config-access"].get("ssh-access"):
+                        if ns_config["config-access"]["ssh-access"].get("required"):
+                            charm_params["username"] = ns_config["config-access"]["ssh-access"].get("default-user")
+
                     # 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)
+                    deploy_charm(None, None, None, None, charm_params, n2vc_info, native_charm)
                     number_to_configure += 1
 
             db_nsr_update["operational-status"] = "running"
@@ -1203,6 +1248,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")
@@ -1226,6 +1377,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"
@@ -1413,7 +1566,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:
@@ -1546,6 +1699,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"
@@ -1626,7 +1780,7 @@ class NsLcm(LcmBase):
             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, desc_params))
-            db_nslcmop_update["detailed-status"] = result_detail
+            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))
@@ -1643,7 +1797,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:
@@ -1664,6 +1819,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)
@@ -1819,7 +1975,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"])
 
@@ -1929,7 +2085,7 @@ class NsLcm(LcmBase):
                         step = db_nslcmop_update["detailed-status"] = \
                             "executing post-scale scaling-config-action '{}'".format(vnf_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"])