osm_lcm/ns.py

   1 # -*- coding: utf-8 -*-
   2
   3 ##
   4 # Copyright 2018 Telefonica S.A.
   5 #
   6 # Licensed under the Apache License, Version 2.0 (the "License"); you may
   7 # not use this file except in compliance with the License. You may obtain
   8 # a copy of the License at
   9 #
  10 #         http://www.apache.org/licenses/LICENSE-2.0
  11 #
  12 # Unless required by applicable law or agreed to in writing, software
  13 # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
  14 # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
  15 # License for the specific language governing permissions and limitations
  16 # under the License.
  17 ##
  18
  19 import asyncio
  20 import yaml
  21 import logging
  22 import logging.handlers
  23 import traceback
  24 import json
  25 from jinja2 import Environment, TemplateError, TemplateNotFound, StrictUndefined, UndefinedError
  26
  27 from osm_lcm import ROclient
  28 from osm_lcm.ng_ro import NgRoClient, NgRoException
  29 from osm_lcm.lcm_utils import LcmException, LcmExceptionNoMgmtIP, LcmBase, deep_get, get_iterable, populate_dict
  30 from osm_lcm.data_utils.nsd import get_vnf_profiles
  31 from osm_lcm.data_utils.vnfd import get_vdu_list, get_vdu_profile, \
  32     get_ee_sorted_initial_config_primitive_list, get_ee_sorted_terminate_config_primitive_list, \
  33     get_kdu_list, get_virtual_link_profiles, get_vdu, get_configuration, \
  34     get_vdu_index, get_scaling_aspect, get_number_of_instances, get_juju_ee_ref
  35 from osm_lcm.data_utils.list_utils import find_in_list
  36 from osm_lcm.data_utils.vnfr import get_osm_params, get_vdur_index
  37 from osm_lcm.data_utils.dict_utils import parse_yaml_strings
  38 from osm_lcm.data_utils.database.vim_account import VimAccountDB
  39 from n2vc.k8s_helm_conn import K8sHelmConnector
  40 from n2vc.k8s_helm3_conn import K8sHelm3Connector
  41 from n2vc.k8s_juju_conn import K8sJujuConnector
  42
  43 from osm_common.dbbase import DbException
  44 from osm_common.fsbase import FsException
  45
  46 from osm_lcm.data_utils.database.database import Database
  47 from osm_lcm.data_utils.filesystem.filesystem import Filesystem
  48
  49 from n2vc.n2vc_juju_conn import N2VCJujuConnector
  50 from n2vc.exceptions import N2VCException, N2VCNotFound, K8sException
  51
  52 from osm_lcm.lcm_helm_conn import LCMHelmConn
  53
  54 from copy import copy, deepcopy
  55 from time import time
  56 from uuid import uuid4
  57
  58 from random import randint
  59
  60 __author__ = "Alfonso Tierno <alfonso.tiernosepulveda@telefonica.com>"
  61
  62
  63 class NsLcm(LcmBase):
  64     timeout_vca_on_error = 5 * 60   # Time for charm from first time at blocked,error status to mark as failed
  65     timeout_ns_deploy = 2 * 3600   # default global timeout for deployment a ns
  66     timeout_ns_terminate = 1800   # default global timeout for un deployment a ns
  67     timeout_charm_delete = 10 * 60
  68     timeout_primitive = 30 * 60  # timeout for primitive execution
  69     timeout_progress_primitive = 10 * 60  # timeout for some progress in a primitive execution
  70
  71     SUBOPERATION_STATUS_NOT_FOUND = -1
  72     SUBOPERATION_STATUS_NEW = -2
  73     SUBOPERATION_STATUS_SKIP = -3
  74     task_name_deploy_vca = "Deploying VCA"
  75
  76     def __init__(self, msg, lcm_tasks, config, loop, prometheus=None):
  77         """
  78         Init, Connect to database, filesystem storage, and messaging
  79         :param config: two level dictionary with configuration. Top level should contain 'database', 'storage',
  80         :return: None
  81         """
  82         super().__init__(
  83             msg=msg,
  84             logger=logging.getLogger('lcm.ns')
  85         )
  86
  87         self.db = Database().instance.db
  88         self.fs = Filesystem().instance.fs
  89         self.loop = loop
  90         self.lcm_tasks = lcm_tasks
  91         self.timeout = config["timeout"]
  92         self.ro_config = config["ro_config"]
  93         self.ng_ro = config["ro_config"].get("ng")
  94         self.vca_config = config["VCA"].copy()
  95
  96         # create N2VC connector
  97         self.n2vc = N2VCJujuConnector(
  98             log=self.logger,
  99             loop=self.loop,
 100             url='{}:{}'.format(self.vca_config['host'], self.vca_config['port']),
 101             username=self.vca_config.get('user', None),
 102             vca_config=self.vca_config,
 103             on_update_db=self._on_update_n2vc_db,
 104             fs=self.fs,
 105             db=self.db
 106         )
 107
 108         self.conn_helm_ee = LCMHelmConn(
 109             log=self.logger,
 110             loop=self.loop,
 111             url=None,
 112             username=None,
 113             vca_config=self.vca_config,
 114             on_update_db=self._on_update_n2vc_db
 115         )
 116
 117         self.k8sclusterhelm2 = K8sHelmConnector(
 118             kubectl_command=self.vca_config.get("kubectlpath"),
 119             helm_command=self.vca_config.get("helmpath"),
 120             log=self.logger,
 121             on_update_db=None,
 122             fs=self.fs,
 123             db=self.db
 124         )
 125
 126         self.k8sclusterhelm3 = K8sHelm3Connector(
 127             kubectl_command=self.vca_config.get("kubectlpath"),
 128             helm_command=self.vca_config.get("helm3path"),
 129             fs=self.fs,
 130             log=self.logger,
 131             db=self.db,
 132             on_update_db=None,
 133         )
 134
 135         self.k8sclusterjuju = K8sJujuConnector(
 136             kubectl_command=self.vca_config.get("kubectlpath"),
 137             juju_command=self.vca_config.get("jujupath"),
 138             log=self.logger,
 139             loop=self.loop,
 140             on_update_db=None,
 141             vca_config=self.vca_config,
 142             fs=self.fs,
 143             db=self.db
 144         )
 145
 146         self.k8scluster_map = {
 147             "helm-chart": self.k8sclusterhelm2,
 148             "helm-chart-v3": self.k8sclusterhelm3,
 149             "chart": self.k8sclusterhelm3,
 150             "juju-bundle": self.k8sclusterjuju,
 151             "juju": self.k8sclusterjuju,
 152         }
 153
 154         self.vca_map = {
 155             "lxc_proxy_charm": self.n2vc,
 156             "native_charm": self.n2vc,
 157             "k8s_proxy_charm": self.n2vc,
 158             "helm": self.conn_helm_ee,
 159             "helm-v3": self.conn_helm_ee
 160         }
 161
 162         self.prometheus = prometheus
 163
 164         # create RO client
 165         self.RO = NgRoClient(self.loop, **self.ro_config)
 166
 167     @staticmethod
 168     def increment_ip_mac(ip_mac, vm_index=1):
 169         if not isinstance(ip_mac, str):
 170             return ip_mac
 171         try:
 172             # try with ipv4 look for last dot
 173             i = ip_mac.rfind(".")
 174             if i > 0:
 175                 i += 1
 176                 return "{}{}".format(ip_mac[:i], int(ip_mac[i:]) + vm_index)
 177             # try with ipv6 or mac look for last colon. Operate in hex
 178             i = ip_mac.rfind(":")
 179             if i > 0:
 180                 i += 1
 181                 # format in hex, len can be 2 for mac or 4 for ipv6
 182                 return ("{}{:0" + str(len(ip_mac) - i) + "x}").format(ip_mac[:i], int(ip_mac[i:], 16) + vm_index)
 183         except Exception:
 184             pass
 185         return None
 186
 187     def _on_update_ro_db(self, nsrs_id, ro_descriptor):
 188
 189         # self.logger.debug('_on_update_ro_db(nsrs_id={}'.format(nsrs_id))
 190
 191         try:
 192             # TODO filter RO descriptor fields...
 193
 194             # write to database
 195             db_dict = dict()
 196             # db_dict['deploymentStatus'] = yaml.dump(ro_descriptor, default_flow_style=False, indent=2)
 197             db_dict['deploymentStatus'] = ro_descriptor
 198             self.update_db_2("nsrs", nsrs_id, db_dict)
 199
 200         except Exception as e:
 201             self.logger.warn('Cannot write database RO deployment for ns={} -> {}'.format(nsrs_id, e))
 202
 203     async def _on_update_n2vc_db(self, table, filter, path, updated_data):
 204
 205         # remove last dot from path (if exists)
 206         if path.endswith('.'):
 207             path = path[:-1]
 208
 209         # self.logger.debug('_on_update_n2vc_db(table={}, filter={}, path={}, updated_data={}'
 210         #                   .format(table, filter, path, updated_data))
 211
 212         try:
 213
 214             nsr_id = filter.get('_id')
 215
 216             # read ns record from database
 217             nsr = self.db.get_one(table='nsrs', q_filter=filter)
 218             current_ns_status = nsr.get('nsState')
 219
 220             # get vca status for NS
 221             status_dict = await self.n2vc.get_status(namespace='.' + nsr_id, yaml_format=False)
 222
 223             # vcaStatus
 224             db_dict = dict()
 225             db_dict['vcaStatus'] = status_dict
 226
 227             # update configurationStatus for this VCA
 228             try:
 229                 vca_index = int(path[path.rfind(".")+1:])
 230
 231                 vca_list = deep_get(target_dict=nsr, key_list=('_admin', 'deployed', 'VCA'))
 232                 vca_status = vca_list[vca_index].get('status')
 233
 234                 configuration_status_list = nsr.get('configurationStatus')
 235                 config_status = configuration_status_list[vca_index].get('status')
 236
 237                 if config_status == 'BROKEN' and vca_status != 'failed':
 238                     db_dict['configurationStatus'][vca_index] = 'READY'
 239                 elif config_status != 'BROKEN' and vca_status == 'failed':
 240                     db_dict['configurationStatus'][vca_index] = 'BROKEN'
 241             except Exception as e:
 242                 # not update configurationStatus
 243                 self.logger.debug('Error updating vca_index (ignore): {}'.format(e))
 244
 245             # if nsState = 'READY' check if juju is reporting some error => nsState = 'DEGRADED'
 246             # if nsState = 'DEGRADED' check if all is OK
 247             is_degraded = False
 248             if current_ns_status in ('READY', 'DEGRADED'):
 249                 error_description = ''
 250                 # check machines
 251                 if status_dict.get('machines'):
 252                     for machine_id in status_dict.get('machines'):
 253                         machine = status_dict.get('machines').get(machine_id)
 254                         # check machine agent-status
 255                         if machine.get('agent-status'):
 256                             s = machine.get('agent-status').get('status')
 257                             if s != 'started':
 258                                 is_degraded = True
 259                                 error_description += 'machine {} agent-status={} ; '.format(machine_id, s)
 260                         # check machine instance status
 261                         if machine.get('instance-status'):
 262                             s = machine.get('instance-status').get('status')
 263                             if s != 'running':
 264                                 is_degraded = True
 265                                 error_description += 'machine {} instance-status={} ; '.format(machine_id, s)
 266                 # check applications
 267                 if status_dict.get('applications'):
 268                     for app_id in status_dict.get('applications'):
 269                         app = status_dict.get('applications').get(app_id)
 270                         # check application status
 271                         if app.get('status'):
 272                             s = app.get('status').get('status')
 273                             if s != 'active':
 274                                 is_degraded = True
 275                                 error_description += 'application {} status={} ; '.format(app_id, s)
 276
 277                 if error_description:
 278                     db_dict['errorDescription'] = error_description
 279                 if current_ns_status == 'READY' and is_degraded:
 280                     db_dict['nsState'] = 'DEGRADED'
 281                 if current_ns_status == 'DEGRADED' and not is_degraded:
 282                     db_dict['nsState'] = 'READY'
 283
 284             # write to database
 285             self.update_db_2("nsrs", nsr_id, db_dict)
 286
 287         except (asyncio.CancelledError, asyncio.TimeoutError):
 288             raise
 289         except Exception as e:
 290             self.logger.warn('Error updating NS state for ns={}: {}'.format(nsr_id, e))
 291
 292     @staticmethod
 293     def _parse_cloud_init(cloud_init_text, additional_params, vnfd_id, vdu_id):
 294         try:
 295             env = Environment(undefined=StrictUndefined)
 296             template = env.from_string(cloud_init_text)
 297             return template.render(additional_params or {})
 298         except UndefinedError as e:
 299             raise LcmException("Variable {} at vnfd[id={}]:vdu[id={}]:cloud-init/cloud-init-"
 300                                "file, must be provided in the instantiation parameters inside the "
 301                                "'additionalParamsForVnf/Vdu' block".format(e, vnfd_id, vdu_id))
 302         except (TemplateError, TemplateNotFound) as e:
 303             raise LcmException("Error parsing Jinja2 to cloud-init content at vnfd[id={}]:vdu[id={}]: {}".
 304                                format(vnfd_id, vdu_id, e))
 305
 306     def _get_vdu_cloud_init_content(self, vdu, vnfd):
 307         cloud_init_content = cloud_init_file = None
 308         try:
 309             if vdu.get("cloud-init-file"):
 310                 base_folder = vnfd["_admin"]["storage"]
 311                 cloud_init_file = "{}/{}/cloud_init/{}".format(base_folder["folder"], base_folder["pkg-dir"],
 312                                                                vdu["cloud-init-file"])
 313                 with self.fs.file_open(cloud_init_file, "r") as ci_file:
 314                     cloud_init_content = ci_file.read()
 315             elif vdu.get("cloud-init"):
 316                 cloud_init_content = vdu["cloud-init"]
 317
 318             return cloud_init_content
 319         except FsException as e:
 320             raise LcmException("Error reading vnfd[id={}]:vdu[id={}]:cloud-init-file={}: {}".
 321                                format(vnfd["id"], vdu["id"], cloud_init_file, e))
 322
 323     def _get_vdu_additional_params(self, db_vnfr, vdu_id):
 324         vdur = next(vdur for vdur in db_vnfr.get("vdur") if vdu_id == vdur["vdu-id-ref"])
 325         additional_params = vdur.get("additionalParams")
 326         return parse_yaml_strings(additional_params)
 327
 328     def vnfd2RO(self, vnfd, new_id=None, additionalParams=None, nsrId=None):
 329         """
 330         Converts creates a new vnfd descriptor for RO base on input OSM IM vnfd
 331         :param vnfd: input vnfd
 332         :param new_id: overrides vnf id if provided
 333         :param additionalParams: Instantiation params for VNFs provided
 334         :param nsrId: Id of the NSR
 335         :return: copy of vnfd
 336         """
 337         vnfd_RO = deepcopy(vnfd)
 338         # remove unused by RO configuration, monitoring, scaling and internal keys
 339         vnfd_RO.pop("_id", None)
 340         vnfd_RO.pop("_admin", None)
 341         vnfd_RO.pop("monitoring-param", None)
 342         vnfd_RO.pop("scaling-group-descriptor", None)
 343         vnfd_RO.pop("kdu", None)
 344         vnfd_RO.pop("k8s-cluster", None)
 345         if new_id:
 346             vnfd_RO["id"] = new_id
 347
 348         # parse cloud-init or cloud-init-file with the provided variables using Jinja2
 349         for vdu in get_iterable(vnfd_RO, "vdu"):
 350             vdu.pop("cloud-init-file", None)
 351             vdu.pop("cloud-init", None)
 352         return vnfd_RO
 353
 354     @staticmethod
 355     def ip_profile_2_RO(ip_profile):
 356         RO_ip_profile = deepcopy(ip_profile)
 357         if "dns-server" in RO_ip_profile:
 358             if isinstance(RO_ip_profile["dns-server"], list):
 359                 RO_ip_profile["dns-address"] = []
 360                 for ds in RO_ip_profile.pop("dns-server"):
 361                     RO_ip_profile["dns-address"].append(ds['address'])
 362             else:
 363                 RO_ip_profile["dns-address"] = RO_ip_profile.pop("dns-server")
 364         if RO_ip_profile.get("ip-version") == "ipv4":
 365             RO_ip_profile["ip-version"] = "IPv4"
 366         if RO_ip_profile.get("ip-version") == "ipv6":
 367             RO_ip_profile["ip-version"] = "IPv6"
 368         if "dhcp-params" in RO_ip_profile:
 369             RO_ip_profile["dhcp"] = RO_ip_profile.pop("dhcp-params")
 370         return RO_ip_profile
 371
 372     def _get_ro_vim_id_for_vim_account(self, vim_account):
 373         db_vim = self.db.get_one("vim_accounts", {"_id": vim_account})
 374         if db_vim["_admin"]["operationalState"] != "ENABLED":
 375             raise LcmException("VIM={} is not available. operationalState={}".format(
 376                 vim_account, db_vim["_admin"]["operationalState"]))
 377         RO_vim_id = db_vim["_admin"]["deployed"]["RO"]
 378         return RO_vim_id
 379
 380     def get_ro_wim_id_for_wim_account(self, wim_account):
 381         if isinstance(wim_account, str):
 382             db_wim = self.db.get_one("wim_accounts", {"_id": wim_account})
 383             if db_wim["_admin"]["operationalState"] != "ENABLED":
 384                 raise LcmException("WIM={} is not available. operationalState={}".format(
 385                     wim_account, db_wim["_admin"]["operationalState"]))
 386             RO_wim_id = db_wim["_admin"]["deployed"]["RO-account"]
 387             return RO_wim_id
 388         else:
 389             return wim_account
 390
 391     def scale_vnfr(self, db_vnfr, vdu_create=None, vdu_delete=None, mark_delete=False):
 392
 393         db_vdu_push_list = []
 394         db_update = {"_admin.modified": time()}
 395         if vdu_create:
 396             for vdu_id, vdu_count in vdu_create.items():
 397                 vdur = next((vdur for vdur in reversed(db_vnfr["vdur"]) if vdur["vdu-id-ref"] == vdu_id), None)
 398                 if not vdur:
 399                     raise LcmException("Error scaling OUT VNFR for {}. There is not any existing vnfr. Scaled to 0?".
 400                                        format(vdu_id))
 401
 402                 for count in range(vdu_count):
 403                     vdur_copy = deepcopy(vdur)
 404                     vdur_copy["status"] = "BUILD"
 405                     vdur_copy["status-detailed"] = None
 406                     vdur_copy["ip-address"]: None
 407                     vdur_copy["_id"] = str(uuid4())
 408                     vdur_copy["count-index"] += count + 1
 409                     vdur_copy["id"] = "{}-{}".format(vdur_copy["vdu-id-ref"], vdur_copy["count-index"])
 410                     vdur_copy.pop("vim_info", None)
 411                     for iface in vdur_copy["interfaces"]:
 412                         if iface.get("fixed-ip"):
 413                             iface["ip-address"] = self.increment_ip_mac(iface["ip-address"], count+1)
 414                         else:
 415                             iface.pop("ip-address", None)
 416                         if iface.get("fixed-mac"):
 417                             iface["mac-address"] = self.increment_ip_mac(iface["mac-address"], count+1)
 418                         else:
 419                             iface.pop("mac-address", None)
 420                         iface.pop("mgmt_vnf", None)  # only first vdu can be managment of vnf
 421                     db_vdu_push_list.append(vdur_copy)
 422                     # self.logger.debug("scale out, adding vdu={}".format(vdur_copy))
 423         if vdu_delete:
 424             for vdu_id, vdu_count in vdu_delete.items():
 425                 if mark_delete:
 426                     indexes_to_delete = [iv[0] for iv in enumerate(db_vnfr["vdur"]) if iv[1]["vdu-id-ref"] == vdu_id]
 427                     db_update.update({"vdur.{}.status".format(i): "DELETING" for i in indexes_to_delete[-vdu_count:]})
 428                 else:
 429                     # it must be deleted one by one because common.db does not allow otherwise
 430                     vdus_to_delete = [v for v in reversed(db_vnfr["vdur"]) if v["vdu-id-ref"] == vdu_id]
 431                     for vdu in vdus_to_delete[:vdu_count]:
 432                         self.db.set_one("vnfrs", {"_id": db_vnfr["_id"]}, None, pull={"vdur": {"_id": vdu["_id"]}})
 433         db_push = {"vdur": db_vdu_push_list} if db_vdu_push_list else None
 434         self.db.set_one("vnfrs", {"_id": db_vnfr["_id"]}, db_update, push_list=db_push)
 435         # modify passed dictionary db_vnfr
 436         db_vnfr_ = self.db.get_one("vnfrs", {"_id": db_vnfr["_id"]})
 437         db_vnfr["vdur"] = db_vnfr_["vdur"]
 438
 439     def ns_update_nsr(self, ns_update_nsr, db_nsr, nsr_desc_RO):
 440         """
 441         Updates database nsr with the RO info for the created vld
 442         :param ns_update_nsr: dictionary to be filled with the updated info
 443         :param db_nsr: content of db_nsr. This is also modified
 444         :param nsr_desc_RO: nsr descriptor from RO
 445         :return: Nothing, LcmException is raised on errors
 446         """
 447
 448         for vld_index, vld in enumerate(get_iterable(db_nsr, "vld")):
 449             for net_RO in get_iterable(nsr_desc_RO, "nets"):
 450                 if vld["id"] != net_RO.get("ns_net_osm_id"):
 451                     continue
 452                 vld["vim-id"] = net_RO.get("vim_net_id")
 453                 vld["name"] = net_RO.get("vim_name")
 454                 vld["status"] = net_RO.get("status")
 455                 vld["status-detailed"] = net_RO.get("error_msg")
 456                 ns_update_nsr["vld.{}".format(vld_index)] = vld
 457                 break
 458             else:
 459                 raise LcmException("ns_update_nsr: Not found vld={} at RO info".format(vld["id"]))
 460
 461     def set_vnfr_at_error(self, db_vnfrs, error_text):
 462         try:
 463             for db_vnfr in db_vnfrs.values():
 464                 vnfr_update = {"status": "ERROR"}
 465                 for vdu_index, vdur in enumerate(get_iterable(db_vnfr, "vdur")):
 466                     if "status" not in vdur:
 467                         vdur["status"] = "ERROR"
 468                         vnfr_update["vdur.{}.status".format(vdu_index)] = "ERROR"
 469                         if error_text:
 470                             vdur["status-detailed"] = str(error_text)
 471                             vnfr_update["vdur.{}.status-detailed".format(vdu_index)] = "ERROR"
 472                 self.update_db_2("vnfrs", db_vnfr["_id"], vnfr_update)
 473         except DbException as e:
 474             self.logger.error("Cannot update vnf. {}".format(e))
 475
 476     def ns_update_vnfr(self, db_vnfrs, nsr_desc_RO):
 477         """
 478         Updates database vnfr with the RO info, e.g. ip_address, vim_id... Descriptor db_vnfrs is also updated
 479         :param db_vnfrs: dictionary with member-vnf-index: vnfr-content
 480         :param nsr_desc_RO: nsr descriptor from RO
 481         :return: Nothing, LcmException is raised on errors
 482         """
 483         for vnf_index, db_vnfr in db_vnfrs.items():
 484             for vnf_RO in nsr_desc_RO["vnfs"]:
 485                 if vnf_RO["member_vnf_index"] != vnf_index:
 486                     continue
 487                 vnfr_update = {}
 488                 if vnf_RO.get("ip_address"):
 489                     db_vnfr["ip-address"] = vnfr_update["ip-address"] = vnf_RO["ip_address"].split(";")[0]
 490                 elif not db_vnfr.get("ip-address"):
 491                     if db_vnfr.get("vdur"):   # if not VDUs, there is not ip_address
 492                         raise LcmExceptionNoMgmtIP("ns member_vnf_index '{}' has no IP address".format(vnf_index))
 493
 494                 for vdu_index, vdur in enumerate(get_iterable(db_vnfr, "vdur")):
 495                     vdur_RO_count_index = 0
 496                     if vdur.get("pdu-type"):
 497                         continue
 498                     for vdur_RO in get_iterable(vnf_RO, "vms"):
 499                         if vdur["vdu-id-ref"] != vdur_RO["vdu_osm_id"]:
 500                             continue
 501                         if vdur["count-index"] != vdur_RO_count_index:
 502                             vdur_RO_count_index += 1
 503                             continue
 504                         vdur["vim-id"] = vdur_RO.get("vim_vm_id")
 505                         if vdur_RO.get("ip_address"):
 506                             vdur["ip-address"] = vdur_RO["ip_address"].split(";")[0]
 507                         else:
 508                             vdur["ip-address"] = None
 509                         vdur["vdu-id-ref"] = vdur_RO.get("vdu_osm_id")
 510                         vdur["name"] = vdur_RO.get("vim_name")
 511                         vdur["status"] = vdur_RO.get("status")
 512                         vdur["status-detailed"] = vdur_RO.get("error_msg")
 513                         for ifacer in get_iterable(vdur, "interfaces"):
 514                             for interface_RO in get_iterable(vdur_RO, "interfaces"):
 515                                 if ifacer["name"] == interface_RO.get("internal_name"):
 516                                     ifacer["ip-address"] = interface_RO.get("ip_address")
 517                                     ifacer["mac-address"] = interface_RO.get("mac_address")
 518                                     break
 519                             else:
 520                                 raise LcmException("ns_update_vnfr: Not found member_vnf_index={} vdur={} interface={} "
 521                                                    "from VIM info"
 522                                                    .format(vnf_index, vdur["vdu-id-ref"], ifacer["name"]))
 523                         vnfr_update["vdur.{}".format(vdu_index)] = vdur
 524                         break
 525                     else:
 526                         raise LcmException("ns_update_vnfr: Not found member_vnf_index={} vdur={} count_index={} from "
 527                                            "VIM info".format(vnf_index, vdur["vdu-id-ref"], vdur["count-index"]))
 528
 529                 for vld_index, vld in enumerate(get_iterable(db_vnfr, "vld")):
 530                     for net_RO in get_iterable(nsr_desc_RO, "nets"):
 531                         if vld["id"] != net_RO.get("vnf_net_osm_id"):
 532                             continue
 533                         vld["vim-id"] = net_RO.get("vim_net_id")
 534                         vld["name"] = net_RO.get("vim_name")
 535                         vld["status"] = net_RO.get("status")
 536                         vld["status-detailed"] = net_RO.get("error_msg")
 537                         vnfr_update["vld.{}".format(vld_index)] = vld
 538                         break
 539                     else:
 540                         raise LcmException("ns_update_vnfr: Not found member_vnf_index={} vld={} from VIM info".format(
 541                             vnf_index, vld["id"]))
 542
 543                 self.update_db_2("vnfrs", db_vnfr["_id"], vnfr_update)
 544                 break
 545
 546             else:
 547                 raise LcmException("ns_update_vnfr: Not found member_vnf_index={} from VIM info".format(vnf_index))
 548
 549     def _get_ns_config_info(self, nsr_id):
 550         """
 551         Generates a mapping between vnf,vdu elements and the N2VC id
 552         :param nsr_id: id of nsr to get last  database _admin.deployed.VCA that contains this list
 553         :return: a dictionary with {osm-config-mapping: {}} where its element contains:
 554             "<member-vnf-index>": <N2VC-id>  for a vnf configuration, or
 555             "<member-vnf-index>.<vdu.id>.<vdu replica(0, 1,..)>": <N2VC-id>  for a vdu configuration
 556         """
 557         db_nsr = self.db.get_one("nsrs", {"_id": nsr_id})
 558         vca_deployed_list = db_nsr["_admin"]["deployed"]["VCA"]
 559         mapping = {}
 560         ns_config_info = {"osm-config-mapping": mapping}
 561         for vca in vca_deployed_list:
 562             if not vca["member-vnf-index"]:
 563                 continue
 564             if not vca["vdu_id"]:
 565                 mapping[vca["member-vnf-index"]] = vca["application"]
 566             else:
 567                 mapping["{}.{}.{}".format(vca["member-vnf-index"], vca["vdu_id"], vca["vdu_count_index"])] =\
 568                     vca["application"]
 569         return ns_config_info
 570
 571     async def _instantiate_ng_ro(self, logging_text, nsr_id, nsd, db_nsr, db_nslcmop, db_vnfrs, db_vnfds,
 572                                  n2vc_key_list, stage, start_deploy, timeout_ns_deploy):
 573
 574         db_vims = {}
 575
 576         def get_vim_account(vim_account_id):
 577             nonlocal db_vims
 578             if vim_account_id in db_vims:
 579                 return db_vims[vim_account_id]
 580             db_vim = self.db.get_one("vim_accounts", {"_id": vim_account_id})
 581             db_vims[vim_account_id] = db_vim
 582             return db_vim
 583
 584         # modify target_vld info with instantiation parameters
 585         def parse_vld_instantiation_params(target_vim, target_vld, vld_params, target_sdn):
 586             if vld_params.get("ip-profile"):
 587                 target_vld["vim_info"][target_vim]["ip_profile"] = vld_params["ip-profile"]
 588             if vld_params.get("provider-network"):
 589                 target_vld["vim_info"][target_vim]["provider_network"] = vld_params["provider-network"]
 590                 if "sdn-ports" in vld_params["provider-network"] and target_sdn:
 591                     target_vld["vim_info"][target_sdn]["sdn-ports"] = vld_params["provider-network"]["sdn-ports"]
 592             if vld_params.get("wimAccountId"):
 593                 target_wim = "wim:{}".format(vld_params["wimAccountId"])
 594                 target_vld["vim_info"][target_wim] = {}
 595             for param in ("vim-network-name", "vim-network-id"):
 596                 if vld_params.get(param):
 597                     if isinstance(vld_params[param], dict):
 598                         for vim, vim_net in vld_params[param].items():
 599                             other_target_vim = "vim:" + vim
 600                             populate_dict(target_vld["vim_info"], (other_target_vim, param.replace("-", "_")), vim_net)
 601                     else:  # isinstance str
 602                         target_vld["vim_info"][target_vim][param.replace("-", "_")] = vld_params[param]
 603             if vld_params.get("common_id"):
 604                 target_vld["common_id"] = vld_params.get("common_id")
 605
 606         nslcmop_id = db_nslcmop["_id"]
 607         target = {
 608             "name": db_nsr["name"],
 609             "ns": {"vld": []},
 610             "vnf": [],
 611             "image": deepcopy(db_nsr["image"]),
 612             "flavor": deepcopy(db_nsr["flavor"]),
 613             "action_id": nslcmop_id,
 614             "cloud_init_content": {},
 615         }
 616         for image in target["image"]:
 617             image["vim_info"] = {}
 618         for flavor in target["flavor"]:
 619             flavor["vim_info"] = {}
 620
 621         if db_nslcmop.get("lcmOperationType") != "instantiate":
 622             # get parameters of instantiation:
 623             db_nslcmop_instantiate = self.db.get_list("nslcmops", {"nsInstanceId": db_nslcmop["nsInstanceId"],
 624                                                                    "lcmOperationType": "instantiate"})[-1]
 625             ns_params = db_nslcmop_instantiate.get("operationParams")
 626         else:
 627             ns_params = db_nslcmop.get("operationParams")
 628         ssh_keys_instantiation = ns_params.get("ssh_keys") or []
 629         ssh_keys_all = ssh_keys_instantiation + (n2vc_key_list or [])
 630
 631         cp2target = {}
 632         for vld_index, vld in enumerate(db_nsr.get("vld")):
 633             target_vim = "vim:{}".format(ns_params["vimAccountId"])
 634             target_vld = {
 635                 "id": vld["id"],
 636                 "name": vld["name"],
 637                 "mgmt-network": vld.get("mgmt-network", False),
 638                 "type": vld.get("type"),
 639                 "vim_info": {
 640                     target_vim: {
 641                         "vim_network_name": vld.get("vim-network-name"),
 642                         "vim_account_id": ns_params["vimAccountId"]
 643                     }
 644                 }
 645             }
 646             # check if this network needs SDN assist
 647             if vld.get("pci-interfaces"):
 648                 db_vim = get_vim_account(ns_params["vimAccountId"])
 649                 sdnc_id = db_vim["config"].get("sdn-controller")
 650                 if sdnc_id:
 651                     sdn_vld = "nsrs:{}:vld.{}".format(nsr_id, vld["id"])
 652                     target_sdn = "sdn:{}".format(sdnc_id)
 653                     target_vld["vim_info"][target_sdn] = {
 654                         "sdn": True, "target_vim": target_vim, "vlds": [sdn_vld], "type": vld.get("type")}
 655
 656             nsd_vnf_profiles = get_vnf_profiles(nsd)
 657             for nsd_vnf_profile in nsd_vnf_profiles:
 658                 for cp in nsd_vnf_profile["virtual-link-connectivity"]:
 659                     if cp["virtual-link-profile-id"] == vld["id"]:
 660                         cp2target["member_vnf:{}.{}".format(
 661                             cp["constituent-cpd-id"][0]["constituent-base-element-id"],
 662                             cp["constituent-cpd-id"][0]["constituent-cpd-id"]
 663                         )] = "nsrs:{}:vld.{}".format(nsr_id, vld_index)
 664
 665             # check at nsd descriptor, if there is an ip-profile
 666             vld_params = {}
 667             virtual_link_profiles = get_virtual_link_profiles(nsd)
 668
 669             for vlp in virtual_link_profiles:
 670                 ip_profile = find_in_list(nsd["ip-profiles"],
 671                                           lambda profile: profile["name"] == vlp["ip-profile-ref"])
 672                 vld_params["ip-profile"] = ip_profile["ip-profile-params"]
 673             # update vld_params with instantiation params
 674             vld_instantiation_params = find_in_list(get_iterable(ns_params, "vld"),
 675                                                     lambda a_vld: a_vld["name"] in (vld["name"], vld["id"]))
 676             if vld_instantiation_params:
 677                 vld_params.update(vld_instantiation_params)
 678             parse_vld_instantiation_params(target_vim, target_vld, vld_params, None)
 679             target["ns"]["vld"].append(target_vld)
 680
 681         for vnfr in db_vnfrs.values():
 682             vnfd = find_in_list(db_vnfds, lambda db_vnf: db_vnf["id"] == vnfr["vnfd-ref"])
 683             vnf_params = find_in_list(get_iterable(ns_params, "vnf"),
 684                                       lambda a_vnf: a_vnf["member-vnf-index"] == vnfr["member-vnf-index-ref"])
 685             target_vnf = deepcopy(vnfr)
 686             target_vim = "vim:{}".format(vnfr["vim-account-id"])
 687             for vld in target_vnf.get("vld", ()):
 688                 # check if connected to a ns.vld, to fill target'
 689                 vnf_cp = find_in_list(vnfd.get("int-virtual-link-desc", ()),
 690                                       lambda cpd: cpd.get("id") == vld["id"])
 691                 if vnf_cp:
 692                     ns_cp = "member_vnf:{}.{}".format(vnfr["member-vnf-index-ref"], vnf_cp["id"])
 693                     if cp2target.get(ns_cp):
 694                         vld["target"] = cp2target[ns_cp]
 695
 696                 vld["vim_info"] = {target_vim: {"vim_network_name": vld.get("vim-network-name")}}
 697                 # check if this network needs SDN assist
 698                 target_sdn = None
 699                 if vld.get("pci-interfaces"):
 700                     db_vim = get_vim_account(vnfr["vim-account-id"])
 701                     sdnc_id = db_vim["config"].get("sdn-controller")
 702                     if sdnc_id:
 703                         sdn_vld = "vnfrs:{}:vld.{}".format(target_vnf["_id"], vld["id"])
 704                         target_sdn = "sdn:{}".format(sdnc_id)
 705                         vld["vim_info"][target_sdn] = {
 706                             "sdn": True, "target_vim": target_vim, "vlds": [sdn_vld], "type": vld.get("type")}
 707
 708                 # check at vnfd descriptor, if there is an ip-profile
 709                 vld_params = {}
 710                 vnfd_vlp = find_in_list(
 711                     get_virtual_link_profiles(vnfd),
 712                     lambda a_link_profile: a_link_profile["id"] == vld["id"]
 713                 )
 714                 if vnfd_vlp and vnfd_vlp.get("virtual-link-protocol-data") and \
 715                    vnfd_vlp["virtual-link-protocol-data"].get("l3-protocol-data"):
 716                     ip_profile_source_data = vnfd_vlp["virtual-link-protocol-data"]["l3-protocol-data"]
 717                     ip_profile_dest_data = {}
 718                     if "ip-version" in ip_profile_source_data:
 719                         ip_profile_dest_data["ip-version"] = ip_profile_source_data["ip-version"]
 720                     if "cidr" in ip_profile_source_data:
 721                         ip_profile_dest_data["subnet-address"] = ip_profile_source_data["cidr"]
 722                     if "gateway-ip" in ip_profile_source_data:
 723                         ip_profile_dest_data["gateway-address"] = ip_profile_source_data["gateway-ip"]
 724                     if "dhcp-enabled" in ip_profile_source_data:
 725                         ip_profile_dest_data["dhcp-params"] = {
 726                             "enabled": ip_profile_source_data["dhcp-enabled"]
 727                         }
 728
 729                     vld_params["ip-profile"] = ip_profile_dest_data
 730                 # update vld_params with instantiation params
 731                 if vnf_params:
 732                     vld_instantiation_params = find_in_list(get_iterable(vnf_params, "internal-vld"),
 733                                                             lambda i_vld: i_vld["name"] == vld["id"])
 734                     if vld_instantiation_params:
 735                         vld_params.update(vld_instantiation_params)
 736                 parse_vld_instantiation_params(target_vim, vld, vld_params, target_sdn)
 737
 738             vdur_list = []
 739             for vdur in target_vnf.get("vdur", ()):
 740                 if vdur.get("status") == "DELETING" or vdur.get("pdu-type"):
 741                     continue  # This vdu must not be created
 742                 vdur["vim_info"] = {"vim_account_id": vnfr["vim-account-id"]}
 743
 744                 self.logger.debug("NS > ssh_keys > {}".format(ssh_keys_all))
 745
 746                 if ssh_keys_all:
 747                     vdu_configuration = get_configuration(vnfd, vdur["vdu-id-ref"])
 748                     vnf_configuration = get_configuration(vnfd, vnfd["id"])
 749                     if vdu_configuration and vdu_configuration.get("config-access") and \
 750                        vdu_configuration.get("config-access").get("ssh-access"):
 751                         vdur["ssh-keys"] = ssh_keys_all
 752                         vdur["ssh-access-required"] = vdu_configuration["config-access"]["ssh-access"]["required"]
 753                     elif vnf_configuration and vnf_configuration.get("config-access") and \
 754                         vnf_configuration.get("config-access").get("ssh-access") and \
 755                             any(iface.get("mgmt-vnf") for iface in vdur["interfaces"]):
 756                         vdur["ssh-keys"] = ssh_keys_all
 757                         vdur["ssh-access-required"] = vnf_configuration["config-access"]["ssh-access"]["required"]
 758                     elif ssh_keys_instantiation and \
 759                             find_in_list(vdur["interfaces"], lambda iface: iface.get("mgmt-vnf")):
 760                         vdur["ssh-keys"] = ssh_keys_instantiation
 761
 762                 self.logger.debug("NS > vdur > {}".format(vdur))
 763
 764                 vdud = get_vdu(vnfd, vdur["vdu-id-ref"])
 765                 # cloud-init
 766                 if vdud.get("cloud-init-file"):
 767                     vdur["cloud-init"] = "{}:file:{}".format(vnfd["_id"], vdud.get("cloud-init-file"))
 768                     # read file and put content at target.cloul_init_content. Avoid ng_ro to use shared package system
 769                     if vdur["cloud-init"] not in target["cloud_init_content"]:
 770                         base_folder = vnfd["_admin"]["storage"]
 771                         cloud_init_file = "{}/{}/cloud_init/{}".format(base_folder["folder"], base_folder["pkg-dir"],
 772                                                                        vdud.get("cloud-init-file"))
 773                         with self.fs.file_open(cloud_init_file, "r") as ci_file:
 774                             target["cloud_init_content"][vdur["cloud-init"]] = ci_file.read()
 775                 elif vdud.get("cloud-init"):
 776                     vdur["cloud-init"] = "{}:vdu:{}".format(vnfd["_id"], get_vdu_index(vnfd, vdur["vdu-id-ref"]))
 777                     # put content at target.cloul_init_content. Avoid ng_ro read vnfd descriptor
 778                     target["cloud_init_content"][vdur["cloud-init"]] = vdud["cloud-init"]
 779                 vdur["additionalParams"] = vdur.get("additionalParams") or {}
 780                 deploy_params_vdu = self._format_additional_params(vdur.get("additionalParams") or {})
 781                 deploy_params_vdu["OSM"] = get_osm_params(vnfr, vdur["vdu-id-ref"], vdur["count-index"])
 782                 vdur["additionalParams"] = deploy_params_vdu
 783
 784                 # flavor
 785                 ns_flavor = target["flavor"][int(vdur["ns-flavor-id"])]
 786                 if target_vim not in ns_flavor["vim_info"]:
 787                     ns_flavor["vim_info"][target_vim] = {}
 788
 789                 # deal with images
 790                 # in case alternative images are provided we must check if they should be applied
 791                 # for the vim_type, modify the vim_type taking into account
 792                 ns_image_id = int(vdur["ns-image-id"])
 793                 if vdur.get("alt-image-ids"):
 794                     db_vim = get_vim_account(vnfr["vim-account-id"])
 795                     vim_type = db_vim["vim_type"]
 796                     for alt_image_id in vdur.get("alt-image-ids"):
 797                         ns_alt_image = target["image"][int(alt_image_id)]
 798                         if vim_type == ns_alt_image.get("vim-type"):
 799                             # must use alternative image
 800                             self.logger.debug("use alternative image id: {}".format(alt_image_id))
 801                             ns_image_id = alt_image_id
 802                             vdur["ns-image-id"] = ns_image_id
 803                             break
 804                 ns_image = target["image"][int(ns_image_id)]
 805                 if target_vim not in ns_image["vim_info"]:
 806                     ns_image["vim_info"][target_vim] = {}
 807
 808                 vdur["vim_info"] = {target_vim: {}}
 809                 # instantiation parameters
 810                 # if vnf_params:
 811                 #     vdu_instantiation_params = next((v for v in get_iterable(vnf_params, "vdu") if v["id"] ==
 812                 #     vdud["id"]), None)
 813                 vdur_list.append(vdur)
 814             target_vnf["vdur"] = vdur_list
 815             target["vnf"].append(target_vnf)
 816
 817         desc = await self.RO.deploy(nsr_id, target)
 818         self.logger.debug("RO return > {}".format(desc))
 819         action_id = desc["action_id"]
 820         await self._wait_ng_ro(nsr_id, action_id, nslcmop_id, start_deploy, timeout_ns_deploy, stage)
 821
 822         # Updating NSR
 823         db_nsr_update = {
 824             "_admin.deployed.RO.operational-status": "running",
 825             "detailed-status": " ".join(stage)
 826         }
 827         # db_nsr["_admin.deployed.RO.detailed-status"] = "Deployed at VIM"
 828         self.update_db_2("nsrs", nsr_id, db_nsr_update)
 829         self._write_op_status(nslcmop_id, stage)
 830         self.logger.debug(logging_text + "ns deployed at RO. RO_id={}".format(action_id))
 831         return
 832
 833     async def _wait_ng_ro(self, nsr_id, action_id, nslcmop_id=None, start_time=None, timeout=600, stage=None):
 834         detailed_status_old = None
 835         db_nsr_update = {}
 836         start_time = start_time or time()
 837         while time() <= start_time + timeout:
 838             desc_status = await self.RO.status(nsr_id, action_id)
 839             self.logger.debug("Wait NG RO > {}".format(desc_status))
 840             if desc_status["status"] == "FAILED":
 841                 raise NgRoException(desc_status["details"])
 842             elif desc_status["status"] == "BUILD":
 843                 if stage:
 844                     stage[2] = "VIM: ({})".format(desc_status["details"])
 845             elif desc_status["status"] == "DONE":
 846                 if stage:
 847                     stage[2] = "Deployed at VIM"
 848                 break
 849             else:
 850                 assert False, "ROclient.check_ns_status returns unknown {}".format(desc_status["status"])
 851             if stage and nslcmop_id and stage[2] != detailed_status_old:
 852                 detailed_status_old = stage[2]
 853                 db_nsr_update["detailed-status"] = " ".join(stage)
 854                 self.update_db_2("nsrs", nsr_id, db_nsr_update)
 855                 self._write_op_status(nslcmop_id, stage)
 856             await asyncio.sleep(15, loop=self.loop)
 857         else:  # timeout_ns_deploy
 858             raise NgRoException("Timeout waiting ns to deploy")
 859
 860     async def _terminate_ng_ro(self, logging_text, nsr_deployed, nsr_id, nslcmop_id, stage):
 861         db_nsr_update = {}
 862         failed_detail = []
 863         action_id = None
 864         start_deploy = time()
 865         try:
 866             target = {
 867                 "ns": {"vld": []},
 868                 "vnf": [],
 869                 "image": [],
 870                 "flavor": [],
 871                 "action_id": nslcmop_id
 872             }
 873             desc = await self.RO.deploy(nsr_id, target)
 874             action_id = desc["action_id"]
 875             db_nsr_update["_admin.deployed.RO.nsr_delete_action_id"] = action_id
 876             db_nsr_update["_admin.deployed.RO.nsr_status"] = "DELETING"
 877             self.logger.debug(logging_text + "ns terminate action at RO. action_id={}".format(action_id))
 878
 879             # wait until done
 880             delete_timeout = 20 * 60  # 20 minutes
 881             await self._wait_ng_ro(nsr_id, action_id, nslcmop_id, start_deploy, delete_timeout, stage)
 882
 883             db_nsr_update["_admin.deployed.RO.nsr_delete_action_id"] = None
 884             db_nsr_update["_admin.deployed.RO.nsr_status"] = "DELETED"
 885             # delete all nsr
 886             await self.RO.delete(nsr_id)
 887         except Exception as e:
 888             if isinstance(e, NgRoException) and e.http_code == 404:  # not found
 889                 db_nsr_update["_admin.deployed.RO.nsr_id"] = None
 890                 db_nsr_update["_admin.deployed.RO.nsr_status"] = "DELETED"
 891                 db_nsr_update["_admin.deployed.RO.nsr_delete_action_id"] = None
 892                 self.logger.debug(logging_text + "RO_action_id={} already deleted".format(action_id))
 893             elif isinstance(e, NgRoException) and e.http_code == 409:  # conflict
 894                 failed_detail.append("delete conflict: {}".format(e))
 895                 self.logger.debug(logging_text + "RO_action_id={} delete conflict: {}".format(action_id, e))
 896             else:
 897                 failed_detail.append("delete error: {}".format(e))
 898                 self.logger.error(logging_text + "RO_action_id={} delete error: {}".format(action_id, e))
 899
 900         if failed_detail:
 901             stage[2] = "Error deleting from VIM"
 902         else:
 903             stage[2] = "Deleted from VIM"
 904         db_nsr_update["detailed-status"] = " ".join(stage)
 905         self.update_db_2("nsrs", nsr_id, db_nsr_update)
 906         self._write_op_status(nslcmop_id, stage)
 907
 908         if failed_detail:
 909             raise LcmException("; ".join(failed_detail))
 910         return
 911
 912     async def instantiate_RO(self, logging_text, nsr_id, nsd, db_nsr, db_nslcmop, db_vnfrs, db_vnfds,
 913                              n2vc_key_list, stage):
 914         """
 915         Instantiate at RO
 916         :param logging_text: preffix text to use at logging
 917         :param nsr_id: nsr identity
 918         :param nsd: database content of ns descriptor
 919         :param db_nsr: database content of ns record
 920         :param db_nslcmop: database content of ns operation, in this case, 'instantiate'
 921         :param db_vnfrs:
 922         :param db_vnfds: database content of vnfds, indexed by id (not _id). {id: {vnfd_object}, ...}
 923         :param n2vc_key_list: ssh-public-key list to be inserted to management vdus via cloud-init
 924         :param stage: list with 3 items: [general stage, tasks, vim_specific]. This task will write over vim_specific
 925         :return: None or exception
 926         """
 927         try:
 928             start_deploy = time()
 929             ns_params = db_nslcmop.get("operationParams")
 930             if ns_params and ns_params.get("timeout_ns_deploy"):
 931                 timeout_ns_deploy = ns_params["timeout_ns_deploy"]
 932             else:
 933                 timeout_ns_deploy = self.timeout.get("ns_deploy", self.timeout_ns_deploy)
 934
 935             # Check for and optionally request placement optimization. Database will be updated if placement activated
 936             stage[2] = "Waiting for Placement."
 937             if await self._do_placement(logging_text, db_nslcmop, db_vnfrs):
 938                 # in case of placement change ns_params[vimAcountId) if not present at any vnfrs
 939                 for vnfr in db_vnfrs.values():
 940                     if ns_params["vimAccountId"] == vnfr["vim-account-id"]:
 941                         break
 942                 else:
 943                     ns_params["vimAccountId"] == vnfr["vim-account-id"]
 944
 945             return await self._instantiate_ng_ro(logging_text, nsr_id, nsd, db_nsr, db_nslcmop, db_vnfrs,
 946                                                  db_vnfds, n2vc_key_list, stage, start_deploy, timeout_ns_deploy)
 947         except Exception as e:
 948             stage[2] = "ERROR deploying at VIM"
 949             self.set_vnfr_at_error(db_vnfrs, str(e))
 950             self.logger.error("Error deploying at VIM {}".format(e),
 951                               exc_info=not isinstance(e, (ROclient.ROClientException, LcmException, DbException,
 952                                                           NgRoException)))
 953             raise
 954
 955     async def wait_kdu_up(self, logging_text, nsr_id, vnfr_id, kdu_name):
 956         """
 957         Wait for kdu to be up, get ip address
 958         :param logging_text: prefix use for logging
 959         :param nsr_id:
 960         :param vnfr_id:
 961         :param kdu_name:
 962         :return: IP address
 963         """
 964
 965         # self.logger.debug(logging_text + "Starting wait_kdu_up")
 966         nb_tries = 0
 967
 968         while nb_tries < 360:
 969             db_vnfr = self.db.get_one("vnfrs", {"_id": vnfr_id})
 970             kdur = next((x for x in get_iterable(db_vnfr, "kdur") if x.get("kdu-name") == kdu_name), None)
 971             if not kdur:
 972                 raise LcmException("Not found vnfr_id={}, kdu_name={}".format(vnfr_id, kdu_name))
 973             if kdur.get("status"):
 974                 if kdur["status"] in ("READY", "ENABLED"):
 975                     return kdur.get("ip-address")
 976                 else:
 977                     raise LcmException("target KDU={} is in error state".format(kdu_name))
 978
 979             await asyncio.sleep(10, loop=self.loop)
 980             nb_tries += 1
 981         raise LcmException("Timeout waiting KDU={} instantiated".format(kdu_name))
 982
 983     async def wait_vm_up_insert_key_ro(self, logging_text, nsr_id, vnfr_id, vdu_id, vdu_index, pub_key=None, user=None):
 984         """
 985         Wait for ip addres at RO, and optionally, insert public key in virtual machine
 986         :param logging_text: prefix use for logging
 987         :param nsr_id:
 988         :param vnfr_id:
 989         :param vdu_id:
 990         :param vdu_index:
 991         :param pub_key: public ssh key to inject, None to skip
 992         :param user: user to apply the public ssh key
 993         :return: IP address
 994         """
 995
 996         self.logger.debug(logging_text + "Starting wait_vm_up_insert_key_ro")
 997         ro_nsr_id = None
 998         ip_address = None
 999         nb_tries = 0
