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