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