1000         target_vdu_id = None
1001         ro_retries = 0
1002
1003         while True:
1004
1005             ro_retries += 1
1006             if ro_retries >= 360:  # 1 hour
1007                 raise LcmException("Not found _admin.deployed.RO.nsr_id for nsr_id: {}".format(nsr_id))
1008
1009             await asyncio.sleep(10, loop=self.loop)
1010
1011             # get ip address
1012             if not target_vdu_id:
1013                 db_vnfr = self.db.get_one("vnfrs", {"_id": vnfr_id})
1014
1015                 if not vdu_id:  # for the VNF case
1016                     if db_vnfr.get("status") == "ERROR":
1017                         raise LcmException("Cannot inject ssh-key because target VNF is in error state")
1018                     ip_address = db_vnfr.get("ip-address")
1019                     if not ip_address:
1020                         continue
1021                     vdur = next((x for x in get_iterable(db_vnfr, "vdur") if x.get("ip-address") == ip_address), None)
1022                 else:  # VDU case
1023                     vdur = next((x for x in get_iterable(db_vnfr, "vdur")
1024                                  if x.get("vdu-id-ref") == vdu_id and x.get("count-index") == vdu_index), None)
1025
1026                 if not vdur and len(db_vnfr.get("vdur", ())) == 1:  # If only one, this should be the target vdu
1027                     vdur = db_vnfr["vdur"][0]
1028                 if not vdur:
1029                     raise LcmException("Not found vnfr_id={}, vdu_id={}, vdu_index={}".format(vnfr_id, vdu_id,
1030                                                                                               vdu_index))
1031                 # New generation RO stores information at "vim_info"
1032                 ng_ro_status = None
1033                 target_vim = None
1034                 if vdur.get("vim_info"):
1035                     target_vim = next(t for t in vdur["vim_info"])  # there should be only one key
1036                     ng_ro_status = vdur["vim_info"][target_vim].get("vim_status")
1037                 if vdur.get("pdu-type") or vdur.get("status") == "ACTIVE" or ng_ro_status == "ACTIVE":
1038                     ip_address = vdur.get("ip-address")
1039                     if not ip_address:
1040                         continue
1041                     target_vdu_id = vdur["vdu-id-ref"]
1042                 elif vdur.get("status") == "ERROR" or ng_ro_status == "ERROR":
1043                     raise LcmException("Cannot inject ssh-key because target VM is in error state")
1044
1045             if not target_vdu_id:
1046                 continue
1047
1048             # inject public key into machine
1049             if pub_key and user:
1050                 self.logger.debug(logging_text + "Inserting RO key")
1051                 self.logger.debug("SSH > PubKey > {}".format(pub_key))
1052                 if vdur.get("pdu-type"):
1053                     self.logger.error(logging_text + "Cannot inject ssh-ky to a PDU")
1054                     return ip_address
1055                 try:
1056                     ro_vm_id = "{}-{}".format(db_vnfr["member-vnf-index-ref"], target_vdu_id)  # TODO add vdu_index
1057                     if self.ng_ro:
1058                         target = {"action": {"action": "inject_ssh_key", "key": pub_key, "user": user},
1059                                   "vnf": [{"_id": vnfr_id, "vdur": [{"id": vdur["id"]}]}],
1060                                   }
1061                         desc = await self.RO.deploy(nsr_id, target)
1062                         action_id = desc["action_id"]
1063                         await self._wait_ng_ro(nsr_id, action_id, timeout=600)
1064                         break
1065                     else:
1066                         # wait until NS is deployed at RO
1067                         if not ro_nsr_id:
1068                             db_nsrs = self.db.get_one("nsrs", {"_id": nsr_id})
1069                             ro_nsr_id = deep_get(db_nsrs, ("_admin", "deployed", "RO", "nsr_id"))
1070                         if not ro_nsr_id:
1071                             continue
1072                         result_dict = await self.RO.create_action(
1073                             item="ns",
1074                             item_id_name=ro_nsr_id,
1075                             descriptor={"add_public_key": pub_key, "vms": [ro_vm_id], "user": user}
1076                         )
1077                         # result_dict contains the format {VM-id: {vim_result: 200, description: text}}
1078                         if not result_dict or not isinstance(result_dict, dict):
1079                             raise LcmException("Unknown response from RO when injecting key")
1080                         for result in result_dict.values():
1081                             if result.get("vim_result") == 200:
1082                                 break
1083                             else:
1084                                 raise ROclient.ROClientException("error injecting key: {}".format(
1085                                     result.get("description")))
1086                         break
1087                 except NgRoException as e:
1088                     raise LcmException("Reaching max tries injecting key. Error: {}".format(e))
1089                 except ROclient.ROClientException as e:
1090                     if not nb_tries:
1091                         self.logger.debug(logging_text + "error injecting key: {}. Retrying until {} seconds".
1092                                           format(e, 20*10))
1093                     nb_tries += 1
1094                     if nb_tries >= 20:
1095                         raise LcmException("Reaching max tries injecting key. Error: {}".format(e))
1096             else:
1097                 break
1098
1099         return ip_address
1100
1101     async def _wait_dependent_n2vc(self, nsr_id, vca_deployed_list, vca_index):
1102         """
1103         Wait until dependent VCA deployments have been finished. NS wait for VNFs and VDUs. VNFs for VDUs
1104         """
1105         my_vca = vca_deployed_list[vca_index]
1106         if my_vca.get("vdu_id") or my_vca.get("kdu_name"):
1107             # vdu or kdu: no dependencies
1108             return
1109         timeout = 300
1110         while timeout >= 0:
1111             db_nsr = self.db.get_one("nsrs", {"_id": nsr_id})
1112             vca_deployed_list = db_nsr["_admin"]["deployed"]["VCA"]
1113             configuration_status_list = db_nsr["configurationStatus"]
1114             for index, vca_deployed in enumerate(configuration_status_list):
1115                 if index == vca_index:
1116                     # myself
1117                     continue
1118                 if not my_vca.get("member-vnf-index") or \
1119                         (vca_deployed.get("member-vnf-index") == my_vca.get("member-vnf-index")):
1120                     internal_status = configuration_status_list[index].get("status")
1121                     if internal_status == 'READY':
1122                         continue
1123                     elif internal_status == 'BROKEN':
1124                         raise LcmException("Configuration aborted because dependent charm/s has failed")
1125                     else:
1126                         break
1127             else:
1128                 # no dependencies, return
1129                 return
1130             await asyncio.sleep(10)
1131             timeout -= 1
1132
1133         raise LcmException("Configuration aborted because dependent charm/s timeout")
1134
1135     async def instantiate_N2VC(self, logging_text, vca_index, nsi_id, db_nsr, db_vnfr, vdu_id, kdu_name, vdu_index,
1136                                config_descriptor, deploy_params, base_folder, nslcmop_id, stage, vca_type, vca_name,
1137                                ee_config_descriptor):
1138         nsr_id = db_nsr["_id"]
1139         db_update_entry = "_admin.deployed.VCA.{}.".format(vca_index)
1140         vca_deployed_list = db_nsr["_admin"]["deployed"]["VCA"]
1141         vca_deployed = db_nsr["_admin"]["deployed"]["VCA"][vca_index]
1142         osm_config = {"osm": {"ns_id": db_nsr["_id"]}}
1143         db_dict = {
1144             'collection': 'nsrs',
1145             'filter': {'_id': nsr_id},
1146             'path': db_update_entry
1147         }
1148         step = ""
1149         try:
1150
1151             element_type = 'NS'
1152             element_under_configuration = nsr_id
1153
1154             vnfr_id = None
1155             if db_vnfr:
1156                 vnfr_id = db_vnfr["_id"]
1157                 osm_config["osm"]["vnf_id"] = vnfr_id
1158
1159             namespace = "{nsi}.{ns}".format(
1160                 nsi=nsi_id if nsi_id else "",
1161                 ns=nsr_id)
1162
1163             if vnfr_id:
1164                 element_type = 'VNF'
1165                 element_under_configuration = vnfr_id
1166                 namespace += ".{}-{}".format(vnfr_id, vdu_index or 0)
1167                 if vdu_id:
1168                     namespace += ".{}-{}".format(vdu_id, vdu_index or 0)
1169                     element_type = 'VDU'
1170                     element_under_configuration = "{}-{}".format(vdu_id, vdu_index or 0)
1171                     osm_config["osm"]["vdu_id"] = vdu_id
1172                 elif kdu_name:
1173                     namespace += ".{}.{}".format(kdu_name, vdu_index or 0)
1174                     element_type = 'KDU'
1175                     element_under_configuration = kdu_name
1176                     osm_config["osm"]["kdu_name"] = kdu_name
1177
1178             # Get artifact path
1179             artifact_path = "{}/{}/{}/{}".format(
1180                 base_folder["folder"],
1181                 base_folder["pkg-dir"],
1182                 "charms" if vca_type in ("native_charm", "lxc_proxy_charm", "k8s_proxy_charm") else "helm-charts",
1183                 vca_name
1184             )
1185
1186             self.logger.debug("Artifact path > {}".format(artifact_path))
1187
1188             # get initial_config_primitive_list that applies to this element
1189             initial_config_primitive_list = config_descriptor.get('initial-config-primitive')
1190
1191             self.logger.debug("Initial config primitive list > {}".format(initial_config_primitive_list))
1192
1193             # add config if not present for NS charm
1194             ee_descriptor_id = ee_config_descriptor.get("id")
1195             self.logger.debug("EE Descriptor > {}".format(ee_descriptor_id))
1196             initial_config_primitive_list = get_ee_sorted_initial_config_primitive_list(initial_config_primitive_list,
1197                                                                                         vca_deployed, ee_descriptor_id)
1198
1199             self.logger.debug("Initial config primitive list #2 > {}".format(initial_config_primitive_list))
1200             # n2vc_redesign STEP 3.1
1201             # find old ee_id if exists
1202             ee_id = vca_deployed.get("ee_id")
1203
1204             vim_account_id = (
1205                 deep_get(db_vnfr, ("vim-account-id",)) or
1206                 deep_get(deploy_params, ("OSM", "vim_account_id"))
1207             )
1208             vca_cloud, vca_cloud_credential = self.get_vca_cloud_and_credentials(vim_account_id)
1209             vca_k8s_cloud, vca_k8s_cloud_credential = self.get_vca_k8s_cloud_and_credentials(vim_account_id)
1210             # create or register execution environment in VCA
1211             if vca_type in ("lxc_proxy_charm", "k8s_proxy_charm", "helm", "helm-v3"):
1212
1213                 self._write_configuration_status(
1214                     nsr_id=nsr_id,
1215                     vca_index=vca_index,
1216                     status='CREATING',
1217                     element_under_configuration=element_under_configuration,
1218                     element_type=element_type
1219                 )
1220
1221                 step = "create execution environment"
1222                 self.logger.debug(logging_text + step)
1223
1224                 ee_id = None
1225                 credentials = None
1226                 if vca_type == "k8s_proxy_charm":
1227                     ee_id = await self.vca_map[vca_type].install_k8s_proxy_charm(
1228                         charm_name=artifact_path[artifact_path.rfind("/") + 1:],
1229                         namespace=namespace,
1230                         artifact_path=artifact_path,
1231                         db_dict=db_dict,
1232                         cloud_name=vca_k8s_cloud,
1233                         credential_name=vca_k8s_cloud_credential,
1234                     )
1235                 elif vca_type == "helm" or vca_type == "helm-v3":
1236                     ee_id, credentials = await self.vca_map[vca_type].create_execution_environment(
1237                         namespace=namespace,
1238                         reuse_ee_id=ee_id,
1239                         db_dict=db_dict,
1240                         config=osm_config,
1241                         artifact_path=artifact_path,
1242                         vca_type=vca_type
1243                     )
1244                 else:
1245                     ee_id, credentials = await self.vca_map[vca_type].create_execution_environment(
1246                         namespace=namespace,
1247                         reuse_ee_id=ee_id,
1248                         db_dict=db_dict,
1249                         cloud_name=vca_cloud,
1250                         credential_name=vca_cloud_credential,
1251                     )
1252
1253             elif vca_type == "native_charm":
1254                 step = "Waiting to VM being up and getting IP address"
1255                 self.logger.debug(logging_text + step)
1256                 rw_mgmt_ip = await self.wait_vm_up_insert_key_ro(logging_text, nsr_id, vnfr_id, vdu_id, vdu_index,
1257                                                                  user=None, pub_key=None)
1258                 credentials = {"hostname": rw_mgmt_ip}
1259                 # get username
1260                 username = deep_get(config_descriptor, ("config-access", "ssh-access", "default-user"))
1261                 # TODO remove this when changes on IM regarding config-access:ssh-access:default-user were
1262                 #  merged. Meanwhile let's get username from initial-config-primitive
1263                 if not username and initial_config_primitive_list:
1264                     for config_primitive in initial_config_primitive_list:
1265                         for param in config_primitive.get("parameter", ()):
1266                             if param["name"] == "ssh-username":
1267                                 username = param["value"]
1268                                 break
1269                 if not username:
1270                     raise LcmException("Cannot determine the username neither with 'initial-config-primitive' nor with "
1271                                        "'config-access.ssh-access.default-user'")
1272                 credentials["username"] = username
1273                 # n2vc_redesign STEP 3.2
1274
1275                 self._write_configuration_status(
1276                     nsr_id=nsr_id,
1277                     vca_index=vca_index,
1278                     status='REGISTERING',
1279                     element_under_configuration=element_under_configuration,
1280                     element_type=element_type
1281                 )
1282
1283                 step = "register execution environment {}".format(credentials)
1284                 self.logger.debug(logging_text + step)
1285                 ee_id = await self.vca_map[vca_type].register_execution_environment(
1286                     credentials=credentials,
1287                     namespace=namespace,
1288                     db_dict=db_dict,
1289                     cloud_name=vca_cloud,
1290                     credential_name=vca_cloud_credential,
1291                 )
1292
1293             # for compatibility with MON/POL modules, the need model and application name at database
1294             # TODO ask MON/POL if needed to not assuming anymore the format "model_name.application_name"
1295             ee_id_parts = ee_id.split('.')
1296             db_nsr_update = {db_update_entry + "ee_id": ee_id}
1297             if len(ee_id_parts) >= 2:
1298                 model_name = ee_id_parts[0]
1299                 application_name = ee_id_parts[1]
1300                 db_nsr_update[db_update_entry + "model"] = model_name
1301                 db_nsr_update[db_update_entry + "application"] = application_name
1302
1303             # n2vc_redesign STEP 3.3
1304             step = "Install configuration Software"
1305
1306             self._write_configuration_status(
1307                 nsr_id=nsr_id,
1308                 vca_index=vca_index,
1309                 status='INSTALLING SW',
1310                 element_under_configuration=element_under_configuration,
1311                 element_type=element_type,
1312                 other_update=db_nsr_update
1313             )
1314
1315             # TODO check if already done
1316             self.logger.debug(logging_text + step)
1317             config = None
1318             if vca_type == "native_charm":
1319                 config_primitive = next((p for p in initial_config_primitive_list if p["name"] == "config"), None)
1320                 if config_primitive:
1321                     config = self._map_primitive_params(
1322                         config_primitive,
1323                         {},
1324                         deploy_params
1325                     )
1326             num_units = 1
1327             if vca_type == "lxc_proxy_charm":
1328                 if element_type == "NS":
1329                     num_units = db_nsr.get("config-units") or 1
1330                 elif element_type == "VNF":
1331                     num_units = db_vnfr.get("config-units") or 1
1332                 elif element_type == "VDU":
1333                     for v in db_vnfr["vdur"]:
1334                         if vdu_id == v["vdu-id-ref"]:
1335                             num_units = v.get("config-units") or 1
1336                             break
1337             if vca_type != "k8s_proxy_charm":
1338                 await self.vca_map[vca_type].install_configuration_sw(
1339                     ee_id=ee_id,
1340                     artifact_path=artifact_path,
1341                     db_dict=db_dict,
1342                     config=config,
1343                     num_units=num_units,
1344                 )
1345
1346             # write in db flag of configuration_sw already installed
1347             self.update_db_2("nsrs", nsr_id, {db_update_entry + "config_sw_installed": True})
1348
1349             # add relations for this VCA (wait for other peers related with this VCA)
1350             await self._add_vca_relations(logging_text=logging_text, nsr_id=nsr_id,
1351                                           vca_index=vca_index, vca_type=vca_type)
1352
1353             # if SSH access is required, then get execution environment SSH public
1354             # if native charm we have waited already to VM be UP
1355             if vca_type in ("k8s_proxy_charm", "lxc_proxy_charm", "helm", "helm-v3"):
1356                 pub_key = None
1357                 user = None
1358                 # self.logger.debug("get ssh key block")
1359                 if deep_get(config_descriptor, ("config-access", "ssh-access", "required")):
1360                     # self.logger.debug("ssh key needed")
1361                     # Needed to inject a ssh key
1362                     user = deep_get(config_descriptor, ("config-access", "ssh-access", "default-user"))
1363                     step = "Install configuration Software, getting public ssh key"
1364                     pub_key = await self.vca_map[vca_type].get_ee_ssh_public__key(ee_id=ee_id, db_dict=db_dict)
1365
1366                     step = "Insert public key into VM user={} ssh_key={}".format(user, pub_key)
1367                 else:
1368                     # self.logger.debug("no need to get ssh key")
1369                     step = "Waiting to VM being up and getting IP address"
1370                 self.logger.debug(logging_text + step)
1371
1372                 # n2vc_redesign STEP 5.1
1373                 # wait for RO (ip-address) Insert pub_key into VM
1374                 if vnfr_id:
1375                     if kdu_name:
1376                         rw_mgmt_ip = await self.wait_kdu_up(logging_text, nsr_id, vnfr_id, kdu_name)
1377                     else:
1378                         rw_mgmt_ip = await self.wait_vm_up_insert_key_ro(logging_text, nsr_id, vnfr_id, vdu_id,
1379                                                                          vdu_index, user=user, pub_key=pub_key)
1380                 else:
1381                     rw_mgmt_ip = None   # This is for a NS configuration
1382
1383                 self.logger.debug(logging_text + ' VM_ip_address={}'.format(rw_mgmt_ip))
1384
1385             # store rw_mgmt_ip in deploy params for later replacement
1386             deploy_params["rw_mgmt_ip"] = rw_mgmt_ip
1387
1388             # n2vc_redesign STEP 6  Execute initial config primitive
1389             step = 'execute initial config primitive'
1390
1391             # wait for dependent primitives execution (NS -> VNF -> VDU)
1392             if initial_config_primitive_list:
1393                 await self._wait_dependent_n2vc(nsr_id, vca_deployed_list, vca_index)
1394
1395             # stage, in function of element type: vdu, kdu, vnf or ns
1396             my_vca = vca_deployed_list[vca_index]
1397             if my_vca.get("vdu_id") or my_vca.get("kdu_name"):
1398                 # VDU or KDU
1399                 stage[0] = 'Stage 3/5: running Day-1 primitives for VDU.'
1400             elif my_vca.get("member-vnf-index"):
1401                 # VNF
1402                 stage[0] = 'Stage 4/5: running Day-1 primitives for VNF.'
1403             else:
1404                 # NS
1405                 stage[0] = 'Stage 5/5: running Day-1 primitives for NS.'
1406
1407             self._write_configuration_status(
1408                 nsr_id=nsr_id,
1409                 vca_index=vca_index,
1410                 status='EXECUTING PRIMITIVE'
1411             )
1412
1413             self._write_op_status(
1414                 op_id=nslcmop_id,
1415                 stage=stage
1416             )
1417
1418             check_if_terminated_needed = True
1419             for initial_config_primitive in initial_config_primitive_list:
1420                 # adding information on the vca_deployed if it is a NS execution environment
1421                 if not vca_deployed["member-vnf-index"]:
1422                     deploy_params["ns_config_info"] = json.dumps(self._get_ns_config_info(nsr_id))
1423                 # TODO check if already done
1424                 primitive_params_ = self._map_primitive_params(initial_config_primitive, {}, deploy_params)
1425
1426                 step = "execute primitive '{}' params '{}'".format(initial_config_primitive["name"], primitive_params_)
1427                 self.logger.debug(logging_text + step)
1428                 await self.vca_map[vca_type].exec_primitive(
1429                     ee_id=ee_id,
1430                     primitive_name=initial_config_primitive["name"],
1431                     params_dict=primitive_params_,
1432                     db_dict=db_dict
1433                 )
1434                 # Once some primitive has been exec, check and write at db if it needs to exec terminated primitives
1435                 if check_if_terminated_needed:
1436                     if config_descriptor.get('terminate-config-primitive'):
1437                         self.update_db_2("nsrs", nsr_id, {db_update_entry + "needed_terminate": True})
1438                     check_if_terminated_needed = False
1439
1440                 # TODO register in database that primitive is done
1441
1442             # STEP 7 Configure metrics
1443             if vca_type == "helm" or vca_type == "helm-v3":
1444                 prometheus_jobs = await self.add_prometheus_metrics(
1445                     ee_id=ee_id,
1446                     artifact_path=artifact_path,
1447                     ee_config_descriptor=ee_config_descriptor,
1448                     vnfr_id=vnfr_id,
1449                     nsr_id=nsr_id,
1450                     target_ip=rw_mgmt_ip,
1451                 )
1452                 if prometheus_jobs:
1453                     self.update_db_2("nsrs", nsr_id, {db_update_entry + "prometheus_jobs": prometheus_jobs})
1454
1455             step = "instantiated at VCA"
1456             self.logger.debug(logging_text + step)
1457
1458             self._write_configuration_status(
1459                 nsr_id=nsr_id,
1460                 vca_index=vca_index,
1461                 status='READY'
1462             )
1463
1464         except Exception as e:  # TODO not use Exception but N2VC exception
1465             # self.update_db_2("nsrs", nsr_id, {db_update_entry + "instantiation": "FAILED"})
1466             if not isinstance(e, (DbException, N2VCException, LcmException, asyncio.CancelledError)):
1467                 self.logger.error("Exception while {} : {}".format(step, e), exc_info=True)
1468             self._write_configuration_status(
1469                 nsr_id=nsr_id,
1470                 vca_index=vca_index,
1471                 status='BROKEN'
1472             )
1473             raise LcmException("{} {}".format(step, e)) from e
1474
1475     def _write_ns_status(self, nsr_id: str, ns_state: str, current_operation: str, current_operation_id: str,
1476                          error_description: str = None, error_detail: str = None, other_update: dict = None):
1477         """
1478         Update db_nsr fields.
1479         :param nsr_id:
1480         :param ns_state:
1481         :param current_operation:
1482         :param current_operation_id:
1483         :param error_description:
1484         :param error_detail:
1485         :param other_update: Other required changes at database if provided, will be cleared
1486         :return:
1487         """
1488         try:
1489             db_dict = other_update or {}
1490             db_dict["_admin.nslcmop"] = current_operation_id    # for backward compatibility
1491             db_dict["_admin.current-operation"] = current_operation_id
1492             db_dict["_admin.operation-type"] = current_operation if current_operation != "IDLE" else None
1493             db_dict["currentOperation"] = current_operation
1494             db_dict["currentOperationID"] = current_operation_id
1495             db_dict["errorDescription"] = error_description
1496             db_dict["errorDetail"] = error_detail
1497
1498             if ns_state:
1499                 db_dict["nsState"] = ns_state
1500             self.update_db_2("nsrs", nsr_id, db_dict)
1501         except DbException as e:
1502             self.logger.warn('Error writing NS status, ns={}: {}'.format(nsr_id, e))
1503
1504     def _write_op_status(self, op_id: str, stage: list = None, error_message: str = None, queuePosition: int = 0,
1505                          operation_state: str = None, other_update: dict = None):
1506         try:
1507             db_dict = other_update or {}
1508             db_dict['queuePosition'] = queuePosition
1509             if isinstance(stage, list):
1510                 db_dict['stage'] = stage[0]
1511                 db_dict['detailed-status'] = " ".join(stage)
1512             elif stage is not None:
1513                 db_dict['stage'] = str(stage)
1514
1515             if error_message is not None:
1516                 db_dict['errorMessage'] = error_message
1517             if operation_state is not None:
1518                 db_dict['operationState'] = operation_state
1519                 db_dict["statusEnteredTime"] = time()
1520             self.update_db_2("nslcmops", op_id, db_dict)
1521         except DbException as e:
1522             self.logger.warn('Error writing OPERATION status for op_id: {} -> {}'.format(op_id, e))
1523
1524     def _write_all_config_status(self, db_nsr: dict, status: str):
1525         try:
1526             nsr_id = db_nsr["_id"]
1527             # configurationStatus
1528             config_status = db_nsr.get('configurationStatus')
1529             if config_status:
1530                 db_nsr_update = {"configurationStatus.{}.status".format(index): status for index, v in
1531                                  enumerate(config_status) if v}
1532                 # update status
1533                 self.update_db_2("nsrs", nsr_id, db_nsr_update)
1534
1535         except DbException as e:
1536             self.logger.warn('Error writing all configuration status, ns={}: {}'.format(nsr_id, e))
1537
1538     def _write_configuration_status(self, nsr_id: str, vca_index: int, status: str = None,
1539                                     element_under_configuration: str = None, element_type: str = None,
1540                                     other_update: dict = None):
1541
1542         # self.logger.debug('_write_configuration_status(): vca_index={}, status={}'
1543         #                   .format(vca_index, status))
1544
1545         try:
1546             db_path = 'configurationStatus.{}.'.format(vca_index)
1547             db_dict = other_update or {}
1548             if status:
1549                 db_dict[db_path + 'status'] = status
1550             if element_under_configuration:
1551                 db_dict[db_path + 'elementUnderConfiguration'] = element_under_configuration
1552             if element_type:
1553                 db_dict[db_path + 'elementType'] = element_type
1554             self.update_db_2("nsrs", nsr_id, db_dict)
1555         except DbException as e:
1556             self.logger.warn('Error writing configuration status={}, ns={}, vca_index={}: {}'
1557                              .format(status, nsr_id, vca_index, e))
1558
1559     async def _do_placement(self, logging_text, db_nslcmop, db_vnfrs):
1560         """
1561         Check and computes the placement, (vim account where to deploy). If it is decided by an external tool, it
1562         sends the request via kafka and wait until the result is wrote at database (nslcmops _admin.plca).
1563         Database is used because the result can be obtained from a different LCM worker in case of HA.
1564         :param logging_text: contains the prefix for logging, with the ns and nslcmop identifiers
1565         :param db_nslcmop: database content of nslcmop
1566         :param db_vnfrs: database content of vnfrs, indexed by member-vnf-index.
1567         :return: True if some modification is done. Modifies database vnfrs and parameter db_vnfr with the
1568             computed 'vim-account-id'
1569         """
1570         modified = False
1571         nslcmop_id = db_nslcmop['_id']
1572         placement_engine = deep_get(db_nslcmop, ('operationParams', 'placement-engine'))
1573         if placement_engine == "PLA":
1574             self.logger.debug(logging_text + "Invoke and wait for placement optimization")
1575             await self.msg.aiowrite("pla", "get_placement", {'nslcmopId': nslcmop_id}, loop=self.loop)
1576             db_poll_interval = 5
1577             wait = db_poll_interval * 10
1578             pla_result = None
1579             while not pla_result and wait >= 0:
1580                 await asyncio.sleep(db_poll_interval)
1581                 wait -= db_poll_interval
1582                 db_nslcmop = self.db.get_one("nslcmops", {"_id": nslcmop_id})
1583                 pla_result = deep_get(db_nslcmop, ('_admin', 'pla'))
1584
1585             if not pla_result:
1586                 raise LcmException("Placement timeout for nslcmopId={}".format(nslcmop_id))
1587
1588             for pla_vnf in pla_result['vnf']:
1589                 vnfr = db_vnfrs.get(pla_vnf['member-vnf-index'])
1590                 if not pla_vnf.get('vimAccountId') or not vnfr:
1591                     continue
1592                 modified = True
1593                 self.db.set_one("vnfrs", {"_id": vnfr["_id"]}, {"vim-account-id": pla_vnf['vimAccountId']})
1594                 # Modifies db_vnfrs
1595                 vnfr["vim-account-id"] = pla_vnf['vimAccountId']
1596         return modified
1597
1598     def update_nsrs_with_pla_result(self, params):
1599         try:
1600             nslcmop_id = deep_get(params, ('placement', 'nslcmopId'))
1601             self.update_db_2("nslcmops", nslcmop_id, {"_admin.pla": params.get('placement')})
1602         except Exception as e:
1603             self.logger.warn('Update failed for nslcmop_id={}:{}'.format(nslcmop_id, e))
1604
1605     async def instantiate(self, nsr_id, nslcmop_id):
1606         """
1607
1608         :param nsr_id: ns instance to deploy
1609         :param nslcmop_id: operation to run
1610         :return:
1611         """
1612
1613         # Try to lock HA task here
1614         task_is_locked_by_me = self.lcm_tasks.lock_HA('ns', 'nslcmops', nslcmop_id)
1615         if not task_is_locked_by_me:
1616             self.logger.debug('instantiate() task is not locked by me, ns={}'.format(nsr_id))
1617             return
1618
1619         logging_text = "Task ns={} instantiate={} ".format(nsr_id, nslcmop_id)
1620         self.logger.debug(logging_text + "Enter")
1621
1622         # get all needed from database
1623
1624         # database nsrs record
1625         db_nsr = None
1626
1627         # database nslcmops record
1628         db_nslcmop = None
1629
1630         # update operation on nsrs
1631         db_nsr_update = {}
1632         # update operation on nslcmops
1633         db_nslcmop_update = {}
1634
1635         nslcmop_operation_state = None
1636         db_vnfrs = {}     # vnf's info indexed by member-index
1637         # n2vc_info = {}
1638         tasks_dict_info = {}  # from task to info text
1639         exc = None
1640         error_list = []
1641         stage = ['Stage 1/5: preparation of the environment.', "Waiting for previous operations to terminate.", ""]
1642         # ^ stage, step, VIM progress
1643         try:
1644             # wait for any previous tasks in process
1645             await self.lcm_tasks.waitfor_related_HA('ns', 'nslcmops', nslcmop_id)
1646
1647             stage[1] = "Sync filesystem from database."
1648             self.fs.sync()  # TODO, make use of partial sync, only for the needed packages
1649
1650             # STEP 0: Reading database (nslcmops, nsrs, nsds, vnfrs, vnfds)
1651             stage[1] = "Reading from database."
1652             # nsState="BUILDING", currentOperation="INSTANTIATING", currentOperationID=nslcmop_id
1653             db_nsr_update["detailed-status"] = "creating"
1654             db_nsr_update["operational-status"] = "init"
1655             self._write_ns_status(
1656                 nsr_id=nsr_id,
1657                 ns_state="BUILDING",
1658                 current_operation="INSTANTIATING",
1659                 current_operation_id=nslcmop_id,
1660                 other_update=db_nsr_update
1661             )
1662             self._write_op_status(
1663                 op_id=nslcmop_id,
1664                 stage=stage,
1665                 queuePosition=0
1666             )
1667
1668             # read from db: operation
1669             stage[1] = "Getting nslcmop={} from db.".format(nslcmop_id)
1670             db_nslcmop = self.db.get_one("nslcmops", {"_id": nslcmop_id})
1671             ns_params = db_nslcmop.get("operationParams")
1672             if ns_params and ns_params.get("timeout_ns_deploy"):
1673                 timeout_ns_deploy = ns_params["timeout_ns_deploy"]
1674             else:
1675                 timeout_ns_deploy = self.timeout.get("ns_deploy", self.timeout_ns_deploy)
1676
1677             # read from db: ns
1678             stage[1] = "Getting nsr={} from db.".format(nsr_id)
1679             db_nsr = self.db.get_one("nsrs", {"_id": nsr_id})
1680             stage[1] = "Getting nsd={} from db.".format(db_nsr["nsd-id"])
1681             nsd = self.db.get_one("nsds", {"_id": db_nsr["nsd-id"]})
1682             db_nsr["nsd"] = nsd
1683             # nsr_name = db_nsr["name"]   # TODO short-name??
1684
1685             # read from db: vnf's of this ns
1686             stage[1] = "Getting vnfrs from db."
1687             self.logger.debug(logging_text + stage[1])
1688             db_vnfrs_list = self.db.get_list("vnfrs", {"nsr-id-ref": nsr_id})
1689
1690             # read from db: vnfd's for every vnf
1691             db_vnfds = []         # every vnfd data
1692
1693             # for each vnf in ns, read vnfd
1694             for vnfr in db_vnfrs_list:
1695                 db_vnfrs[vnfr["member-vnf-index-ref"]] = vnfr
1696                 vnfd_id = vnfr["vnfd-id"]
1697                 vnfd_ref = vnfr["vnfd-ref"]
1698
1699                 # if we haven't this vnfd, read it from db
1700                 if vnfd_id not in db_vnfds:
1701                     # read from db
1702                     stage[1] = "Getting vnfd={} id='{}' from db.".format(vnfd_id, vnfd_ref)
1703                     self.logger.debug(logging_text + stage[1])
1704                     vnfd = self.db.get_one("vnfds", {"_id": vnfd_id})
1705
1706                     # store vnfd
1707                     db_vnfds.append(vnfd)
1708
1709             # Get or generates the _admin.deployed.VCA list
1710             vca_deployed_list = None
1711             if db_nsr["_admin"].get("deployed"):
1712                 vca_deployed_list = db_nsr["_admin"]["deployed"].get("VCA")
1713             if vca_deployed_list is None:
1714                 vca_deployed_list = []
1715                 configuration_status_list = []
1716                 db_nsr_update["_admin.deployed.VCA"] = vca_deployed_list
1717                 db_nsr_update["configurationStatus"] = configuration_status_list
1718                 # add _admin.deployed.VCA to db_nsr dictionary, value=vca_deployed_list
1719                 populate_dict(db_nsr, ("_admin", "deployed", "VCA"), vca_deployed_list)
1720             elif isinstance(vca_deployed_list, dict):
1721                 # maintain backward compatibility. Change a dict to list at database
1722                 vca_deployed_list = list(vca_deployed_list.values())
1723                 db_nsr_update["_admin.deployed.VCA"] = vca_deployed_list
1724                 populate_dict(db_nsr, ("_admin", "deployed", "VCA"), vca_deployed_list)
1725
1726             if not isinstance(deep_get(db_nsr, ("_admin", "deployed", "RO", "vnfd")), list):
1727                 populate_dict(db_nsr, ("_admin", "deployed", "RO", "vnfd"), [])
1728                 db_nsr_update["_admin.deployed.RO.vnfd"] = []
1729
1730             # set state to INSTANTIATED. When instantiated NBI will not delete directly
1731             db_nsr_update["_admin.nsState"] = "INSTANTIATED"
1732             self.update_db_2("nsrs", nsr_id, db_nsr_update)
1733             self.db.set_list("vnfrs", {"nsr-id-ref": nsr_id}, {"_admin.nsState": "INSTANTIATED"})
1734
1735             # n2vc_redesign STEP 2 Deploy Network Scenario
1736             stage[0] = 'Stage 2/5: deployment of KDUs, VMs and execution environments.'
1737             self._write_op_status(
1738                 op_id=nslcmop_id,
1739                 stage=stage
1740             )
1741
1742             stage[1] = "Deploying KDUs."
1743             # self.logger.debug(logging_text + "Before deploy_kdus")
1744             # Call to deploy_kdus in case exists the "vdu:kdu" param
1745             await self.deploy_kdus(
1746                 logging_text=logging_text,
1747                 nsr_id=nsr_id,
1748                 nslcmop_id=nslcmop_id,
1749                 db_vnfrs=db_vnfrs,
1750                 db_vnfds=db_vnfds,
1751                 task_instantiation_info=tasks_dict_info,
1752             )
1753
1754             stage[1] = "Getting VCA public key."
1755             # n2vc_redesign STEP 1 Get VCA public ssh-key
1756             # feature 1429. Add n2vc public key to needed VMs
1757             n2vc_key = self.n2vc.get_public_key()
1758             n2vc_key_list = [n2vc_key]
1759             if self.vca_config.get("public_key"):
1760                 n2vc_key_list.append(self.vca_config["public_key"])
1761
1762             stage[1] = "Deploying NS at VIM."
1763             task_ro = asyncio.ensure_future(
1764                 self.instantiate_RO(
1765                     logging_text=logging_text,
1766                     nsr_id=nsr_id,
1767                     nsd=nsd,
1768                     db_nsr=db_nsr,
1769                     db_nslcmop=db_nslcmop,
1770                     db_vnfrs=db_vnfrs,
1771                     db_vnfds=db_vnfds,
1772                     n2vc_key_list=n2vc_key_list,
1773                     stage=stage
1774                 )
1775             )
1776             self.lcm_tasks.register("ns", nsr_id, nslcmop_id, "instantiate_RO", task_ro)
1777             tasks_dict_info[task_ro] = "Deploying at VIM"
1778
1779             # n2vc_redesign STEP 3 to 6 Deploy N2VC
1780             stage[1] = "Deploying Execution Environments."
1781             self.logger.debug(logging_text + stage[1])
1782
1783             nsi_id = None  # TODO put nsi_id when this nsr belongs to a NSI
1784             for vnf_profile in get_vnf_profiles(nsd):
1785                 vnfd_id = vnf_profile["vnfd-id"]
1786                 vnfd = find_in_list(db_vnfds, lambda a_vnf: a_vnf["id"] == vnfd_id)
1787                 member_vnf_index = str(vnf_profile["id"])
1788                 db_vnfr = db_vnfrs[member_vnf_index]
1789                 base_folder = vnfd["_admin"]["storage"]
1790                 vdu_id = None
1791                 vdu_index = 0
1792                 vdu_name = None
1793                 kdu_name = None
1794
1795                 # Get additional parameters
1796                 deploy_params = {"OSM": get_osm_params(db_vnfr)}
1797                 if db_vnfr.get("additionalParamsForVnf"):
1798                     deploy_params.update(parse_yaml_strings(db_vnfr["additionalParamsForVnf"].copy()))
1799
1800                 descriptor_config = get_configuration(vnfd, vnfd["id"])
1801                 if descriptor_config:
1802                     self._deploy_n2vc(
1803                         logging_text=logging_text + "member_vnf_index={} ".format(member_vnf_index),
1804                         db_nsr=db_nsr,
1805                         db_vnfr=db_vnfr,
1806                         nslcmop_id=nslcmop_id,
1807                         nsr_id=nsr_id,
1808                         nsi_id=nsi_id,
1809                         vnfd_id=vnfd_id,
1810                         vdu_id=vdu_id,
1811                         kdu_name=kdu_name,
1812                         member_vnf_index=member_vnf_index,
1813                         vdu_index=vdu_index,
1814                         vdu_name=vdu_name,
1815                         deploy_params=deploy_params,
1816                         descriptor_config=descriptor_config,
1817                         base_folder=base_folder,
1818                         task_instantiation_info=tasks_dict_info,
1819                         stage=stage
1820                     )
1821
1822                 # Deploy charms for each VDU that supports one.
1823                 for vdud in get_vdu_list(vnfd):
1824                     vdu_id = vdud["id"]
1825                     descriptor_config = get_configuration(vnfd, vdu_id)
1826                     vdur = find_in_list(db_vnfr["vdur"], lambda vdu: vdu["vdu-id-ref"] == vdu_id)
1827
1828                     if vdur.get("additionalParams"):
1829                         deploy_params_vdu = parse_yaml_strings(vdur["additionalParams"])
1830                     else:
1831                         deploy_params_vdu = deploy_params
1832                     deploy_params_vdu["OSM"] = get_osm_params(db_vnfr, vdu_id, vdu_count_index=0)
1833                     vdud_count = get_vdu_profile(vnfd, vdu_id).get("max-number-of-instances", 1)
1834
1835                     self.logger.debug("VDUD > {}".format(vdud))
1836                     self.logger.debug("Descriptor config > {}".format(descriptor_config))
1837                     if descriptor_config:
1838                         vdu_name = None
1839                         kdu_name = None
1840                         for vdu_index in range(vdud_count):
1841                             # TODO vnfr_params["rw_mgmt_ip"] = vdur["ip-address"]
1842                             self._deploy_n2vc(
1843                                 logging_text=logging_text + "member_vnf_index={}, vdu_id={}, vdu_index={} ".format(
1844                                     member_vnf_index, vdu_id, vdu_index),
1845                                 db_nsr=db_nsr,
1846                                 db_vnfr=db_vnfr,
1847                                 nslcmop_id=nslcmop_id,
1848                                 nsr_id=nsr_id,
1849                                 nsi_id=nsi_id,
1850                                 vnfd_id=vnfd_id,
1851                                 vdu_id=vdu_id,
1852                                 kdu_name=kdu_name,
1853                                 member_vnf_index=member_vnf_index,
1854                                 vdu_index=vdu_index,
1855                                 vdu_name=vdu_name,
1856                                 deploy_params=deploy_params_vdu,
1857                                 descriptor_config=descriptor_config,
1858                                 base_folder=base_folder,
1859                                 task_instantiation_info=tasks_dict_info,
1860                                 stage=stage
1861                             )
1862                 for kdud in get_kdu_list(vnfd):
1863                     kdu_name = kdud["name"]
1864                     descriptor_config = get_configuration(vnfd, kdu_name)
1865                     if descriptor_config:
1866                         vdu_id = None
1867                         vdu_index = 0
1868                         vdu_name = None
1869                         kdur = next(x for x in db_vnfr["kdur"] if x["kdu-name"] == kdu_name)
1870                         deploy_params_kdu = {"OSM": get_osm_params(db_vnfr)}
1871                         if kdur.get("additionalParams"):
1872                             deploy_params_kdu = parse_yaml_strings(kdur["additionalParams"])
1873
1874                         self._deploy_n2vc(
1875                             logging_text=logging_text,
1876                             db_nsr=db_nsr,
1877                             db_vnfr=db_vnfr,
1878                             nslcmop_id=nslcmop_id,
1879                             nsr_id=nsr_id,
1880                             nsi_id=nsi_id,
1881                             vnfd_id=vnfd_id,
1882                             vdu_id=vdu_id,
1883                             kdu_name=kdu_name,
1884                             member_vnf_index=member_vnf_index,
1885                             vdu_index=vdu_index,
1886                             vdu_name=vdu_name,
1887                             deploy_params=deploy_params_kdu,
1888                             descriptor_config=descriptor_config,
1889                             base_folder=base_folder,
1890                             task_instantiation_info=tasks_dict_info,
1891                             stage=stage
1892                         )
1893
1894             # Check if this NS has a charm configuration
1895             descriptor_config = nsd.get("ns-configuration")
1896             if descriptor_config and descriptor_config.get("juju"):
1897                 vnfd_id = None
1898                 db_vnfr = None
1899                 member_vnf_index = None
1900                 vdu_id = None
1901                 kdu_name = None
1902                 vdu_index = 0
1903                 vdu_name = None
1904
1905                 # Get additional parameters
1906                 deploy_params = {"OSM": {"vim_account_id": ns_params["vimAccountId"]}}
1907                 if db_nsr.get("additionalParamsForNs"):
1908                     deploy_params.update(parse_yaml_strings(db_nsr["additionalParamsForNs"].copy()))
1909                 base_folder = nsd["_admin"]["storage"]
1910                 self._deploy_n2vc(
1911                     logging_text=logging_text,
1912                     db_nsr=db_nsr,
1913                     db_vnfr=db_vnfr,
1914                     nslcmop_id=nslcmop_id,
1915                     nsr_id=nsr_id,
1916                     nsi_id=nsi_id,
1917                     vnfd_id=vnfd_id,
1918                     vdu_id=vdu_id,
1919                     kdu_name=kdu_name,
1920                     member_vnf_index=member_vnf_index,
1921                     vdu_index=vdu_index,
1922                     vdu_name=vdu_name,
1923                     deploy_params=deploy_params,
1924                     descriptor_config=descriptor_config,
1925                     base_folder=base_folder,
1926                     task_instantiation_info=tasks_dict_info,
1927                     stage=stage
1928                 )
1929
1930             # rest of staff will be done at finally
1931
1932         except (ROclient.ROClientException, DbException, LcmException, N2VCException) as e:
1933             self.logger.error(logging_text + "Exit Exception while '{}': {}".format(stage[1], e))
1934             exc = e
1935         except asyncio.CancelledError:
1936             self.logger.error(logging_text + "Cancelled Exception while '{}'".format(stage[1]))
1937             exc = "Operation was cancelled"
1938         except Exception as e:
1939             exc = traceback.format_exc()
1940             self.logger.critical(logging_text + "Exit Exception while '{}': {}".format(stage[1], e), exc_info=True)
1941         finally:
1942             if exc:
1943                 error_list.append(str(exc))
1944             try:
1945                 # wait for pending tasks
1946                 if tasks_dict_info:
1947                     stage[1] = "Waiting for instantiate pending tasks."
1948                     self.logger.debug(logging_text + stage[1])
1949                     error_list += await self._wait_for_tasks(logging_text, tasks_dict_info, timeout_ns_deploy,
1950                                                              stage, nslcmop_id, nsr_id=nsr_id)
1951                 stage[1] = stage[2] = ""
1952             except asyncio.CancelledError:
1953                 error_list.append("Cancelled")
1954                 # TODO cancel all tasks
1955             except Exception as exc:
1956                 error_list.append(str(exc))
1957
1958             # update operation-status
1959             db_nsr_update["operational-status"] = "running"
1960             # let's begin with VCA 'configured' status (later we can change it)
1961             db_nsr_update["config-status"] = "configured"
1962             for task, task_name in tasks_dict_info.items():
1963                 if not task.done() or task.cancelled() or task.exception():
1964                     if task_name.startswith(self.task_name_deploy_vca):
1965                         # A N2VC task is pending
1966                         db_nsr_update["config-status"] = "failed"
1967                     else:
1968                         # RO or KDU task is pending
1969                         db_nsr_update["operational-status"] = "failed"
1970
1971             # update status at database
1972             if error_list:
1973                 error_detail = ". ".join(error_list)
1974                 self.logger.error(logging_text + error_detail)
1975                 error_description_nslcmop = '{} Detail: {}'.format(stage[0], error_detail)
1976                 error_description_nsr = 'Operation: INSTANTIATING.{}, {}'.format(nslcmop_id, stage[0])
1977
1978                 db_nsr_update["detailed-status"] = error_description_nsr + " Detail: " + error_detail
1979                 db_nslcmop_update["detailed-status"] = error_detail
1980                 nslcmop_operation_state = "FAILED"
1981                 ns_state = "BROKEN"
1982             else:
1983                 error_detail = None
1984                 error_description_nsr = error_description_nslcmop = None
1985                 ns_state = "READY"
1986                 db_nsr_update["detailed-status"] = "Done"
1987                 db_nslcmop_update["detailed-status"] = "Done"
1988                 nslcmop_operation_state = "COMPLETED"
1989
1990             if db_nsr:
1991                 self._write_ns_status(
1992                     nsr_id=nsr_id,
1993                     ns_state=ns_state,
1994                     current_operation="IDLE",
1995                     current_operation_id=None,
1996                     error_description=error_description_nsr,
1997                     error_detail=error_detail,
1998                     other_update=db_nsr_update
1999                 )
2000             self._write_op_status(
2001                 op_id=nslcmop_id,
2002                 stage="",
2003                 error_message=error_description_nslcmop,
2004                 operation_state=nslcmop_operation_state,
2005                 other_update=db_nslcmop_update,
2006             )
2007
2008             if nslcmop_operation_state:
2009                 try:
2010                     await self.msg.aiowrite("ns", "instantiated", {"nsr_id": nsr_id, "nslcmop_id": nslcmop_id,
2011                                                                    "operationState": nslcmop_operation_state},
2012                                             loop=self.loop)
2013                 except Exception as e:
2014                     self.logger.error(logging_text + "kafka_write notification Exception {}".format(e))
2015
2016             self.logger.debug(logging_text + "Exit")
2017             self.lcm_tasks.remove("ns", nsr_id, nslcmop_id, "ns_instantiate")
2018
2019     async def _add_vca_relations(self, logging_text, nsr_id, vca_index: int,
2020                                  timeout: int = 3600, vca_type: str = None) -> bool:
2021
2022         # steps:
2023         # 1. find all relations for this VCA
2024         # 2. wait for other peers related
2025         # 3. add relations
2026
2027         try:
2028             vca_type = vca_type or "lxc_proxy_charm"
2029
2030             # STEP 1: find all relations for this VCA
2031
2032             # read nsr record
2033             db_nsr = self.db.get_one("nsrs", {"_id": nsr_id})
2034             nsd = self.db.get_one("nsds", {"_id": db_nsr["nsd-id"]})
2035
2036             # this VCA data
2037             my_vca = deep_get(db_nsr, ('_admin', 'deployed', 'VCA'))[vca_index]
2038
2039             # read all ns-configuration relations
2040             ns_relations = list()
2041             db_ns_relations = deep_get(nsd, ('ns-configuration', 'relation'))
2042             if db_ns_relations:
2043                 for r in db_ns_relations:
2044                     # check if this VCA is in the relation
2045                     if my_vca.get('member-vnf-index') in\
2046                             (r.get('entities')[0].get('id'), r.get('entities')[1].get('id')):
2047                         ns_relations.append(r)
2048
2049             # read all vnf-configuration relations
2050             vnf_relations = list()
2051             db_vnfd_list = db_nsr.get('vnfd-id')
2052             if db_vnfd_list:
2053                 for vnfd in db_vnfd_list:
2054                     db_vnfd = self.db.get_one("vnfds", {"_id": vnfd})
2055                     db_vnf_relations = get_configuration(db_vnfd, db_vnfd["id"]).get("relation", [])
2056                     if db_vnf_relations:
2057                         for r in db_vnf_relations:
2058                             # check if this VCA is in the relation
2059                             if my_vca.get('vdu_id') in (r.get('entities')[0].get('id'), r.get('entities')[1].get('id')):
2060                                 vnf_relations.append(r)
2061
2062             # if no relations, terminate
2063             if not ns_relations and not vnf_relations:
2064                 self.logger.debug(logging_text + ' No relations')
2065                 return True
2066
2067             self.logger.debug(logging_text + ' adding relations\n    {}\n    {}'.format(ns_relations, vnf_relations))
2068
2069             # add all relations
2070             start = time()
2071             while True:
2072                 # check timeout
2073                 now = time()
2074                 if now - start >= timeout:
2075                     self.logger.error(logging_text + ' : timeout adding relations')
2076                     return False
2077
2078                 # reload nsr from database (we need to update record: _admin.deloyed.VCA)
2079                 db_nsr = self.db.get_one("nsrs", {"_id": nsr_id})
2080
2081                 # for each defined NS relation, find the VCA's related
2082                 for r in ns_relations.copy():
2083                     from_vca_ee_id = None
2084                     to_vca_ee_id = None
2085                     from_vca_endpoint = None
2086                     to_vca_endpoint = None
2087                     vca_list = deep_get(db_nsr, ('_admin', 'deployed', 'VCA'))
2088                     for vca in vca_list:
2089                         if vca.get('member-vnf-index') == r.get('entities')[0].get('id') \
2090                                 and vca.get('config_sw_installed'):
2091                             from_vca_ee_id = vca.get('ee_id')
2092                             from_vca_endpoint = r.get('entities')[0].get('endpoint')
2093                         if vca.get('member-vnf-index') == r.get('entities')[1].get('id') \
2094                                 and vca.get('config_sw_installed'):
2095                             to_vca_ee_id = vca.get('ee_id')
2096                             to_vca_endpoint = r.get('entities')[1].get('endpoint')
2097                     if from_vca_ee_id and to_vca_ee_id:
2098                         # add relation
2099                         await self.vca_map[vca_type].add_relation(
2100                             ee_id_1=from_vca_ee_id,
2101                             ee_id_2=to_vca_ee_id,
2102                             endpoint_1=from_vca_endpoint,
2103                             endpoint_2=to_vca_endpoint)
2104                         # remove entry from relations list
2105                         ns_relations.remove(r)
2106                     else:
2107                         # check failed peers
2108                         try:
2109                             vca_status_list = db_nsr.get('configurationStatus')
2110                             if vca_status_list:
2111                                 for i in range(len(vca_list)):
2112                                     vca = vca_list[i]
2113                                     vca_status = vca_status_list[i]
2114                                     if vca.get('member-vnf-index') == r.get('entities')[0].get('id'):
2115                                         if vca_status.get('status') == 'BROKEN':
2116                                             # peer broken: remove relation from list
2117                                             ns_relations.remove(r)
2118                                     if vca.get('member-vnf-index') == r.get('entities')[1].get('id'):
2119                                         if vca_status.get('status') == 'BROKEN':
2120                                             # peer broken: remove relation from list
2121                                             ns_relations.remove(r)
2122                         except Exception:
2123                             # ignore
2124                             pass
2125
2126                 # for each defined VNF relation, find the VCA's related
2127                 for r in vnf_relations.copy():
2128                     from_vca_ee_id = None
2129                     to_vca_ee_id = None
2130                     from_vca_endpoint = None
2131                     to_vca_endpoint = None
2132                     vca_list = deep_get(db_nsr, ('_admin', 'deployed', 'VCA'))
2133                     for vca in vca_list:
2134                         key_to_check = "vdu_id"
2135                         if vca.get("vdu_id") is None:
2136                             key_to_check = "vnfd_id"
2137                         if vca.get(key_to_check) == r.get('entities')[0].get('id') and vca.get('config_sw_installed'):
2138                             from_vca_ee_id = vca.get('ee_id')
2139                             from_vca_endpoint = r.get('entities')[0].get('endpoint')
2140                         if vca.get(key_to_check) == r.get('entities')[1].get('id') and vca.get('config_sw_installed'):
2141                             to_vca_ee_id = vca.get('ee_id')
2142                             to_vca_endpoint = r.get('entities')[1].get('endpoint')
2143                     if from_vca_ee_id and to_vca_ee_id:
2144                         # add relation
2145                         await self.vca_map[vca_type].add_relation(
2146                             ee_id_1=from_vca_ee_id,
2147                             ee_id_2=to_vca_ee_id,
2148                             endpoint_1=from_vca_endpoint,
2149                             endpoint_2=to_vca_endpoint)
2150                         # remove entry from relations list
2151                         vnf_relations.remove(r)
2152                     else:
2153                         # check failed peers
2154                         try:
2155                             vca_status_list = db_nsr.get('configurationStatus')
2156                             if vca_status_list:
2157                                 for i in range(len(vca_list)):
2158                                     vca = vca_list[i]
2159                                     vca_status = vca_status_list[i]
2160                                     if vca.get('vdu_id') == r.get('entities')[0].get('id'):
2161                                         if vca_status.get('status') == 'BROKEN':
2162                                             # peer broken: remove relation from list
2163                                             vnf_relations.remove(r)
2164                                     if vca.get('vdu_id') == r.get('entities')[1].get('id'):
2165                                         if vca_status.get('status') == 'BROKEN':
2166                                             # peer broken: remove relation from list
2167                                             vnf_relations.remove(r)
2168                         except Exception:
2169                             # ignore
2170                             pass
2171
2172                 # wait for next try
2173                 await asyncio.sleep(5.0)
2174
2175                 if not ns_relations and not vnf_relations:
2176                     self.logger.debug('Relations added')
2177                     break
2178
2179             return True
2180
2181         except Exception as e:
2182             self.logger.warn(logging_text + ' ERROR adding relations: {}'.format(e))
2183             return False
2184
2185     async def _install_kdu(self, nsr_id: str, nsr_db_path: str, vnfr_data: dict, kdu_index: int, kdud: dict,
2186                            vnfd: dict, k8s_instance_info: dict, k8params: dict = None, timeout: int = 600):
2187
2188         try:
2189             k8sclustertype = k8s_instance_info["k8scluster-type"]
2190             # Instantiate kdu
2191             db_dict_install = {"collection": "nsrs",
2192                                "filter": {"_id": nsr_id},
2193                                "path": nsr_db_path}
2194
2195             kdu_instance = self.k8scluster_map[k8sclustertype].generate_kdu_instance_name(
2196                 db_dict=db_dict_install,
2197                 kdu_model=k8s_instance_info["kdu-model"],
2198             )
2199             self.update_db_2("nsrs", nsr_id, {nsr_db_path + ".kdu-instance": kdu_instance})
2200             await self.k8scluster_map[k8sclustertype].install(
2201                 cluster_uuid=k8s_instance_info["k8scluster-uuid"],
2202                 kdu_model=k8s_instance_info["kdu-model"],
2203                 atomic=True,
2204                 params=k8params,
2205                 db_dict=db_dict_install,
2206                 timeout=timeout,
2207                 kdu_name=k8s_instance_info["kdu-name"],
2208                 namespace=k8s_instance_info["namespace"],
2209                 kdu_instance=kdu_instance,
2210             )
2211             self.update_db_2("nsrs", nsr_id, {nsr_db_path + ".kdu-instance": kdu_instance})
2212
2213             # Obtain services to obtain management service ip
2214             services = await self.k8scluster_map[k8sclustertype].get_services(
2215                 cluster_uuid=k8s_instance_info["k8scluster-uuid"],
2216                 kdu_instance=kdu_instance,
2217                 namespace=k8s_instance_info["namespace"])
2218
2219             # Obtain management service info (if exists)
2220             vnfr_update_dict = {}
2221             if services:
2222                 vnfr_update_dict["kdur.{}.services".format(kdu_index)] = services
2223                 mgmt_services = [service for service in kdud.get("service", []) if service.get("mgmt-service")]
2224                 for mgmt_service in mgmt_services:
2225                     for service in services:
2226                         if service["name"].startswith(mgmt_service["name"]):
2227                             # Mgmt service found, Obtain service ip
2228                             ip = service.get("external_ip", service.get("cluster_ip"))
2229                             if isinstance(ip, list) and len(ip) == 1:
2230                                 ip = ip[0]
2231
2232                             vnfr_update_dict["kdur.{}.ip-address".format(kdu_index)] = ip
2233
2234                             # Check if must update also mgmt ip at the vnf
2235                             service_external_cp = mgmt_service.get("external-connection-point-ref")
2236                             if service_external_cp:
2237                                 if deep_get(vnfd, ("mgmt-interface", "cp")) == service_external_cp:
2238                                     vnfr_update_dict["ip-address"] = ip
2239
2240                             break
2241                     else:
2242                         self.logger.warn("Mgmt service name: {} not found".format(mgmt_service["name"]))
2243
2244             vnfr_update_dict["kdur.{}.status".format(kdu_index)] = "READY"
2245             self.update_db_2("vnfrs", vnfr_data.get("_id"), vnfr_update_dict)
2246
2247             kdu_config = get_configuration(vnfd, k8s_instance_info["kdu-name"])
2248             if kdu_config and kdu_config.get("initial-config-primitive") and \
2249                get_juju_ee_ref(vnfd, k8s_instance_info["kdu-name"]) is None:
2250                 initial_config_primitive_list = kdu_config.get("initial-config-primitive")
2251                 initial_config_primitive_list.sort(key=lambda val: int(val["seq"]))
2252
2253                 for initial_config_primitive in initial_config_primitive_list:
2254                     primitive_params_ = self._map_primitive_params(initial_config_primitive, {}, {})
2255
2256                     await asyncio.wait_for(
2257                         self.k8scluster_map[k8sclustertype].exec_primitive(
2258                             cluster_uuid=k8s_instance_info["k8scluster-uuid"],
2259                             kdu_instance=kdu_instance,
2260                             primitive_name=initial_config_primitive["name"],
2261                             params=primitive_params_, db_dict={}),
2262                         timeout=timeout)
2263
2264         except Exception as e:
2265             # Prepare update db with error and raise exception
2266             try:
2267                 self.update_db_2("nsrs", nsr_id, {nsr_db_path + ".detailed-status": str(e)})
2268                 self.update_db_2("vnfrs", vnfr_data.get("_id"), {"kdur.{}.status".format(kdu_index): "ERROR"})
2269             except Exception:
2270                 # ignore to keep original exception
2271                 pass
2272             # reraise original error
2273             raise
2274
2275         return kdu_instance
2276
2277     async def deploy_kdus(self, logging_text, nsr_id, nslcmop_id, db_vnfrs, db_vnfds, task_instantiation_info):
2278         # Launch kdus if present in the descriptor
2279
2280         k8scluster_id_2_uuic = {"helm-chart-v3": {}, "helm-chart": {}, "juju-bundle": {}}
2281
2282         async def _get_cluster_id(cluster_id, cluster_type):
2283             nonlocal k8scluster_id_2_uuic
2284             if cluster_id in k8scluster_id_2_uuic[cluster_type]:
2285                 return k8scluster_id_2_uuic[cluster_type][cluster_id]
2286
2287             # check if K8scluster is creating and wait look if previous tasks in process
2288             task_name, task_dependency = self.lcm_tasks.lookfor_related("k8scluster", cluster_id)
2289             if task_dependency:
2290                 text = "Waiting for related tasks '{}' on k8scluster {} to be completed".format(task_name, cluster_id)
2291                 self.logger.debug(logging_text + text)
2292                 await asyncio.wait(task_dependency, timeout=3600)
2293
2294             db_k8scluster = self.db.get_one("k8sclusters", {"_id": cluster_id}, fail_on_empty=False)
2295             if not db_k8scluster:
2296                 raise LcmException("K8s cluster {} cannot be found".format(cluster_id))
2297
2298             k8s_id = deep_get(db_k8scluster, ("_admin", cluster_type, "id"))
2299             if not k8s_id:
2300                 if cluster_type == "helm-chart-v3":
2301                     try:
2302                         # backward compatibility for existing clusters that have not been initialized for helm v3
2303                         k8s_credentials = yaml.safe_dump(db_k8scluster.get("credentials"))
2304                         k8s_id, uninstall_sw = await self.k8sclusterhelm3.init_env(k8s_credentials,
2305                                                                                    reuse_cluster_uuid=cluster_id)
2306                         db_k8scluster_update = {}
2307                         db_k8scluster_update["_admin.helm-chart-v3.error_msg"] = None
2308                         db_k8scluster_update["_admin.helm-chart-v3.id"] = k8s_id
2309                         db_k8scluster_update["_admin.helm-chart-v3.created"] = uninstall_sw
2310                         db_k8scluster_update["_admin.helm-chart-v3.operationalState"] = "ENABLED"
2311                         self.update_db_2("k8sclusters", cluster_id, db_k8scluster_update)
2312                     except Exception as e:
2313                         self.logger.error(logging_text + "error initializing helm-v3 cluster: {}".format(str(e)))
2314                         raise LcmException("K8s cluster '{}' has not been initialized for '{}'".format(cluster_id,
2315                                                                                                        cluster_type))
2316                 else:
2317                     raise LcmException("K8s cluster '{}' has not been initialized for '{}'".
2318                                        format(cluster_id, cluster_type))
2319             k8scluster_id_2_uuic[cluster_type][cluster_id] = k8s_id
2320             return k8s_id
2321
2322         logging_text += "Deploy kdus: "
2323         step = ""
2324         try:
2325             db_nsr_update = {"_admin.deployed.K8s": []}
2326             self.update_db_2("nsrs", nsr_id, db_nsr_update)
2327
2328             index = 0
2329             updated_cluster_list = []
2330             updated_v3_cluster_list = []
2331
2332             for vnfr_data in db_vnfrs.values():
2333                 for kdu_index, kdur in enumerate(get_iterable(vnfr_data, "kdur")):
2334                     # Step 0: Prepare and set parameters
2335                     desc_params = parse_yaml_strings(kdur.get("additionalParams"))
2336                     vnfd_id = vnfr_data.get('vnfd-id')
2337                     vnfd_with_id = find_in_list(db_vnfds, lambda vnfd: vnfd["_id"] == vnfd_id)
2338                     kdud = next(kdud for kdud in vnfd_with_id["kdu"] if kdud["name"] == kdur["kdu-name"])
2339                     namespace = kdur.get("k8s-namespace")
2340                     if kdur.get("helm-chart"):
2341                         kdumodel = kdur["helm-chart"]
2342                         # Default version: helm3, if helm-version is v2 assign v2
2343                         k8sclustertype = "helm-chart-v3"
2344                         self.logger.debug("kdur: {}".format(kdur))
2345                         if kdur.get("helm-version") and kdur.get("helm-version") == "v2":
2346                             k8sclustertype = "helm-chart"
2347                     elif kdur.get("juju-bundle"):
2348                         kdumodel = kdur["juju-bundle"]
2349                         k8sclustertype = "juju-bundle"
2350                     else:
2351                         raise LcmException("kdu type for kdu='{}.{}' is neither helm-chart nor "
2352                                            "juju-bundle. Maybe an old NBI version is running".
2353                                            format(vnfr_data["member-vnf-index-ref"], kdur["kdu-name"]))
2354                     # check if kdumodel is a file and exists
2355                     try:
2356                         vnfd_with_id = find_in_list(db_vnfds, lambda vnfd: vnfd["_id"] == vnfd_id)
2357                         storage = deep_get(vnfd_with_id, ('_admin', 'storage'))
2358                         if storage and storage.get('pkg-dir'):  # may be not present if vnfd has not artifacts
2359                             # path format: /vnfdid/pkkdir/helm-charts|juju-bundles/kdumodel
2360                             filename = '{}/{}/{}s/{}'.format(storage["folder"], storage["pkg-dir"], k8sclustertype,
2361                                                              kdumodel)
2362                             if self.fs.file_exists(filename, mode='file') or self.fs.file_exists(filename, mode='dir'):
2363                                 kdumodel = self.fs.path + filename
2364                     except (asyncio.TimeoutError, asyncio.CancelledError):
2365                         raise
2366                     except Exception:       # it is not a file
2367                         pass
2368
2369                     k8s_cluster_id = kdur["k8s-cluster"]["id"]
2370                     step = "Synchronize repos for k8s cluster '{}'".format(k8s_cluster_id)
2371                     cluster_uuid = await _get_cluster_id(k8s_cluster_id, k8sclustertype)
2372
2373                     # Synchronize  repos
2374                     if (k8sclustertype == "helm-chart" and cluster_uuid not in updated_cluster_list)\
2375                             or (k8sclustertype == "helm-chart-v3" and cluster_uuid not in updated_v3_cluster_list):
2376                         del_repo_list, added_repo_dict = await asyncio.ensure_future(
2377                             self.k8scluster_map[k8sclustertype].synchronize_repos(cluster_uuid=cluster_uuid))
2378                         if del_repo_list or added_repo_dict:
2379                             if k8sclustertype == "helm-chart":
2380                                 unset = {'_admin.helm_charts_added.' + item: None for item in del_repo_list}
2381                                 updated = {'_admin.helm_charts_added.' +
2382                                            item: name for item, name in added_repo_dict.items()}
2383                                 updated_cluster_list.append(cluster_uuid)
2384                             elif k8sclustertype == "helm-chart-v3":
2385                                 unset = {'_admin.helm_charts_v3_added.' + item: None for item in del_repo_list}
2386                                 updated = {'_admin.helm_charts_v3_added.' +
2387                                            item: name for item, name in added_repo_dict.items()}
2388                                 updated_v3_cluster_list.append(cluster_uuid)
2389                             self.logger.debug(logging_text + "repos synchronized on k8s cluster "
2390                                                              "'{}' to_delete: {}, to_add: {}".
2391                                               format(k8s_cluster_id, del_repo_list, added_repo_dict))
2392                             self.db.set_one("k8sclusters", {"_id": k8s_cluster_id}, updated, unset=unset)
2393
2394                     # Instantiate kdu
2395                     step = "Instantiating KDU {}.{} in k8s cluster {}".format(vnfr_data["member-vnf-index-ref"],
2396                                                                               kdur["kdu-name"], k8s_cluster_id)
2397                     k8s_instance_info = {"kdu-instance": None,
2398                                          "k8scluster-uuid": cluster_uuid,
2399                                          "k8scluster-type": k8sclustertype,
2400                                          "member-vnf-index": vnfr_data["member-vnf-index-ref"],
2401                                          "kdu-name": kdur["kdu-name"],
2402                                          "kdu-model": kdumodel,
2403                                          "namespace": namespace}
2404                     db_path = "_admin.deployed.K8s.{}".format(index)
2405                     db_nsr_update[db_path] = k8s_instance_info
2406                     self.update_db_2("nsrs", nsr_id, db_nsr_update)
2407                     vnfd_with_id = find_in_list(db_vnfds, lambda vnf: vnf["_id"] == vnfd_id)
2408                     task = asyncio.ensure_future(
2409                         self._install_kdu(nsr_id, db_path, vnfr_data, kdu_index, kdud, vnfd_with_id,
2410                                           k8s_instance_info, k8params=desc_params, timeout=600))
2411                     self.lcm_tasks.register("ns", nsr_id, nslcmop_id, "instantiate_KDU-{}".format(index), task)
2412                     task_instantiation_info[task] = "Deploying KDU {}".format(kdur["kdu-name"])
2413
2414                     index += 1
2415
2416         except (LcmException, asyncio.CancelledError):
2417             raise
2418         except Exception as e:
2419             msg = "Exception {} while {}: {}".format(type(e).__name__, step, e)
2420             if isinstance(e, (N2VCException, DbException)):
2421                 self.logger.error(logging_text + msg)
2422             else:
2423                 self.logger.critical(logging_text + msg, exc_info=True)
2424             raise LcmException(msg)
2425         finally:
2426             if db_nsr_update:
2427                 self.update_db_2("nsrs", nsr_id, db_nsr_update)
2428
2429     def _deploy_n2vc(self, logging_text, db_nsr, db_vnfr, nslcmop_id, nsr_id, nsi_id, vnfd_id, vdu_id,
2430                      kdu_name, member_vnf_index, vdu_index, vdu_name, deploy_params, descriptor_config,
2431                      base_folder, task_instantiation_info, stage):
2432         # launch instantiate_N2VC in a asyncio task and register task object
2433         # Look where information of this charm is at database <nsrs>._admin.deployed.VCA
2434         # if not found, create one entry and update database
2435         # fill db_nsr._admin.deployed.VCA.<index>
2436
2437         self.logger.debug(logging_text + "_deploy_n2vc vnfd_id={}, vdu_id={}".format(vnfd_id, vdu_id))
2438         if "execution-environment-list" in descriptor_config:
2439             ee_list = descriptor_config.get("execution-environment-list", [])
2440         else:  # other types as script are not supported
2441             ee_list = []
2442
2443         for ee_item in ee_list:
2444             self.logger.debug(logging_text + "_deploy_n2vc ee_item juju={}, helm={}".format(ee_item.get('juju'),
2445                                                                                             ee_item.get("helm-chart")))
2446             ee_descriptor_id = ee_item.get("id")
2447             if ee_item.get("juju"):
2448                 vca_name = ee_item['juju'].get('charm')
2449                 vca_type = "lxc_proxy_charm" if ee_item['juju'].get('charm') is not None else "native_charm"
2450                 if ee_item['juju'].get('cloud') == "k8s":
2451                     vca_type = "k8s_proxy_charm"
2452                 elif ee_item['juju'].get('proxy') is False:
2453                     vca_type = "native_charm"
2454             elif ee_item.get("helm-chart"):
2455                 vca_name = ee_item['helm-chart']
2456                 if ee_item.get("helm-version") and ee_item.get("helm-version") == "v2":
2457                     vca_type = "helm"
2458                 else:
2459                     vca_type = "helm-v3"
2460             else:
2461                 self.logger.debug(logging_text + "skipping non juju neither charm configuration")
2462                 continue
2463
2464             vca_index = -1
2465             for vca_index, vca_deployed in enumerate(db_nsr["_admin"]["deployed"]["VCA"]):
2466                 if not vca_deployed:
2467                     continue
2468                 if vca_deployed.get("member-vnf-index") == member_vnf_index and \
2469                         vca_deployed.get("vdu_id") == vdu_id and \
2470                         vca_deployed.get("kdu_name") == kdu_name and \
2471                         vca_deployed.get("vdu_count_index", 0) == vdu_index and \
2472                         vca_deployed.get("ee_descriptor_id") == ee_descriptor_id:
2473                     break
2474             else:
2475                 # not found, create one.
2476                 target = "ns" if not member_vnf_index else "vnf/{}".format(member_vnf_index)
2477                 if vdu_id:
2478                     target += "/vdu/{}/{}".format(vdu_id, vdu_index or 0)
2479                 elif kdu_name:
2480                     target += "/kdu/{}".format(kdu_name)
2481                 vca_deployed = {
2482                     "target_element": target,
2483                     # ^ target_element will replace member-vnf-index, kdu_name, vdu_id ... in a single string
2484                     "member-vnf-index": member_vnf_index,
2485                     "vdu_id": vdu_id,
2486                     "kdu_name": kdu_name,
2487                     "vdu_count_index": vdu_index,
2488                     "operational-status": "init",  # TODO revise
2489                     "detailed-status": "",  # TODO revise
2490                     "step": "initial-deploy",   # TODO revise
2491                     "vnfd_id": vnfd_id,
2492                     "vdu_name": vdu_name,
2493                     "type": vca_type,
2494                     "ee_descriptor_id": ee_descriptor_id
2495                 }
2496                 vca_index += 1
2497
2498                 # create VCA and configurationStatus in db
2499                 db_dict = {
2500                     "_admin.deployed.VCA.{}".format(vca_index): vca_deployed,
2501                     "configurationStatus.{}".format(vca_index): dict()
2502                 }
2503                 self.update_db_2("nsrs", nsr_id, db_dict)
2504
2505                 db_nsr["_admin"]["deployed"]["VCA"].append(vca_deployed)
2506
2507             self.logger.debug("N2VC > NSR_ID > {}".format(nsr_id))
2508             self.logger.debug("N2VC > DB_NSR > {}".format(db_nsr))
2509             self.logger.debug("N2VC > VCA_DEPLOYED > {}".format(vca_deployed))
2510
2511             # Launch task
2512             task_n2vc = asyncio.ensure_future(
2513                 self.instantiate_N2VC(
2514                     logging_text=logging_text,
2515                     vca_index=vca_index,
2516                     nsi_id=nsi_id,
2517                     db_nsr=db_nsr,
2518                     db_vnfr=db_vnfr,
2519                     vdu_id=vdu_id,
2520                     kdu_name=kdu_name,
2521                     vdu_index=vdu_index,
2522                     deploy_params=deploy_params,
2523                     config_descriptor=descriptor_config,
2524                     base_folder=base_folder,
2525                     nslcmop_id=nslcmop_id,
2526                     stage=stage,
2527                     vca_type=vca_type,
2528                     vca_name=vca_name,
2529                     ee_config_descriptor=ee_item
2530                 )
2531             )
2532             self.lcm_tasks.register("ns", nsr_id, nslcmop_id, "instantiate_N2VC-{}".format(vca_index), task_n2vc)
2533             task_instantiation_info[task_n2vc] = self.task_name_deploy_vca + " {}.{}".format(
2534                 member_vnf_index or "", vdu_id or "")
2535
2536     @staticmethod
2537     def _create_nslcmop(nsr_id, operation, params):
2538         """
2539         Creates a ns-lcm-opp content to be stored at database.
2540         :param nsr_id: internal id of the instance
2541         :param operation: instantiate, terminate, scale, action, ...
2542         :param params: user parameters for the operation
2543         :return: dictionary following SOL005 format
2544         """
2545         # Raise exception if invalid arguments
2546         if not (nsr_id and operation and params):
2547             raise LcmException(
2548                 "Parameters 'nsr_id', 'operation' and 'params' needed to create primitive not provided")
2549         now = time()
2550         _id = str(uuid4())
2551         nslcmop = {
2552             "id": _id,
2553             "_id": _id,
2554             # COMPLETED,PARTIALLY_COMPLETED,FAILED_TEMP,FAILED,ROLLING_BACK,ROLLED_BACK
2555             "operationState": "PROCESSING",
2556             "statusEnteredTime": now,
2557             "nsInstanceId": nsr_id,
2558             "lcmOperationType": operation,
2559             "startTime": now,
2560             "isAutomaticInvocation": False,
2561             "operationParams": params,
2562             "isCancelPending": False,
2563             "links": {
2564                 "self": "/osm/nslcm/v1/ns_lcm_op_occs/" + _id,
2565                 "nsInstance": "/osm/nslcm/v1/ns_instances/" + nsr_id,
2566             }
2567         }
2568         return nslcmop
2569
2570     def _format_additional_params(self, params):
2571         params = params or {}
2572         for key, value in params.items():
2573             if str(value).startswith("!!yaml "):
2574                 params[key] = yaml.safe_load(value[7:])
2575         return params
2576
2577     def _get_terminate_primitive_params(self, seq, vnf_index):
2578         primitive = seq.get('name')
2579         primitive_params = {}
2580         params = {
2581             "member_vnf_index": vnf_index,
2582             "primitive": primitive,
2583             "primitive_params": primitive_params,
2584         }
2585         desc_params = {}
2586         return self._map_primitive_params(seq, params, desc_params)
2587
2588     # sub-operations
2589
2590     def _retry_or_skip_suboperation(self, db_nslcmop, op_index):
2591         op = deep_get(db_nslcmop, ('_admin', 'operations'), [])[op_index]
2592         if op.get('operationState') == 'COMPLETED':
2593             # b. Skip sub-operation
2594             # _ns_execute_primitive() or RO.create_action() will NOT be executed
2595             return self.SUBOPERATION_STATUS_SKIP
2596         else:
2597             # c. retry executing sub-operation
2598             # The sub-operation exists, and operationState != 'COMPLETED'
2599             # Update operationState = 'PROCESSING' to indicate a retry.
2600             operationState = 'PROCESSING'
2601             detailed_status = 'In progress'
2602             self._update_suboperation_status(
2603                 db_nslcmop, op_index, operationState, detailed_status)
2604             # Return the sub-operation index
2605             # _ns_execute_primitive() or RO.create_action() will be called from scale()
2606             # with arguments extracted from the sub-operation
2607             return op_index
2608
2609     # Find a sub-operation where all keys in a matching dictionary must match
2610     # Returns the index of the matching sub-operation, or SUBOPERATION_STATUS_NOT_FOUND if no match
2611     def _find_suboperation(self, db_nslcmop, match):
2612         if db_nslcmop and match:
2613             op_list = db_nslcmop.get('_admin', {}).get('operations', [])
2614             for i, op in enumerate(op_list):
2615                 if all(op.get(k) == match[k] for k in match):
2616                     return i
2617         return self.SUBOPERATION_STATUS_NOT_FOUND
2618
2619     # Update status for a sub-operation given its index
2620     def _update_suboperation_status(self, db_nslcmop, op_index, operationState, detailed_status):
2621         # Update DB for HA tasks
2622         q_filter = {'_id': db_nslcmop['_id']}
2623         update_dict = {'_admin.operations.{}.operationState'.format(op_index): operationState,
2624                        '_admin.operations.{}.detailed-status'.format(op_index): detailed_status}
2625         self.db.set_one("nslcmops",
2626                         q_filter=q_filter,
2627                         update_dict=update_dict,
2628                         fail_on_empty=False)
2629
2630     # Add sub-operation, return the index of the added sub-operation
2631     # Optionally, set operationState, detailed-status, and operationType
2632     # Status and type are currently set for 'scale' sub-operations:
2633     # 'operationState' : 'PROCESSING' | 'COMPLETED' | 'FAILED'
2634     # 'detailed-status' : status message
2635     # 'operationType': may be any type, in the case of scaling: 'PRE-SCALE' | 'POST-SCALE'
2636     # Status and operation type are currently only used for 'scale', but NOT for 'terminate' sub-operations.
2637     def _add_suboperation(self, db_nslcmop, vnf_index, vdu_id, vdu_count_index, vdu_name, primitive,
2638                           mapped_primitive_params, operationState=None, detailed_status=None, operationType=None,
2639                           RO_nsr_id=None, RO_scaling_info=None):
2640         if not db_nslcmop:
2641             return self.SUBOPERATION_STATUS_NOT_FOUND
2642         # Get the "_admin.operations" list, if it exists
2643         db_nslcmop_admin = db_nslcmop.get('_admin', {})
2644         op_list = db_nslcmop_admin.get('operations')
2645         # Create or append to the "_admin.operations" list
2646         new_op = {'member_vnf_index': vnf_index,
2647                   'vdu_id': vdu_id,
2648                   'vdu_count_index': vdu_count_index,
2649                   'primitive': primitive,
2650                   'primitive_params': mapped_primitive_params}
2651         if operationState:
2652             new_op['operationState'] = operationState
2653         if detailed_status:
2654             new_op['detailed-status'] = detailed_status
2655         if operationType:
2656             new_op['lcmOperationType'] = operationType
2657         if RO_nsr_id:
2658             new_op['RO_nsr_id'] = RO_nsr_id
2659         if RO_scaling_info:
2660             new_op['RO_scaling_info'] = RO_scaling_info
2661         if not op_list:
2662             # No existing operations, create key 'operations' with current operation as first list element
2663             db_nslcmop_admin.update({'operations': [new_op]})
2664             op_list = db_nslcmop_admin.get('operations')
2665         else:
2666             # Existing operations, append operation to list
2667             op_list.append(new_op)
2668
2669         db_nslcmop_update = {'_admin.operations': op_list}
2670         self.update_db_2("nslcmops", db_nslcmop['_id'], db_nslcmop_update)
2671         op_index = len(op_list) - 1
2672         return op_index
2673
2674     # Helper methods for scale() sub-operations
2675
2676     # pre-scale/post-scale:
2677     # Check for 3 different cases:
2678     # a. New: First time execution, return SUBOPERATION_STATUS_NEW
2679     # b. Skip: Existing sub-operation exists, operationState == 'COMPLETED', return SUBOPERATION_STATUS_SKIP
2680     # c. retry: Existing sub-operation exists, operationState != 'COMPLETED', return op_index to re-execute
2681     def _check_or_add_scale_suboperation(self, db_nslcmop, vnf_index, vnf_config_primitive, primitive_params,
2682                                          operationType, RO_nsr_id=None, RO_scaling_info=None):
2683         # Find this sub-operation
2684         if RO_nsr_id and RO_scaling_info:
2685             operationType = 'SCALE-RO'
2686             match = {
2687                 'member_vnf_index': vnf_index,
2688                 'RO_nsr_id': RO_nsr_id,
2689                 'RO_scaling_info': RO_scaling_info,
2690             }
2691         else:
2692             match = {
2693                 'member_vnf_index': vnf_index,
2694                 'primitive': vnf_config_primitive,
2695                 'primitive_params': primitive_params,
2696                 'lcmOperationType': operationType
2697             }
2698         op_index = self._find_suboperation(db_nslcmop, match)
2699         if op_index == self.SUBOPERATION_STATUS_NOT_FOUND:
2700             # a. New sub-operation
2701             # The sub-operation does not exist, add it.
2702             # _ns_execute_primitive() will be called from scale() as usual, with non-modified arguments
2703             # The following parameters are set to None for all kind of scaling:
2704             vdu_id = None
2705             vdu_count_index = None
2706             vdu_name = None
2707             if RO_nsr_id and RO_scaling_info:
2708                 vnf_config_primitive = None
2709                 primitive_params = None
2710             else:
2711                 RO_nsr_id = None
2712                 RO_scaling_info = None
2713             # Initial status for sub-operation
2714             operationState = 'PROCESSING'
2715             detailed_status = 'In progress'
2716             # Add sub-operation for pre/post-scaling (zero or more operations)
2717             self._add_suboperation(db_nslcmop,
2718                                    vnf_index,
2719                                    vdu_id,
2720                                    vdu_count_index,
2721                                    vdu_name,
2722                                    vnf_config_primitive,
2723                                    primitive_params,
2724                                    operationState,
2725                                    detailed_status,
2726                                    operationType,
2727                                    RO_nsr_id,
2728                                    RO_scaling_info)
2729             return self.SUBOPERATION_STATUS_NEW
2730         else:
2731             # Return either SUBOPERATION_STATUS_SKIP (operationState == 'COMPLETED'),
2732             # or op_index (operationState != 'COMPLETED')
2733             return self._retry_or_skip_suboperation(db_nslcmop, op_index)
2734
2735     # Function to return execution_environment id
2736
2737     def _get_ee_id(self, vnf_index, vdu_id, vca_deployed_list):
2738         # TODO vdu_index_count
2739         for vca in vca_deployed_list:
2740             if vca["member-vnf-index"] == vnf_index and vca["vdu_id"] == vdu_id:
2741                 return vca["ee_id"]
2742
2743     async def destroy_N2VC(self, logging_text, db_nslcmop, vca_deployed, config_descriptor,
2744                            vca_index, destroy_ee=True, exec_primitives=True, scaling_in=False):
2745         """
2746         Execute the terminate primitives and destroy the execution environment (if destroy_ee=False
2747         :param logging_text:
2748         :param db_nslcmop:
2749         :param vca_deployed: Dictionary of deployment info at db_nsr._admin.depoloyed.VCA.<INDEX>
2750         :param config_descriptor: Configuration descriptor of the NSD, VNFD, VNFD.vdu or VNFD.kdu
2751         :param vca_index: index in the database _admin.deployed.VCA
2752         :param destroy_ee: False to do not destroy, because it will be destroyed all of then at once
2753         :param exec_primitives: False to do not execute terminate primitives, because the config is not completed or has
2754                             not executed properly
2755         :param scaling_in: True destroys the application, False destroys the model
2756         :return: None or exception
2757         """
2758
2759         self.logger.debug(
2760             logging_text + " vca_index: {}, vca_deployed: {}, config_descriptor: {}, destroy_ee: {}".format(
2761                 vca_index, vca_deployed, config_descriptor, destroy_ee
2762             )
2763         )
2764
2765         vca_type = vca_deployed.get("type", "lxc_proxy_charm")
2766
2767         # execute terminate_primitives
2768         if exec_primitives:
2769             terminate_primitives = get_ee_sorted_terminate_config_primitive_list(
2770                 config_descriptor.get("terminate-config-primitive"), vca_deployed.get("ee_descriptor_id"))
2771             vdu_id = vca_deployed.get("vdu_id")
2772             vdu_count_index = vca_deployed.get("vdu_count_index")
2773             vdu_name = vca_deployed.get("vdu_name")
2774             vnf_index = vca_deployed.get("member-vnf-index")
2775             if terminate_primitives and vca_deployed.get("needed_terminate"):
2776                 for seq in terminate_primitives:
2777                     # For each sequence in list, get primitive and call _ns_execute_primitive()
2778                     step = "Calling terminate action for vnf_member_index={} primitive={}".format(
2779                         vnf_index, seq.get("name"))
2780                     self.logger.debug(logging_text + step)
2781                     # Create the primitive for each sequence, i.e. "primitive": "touch"
2782                     primitive = seq.get('name')
2783                     mapped_primitive_params = self._get_terminate_primitive_params(seq, vnf_index)
2784
2785                     # Add sub-operation
2786                     self._add_suboperation(db_nslcmop,
2787                                            vnf_index,
2788                                            vdu_id,
2789                                            vdu_count_index,
2790                                            vdu_name,
2791                                            primitive,
2792                                            mapped_primitive_params)
2793                     # Sub-operations: Call _ns_execute_primitive() instead of action()
2794                     try:
2795                         result, result_detail = await self._ns_execute_primitive(vca_deployed["ee_id"], primitive,
2796                                                                                  mapped_primitive_params,
2797                                                                                  vca_type=vca_type)
2798                     except LcmException:
2799                         # this happens when VCA is not deployed. In this case it is not needed to terminate
2800                         continue
2801                     result_ok = ['COMPLETED', 'PARTIALLY_COMPLETED']
2802                     if result not in result_ok:
2803                         raise LcmException("terminate_primitive {}  for vnf_member_index={} fails with "
2804                                            "error {}".format(seq.get("name"), vnf_index, result_detail))
2805                 # set that this VCA do not need terminated
2806                 db_update_entry = "_admin.deployed.VCA.{}.needed_terminate".format(vca_index)
2807                 self.update_db_2("nsrs", db_nslcmop["nsInstanceId"], {db_update_entry: False})
2808
2809         if vca_deployed.get("prometheus_jobs") and self.prometheus:
2810             await self.prometheus.update(remove_jobs=vca_deployed["prometheus_jobs"])
2811
2812         if destroy_ee:
2813             await self.vca_map[vca_type].delete_execution_environment(vca_deployed["ee_id"], scaling_in=scaling_in)
2814
2815     async def _delete_all_N2VC(self, db_nsr: dict):
2816         self._write_all_config_status(db_nsr=db_nsr, status='TERMINATING')
2817         namespace = "." + db_nsr["_id"]
2818         try:
2819             await self.n2vc.delete_namespace(namespace=namespace, total_timeout=self.timeout_charm_delete)
2820         except N2VCNotFound:  # already deleted. Skip
2821             pass
2822         self._write_all_config_status(db_nsr=db_nsr, status='DELETED')
2823
2824     async def _terminate_RO(self, logging_text, nsr_deployed, nsr_id, nslcmop_id, stage):
2825         """
2826         Terminates a deployment from RO
2827         :param logging_text:
2828         :param nsr_deployed: db_nsr._admin.deployed
2829         :param nsr_id:
2830         :param nslcmop_id:
2831         :param stage: list of string with the content to write on db_nslcmop.detailed-status.
2832             this method will update only the index 2, but it will write on database the concatenated content of the list
2833         :return:
2834         """
2835         db_nsr_update = {}
2836         failed_detail = []
2837         ro_nsr_id = ro_delete_action = None
2838         if nsr_deployed and nsr_deployed.get("RO"):
2839             ro_nsr_id = nsr_deployed["RO"].get("nsr_id")
2840             ro_delete_action = nsr_deployed["RO"].get("nsr_delete_action_id")
2841         try:
2842             if ro_nsr_id:
2843                 stage[2] = "Deleting ns from VIM."
2844                 db_nsr_update["detailed-status"] = " ".join(stage)
2845                 self._write_op_status(nslcmop_id, stage)
2846                 self.logger.debug(logging_text + stage[2])
2847                 self.update_db_2("nsrs", nsr_id, db_nsr_update)
2848                 self._write_op_status(nslcmop_id, stage)
2849                 desc = await self.RO.delete("ns", ro_nsr_id)
2850                 ro_delete_action = desc["action_id"]
2851                 db_nsr_update["_admin.deployed.RO.nsr_delete_action_id"] = ro_delete_action
2852                 db_nsr_update["_admin.deployed.RO.nsr_id"] = None
2853                 db_nsr_update["_admin.deployed.RO.nsr_status"] = "DELETED"
2854             if ro_delete_action:
2855                 # wait until NS is deleted from VIM
2856                 stage[2] = "Waiting ns deleted from VIM."
2857                 detailed_status_old = None
2858                 self.logger.debug(logging_text + stage[2] + " RO_id={} ro_delete_action={}".format(ro_nsr_id,
2859                                                                                                    ro_delete_action))
2860                 self.update_db_2("nsrs", nsr_id, db_nsr_update)
2861                 self._write_op_status(nslcmop_id, stage)
2862
2863                 delete_timeout = 20 * 60  # 20 minutes
2864                 while delete_timeout > 0:
2865                     desc = await self.RO.show(
2866                         "ns",
2867                         item_id_name=ro_nsr_id,
2868                         extra_item="action",
2869                         extra_item_id=ro_delete_action)
2870
2871                     # deploymentStatus
2872                     self._on_update_ro_db(nsrs_id=nsr_id, ro_descriptor=desc)
2873
2874                     ns_status, ns_status_info = self.RO.check_action_status(desc)
2875                     if ns_status == "ERROR":
2876                         raise ROclient.ROClientException(ns_status_info)
2877                     elif ns_status == "BUILD":
2878                         stage[2] = "Deleting from VIM {}".format(ns_status_info)
2879                     elif ns_status == "ACTIVE":
2880                         db_nsr_update["_admin.deployed.RO.nsr_delete_action_id"] = None
2881                         db_nsr_update["_admin.deployed.RO.nsr_status"] = "DELETED"
2882                         break
2883                     else:
2884                         assert False, "ROclient.check_action_status returns unknown {}".format(ns_status)
2885                     if stage[2] != detailed_status_old:
2886                         detailed_status_old = stage[2]
2887                         db_nsr_update["detailed-status"] = " ".join(stage)
2888                         self._write_op_status(nslcmop_id, stage)
2889                         self.update_db_2("nsrs", nsr_id, db_nsr_update)
2890                     await asyncio.sleep(5, loop=self.loop)
2891                     delete_timeout -= 5
2892                 else:  # delete_timeout <= 0:
2893                     raise ROclient.ROClientException("Timeout waiting ns deleted from VIM")
2894
2895         except Exception as e:
2896             self.update_db_2("nsrs", nsr_id, db_nsr_update)
2897             if isinstance(e, ROclient.ROClientException) and e.http_code == 404:  # not found
2898                 db_nsr_update["_admin.deployed.RO.nsr_id"] = None
2899                 db_nsr_update["_admin.deployed.RO.nsr_status"] = "DELETED"
2900                 db_nsr_update["_admin.deployed.RO.nsr_delete_action_id"] = None
2901                 self.logger.debug(logging_text + "RO_ns_id={} already deleted".format(ro_nsr_id))
2902             elif isinstance(e, ROclient.ROClientException) and e.http_code == 409:  # conflict
2903                 failed_detail.append("delete conflict: {}".format(e))
2904                 self.logger.debug(logging_text + "RO_ns_id={} delete conflict: {}".format(ro_nsr_id, e))
2905             else:
2906                 failed_detail.append("delete error: {}".format(e))
2907                 self.logger.error(logging_text + "RO_ns_id={} delete error: {}".format(ro_nsr_id, e))
2908
2909         # Delete nsd
2910         if not failed_detail and deep_get(nsr_deployed, ("RO", "nsd_id")):
2911             ro_nsd_id = nsr_deployed["RO"]["nsd_id"]
2912             try:
2913                 stage[2] = "Deleting nsd from RO."
2914                 db_nsr_update["detailed-status"] = " ".join(stage)
2915                 self.update_db_2("nsrs", nsr_id, db_nsr_update)
2916                 self._write_op_status(nslcmop_id, stage)
2917                 await self.RO.delete("nsd", ro_nsd_id)
2918                 self.logger.debug(logging_text + "ro_nsd_id={} deleted".format(ro_nsd_id))
2919                 db_nsr_update["_admin.deployed.RO.nsd_id"] = None
2920             except Exception as e:
2921                 if isinstance(e, ROclient.ROClientException) and e.http_code == 404:  # not found
2922                     db_nsr_update["_admin.deployed.RO.nsd_id"] = None
2923                     self.logger.debug(logging_text + "ro_nsd_id={} already deleted".format(ro_nsd_id))
2924                 elif isinstance(e, ROclient.ROClientException) and e.http_code == 409:  # conflict
2925                     failed_detail.append("ro_nsd_id={} delete conflict: {}".format(ro_nsd_id, e))
2926                     self.logger.debug(logging_text + failed_detail[-1])
2927                 else:
2928                     failed_detail.append("ro_nsd_id={} delete error: {}".format(ro_nsd_id, e))
2929                     self.logger.error(logging_text + failed_detail[-1])
2930
2931         if not failed_detail and deep_get(nsr_deployed, ("RO", "vnfd")):
2932             for index, vnf_deployed in enumerate(nsr_deployed["RO"]["vnfd"]):
2933                 if not vnf_deployed or not vnf_deployed["id"]:
2934                     continue
2935                 try:
2936                     ro_vnfd_id = vnf_deployed["id"]
2937                     stage[2] = "Deleting member_vnf_index={} ro_vnfd_id={} from RO.".format(
2938                         vnf_deployed["member-vnf-index"], ro_vnfd_id)
2939                     db_nsr_update["detailed-status"] = " ".join(stage)
2940                     self.update_db_2("nsrs", nsr_id, db_nsr_update)
2941                     self._write_op_status(nslcmop_id, stage)
2942                     await self.RO.delete("vnfd", ro_vnfd_id)
2943                     self.logger.debug(logging_text + "ro_vnfd_id={} deleted".format(ro_vnfd_id))
2944                     db_nsr_update["_admin.deployed.RO.vnfd.{}.id".format(index)] = None
2945                 except Exception as e:
2946                     if isinstance(e, ROclient.ROClientException) and e.http_code == 404:  # not found
2947                         db_nsr_update["_admin.deployed.RO.vnfd.{}.id".format(index)] = None
2948                         self.logger.debug(logging_text + "ro_vnfd_id={} already deleted ".format(ro_vnfd_id))
2949                     elif isinstance(e, ROclient.ROClientException) and e.http_code == 409:  # conflict
2950                         failed_detail.append("ro_vnfd_id={} delete conflict: {}".format(ro_vnfd_id, e))
2951                         self.logger.debug(logging_text + failed_detail[-1])
2952                     else:
2953                         failed_detail.append("ro_vnfd_id={} delete error: {}".format(ro_vnfd_id, e))
2954                         self.logger.error(logging_text + failed_detail[-1])
2955
2956         if failed_detail:
2957             stage[2] = "Error deleting from VIM"
2958         else:
2959             stage[2] = "Deleted from VIM"
2960         db_nsr_update["detailed-status"] = " ".join(stage)
2961         self.update_db_2("nsrs", nsr_id, db_nsr_update)
2962         self._write_op_status(nslcmop_id, stage)
2963
2964         if failed_detail:
2965             raise LcmException("; ".join(failed_detail))
2966
2967     async def terminate(self, nsr_id, nslcmop_id):
2968         # Try to lock HA task here
2969         task_is_locked_by_me = self.lcm_tasks.lock_HA('ns', 'nslcmops', nslcmop_id)
2970         if not task_is_locked_by_me:
2971             return
2972
2973         logging_text = "Task ns={} terminate={} ".format(nsr_id, nslcmop_id)
2974         self.logger.debug(logging_text + "Enter")
2975         timeout_ns_terminate = self.timeout_ns_terminate
2976         db_nsr = None
2977         db_nslcmop = None
2978         operation_params = None
2979         exc = None
2980         error_list = []   # annotates all failed error messages
2981         db_nslcmop_update = {}
2982         autoremove = False  # autoremove after terminated
2983         tasks_dict_info = {}
2984         db_nsr_update = {}
2985         stage = ["Stage 1/3: Preparing task.", "Waiting for previous operations to terminate.", ""]
2986         # ^ contains [stage, step, VIM-status]
2987         try:
2988             # wait for any previous tasks in process
2989             await self.lcm_tasks.waitfor_related_HA("ns", 'nslcmops', nslcmop_id)
2990
2991             stage[1] = "Getting nslcmop={} from db.".format(nslcmop_id)
2992             db_nslcmop = self.db.get_one("nslcmops", {"_id": nslcmop_id})
2993             operation_params = db_nslcmop.get("operationParams") or {}
2994             if operation_params.get("timeout_ns_terminate"):
2995                 timeout_ns_terminate = operation_params["timeout_ns_terminate"]
2996             stage[1] = "Getting nsr={} from db.".format(nsr_id)
2997             db_nsr = self.db.get_one("nsrs", {"_id": nsr_id})
2998
2999             db_nsr_update["operational-status"] = "terminating"
3000             db_nsr_update["config-status"] = "terminating"
3001             self._write_ns_status(
3002                 nsr_id=nsr_id,
3003                 ns_state="TERMINATING",
3004                 current_operation="TERMINATING",
3005                 current_operation_id=nslcmop_id,
3006                 other_update=db_nsr_update
3007             )
3008             self._write_op_status(
3009                 op_id=nslcmop_id,
3010                 queuePosition=0,
3011                 stage=stage
3012             )
3013             nsr_deployed = deepcopy(db_nsr["_admin"].get("deployed")) or {}
3014             if db_nsr["_admin"]["nsState"] == "NOT_INSTANTIATED":
3015                 return
3016
3017             stage[1] = "Getting vnf descriptors from db."
3018             db_vnfrs_list = self.db.get_list("vnfrs", {"nsr-id-ref": nsr_id})
3019             db_vnfds_from_id = {}
3020             db_vnfds_from_member_index = {}
3021             # Loop over VNFRs
3022             for vnfr in db_vnfrs_list:
3023                 vnfd_id = vnfr["vnfd-id"]
3024                 if vnfd_id not in db_vnfds_from_id:
3025                     vnfd = self.db.get_one("vnfds", {"_id": vnfd_id})
3026                     db_vnfds_from_id[vnfd_id] = vnfd
3027                 db_vnfds_from_member_index[vnfr["member-vnf-index-ref"]] = db_vnfds_from_id[vnfd_id]
3028
3029             # Destroy individual execution environments when there are terminating primitives.
3030             # Rest of EE will be deleted at once
3031             # TODO - check before calling _destroy_N2VC
3032             # if not operation_params.get("skip_terminate_primitives"):#
3033             # or not vca.get("needed_terminate"):
3034             stage[0] = "Stage 2/3 execute terminating primitives."
3035             self.logger.debug(logging_text + stage[0])
3036             stage[1] = "Looking execution environment that needs terminate."
3037             self.logger.debug(logging_text + stage[1])
3038
3039             for vca_index, vca in enumerate(get_iterable(nsr_deployed, "VCA")):
3040                 config_descriptor = None
3041                 if not vca or not vca.get("ee_id"):
3042                     continue
3043                 if not vca.get("member-vnf-index"):
3044                     # ns
3045                     config_descriptor = db_nsr.get("ns-configuration")
3046                 elif vca.get("vdu_id"):
3047                     db_vnfd = db_vnfds_from_member_index[vca["member-vnf-index"]]
3048                     config_descriptor = get_configuration(db_vnfd, vca.get("vdu_id"))
3049                 elif vca.get("kdu_name"):
3050                     db_vnfd = db_vnfds_from_member_index[vca["member-vnf-index"]]
3051                     config_descriptor = get_configuration(db_vnfd, vca.get("kdu_name"))
3052                 else:
3053                     db_vnfd = db_vnfds_from_member_index[vca["member-vnf-index"]]
3054                     config_descriptor = get_configuration(db_vnfd, db_vnfd["id"])
3055                 vca_type = vca.get("type")
3056                 exec_terminate_primitives = (not operation_params.get("skip_terminate_primitives") and
3057                                              vca.get("needed_terminate"))
3058                 # For helm we must destroy_ee. Also for native_charm, as juju_model cannot be deleted if there are
3059                 # pending native charms
3060                 destroy_ee = True if vca_type in ("helm", "helm-v3", "native_charm") else False
3061                 # self.logger.debug(logging_text + "vca_index: {}, ee_id: {}, vca_type: {} destroy_ee: {}".format(
3062                 #     vca_index, vca.get("ee_id"), vca_type, destroy_ee))
3063                 task = asyncio.ensure_future(
3064                     self.destroy_N2VC(logging_text, db_nslcmop, vca, config_descriptor, vca_index,
3065                                       destroy_ee, exec_terminate_primitives))
3066                 tasks_dict_info[task] = "Terminating VCA {}".format(vca.get("ee_id"))
3067
3068             # wait for pending tasks of terminate primitives
3069             if tasks_dict_info:
3070                 self.logger.debug(logging_text + 'Waiting for tasks {}'.format(list(tasks_dict_info.keys())))
3071                 error_list = await self._wait_for_tasks(logging_text, tasks_dict_info,
3072                                                         min(self.timeout_charm_delete, timeout_ns_terminate),
3073                                                         stage, nslcmop_id)
3074                 tasks_dict_info.clear()
3075                 if error_list:
3076                     return   # raise LcmException("; ".join(error_list))
3077
3078             # remove All execution environments at once
3079             stage[0] = "Stage 3/3 delete all."
3080
3081             if nsr_deployed.get("VCA"):
3082                 stage[1] = "Deleting all execution environments."
3083                 self.logger.debug(logging_text + stage[1])
3084                 task_delete_ee = asyncio.ensure_future(asyncio.wait_for(self._delete_all_N2VC(db_nsr=db_nsr),
3085                                                                         timeout=self.timeout_charm_delete))
3086                 # task_delete_ee = asyncio.ensure_future(self.n2vc.delete_namespace(namespace="." + nsr_id))
3087                 tasks_dict_info[task_delete_ee] = "Terminating all VCA"
3088
3089             # Delete from k8scluster
3090             stage[1] = "Deleting KDUs."
3091             self.logger.debug(logging_text + stage[1])
3092             # print(nsr_deployed)
3093             for kdu in get_iterable(nsr_deployed, "K8s"):
3094                 if not kdu or not kdu.get("kdu-instance"):
3095                     continue
3096                 kdu_instance = kdu.get("kdu-instance")
3097                 if kdu.get("k8scluster-type") in self.k8scluster_map:
3098                     task_delete_kdu_instance = asyncio.ensure_future(
3099                         self.k8scluster_map[kdu["k8scluster-type"]].uninstall(
3100                             cluster_uuid=kdu.get("k8scluster-uuid"),
3101                             kdu_instance=kdu_instance))
3102                 else:
3103                     self.logger.error(logging_text + "Unknown k8s deployment type {}".
3104                                       format(kdu.get("k8scluster-type")))
3105                     continue
3106                 tasks_dict_info[task_delete_kdu_instance] = "Terminating KDU '{}'".format(kdu.get("kdu-name"))
3107
3108             # remove from RO
3109             stage[1] = "Deleting ns from VIM."
3110             if self.ng_ro:
3111                 task_delete_ro = asyncio.ensure_future(
3112                     self._terminate_ng_ro(logging_text, nsr_deployed, nsr_id, nslcmop_id, stage))
3113             else:
3114                 task_delete_ro = asyncio.ensure_future(
3115                     self._terminate_RO(logging_text, nsr_deployed, nsr_id, nslcmop_id, stage))
3116             tasks_dict_info[task_delete_ro] = "Removing deployment from VIM"
3117
3118             # rest of staff will be done at finally
3119
3120         except (ROclient.ROClientException, DbException, LcmException, N2VCException) as e:
3121             self.logger.error(logging_text + "Exit Exception {}".format(e))
3122             exc = e
3123         except asyncio.CancelledError:
3124             self.logger.error(logging_text + "Cancelled Exception while '{}'".format(stage[1]))
3125             exc = "Operation was cancelled"
3126         except Exception as e:
3127             exc = traceback.format_exc()
3128             self.logger.critical(logging_text + "Exit Exception while '{}': {}".format(stage[1], e), exc_info=True)
3129         finally:
3130             if exc:
3131                 error_list.append(str(exc))
3132             try:
3133                 # wait for pending tasks
3134                 if tasks_dict_info:
3135                     stage[1] = "Waiting for terminate pending tasks."
3136                     self.logger.debug(logging_text + stage[1])
3137                     error_list += await self._wait_for_tasks(logging_text, tasks_dict_info, timeout_ns_terminate,
3138                                                              stage, nslcmop_id)
3139                 stage[1] = stage[2] = ""
3140             except asyncio.CancelledError:
3141                 error_list.append("Cancelled")
3142                 # TODO cancell all tasks
3143             except Exception as exc:
3144                 error_list.append(str(exc))
3145             # update status at database
3146             if error_list:
3147                 error_detail = "; ".join(error_list)
3148                 # self.logger.error(logging_text + error_detail)
3149                 error_description_nslcmop = '{} Detail: {}'.format(stage[0], error_detail)
3150                 error_description_nsr = 'Operation: TERMINATING.{}, {}.'.format(nslcmop_id, stage[0])
3151
3152                 db_nsr_update["operational-status"] = "failed"
3153                 db_nsr_update["detailed-status"] = error_description_nsr + " Detail: " + error_detail
3154                 db_nslcmop_update["detailed-status"] = error_detail
3155                 nslcmop_operation_state = "FAILED"
3156                 ns_state = "BROKEN"
3157             else:
3158                 error_detail = None
3159                 error_description_nsr = error_description_nslcmop = None
3160                 ns_state = "NOT_INSTANTIATED"
3161                 db_nsr_update["operational-status"] = "terminated"
3162                 db_nsr_update["detailed-status"] = "Done"
3163                 db_nsr_update["_admin.nsState"] = "NOT_INSTANTIATED"
3164                 db_nslcmop_update["detailed-status"] = "Done"
3165                 nslcmop_operation_state = "COMPLETED"
3166
3167             if db_nsr:
3168                 self._write_ns_status(
3169                     nsr_id=nsr_id,
3170                     ns_state=ns_state,
3171                     current_operation="IDLE",
3172                     current_operation_id=None,
3173                     error_description=error_description_nsr,
3174                     error_detail=error_detail,
3175                     other_update=db_nsr_update
3176                 )
3177             self._write_op_status(
3178                 op_id=nslcmop_id,
3179                 stage="",
3180                 error_message=error_description_nslcmop,
3181                 operation_state=nslcmop_operation_state,
3182                 other_update=db_nslcmop_update,
3183             )
3184             if ns_state == "NOT_INSTANTIATED":
3185                 try:
3186                     self.db.set_list("vnfrs", {"nsr-id-ref": nsr_id}, {"_admin.nsState": "NOT_INSTANTIATED"})
3187                 except DbException as e:
3188                     self.logger.warn(logging_text + 'Error writing VNFR status for nsr-id-ref: {} -> {}'.
3189                                      format(nsr_id, e))
3190             if operation_params:
3191                 autoremove = operation_params.get("autoremove", False)
3192             if nslcmop_operation_state:
3193                 try:
3194                     await self.msg.aiowrite("ns", "terminated", {"nsr_id": nsr_id, "nslcmop_id": nslcmop_id,
3195                                                                  "operationState": nslcmop_operation_state,
3196                                                                  "autoremove": autoremove},
3197                                             loop=self.loop)
3198                 except Exception as e:
3199                     self.logger.error(logging_text + "kafka_write notification Exception {}".format(e))
3200
3201             self.logger.debug(logging_text + "Exit")
3202             self.lcm_tasks.remove("ns", nsr_id, nslcmop_id, "ns_terminate")
3203
3204     async def _wait_for_tasks(self, logging_text, created_tasks_info, timeout, stage, nslcmop_id, nsr_id=None):
3205         time_start = time()
3206         error_detail_list = []
3207         error_list = []
3208         pending_tasks = list(created_tasks_info.keys())
3209         num_tasks = len(pending_tasks)
3210         num_done = 0
3211         stage[1] = "{}/{}.".format(num_done, num_tasks)
3212         self._write_op_status(nslcmop_id, stage)
3213         while pending_tasks:
3214             new_error = None
3215             _timeout = timeout + time_start - time()
3216             done, pending_tasks = await asyncio.wait(pending_tasks, timeout=_timeout,
3217                                                      return_when=asyncio.FIRST_COMPLETED)
3218             num_done += len(done)
3219             if not done:   # Timeout
3220                 for task in pending_tasks:
3221                     new_error = created_tasks_info[task] + ": Timeout"
3222                     error_detail_list.append(new_error)
3223                     error_list.append(new_error)
3224                 break
3225             for task in done:
3226                 if task.cancelled():
3227                     exc = "Cancelled"
3228                 else:
3229                     exc = task.exception()
3230                 if exc:
3231                     if isinstance(exc, asyncio.TimeoutError):
3232                         exc = "Timeout"
3233                     new_error = created_tasks_info[task] + ": {}".format(exc)
3234                     error_list.append(created_tasks_info[task])
3235                     error_detail_list.append(new_error)
3236                     if isinstance(exc, (str, DbException, N2VCException, ROclient.ROClientException, LcmException,
3237                                         K8sException, NgRoException)):
3238                         self.logger.error(logging_text + new_error)
3239                     else:
3240                         exc_traceback = "".join(traceback.format_exception(None, exc, exc.__traceback__))
3241                         self.logger.error(logging_text + created_tasks_info[task] + " " + exc_traceback)
3242                 else:
3243                     self.logger.debug(logging_text + created_tasks_info[task] + ": Done")
3244             stage[1] = "{}/{}.".format(num_done, num_tasks)
3245             if new_error:
3246                 stage[1] += " Errors: " + ". ".join(error_detail_list) + "."
3247                 if nsr_id:  # update also nsr
3248                     self.update_db_2("nsrs", nsr_id, {"errorDescription": "Error at: " + ", ".join(error_list),
3249                                                       "errorDetail": ". ".join(error_detail_list)})
3250             self._write_op_status(nslcmop_id, stage)
3251         return error_detail_list
3252
3253     @staticmethod
3254     def _map_primitive_params(primitive_desc, params, instantiation_params):
3255         """
3256         Generates the params to be provided to charm before executing primitive. If user does not provide a parameter,
3257         The default-value is used. If it is between < > it look for a value at instantiation_params
3258         :param primitive_desc: portion of VNFD/NSD that describes primitive
3259         :param params: Params provided by user
3260         :param instantiation_params: Instantiation params provided by user
3261         :return: a dictionary with the calculated params
3262         """
3263         calculated_params = {}
3264         for parameter in primitive_desc.get("parameter", ()):
3265             param_name = parameter["name"]
3266             if param_name in params:
3267                 calculated_params[param_name] = params[param_name]
3268             elif "default-value" in parameter or "value" in parameter:
3269                 if "value" in parameter:
3270                     calculated_params[param_name] = parameter["value"]
3271                 else:
3272                     calculated_params[param_name] = parameter["default-value"]
3273                 if isinstance(calculated_params[param_name], str) and calculated_params[param_name].startswith("<") \
3274                         and calculated_params[param_name].endswith(">"):
3275                     if calculated_params[param_name][1:-1] in instantiation_params:
3276                         calculated_params[param_name] = instantiation_params[calculated_params[param_name][1:-1]]
3277                     else:
3278                         raise LcmException("Parameter {} needed to execute primitive {} not provided".
3279                                            format(calculated_params[param_name], primitive_desc["name"]))
3280             else:
3281                 raise LcmException("Parameter {} needed to execute primitive {} not provided".
3282                                    format(param_name, primitive_desc["name"]))
3283
3284             if isinstance(calculated_params[param_name], (dict, list, tuple)):
3285                 calculated_params[param_name] = yaml.safe_dump(calculated_params[param_name],
3286                                                                default_flow_style=True, width=256)
3287             elif isinstance(calculated_params[param_name], str) and calculated_params[param_name].startswith("!!yaml "):
3288                 calculated_params[param_name] = calculated_params[param_name][7:]
3289             if parameter.get("data-type") == "INTEGER":
3290                 try:
3291                     calculated_params[param_name] = int(calculated_params[param_name])
3292                 except ValueError:  # error converting string to int
3293                     raise LcmException(
3294                         "Parameter {} of primitive {} must be integer".format(param_name, primitive_desc["name"]))
3295             elif parameter.get("data-type") == "BOOLEAN":
3296                 calculated_params[param_name] = not ((str(calculated_params[param_name])).lower() == 'false')
3297
3298         # add always ns_config_info if primitive name is config
3299         if primitive_desc["name"] == "config":
3300             if "ns_config_info" in instantiation_params:
3301                 calculated_params["ns_config_info"] = instantiation_params["ns_config_info"]
3302         return calculated_params
3303
3304     def _look_for_deployed_vca(self, deployed_vca, member_vnf_index, vdu_id, vdu_count_index, kdu_name=None,
3305                                ee_descriptor_id=None):
3306         # find vca_deployed record for this action. Raise LcmException if not found or there is not any id.
3307         for vca in deployed_vca:
3308             if not vca:
3309                 continue
3310             if member_vnf_index != vca["member-vnf-index"] or vdu_id != vca["vdu_id"]:
3311                 continue
3312             if vdu_count_index is not None and vdu_count_index != vca["vdu_count_index"]:
3313                 continue
3314             if kdu_name and kdu_name != vca["kdu_name"]:
3315                 continue
3316             if ee_descriptor_id and ee_descriptor_id != vca["ee_descriptor_id"]:
3317                 continue
3318             break
3319         else:
3320             # vca_deployed not found
3321             raise LcmException("charm for member_vnf_index={} vdu_id={}.{} kdu_name={} execution-environment-list.id={}"
3322                                " is not deployed".format(member_vnf_index, vdu_id, vdu_count_index, kdu_name,
3323                                                          ee_descriptor_id))
3324         # get ee_id
3325         ee_id = vca.get("ee_id")
3326         vca_type = vca.get("type", "lxc_proxy_charm")  # default value for backward compatibility - proxy charm
3327         if not ee_id:
3328             raise LcmException("charm for member_vnf_index={} vdu_id={} kdu_name={} vdu_count_index={} has not "
3329                                "execution environment"
3330                                .format(member_vnf_index, vdu_id, kdu_name, vdu_count_index))
3331         return ee_id, vca_type
3332
3333     async def _ns_execute_primitive(self, ee_id, primitive, primitive_params, retries=0, retries_interval=30,
3334                                     timeout=None, vca_type=None, db_dict=None) -> (str, str):
3335         try:
3336             if primitive == "config":
3337                 primitive_params = {"params": primitive_params}
3338
3339             vca_type = vca_type or "lxc_proxy_charm"
3340
3341             while retries >= 0:
3342                 try:
3343                     output = await asyncio.wait_for(
3344                         self.vca_map[vca_type].exec_primitive(
3345                             ee_id=ee_id,
3346                             primitive_name=primitive,
3347                             params_dict=primitive_params,
3348                             progress_timeout=self.timeout_progress_primitive,
3349                             total_timeout=self.timeout_primitive,
3350                             db_dict=db_dict),
3351                         timeout=timeout or self.timeout_primitive)
3352                     # execution was OK
3353                     break
3354                 except asyncio.CancelledError:
3355                     raise
3356                 except Exception as e:  # asyncio.TimeoutError
3357                     if isinstance(e, asyncio.TimeoutError):
3358                         e = "Timeout"
3359                     retries -= 1
3360                     if retries >= 0:
3361                         self.logger.debug('Error executing action {} on {} -> {}'.format(primitive, ee_id, e))
3362                         # wait and retry
3363                         await asyncio.sleep(retries_interval, loop=self.loop)
3364                     else:
3365                         return 'FAILED', str(e)
3366
3367             return 'COMPLETED', output
3368
3369         except (LcmException, asyncio.CancelledError):
3370             raise
3371         except Exception as e:
3372             return 'FAIL', 'Error executing action {}: {}'.format(primitive, e)
3373
3374     async def action(self, nsr_id, nslcmop_id):
3375         # Try to lock HA task here
3376         task_is_locked_by_me = self.lcm_tasks.lock_HA('ns', 'nslcmops', nslcmop_id)
3377         if not task_is_locked_by_me:
3378             return
3379
3380         logging_text = "Task ns={} action={} ".format(nsr_id, nslcmop_id)
3381         self.logger.debug(logging_text + "Enter")
3382         # get all needed from database
3383         db_nsr = None
3384         db_nslcmop = None
3385         db_nsr_update = {}
3386         db_nslcmop_update = {}
3387         nslcmop_operation_state = None
3388         error_description_nslcmop = None
3389         exc = None
3390         try:
3391             # wait for any previous tasks in process
3392             step = "Waiting for previous operations to terminate"
3393             await self.lcm_tasks.waitfor_related_HA('ns', 'nslcmops', nslcmop_id)
3394
3395             self._write_ns_status(
3396                 nsr_id=nsr_id,
3397                 ns_state=None,
3398                 current_operation="RUNNING ACTION",
3399                 current_operation_id=nslcmop_id
3400             )
3401
3402             step = "Getting information from database"
3403             db_nslcmop = self.db.get_one("nslcmops", {"_id": nslcmop_id})
3404             db_nsr = self.db.get_one("nsrs", {"_id": nsr_id})
3405
3406             nsr_deployed = db_nsr["_admin"].get("deployed")
3407             vnf_index = db_nslcmop["operationParams"].get("member_vnf_index")
3408             vdu_id = db_nslcmop["operationParams"].get("vdu_id")
3409             kdu_name = db_nslcmop["operationParams"].get("kdu_name")
3410             vdu_count_index = db_nslcmop["operationParams"].get("vdu_count_index")
3411             primitive = db_nslcmop["operationParams"]["primitive"]
3412             primitive_params = db_nslcmop["operationParams"]["primitive_params"]
3413             timeout_ns_action = db_nslcmop["operationParams"].get("timeout_ns_action", self.timeout_primitive)
3414
3415             if vnf_index:
3416                 step = "Getting vnfr from database"
3417                 db_vnfr = self.db.get_one("vnfrs", {"member-vnf-index-ref": vnf_index, "nsr-id-ref": nsr_id})
3418                 step = "Getting vnfd from database"
3419                 db_vnfd = self.db.get_one("vnfds", {"_id": db_vnfr["vnfd-id"]})
3420             else:
3421                 step = "Getting nsd from database"
3422                 db_nsd = self.db.get_one("nsds", {"_id": db_nsr["nsd-id"]})
3423
3424             # for backward compatibility
3425             if nsr_deployed and isinstance(nsr_deployed.get("VCA"), dict):
3426                 nsr_deployed["VCA"] = list(nsr_deployed["VCA"].values())
3427                 db_nsr_update["_admin.deployed.VCA"] = nsr_deployed["VCA"]
3428                 self.update_db_2("nsrs", nsr_id, db_nsr_update)
3429
3430             # look for primitive
3431             config_primitive_desc = descriptor_configuration = None
3432             if vdu_id:
3433                 descriptor_configuration = get_configuration(db_vnfd, vdu_id)
3434             elif kdu_name:
3435                 descriptor_configuration = get_configuration(db_vnfd, kdu_name)
3436             elif vnf_index:
3437                 descriptor_configuration = get_configuration(db_vnfd, db_vnfd["id"])
3438             else:
3439                 descriptor_configuration = db_nsd.get("ns-configuration")
3440
3441             if descriptor_configuration and descriptor_configuration.get("config-primitive"):
3442                 for config_primitive in descriptor_configuration["config-primitive"]:
3443                     if config_primitive["name"] == primitive:
3444                         config_primitive_desc = config_primitive
3445                         break
3446
3447             if not config_primitive_desc:
3448                 if not (kdu_name and primitive in ("upgrade", "rollback", "status")):
3449                     raise LcmException("Primitive {} not found at [ns|vnf|vdu]-configuration:config-primitive ".
3450                                        format(primitive))
3451                 primitive_name = primitive
3452                 ee_descriptor_id = None
3453             else:
3454                 primitive_name = config_primitive_desc.get("execution-environment-primitive", primitive)
3455                 ee_descriptor_id = config_primitive_desc.get("execution-environment-ref")
3456
3457             if vnf_index:
3458                 if vdu_id:
3459                     vdur = next((x for x in db_vnfr["vdur"] if x["vdu-id-ref"] == vdu_id), None)
3460                     desc_params = parse_yaml_strings(vdur.get("additionalParams"))
3461                 elif kdu_name:
3462                     kdur = next((x for x in db_vnfr["kdur"] if x["kdu-name"] == kdu_name), None)
3463                     desc_params = parse_yaml_strings(kdur.get("additionalParams"))
3464                 else:
3465                     desc_params = parse_yaml_strings(db_vnfr.get("additionalParamsForVnf"))
3466             else:
3467                 desc_params = parse_yaml_strings(db_nsr.get("additionalParamsForNs"))
3468             if kdu_name and get_configuration(db_vnfd, kdu_name):
3469                 kdu_configuration = get_configuration(db_vnfd, kdu_name)
3470                 actions = set()
3471                 for primitive in kdu_configuration.get("initial-config-primitive", []):
3472                     actions.add(primitive["name"])
3473                 for primitive in kdu_configuration.get("config-primitive", []):
3474                     actions.add(primitive["name"])
3475                 kdu_action = True if primitive_name in actions else False
3476
3477             # TODO check if ns is in a proper status
3478             if kdu_name and (primitive_name in ("upgrade", "rollback", "status") or kdu_action):
3479                 # kdur and desc_params already set from before
3480                 if primitive_params:
3481                     desc_params.update(primitive_params)
3482                 # TODO Check if we will need something at vnf level
3483                 for index, kdu in enumerate(get_iterable(nsr_deployed, "K8s")):
3484                     if kdu_name == kdu["kdu-name"] and kdu["member-vnf-index"] == vnf_index:
3485                         break
3486                 else:
3487                     raise LcmException("KDU '{}' for vnf '{}' not deployed".format(kdu_name, vnf_index))
3488
3489                 if kdu.get("k8scluster-type") not in self.k8scluster_map:
3490                     msg = "unknown k8scluster-type '{}'".format(kdu.get("k8scluster-type"))
3491                     raise LcmException(msg)
3492
3493                 db_dict = {"collection": "nsrs",
3494                            "filter": {"_id": nsr_id},
3495                            "path": "_admin.deployed.K8s.{}".format(index)}
3496                 self.logger.debug(logging_text + "Exec k8s {} on {}.{}".format(primitive_name, vnf_index, kdu_name))
3497                 step = "Executing kdu {}".format(primitive_name)
3498                 if primitive_name == "upgrade":
3499                     if desc_params.get("kdu_model"):
3500                         kdu_model = desc_params.get("kdu_model")
3501                         del desc_params["kdu_model"]
3502                     else:
3503                         kdu_model = kdu.get("kdu-model")
3504                         parts = kdu_model.split(sep=":")
3505                         if len(parts) == 2:
3506                             kdu_model = parts[0]
3507
3508                     detailed_status = await asyncio.wait_for(
3509                         self.k8scluster_map[kdu["k8scluster-type"]].upgrade(
3510                             cluster_uuid=kdu.get("k8scluster-uuid"),
3511                             kdu_instance=kdu.get("kdu-instance"),
3512                             atomic=True, kdu_model=kdu_model,
3513                             params=desc_params, db_dict=db_dict,
3514                             timeout=timeout_ns_action),
3515                         timeout=timeout_ns_action + 10)
3516                     self.logger.debug(logging_text + " Upgrade of kdu {} done".format(detailed_status))
3517                 elif primitive_name == "rollback":
3518                     detailed_status = await asyncio.wait_for(
3519                         self.k8scluster_map[kdu["k8scluster-type"]].rollback(
3520                             cluster_uuid=kdu.get("k8scluster-uuid"),
3521                             kdu_instance=kdu.get("kdu-instance"),
3522                             db_dict=db_dict),
3523                         timeout=timeout_ns_action)
3524                 elif primitive_name == "status":
3525                     detailed_status = await asyncio.wait_for(
3526                         self.k8scluster_map[kdu["k8scluster-type"]].status_kdu(
3527                             cluster_uuid=kdu.get("k8scluster-uuid"),
3528                             kdu_instance=kdu.get("kdu-instance")),
3529                         timeout=timeout_ns_action)
3530                 else:
3531                     kdu_instance = kdu.get("kdu-instance") or "{}-{}".format(kdu["kdu-name"], nsr_id)
3532                     params = self._map_primitive_params(config_primitive_desc, primitive_params, desc_params)
3533
3534                     detailed_status = await asyncio.wait_for(
3535                         self.k8scluster_map[kdu["k8scluster-type"]].exec_primitive(
3536                             cluster_uuid=kdu.get("k8scluster-uuid"),
3537                             kdu_instance=kdu_instance,
3538                             primitive_name=primitive_name,
3539                             params=params, db_dict=db_dict,
3540                             timeout=timeout_ns_action),
3541                         timeout=timeout_ns_action)
3542
3543                 if detailed_status:
3544                     nslcmop_operation_state = 'COMPLETED'
3545                 else:
3546                     detailed_status = ''
3547                     nslcmop_operation_state = 'FAILED'
3548             else:
3549                 ee_id, vca_type = self._look_for_deployed_vca(nsr_deployed["VCA"], member_vnf_index=vnf_index,
3550                                                               vdu_id=vdu_id, vdu_count_index=vdu_count_index,
3551                                                               ee_descriptor_id=ee_descriptor_id)
3552                 db_nslcmop_notif = {"collection": "nslcmops",
3553                                     "filter": {"_id": nslcmop_id},
3554                                     "path": "admin.VCA"}
3555                 nslcmop_operation_state, detailed_status = await self._ns_execute_primitive(
3556                     ee_id,
3557                     primitive=primitive_name,
3558                     primitive_params=self._map_primitive_params(config_primitive_desc, primitive_params, desc_params),
3559                     timeout=timeout_ns_action,
3560                     vca_type=vca_type,
3561                     db_dict=db_nslcmop_notif)
3562
3563             db_nslcmop_update["detailed-status"] = detailed_status
3564             error_description_nslcmop = detailed_status if nslcmop_operation_state == "FAILED" else ""
3565             self.logger.debug(logging_text + " task Done with result {} {}".format(nslcmop_operation_state,
3566                                                                                    detailed_status))
3567             return  # database update is called inside finally
3568
3569         except (DbException, LcmException, N2VCException, K8sException) as e:
3570             self.logger.error(logging_text + "Exit Exception {}".format(e))
3571             exc = e
3572         except asyncio.CancelledError:
3573             self.logger.error(logging_text + "Cancelled Exception while '{}'".format(step))
3574             exc = "Operation was cancelled"
3575         except asyncio.TimeoutError:
3576             self.logger.error(logging_text + "Timeout while '{}'".format(step))
3577             exc = "Timeout"
3578         except Exception as e:
3579             exc = traceback.format_exc()
3580             self.logger.critical(logging_text + "Exit Exception {} {}".format(type(e).__name__, e), exc_info=True)
3581         finally:
3582             if exc:
3583                 db_nslcmop_update["detailed-status"] = detailed_status = error_description_nslcmop = \
3584                     "FAILED {}: {}".format(step, exc)
3585                 nslcmop_operation_state = "FAILED"
3586             if db_nsr:
3587                 self._write_ns_status(
3588                     nsr_id=nsr_id,
3589                     ns_state=db_nsr["nsState"],   # TODO check if degraded. For the moment use previous status
3590                     current_operation="IDLE",
3591                     current_operation_id=None,
3592                     # error_description=error_description_nsr,
3593                     # error_detail=error_detail,
3594                     other_update=db_nsr_update
3595                 )
3596
3597             self._write_op_status(op_id=nslcmop_id, stage="", error_message=error_description_nslcmop,
3598                                   operation_state=nslcmop_operation_state, other_update=db_nslcmop_update)
3599
3600             if nslcmop_operation_state:
3601                 try:
3602                     await self.msg.aiowrite("ns", "actioned", {"nsr_id": nsr_id, "nslcmop_id": nslcmop_id,
3603                                                                "operationState": nslcmop_operation_state},
3604                                             loop=self.loop)
3605                 except Exception as e:
3606                     self.logger.error(logging_text + "kafka_write notification Exception {}".format(e))
3607             self.logger.debug(logging_text + "Exit")
3608             self.lcm_tasks.remove("ns", nsr_id, nslcmop_id, "ns_action")
3609             return nslcmop_operation_state, detailed_status
3610
3611     async def scale(self, nsr_id, nslcmop_id):
3612         # Try to lock HA task here
3613         task_is_locked_by_me = self.lcm_tasks.lock_HA('ns', 'nslcmops', nslcmop_id)
3614         if not task_is_locked_by_me:
3615             return
3616
3617         logging_text = "Task ns={} scale={} ".format(nsr_id, nslcmop_id)
3618         stage = ['', '', '']
3619         tasks_dict_info = {}
3620         # ^ stage, step, VIM progress
3621         self.logger.debug(logging_text + "Enter")
3622         # get all needed from database
3623         db_nsr = None
3624         db_nslcmop_update = {}
3625         db_nsr_update = {}
3626         exc = None
3627         # in case of error, indicates what part of scale was failed to put nsr at error status
3628         scale_process = None
3629         old_operational_status = ""
3630         old_config_status = ""
3631         nsi_id = None
3632         try:
3633             # wait for any previous tasks in process
3634             step = "Waiting for previous operations to terminate"
3635             await self.lcm_tasks.waitfor_related_HA('ns', 'nslcmops', nslcmop_id)
3636             self._write_ns_status(nsr_id=nsr_id, ns_state=None,
3637                                   current_operation="SCALING", current_operation_id=nslcmop_id)
3638
3639             step = "Getting nslcmop from database"
3640             self.logger.debug(step + " after having waited for previous tasks to be completed")
3641             db_nslcmop = self.db.get_one("nslcmops", {"_id": nslcmop_id})
3642
3643             step = "Getting nsr from database"
3644             db_nsr = self.db.get_one("nsrs", {"_id": nsr_id})
3645             old_operational_status = db_nsr["operational-status"]
3646             old_config_status = db_nsr["config-status"]
3647
3648             step = "Parsing scaling parameters"
3649             db_nsr_update["operational-status"] = "scaling"
3650             self.update_db_2("nsrs", nsr_id, db_nsr_update)
3651             nsr_deployed = db_nsr["_admin"].get("deployed")
3652
3653             #######
3654             nsr_deployed = db_nsr["_admin"].get("deployed")
3655             vnf_index = db_nslcmop["operationParams"].get("member_vnf_index")
3656             # vdu_id = db_nslcmop["operationParams"].get("vdu_id")
3657             # vdu_count_index = db_nslcmop["operationParams"].get("vdu_count_index")
3658             # vdu_name = db_nslcmop["operationParams"].get("vdu_name")
3659             #######
3660
3661             vnf_index = db_nslcmop["operationParams"]["scaleVnfData"]["scaleByStepData"]["member-vnf-index"]
3662             scaling_group = db_nslcmop["operationParams"]["scaleVnfData"]["scaleByStepData"]["scaling-group-descriptor"]
3663             scaling_type = db_nslcmop["operationParams"]["scaleVnfData"]["scaleVnfType"]
3664             # for backward compatibility
3665             if nsr_deployed and isinstance(nsr_deployed.get("VCA"), dict):
3666                 nsr_deployed["VCA"] = list(nsr_deployed["VCA"].values())
3667                 db_nsr_update["_admin.deployed.VCA"] = nsr_deployed["VCA"]
3668                 self.update_db_2("nsrs", nsr_id, db_nsr_update)
3669
3670             step = "Getting vnfr from database"
3671             db_vnfr = self.db.get_one("vnfrs", {"member-vnf-index-ref": vnf_index, "nsr-id-ref": nsr_id})
3672
3673             step = "Getting vnfd from database"
3674             db_vnfd = self.db.get_one("vnfds", {"_id": db_vnfr["vnfd-id"]})
3675
3676             base_folder = db_vnfd["_admin"]["storage"]
3677
3678             step = "Getting scaling-group-descriptor"
3679             scaling_descriptor = find_in_list(
3680                 get_scaling_aspect(
3681                     db_vnfd
3682                 ),
3683                 lambda scale_desc: scale_desc["name"] == scaling_group
3684             )
3685             if not scaling_descriptor:
3686                 raise LcmException("input parameter 'scaleByStepData':'scaling-group-descriptor':'{}' is not present "
3687                                    "at vnfd:scaling-group-descriptor".format(scaling_group))
3688
3689             step = "Sending scale order to VIM"
3690             # TODO check if ns is in a proper status
3691             nb_scale_op = 0
3692             if not db_nsr["_admin"].get("scaling-group"):
3693                 self.update_db_2("nsrs", nsr_id, {"_admin.scaling-group": [{"name": scaling_group, "nb-scale-op": 0}]})
3694                 admin_scale_index = 0
3695             else:
3696                 for admin_scale_index, admin_scale_info in enumerate(db_nsr["_admin"]["scaling-group"]):
3697                     if admin_scale_info["name"] == scaling_group:
3698                         nb_scale_op = admin_scale_info.get("nb-scale-op", 0)
3699                         break
3700                 else:  # not found, set index one plus last element and add new entry with the name
3701                     admin_scale_index += 1
3702                     db_nsr_update["_admin.scaling-group.{}.name".format(admin_scale_index)] = scaling_group
3703             RO_scaling_info = []
3704             VCA_scaling_info = []
3705             vdu_scaling_info = {"scaling_group_name": scaling_group, "vdu": []}
3706             if scaling_type == "SCALE_OUT":
3707                 if "aspect-delta-details" not in scaling_descriptor:
3708                     raise LcmException(
3709                         "Aspect delta details not fount in scaling descriptor {}".format(
3710                             scaling_descriptor["name"]
3711                         )
3712                     )
3713                 # count if max-instance-count is reached
3714                 deltas = scaling_descriptor.get("aspect-delta-details")["deltas"]
3715
3716                 vdu_scaling_info["scaling_direction"] = "OUT"
3717                 vdu_scaling_info["vdu-create"] = {}
3718                 for delta in deltas:
3719                     for vdu_delta in delta["vdu-delta"]:
3720                         vdud = get_vdu(db_vnfd, vdu_delta["id"])
3721                         vdu_index = get_vdur_index(db_vnfr, vdu_delta)
3722                         cloud_init_text = self._get_vdu_cloud_init_content(vdud, db_vnfd)
3723                         if cloud_init_text:
3724                             additional_params = self._get_vdu_additional_params(db_vnfr, vdud["id"]) or {}
3725                         cloud_init_list = []
3726
3727                         vdu_profile = get_vdu_profile(db_vnfd, vdu_delta["id"])
3728                         max_instance_count = 10
3729                         if vdu_profile and "max-number-of-instances" in vdu_profile:
3730                             max_instance_count = vdu_profile.get("max-number-of-instances", 10)
3731
3732                         default_instance_num = get_number_of_instances(db_vnfd, vdud["id"])
3733
3734                         nb_scale_op += vdu_delta.get("number-of-instances", 1)
3735
3736                         if nb_scale_op + default_instance_num > max_instance_count:
3737                             raise LcmException(
3738                                 "reached the limit of {} (max-instance-count) "
3739                                 "scaling-out operations for the "
3740                                 "scaling-group-descriptor '{}'".format(nb_scale_op, scaling_group)
3741                             )
3742                         for x in range(vdu_delta.get("number-of-instances", 1)):
3743                             if cloud_init_text:
3744                                 # TODO Information of its own ip is not available because db_vnfr is not updated.
3745                                 additional_params["OSM"] = get_osm_params(
3746                                     db_vnfr,
3747                                     vdu_delta["id"],
3748                                     vdu_index + x
3749                                 )
3750                                 cloud_init_list.append(
3751                                     self._parse_cloud_init(
3752                                         cloud_init_text,
3753                                         additional_params,
3754                                         db_vnfd["id"],
3755                                         vdud["id"]
3756                                     )
3757                                 )
3758                                 VCA_scaling_info.append(
3759                                     {
3760                                         "osm_vdu_id": vdu_delta["id"],
3761                                         "member-vnf-index": vnf_index,
3762                                         "type": "create",
3763                                         "vdu_index": vdu_index + x
3764                                     }
3765                                 )
3766                         RO_scaling_info.append(
3767                             {
3768                                 "osm_vdu_id": vdu_delta["id"],
3769                                 "member-vnf-index": vnf_index,
3770                                 "type": "create",
3771                                 "count": vdu_delta.get("number-of-instances", 1)
3772                             }
3773                         )
3774                         if cloud_init_list:
3775                             RO_scaling_info[-1]["cloud_init"] = cloud_init_list
3776                         vdu_scaling_info["vdu-create"][vdu_delta["id"]] = vdu_delta.get("number-of-instances", 1)
3777
3778             elif scaling_type == "SCALE_IN":
3779                 if "min-instance-count" in scaling_descriptor and scaling_descriptor["min-instance-count"] is not None:
3780                     min_instance_count = int(scaling_descriptor["min-instance-count"])
3781
3782                 vdu_scaling_info["scaling_direction"] = "IN"
3783                 vdu_scaling_info["vdu-delete"] = {}
3784                 deltas = scaling_descriptor.get("aspect-delta-details")["deltas"]
3785                 for delta in deltas:
3786                     for vdu_delta in delta["vdu-delta"]:
3787                         vdu_index = get_vdur_index(db_vnfr, vdu_delta)
3788                         min_instance_count = 0
3789                         vdu_profile = get_vdu_profile(db_vnfd, vdu_delta["id"])
3790                         if vdu_profile and "min-number-of-instances" in vdu_profile:
3791                             min_instance_count = vdu_profile["min-number-of-instances"]
3792
3793                         default_instance_num = get_number_of_instances(db_vnfd, vdu_delta["id"])
3794
3795                         nb_scale_op -= vdu_delta.get("number-of-instances", 1)
3796                         if nb_scale_op + default_instance_num < min_instance_count:
3797                             raise LcmException(
3798                                 "reached the limit of {} (min-instance-count) scaling-in operations for the "
3799                                 "scaling-group-descriptor '{}'".format(nb_scale_op, scaling_group)
3800                             )
3801                         RO_scaling_info.append({"osm_vdu_id": vdu_delta["id"], "member-vnf-index": vnf_index,
3802                                                 "type": "delete", "count": vdu_delta.get("number-of-instances", 1),
3803                                                 "vdu_index": vdu_index - 1})
3804                         for x in range(vdu_delta.get("number-of-instances", 1)):
3805                             VCA_scaling_info.append(
3806                                 {
3807                                     "osm_vdu_id": vdu_delta["id"],
3808                                     "member-vnf-index": vnf_index,
3809                                     "type": "delete",
3810                                     "vdu_index": vdu_index - 1 - x
3811                                 }
3812                             )
3813                         vdu_scaling_info["vdu-delete"][vdu_delta["id"]] = vdu_delta.get("number-of-instances", 1)
3814
3815             # update VDU_SCALING_INFO with the VDUs to delete ip_addresses
3816             vdu_delete = copy(vdu_scaling_info.get("vdu-delete"))
3817             if vdu_scaling_info["scaling_direction"] == "IN":
3818                 for vdur in reversed(db_vnfr["vdur"]):
3819                     if vdu_delete.get(vdur["vdu-id-ref"]):
3820                         vdu_delete[vdur["vdu-id-ref"]] -= 1
3821                         vdu_scaling_info["vdu"].append({
3822                             "name": vdur.get("name") or vdur.get("vdu-name"),
3823                             "vdu_id": vdur["vdu-id-ref"],
3824                             "interface": []
3825                         })
3826                         for interface in vdur["interfaces"]:
3827                             vdu_scaling_info["vdu"][-1]["interface"].append({
3828                                 "name": interface["name"],
3829                                 "ip_address": interface["ip-address"],
3830                                 "mac_address": interface.get("mac-address"),
3831                             })
3832                 # vdu_delete = vdu_scaling_info.pop("vdu-delete")
3833
3834             # PRE-SCALE BEGIN
3835             step = "Executing pre-scale vnf-config-primitive"
3836             if scaling_descriptor.get("scaling-config-action"):
3837                 for scaling_config_action in scaling_descriptor["scaling-config-action"]:
3838                     if (scaling_config_action.get("trigger") == "pre-scale-in" and scaling_type == "SCALE_IN") \
3839                        or (scaling_config_action.get("trigger") == "pre-scale-out" and scaling_type == "SCALE_OUT"):
3840                         vnf_config_primitive = scaling_config_action["vnf-config-primitive-name-ref"]
3841                         step = db_nslcmop_update["detailed-status"] = \
3842                             "executing pre-scale scaling-config-action '{}'".format(vnf_config_primitive)
3843
3844                         # look for primitive
3845                         for config_primitive in (get_configuration(
3846                             db_vnfd, db_vnfd["id"]
3847                         ) or {}).get("config-primitive", ()):
3848                             if config_primitive["name"] == vnf_config_primitive:
3849                                 break
3850                         else:
3851                             raise LcmException(
3852                                 "Invalid vnfd descriptor at scaling-group-descriptor[name='{}']:scaling-config-action"
3853                                 "[vnf-config-primitive-name-ref='{}'] does not match any vnf-configuration:config-"
3854                                 "primitive".format(scaling_group, vnf_config_primitive))
3855
3856                         vnfr_params = {"VDU_SCALE_INFO": vdu_scaling_info}
3857                         if db_vnfr.get("additionalParamsForVnf"):
3858                             vnfr_params.update(db_vnfr["additionalParamsForVnf"])
3859
3860                         scale_process = "VCA"
3861                         db_nsr_update["config-status"] = "configuring pre-scaling"
3862                         primitive_params = self._map_primitive_params(config_primitive, {}, vnfr_params)
3863
3864                         # Pre-scale retry check: Check if this sub-operation has been executed before
3865                         op_index = self._check_or_add_scale_suboperation(
3866                             db_nslcmop, nslcmop_id, vnf_index, vnf_config_primitive, primitive_params, 'PRE-SCALE')
3867                         if op_index == self.SUBOPERATION_STATUS_SKIP:
3868                             # Skip sub-operation
3869                             result = 'COMPLETED'
3870                             result_detail = 'Done'
3871                             self.logger.debug(logging_text +
3872                                               "vnf_config_primitive={} Skipped sub-operation, result {} {}".format(
3873                                                   vnf_config_primitive, result, result_detail))
3874                         else:
3875                             if op_index == self.SUBOPERATION_STATUS_NEW:
3876                                 # New sub-operation: Get index of this sub-operation
3877                                 op_index = len(db_nslcmop.get('_admin', {}).get('operations')) - 1
3878                                 self.logger.debug(logging_text + "vnf_config_primitive={} New sub-operation".
3879                                                   format(vnf_config_primitive))
3880                             else:
3881                                 # retry:  Get registered params for this existing sub-operation
3882                                 op = db_nslcmop.get('_admin', {}).get('operations', [])[op_index]
3883                                 vnf_index = op.get('member_vnf_index')
3884                                 vnf_config_primitive = op.get('primitive')
3885                                 primitive_params = op.get('primitive_params')
3886                                 self.logger.debug(logging_text + "vnf_config_primitive={} Sub-operation retry".
3887                                                   format(vnf_config_primitive))
3888                             # Execute the primitive, either with new (first-time) or registered (reintent) args
3889                             ee_descriptor_id = config_primitive.get("execution-environment-ref")
3890                             primitive_name = config_primitive.get("execution-environment-primitive",
3891                                                                   vnf_config_primitive)
3892                             ee_id, vca_type = self._look_for_deployed_vca(nsr_deployed["VCA"],
3893                                                                           member_vnf_index=vnf_index,
3894                                                                           vdu_id=None,
3895                                                                           vdu_count_index=None,
3896                                                                           ee_descriptor_id=ee_descriptor_id)
3897                             result, result_detail = await self._ns_execute_primitive(
3898                                 ee_id, primitive_name, primitive_params, vca_type)
3899                             self.logger.debug(logging_text + "vnf_config_primitive={} Done with result {} {}".format(
3900                                 vnf_config_primitive, result, result_detail))
3901                             # Update operationState = COMPLETED | FAILED
3902                             self._update_suboperation_status(
3903                                 db_nslcmop, op_index, result, result_detail)
3904
3905                         if result == "FAILED":
3906                             raise LcmException(result_detail)
3907                         db_nsr_update["config-status"] = old_config_status
3908                         scale_process = None
3909             # PRE-SCALE END
3910
3911             db_nsr_update["_admin.scaling-group.{}.nb-scale-op".format(admin_scale_index)] = nb_scale_op
3912             db_nsr_update["_admin.scaling-group.{}.time".format(admin_scale_index)] = time()
3913
3914             # SCALE-IN VCA - BEGIN
3915             if VCA_scaling_info:
3916                 step = db_nslcmop_update["detailed-status"] = \
3917                     "Deleting the execution environments"
3918                 scale_process = "VCA"
3919                 for vdu_info in VCA_scaling_info:
3920                     if vdu_info["type"] == "delete":
3921                         member_vnf_index = str(vdu_info["member-vnf-index"])
3922                         self.logger.debug(logging_text + "vdu info: {}".format(vdu_info))
3923                         vdu_id = vdu_info["osm_vdu_id"]
3924                         vdu_index = int(vdu_info["vdu_index"])
3925                         stage[1] = "Scaling member_vnf_index={}, vdu_id={}, vdu_index={} ".format(
3926                             member_vnf_index, vdu_id, vdu_index)
3927                         stage[2] = step = "Scaling in VCA"
3928                         self._write_op_status(
3929                             op_id=nslcmop_id,
3930                             stage=stage
3931                         )
3932                         vca_update = db_nsr["_admin"]["deployed"]["VCA"]
3933                         config_update = db_nsr["configurationStatus"]
3934                         for vca_index, vca in enumerate(vca_update):
3935                             if (vca or vca.get("ee_id")) and vca["member-vnf-index"] == member_vnf_index and \
3936                                     vca["vdu_count_index"] == vdu_index:
3937                                 if vca.get("vdu_id"):
3938                                     config_descriptor = get_configuration(db_vnfd, vca.get("vdu_id"))
3939                                 elif vca.get("kdu_name"):
3940                                     config_descriptor = get_configuration(db_vnfd, vca.get("kdu_name"))
3941                                 else:
3942                                     config_descriptor = get_configuration(db_vnfd, db_vnfd["id"])
3943                                 operation_params = db_nslcmop.get("operationParams") or {}
3944                                 exec_terminate_primitives = (not operation_params.get("skip_terminate_primitives") and
3945                                                              vca.get("needed_terminate"))
3946                                 task = asyncio.ensure_future(asyncio.wait_for(
3947                                     self.destroy_N2VC(logging_text, db_nslcmop, vca, config_descriptor,
3948                                                       vca_index, destroy_ee=True,
3949                                                       exec_primitives=exec_terminate_primitives,
3950                                                       scaling_in=True), timeout=self.timeout_charm_delete))
3951                                 # wait before next removal
3952                                 await asyncio.sleep(30)
3953                                 tasks_dict_info[task] = "Terminating VCA {}".format(vca.get("ee_id"))
3954                                 del vca_update[vca_index]
3955                                 del config_update[vca_index]
3956                         # wait for pending tasks of terminate primitives
3957                         if tasks_dict_info:
3958                             self.logger.debug(logging_text +
3959                                               'Waiting for tasks {}'.format(list(tasks_dict_info.keys())))
3960                             error_list = await self._wait_for_tasks(logging_text, tasks_dict_info,
3961                                                                     min(self.timeout_charm_delete,
3962                                                                         self.timeout_ns_terminate),
3963                                                                     stage, nslcmop_id)
3964                             tasks_dict_info.clear()
3965                             if error_list:
3966                                 raise LcmException("; ".join(error_list))
3967
3968                         db_vca_and_config_update = {
3969                             "_admin.deployed.VCA": vca_update,
3970                             "configurationStatus": config_update
3971                         }
3972                         self.update_db_2("nsrs", db_nsr["_id"], db_vca_and_config_update)
3973             scale_process = None
3974             # SCALE-IN VCA - END
3975
3976             # SCALE RO - BEGIN
3977             if RO_scaling_info:
3978                 scale_process = "RO"
3979                 if self.ro_config.get("ng"):
3980                     await self._scale_ng_ro(logging_text, db_nsr, db_nslcmop, db_vnfr, vdu_scaling_info, stage)
3981             vdu_scaling_info.pop("vdu-create", None)
3982             vdu_scaling_info.pop("vdu-delete", None)
3983
3984             scale_process = None
3985             if db_nsr_update:
3986                 self.update_db_2("nsrs", nsr_id, db_nsr_update)
3987             # SCALE RO - END
3988
3989             # SCALE-UP VCA - BEGIN
3990             if VCA_scaling_info:
3991                 step = db_nslcmop_update["detailed-status"] = \
3992                     "Creating new execution environments"
3993                 scale_process = "VCA"
3994                 for vdu_info in VCA_scaling_info:
3995                     if vdu_info["type"] == "create":
3996                         member_vnf_index = str(vdu_info["member-vnf-index"])
3997                         self.logger.debug(logging_text + "vdu info: {}".format(vdu_info))
3998                         vnfd_id = db_vnfr["vnfd-ref"]
3999                         vdu_index = int(vdu_info["vdu_index"])
4000                         deploy_params = {"OSM": get_osm_params(db_vnfr)}
4001                         if db_vnfr.get("additionalParamsForVnf"):
4002                             deploy_params.update(parse_yaml_strings(db_vnfr["additionalParamsForVnf"].copy()))
4003                         descriptor_config = get_configuration(db_vnfd, db_vnfd["id"])
4004                         if descriptor_config:
4005                             vdu_id = None
4006                             vdu_name = None
4007                             kdu_name = None
4008                             self._deploy_n2vc(
4009                                 logging_text=logging_text + "member_vnf_index={} ".format(member_vnf_index),
4010                                 db_nsr=db_nsr,
4011                                 db_vnfr=db_vnfr,
4012                                 nslcmop_id=nslcmop_id,
4013                                 nsr_id=nsr_id,
4014                                 nsi_id=nsi_id,
4015                                 vnfd_id=vnfd_id,
4016                                 vdu_id=vdu_id,
4017                                 kdu_name=kdu_name,
4018                                 member_vnf_index=member_vnf_index,
4019                                 vdu_index=vdu_index,
4020                                 vdu_name=vdu_name,
4021                                 deploy_params=deploy_params,
4022                                 descriptor_config=descriptor_config,
4023                                 base_folder=base_folder,
4024                                 task_instantiation_info=tasks_dict_info,
4025                                 stage=stage
4026                             )
4027                         vdu_id = vdu_info["osm_vdu_id"]
4028                         vdur = find_in_list(db_vnfr["vdur"], lambda vdu: vdu["vdu-id-ref"] == vdu_id)
4029                         descriptor_config = get_configuration(db_vnfd, vdu_id)
4030                         if vdur.get("additionalParams"):
4031                             deploy_params_vdu = parse_yaml_strings(vdur["additionalParams"])
4032                         else:
4033                             deploy_params_vdu = deploy_params
4034                         deploy_params_vdu["OSM"] = get_osm_params(db_vnfr, vdu_id, vdu_count_index=vdu_index)
4035                         if descriptor_config:
4036                             vdu_name = None
4037                             kdu_name = None
4038                             stage[1] = "Scaling member_vnf_index={}, vdu_id={}, vdu_index={} ".format(
4039                                 member_vnf_index, vdu_id, vdu_index)
4040                             stage[2] = step = "Scaling out VCA"
4041                             self._write_op_status(
4042                                 op_id=nslcmop_id,
4043                                 stage=stage
4044                             )
4045                             self._deploy_n2vc(
4046                                 logging_text=logging_text + "member_vnf_index={}, vdu_id={}, vdu_index={} ".format(
4047                                     member_vnf_index, vdu_id, vdu_index),
4048                                 db_nsr=db_nsr,
4049                                 db_vnfr=db_vnfr,
4050                                 nslcmop_id=nslcmop_id,
4051                                 nsr_id=nsr_id,
4052                                 nsi_id=nsi_id,
4053                                 vnfd_id=vnfd_id,
4054                                 vdu_id=vdu_id,
4055                                 kdu_name=kdu_name,
4056                                 member_vnf_index=member_vnf_index,
4057                                 vdu_index=vdu_index,
4058                                 vdu_name=vdu_name,
4059                                 deploy_params=deploy_params_vdu,
4060                                 descriptor_config=descriptor_config,
4061                                 base_folder=base_folder,
4062                                 task_instantiation_info=tasks_dict_info,
4063                                 stage=stage
4064                             )
4065                         # TODO: scaling for kdu is not implemented yet.
4066                         kdu_name = vdu_info["osm_vdu_id"]
4067                         descriptor_config = get_configuration(db_vnfd, kdu_name)
4068                         if descriptor_config:
4069                             vdu_id = None
4070                             vdu_index = vdu_index
4071                             vdu_name = None
4072                             kdur = next(x for x in db_vnfr["kdur"] if x["kdu-name"] == kdu_name)
4073                             deploy_params_kdu = {"OSM": get_osm_params(db_vnfr)}
4074                             if kdur.get("additionalParams"):
4075                                 deploy_params_kdu = parse_yaml_strings(kdur["additionalParams"])
4076
4077                             self._deploy_n2vc(
4078                                 logging_text=logging_text,
4079                                 db_nsr=db_nsr,
4080                                 db_vnfr=db_vnfr,
4081                                 nslcmop_id=nslcmop_id,
4082                                 nsr_id=nsr_id,
4083                                 nsi_id=nsi_id,
4084                                 vnfd_id=vnfd_id,
4085                                 vdu_id=vdu_id,
4086                                 kdu_name=kdu_name,
4087                                 member_vnf_index=member_vnf_index,
4088                                 vdu_index=vdu_index,
4089                                 vdu_name=vdu_name,
4090                                 deploy_params=deploy_params_kdu,
4091                                 descriptor_config=descriptor_config,
4092                                 base_folder=base_folder,
4093                                 task_instantiation_info=tasks_dict_info,
4094                                 stage=stage
4095                             )
4096             # SCALE-UP VCA - END
4097             scale_process = None
4098
4099             # POST-SCALE BEGIN
4100             # execute primitive service POST-SCALING
4101             step = "Executing post-scale vnf-config-primitive"
4102             if scaling_descriptor.get("scaling-config-action"):
4103                 for scaling_config_action in scaling_descriptor["scaling-config-action"]:
4104                     if (scaling_config_action.get("trigger") == "post-scale-in" and scaling_type == "SCALE_IN") \
4105                        or (scaling_config_action.get("trigger") == "post-scale-out" and scaling_type == "SCALE_OUT"):
4106                         vnf_config_primitive = scaling_config_action["vnf-config-primitive-name-ref"]
4107                         step = db_nslcmop_update["detailed-status"] = \
4108                             "executing post-scale scaling-config-action '{}'".format(vnf_config_primitive)
4109
4110                         vnfr_params = {"VDU_SCALE_INFO": vdu_scaling_info}
4111                         if db_vnfr.get("additionalParamsForVnf"):
4112                             vnfr_params.update(db_vnfr["additionalParamsForVnf"])
4113
4114                         # look for primitive
4115                         for config_primitive in (
4116                             get_configuration(db_vnfd, db_vnfd["id"]) or {}
4117                         ).get("config-primitive", ()):
4118                             if config_primitive["name"] == vnf_config_primitive:
4119                                 break
4120                         else:
4121                             raise LcmException(
4122                                 "Invalid vnfd descriptor at scaling-group-descriptor[name='{}']:scaling-config-"
4123                                 "action[vnf-config-primitive-name-ref='{}'] does not match any vnf-configuration:"
4124                                 "config-primitive".format(scaling_group, vnf_config_primitive))
4125                         scale_process = "VCA"
4126                         db_nsr_update["config-status"] = "configuring post-scaling"
4127                         primitive_params = self._map_primitive_params(config_primitive, {}, vnfr_params)
4128
4129                         # Post-scale retry check: Check if this sub-operation has been executed before
4130                         op_index = self._check_or_add_scale_suboperation(
4131                             db_nslcmop, nslcmop_id, vnf_index, vnf_config_primitive, primitive_params, 'POST-SCALE')
4132                         if op_index == self.SUBOPERATION_STATUS_SKIP:
4133                             # Skip sub-operation
4134                             result = 'COMPLETED'
4135                             result_detail = 'Done'
4136                             self.logger.debug(logging_text +
4137                                               "vnf_config_primitive={} Skipped sub-operation, result {} {}".
4138                                               format(vnf_config_primitive, result, result_detail))
4139                         else:
4140                             if op_index == self.SUBOPERATION_STATUS_NEW:
4141                                 # New sub-operation: Get index of this sub-operation
4142                                 op_index = len(db_nslcmop.get('_admin', {}).get('operations')) - 1
4143                                 self.logger.debug(logging_text + "vnf_config_primitive={} New sub-operation".
4144                                                   format(vnf_config_primitive))
4145                             else:
4146                                 # retry:  Get registered params for this existing sub-operation
4147                                 op = db_nslcmop.get('_admin', {}).get('operations', [])[op_index]
4148                                 vnf_index = op.get('member_vnf_index')
4149                                 vnf_config_primitive = op.get('primitive')
4150                                 primitive_params = op.get('primitive_params')
4151                                 self.logger.debug(logging_text + "vnf_config_primitive={} Sub-operation retry".
4152                                                   format(vnf_config_primitive))
4153                             # Execute the primitive, either with new (first-time) or registered (reintent) args
4154                             ee_descriptor_id = config_primitive.get("execution-environment-ref")
4155                             primitive_name = config_primitive.get("execution-environment-primitive",
4156                                                                   vnf_config_primitive)
4157                             ee_id, vca_type = self._look_for_deployed_vca(nsr_deployed["VCA"],
4158                                                                           member_vnf_index=vnf_index,
4159                                                                           vdu_id=None,
4160                                                                           vdu_count_index=None,
4161                                                                           ee_descriptor_id=ee_descriptor_id)
4162                             result, result_detail = await self._ns_execute_primitive(
4163                                 ee_id, primitive_name, primitive_params, vca_type)
4164                             self.logger.debug(logging_text + "vnf_config_primitive={} Done with result {} {}".format(
4165                                 vnf_config_primitive, result, result_detail))
4166                             # Update operationState = COMPLETED | FAILED
4167                             self._update_suboperation_status(
4168                                 db_nslcmop, op_index, result, result_detail)
4169
4170                         if result == "FAILED":
4171                             raise LcmException(result_detail)
4172                         db_nsr_update["config-status"] = old_config_status
4173                         scale_process = None
4174             # POST-SCALE END
4175
4176             db_nsr_update["detailed-status"] = ""  # "scaled {} {}".format(scaling_group, scaling_type)
4177             db_nsr_update["operational-status"] = "running" if old_operational_status == "failed" \
4178                 else old_operational_status
4179             db_nsr_update["config-status"] = old_config_status
4180             return
4181         except (ROclient.ROClientException, DbException, LcmException, NgRoException) as e:
4182             self.logger.error(logging_text + "Exit Exception {}".format(e))
4183             exc = e
4184         except asyncio.CancelledError:
4185             self.logger.error(logging_text + "Cancelled Exception while '{}'".format(step))
4186             exc = "Operation was cancelled"
4187         except Exception as e:
4188             exc = traceback.format_exc()
4189             self.logger.critical(logging_text + "Exit Exception {} {}".format(type(e).__name__, e), exc_info=True)
4190         finally:
4191             self._write_ns_status(nsr_id=nsr_id, ns_state=None, current_operation="IDLE", current_operation_id=None)
4192             if tasks_dict_info:
4193                 stage[1] = "Waiting for instantiate pending tasks."
4194                 self.logger.debug(logging_text + stage[1])
4195                 exc = await self._wait_for_tasks(logging_text, tasks_dict_info, self.timeout_ns_deploy,
4196                                                  stage, nslcmop_id, nsr_id=nsr_id)
4197             if exc:
4198                 db_nslcmop_update["detailed-status"] = error_description_nslcmop = "FAILED {}: {}".format(step, exc)
4199                 nslcmop_operation_state = "FAILED"
4200                 if db_nsr:
4201                     db_nsr_update["operational-status"] = old_operational_status
4202                     db_nsr_update["config-status"] = old_config_status
4203                     db_nsr_update["detailed-status"] = ""
4204                     if scale_process:
4205                         if "VCA" in scale_process:
4206                             db_nsr_update["config-status"] = "failed"
4207                         if "RO" in scale_process:
4208                             db_nsr_update["operational-status"] = "failed"
4209                         db_nsr_update["detailed-status"] = "FAILED scaling nslcmop={} {}: {}".format(nslcmop_id, step,
4210                                                                                                      exc)
4211             else:
4212                 error_description_nslcmop = None
4213                 nslcmop_operation_state = "COMPLETED"
4214                 db_nslcmop_update["detailed-status"] = "Done"
4215
4216             self._write_op_status(op_id=nslcmop_id, stage="", error_message=error_description_nslcmop,
4217                                   operation_state=nslcmop_operation_state, other_update=db_nslcmop_update)
4218             if db_nsr:
4219                 self._write_ns_status(nsr_id=nsr_id, ns_state=None, current_operation="IDLE",
4220                                       current_operation_id=None, other_update=db_nsr_update)
4221
4222             if nslcmop_operation_state:
4223                 try:
4224                     msg = {"nsr_id": nsr_id, "nslcmop_id": nslcmop_id, "operationState": nslcmop_operation_state}
4225                     await self.msg.aiowrite("ns", "scaled", msg, loop=self.loop)
4226                 except Exception as e:
4227                     self.logger.error(logging_text + "kafka_write notification Exception {}".format(e))
4228             self.logger.debug(logging_text + "Exit")
4229             self.lcm_tasks.remove("ns", nsr_id, nslcmop_id, "ns_scale")
4230
4231     async def _scale_ng_ro(self, logging_text, db_nsr, db_nslcmop, db_vnfr, vdu_scaling_info, stage):
4232         nsr_id = db_nslcmop["nsInstanceId"]
4233         db_nsd = self.db.get_one("nsds", {"_id": db_nsr["nsd-id"]})
4234         db_vnfrs = {}
4235
4236         # read from db: vnfd's for every vnf
4237         db_vnfds = []
4238
4239         # for each vnf in ns, read vnfd
4240         for vnfr in self.db.get_list("vnfrs", {"nsr-id-ref": nsr_id}):
4241             db_vnfrs[vnfr["member-vnf-index-ref"]] = vnfr
4242             vnfd_id = vnfr["vnfd-id"]  # vnfd uuid for this vnf
4243             # if we haven't this vnfd, read it from db
4244             if not find_in_list(db_vnfds, lambda a_vnfd: a_vnfd["id"] == vnfd_id):
4245                 # read from db
4246                 vnfd = self.db.get_one("vnfds", {"_id": vnfd_id})
4247                 db_vnfds.append(vnfd)
4248         n2vc_key = self.n2vc.get_public_key()
4249         n2vc_key_list = [n2vc_key]
4250         self.scale_vnfr(db_vnfr, vdu_scaling_info.get("vdu-create"), vdu_scaling_info.get("vdu-delete"),
4251                         mark_delete=True)
4252         # db_vnfr has been updated, update db_vnfrs to use it
4253         db_vnfrs[db_vnfr["member-vnf-index-ref"]] = db_vnfr
4254         await self._instantiate_ng_ro(logging_text, nsr_id, db_nsd, db_nsr, db_nslcmop, db_vnfrs,
4255                                       db_vnfds, n2vc_key_list, stage=stage, start_deploy=time(),
4256                                       timeout_ns_deploy=self.timeout_ns_deploy)
4257         if vdu_scaling_info.get("vdu-delete"):
4258             self.scale_vnfr(db_vnfr, None, vdu_scaling_info["vdu-delete"], mark_delete=False)
4259
4260     async def add_prometheus_metrics(self, ee_id, artifact_path, ee_config_descriptor, vnfr_id, nsr_id, target_ip):
4261         if not self.prometheus:
4262             return
4263         # look if exist a file called 'prometheus*.j2' and
4264         artifact_content = self.fs.dir_ls(artifact_path)
4265         job_file = next((f for f in artifact_content if f.startswith("prometheus") and f.endswith(".j2")), None)
4266         if not job_file:
4267             return
4268         with self.fs.file_open((artifact_path, job_file), "r") as f:
4269             job_data = f.read()
4270
4271         # TODO get_service
4272         _, _, service = ee_id.partition(".")   # remove prefix   "namespace."
4273         host_name = "{}-{}".format(service, ee_config_descriptor["metric-service"])
4274         host_port = "80"
4275         vnfr_id = vnfr_id.replace("-", "")
4276         variables = {
4277             "JOB_NAME": vnfr_id,
4278             "TARGET_IP": target_ip,
4279             "EXPORTER_POD_IP": host_name,
4280             "EXPORTER_POD_PORT": host_port,
4281         }
4282         job_list = self.prometheus.parse_job(job_data, variables)
4283         # ensure job_name is using the vnfr_id. Adding the metadata nsr_id
4284         for job in job_list:
4285             if not isinstance(job.get("job_name"), str) or vnfr_id not in job["job_name"]:
4286                 job["job_name"] = vnfr_id + "_" + str(randint(1, 10000))
4287             job["nsr_id"] = nsr_id
4288         job_dict = {jl["job_name"]: jl for jl in job_list}
4289         if await self.prometheus.update(job_dict):
4290             return list(job_dict.keys())
4291
4292     def get_vca_cloud_and_credentials(self, vim_account_id: str) -> (str, str):
4293         """
4294         Get VCA Cloud and VCA Cloud Credentials for the VIM account
4295
4296         :param: vim_account_id:     VIM Account ID
4297
4298         :return: (cloud_name, cloud_credential)
4299         """
4300         config = VimAccountDB.get_vim_account_with_id(vim_account_id).get("config", {})
4301         return config.get("vca_cloud"), config.get("vca_cloud_credential")
4302
4303     def get_vca_k8s_cloud_and_credentials(self, vim_account_id: str) -> (str, str):
4304         """
4305         Get VCA K8s Cloud and VCA K8s Cloud Credentials for the VIM account
4306
4307         :param: vim_account_id:     VIM Account ID
4308
4309         :return: (cloud_name, cloud_credential)
4310         """
4311         config = VimAccountDB.get_vim_account_with_id(vim_account_id).get("config", {})
4312         return config.get("vca_k8s_cloud"), config.get("vca_k8s_cloud_credential")