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         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             db_k8scluster = self.db.get_one("k8sclusters", {"_id": cluster_id}, fail_on_empty=False)
2474             if not db_k8scluster:
2475                 raise LcmException("K8s cluster {} cannot be found".format(cluster_id))
2476             k8s_id = deep_get(db_k8scluster, ("_admin", cluster_type, "id"))
2477             if not k8s_id:
2478                 raise LcmException("K8s cluster '{}' has not been initilized for '{}'".format(cluster_id, cluster_type))
2479             k8scluster_id_2_uuic[cluster_type][cluster_id] = k8s_id
2480             return k8s_id
2481
2482         logging_text += "Deploy kdus: "
2483         step = ""
2484         try:
2485             db_nsr_update = {"_admin.deployed.K8s": []}
2486             self.update_db_2("nsrs", nsr_id, db_nsr_update)
2487
2488             index = 0
2489             updated_cluster_list = []
2490
2491             for vnfr_data in db_vnfrs.values():
2492                 for kdu_index, kdur in enumerate(get_iterable(vnfr_data, "kdur")):
2493                     # Step 0: Prepare and set parameters
2494                     desc_params = self._format_additional_params(kdur.get("additionalParams"))
2495                     vnfd_id = vnfr_data.get('vnfd-id')
2496                     kdud = next(kdud for kdud in db_vnfds[vnfd_id]["kdu"] if kdud["name"] == kdur["kdu-name"])
2497                     namespace = kdur.get("k8s-namespace")
2498                     if kdur.get("helm-chart"):
2499                         kdumodel = kdur["helm-chart"]
2500                         k8sclustertype = "helm-chart"
2501                     elif kdur.get("juju-bundle"):
2502                         kdumodel = kdur["juju-bundle"]
2503                         k8sclustertype = "juju-bundle"
2504                     else:
2505                         raise LcmException("kdu type for kdu='{}.{}' is neither helm-chart nor "
2506                                            "juju-bundle. Maybe an old NBI version is running".
2507                                            format(vnfr_data["member-vnf-index-ref"], kdur["kdu-name"]))
2508                     # check if kdumodel is a file and exists
2509                     try:
2510                         storage = deep_get(db_vnfds.get(vnfd_id), ('_admin', 'storage'))
2511                         if storage and storage.get('pkg-dir'):  # may be not present if vnfd has not artifacts
2512                             # path format: /vnfdid/pkkdir/helm-charts|juju-bundles/kdumodel
2513                             filename = '{}/{}/{}s/{}'.format(storage["folder"], storage["pkg-dir"], k8sclustertype,
2514                                                              kdumodel)
2515                             if self.fs.file_exists(filename, mode='file') or self.fs.file_exists(filename, mode='dir'):
2516                                 kdumodel = self.fs.path + filename
2517                     except (asyncio.TimeoutError, asyncio.CancelledError):
2518                         raise
2519                     except Exception:       # it is not a file
2520                         pass
2521
2522                     k8s_cluster_id = kdur["k8s-cluster"]["id"]
2523                     step = "Synchronize repos for k8s cluster '{}'".format(k8s_cluster_id)
2524                     cluster_uuid = _get_cluster_id(k8s_cluster_id, k8sclustertype)
2525
2526                     # Synchronize  repos
2527                     if k8sclustertype == "helm-chart" and cluster_uuid not in updated_cluster_list:
2528                         del_repo_list, added_repo_dict = await asyncio.ensure_future(
2529                             self.k8sclusterhelm.synchronize_repos(cluster_uuid=cluster_uuid))
2530                         if del_repo_list or added_repo_dict:
2531                             unset = {'_admin.helm_charts_added.' + item: None for item in del_repo_list}
2532                             updated = {'_admin.helm_charts_added.' +
2533                                        item: name for item, name in added_repo_dict.items()}
2534                             self.logger.debug(logging_text + "repos synchronized on k8s cluster '{}' to_delete: {}, "
2535                                                              "to_add: {}".format(k8s_cluster_id, del_repo_list,
2536                                                                                  added_repo_dict))
2537                             self.db.set_one("k8sclusters", {"_id": k8s_cluster_id}, updated, unset=unset)
2538                         updated_cluster_list.append(cluster_uuid)
2539
2540                     # Instantiate kdu
2541                     step = "Instantiating KDU {}.{} in k8s cluster {}".format(vnfr_data["member-vnf-index-ref"],
2542                                                                               kdur["kdu-name"], k8s_cluster_id)
2543                     k8s_instance_info = {"kdu-instance": None,
2544                                          "k8scluster-uuid": cluster_uuid,
2545                                          "k8scluster-type": k8sclustertype,
2546                                          "member-vnf-index": vnfr_data["member-vnf-index-ref"],
2547                                          "kdu-name": kdur["kdu-name"],
2548                                          "kdu-model": kdumodel,
2549                                          "namespace": namespace}
2550                     db_path = "_admin.deployed.K8s.{}".format(index)
2551                     db_nsr_update[db_path] = k8s_instance_info
2552                     self.update_db_2("nsrs", nsr_id, db_nsr_update)
2553
2554                     task = asyncio.ensure_future(
2555                         self._install_kdu(nsr_id, db_path, vnfr_data, kdu_index, kdur, kdud, db_vnfds[vnfd_id],
2556                                           k8s_instance_info, k8params=desc_params, timeout=600))
2557                     self.lcm_tasks.register("ns", nsr_id, nslcmop_id, "instantiate_KDU-{}".format(index), task)
2558                     task_instantiation_info[task] = "Deploying KDU {}".format(kdur["kdu-name"])
2559
2560                     index += 1
2561
2562         except (LcmException, asyncio.CancelledError):
2563             raise
2564         except Exception as e:
2565             msg = "Exception {} while {}: {}".format(type(e).__name__, step, e)
2566             if isinstance(e, (N2VCException, DbException)):
2567                 self.logger.error(logging_text + msg)
2568             else:
2569                 self.logger.critical(logging_text + msg, exc_info=True)
2570             raise LcmException(msg)
2571         finally:
2572             if db_nsr_update:
2573                 self.update_db_2("nsrs", nsr_id, db_nsr_update)
2574
2575     def _deploy_n2vc(self, logging_text, db_nsr, db_vnfr, nslcmop_id, nsr_id, nsi_id, vnfd_id, vdu_id,
2576                      kdu_name, member_vnf_index, vdu_index, vdu_name, deploy_params, descriptor_config,
2577                      base_folder, task_instantiation_info, stage):
2578         # launch instantiate_N2VC in a asyncio task and register task object
2579         # Look where information of this charm is at database <nsrs>._admin.deployed.VCA
2580         # if not found, create one entry and update database
2581         # fill db_nsr._admin.deployed.VCA.<index>
2582
2583         self.logger.debug(logging_text + "_deploy_n2vc vnfd_id={}, vdu_id={}".format(vnfd_id, vdu_id))
2584         if descriptor_config.get("juju"):   # There is one execution envioronment of type juju
2585             ee_list = [descriptor_config]
2586         elif descriptor_config.get("execution-environment-list"):
2587             ee_list = descriptor_config.get("execution-environment-list")
2588         else:  # other types as script are not supported
2589             ee_list = []
2590
2591         for ee_item in ee_list:
2592             self.logger.debug(logging_text + "_deploy_n2vc ee_item juju={}, helm={}".format(ee_item.get('juju'),
2593                                                                                             ee_item.get("helm-chart")))
2594             ee_descriptor_id = ee_item.get("id")
2595             if ee_item.get("juju"):
2596                 vca_name = ee_item['juju'].get('charm')
2597                 vca_type = "lxc_proxy_charm" if ee_item['juju'].get('charm') is not None else "native_charm"
2598                 if ee_item['juju'].get('cloud') == "k8s":
2599                     vca_type = "k8s_proxy_charm"
2600                 elif ee_item['juju'].get('proxy') is False:
2601                     vca_type = "native_charm"
2602             elif ee_item.get("helm-chart"):
2603                 vca_name = ee_item['helm-chart']
2604                 vca_type = "helm"
2605             else:
2606                 self.logger.debug(logging_text + "skipping non juju neither charm configuration")
2607                 continue
2608
2609             vca_index = -1
2610             for vca_index, vca_deployed in enumerate(db_nsr["_admin"]["deployed"]["VCA"]):
2611                 if not vca_deployed:
2612                     continue
2613                 if vca_deployed.get("member-vnf-index") == member_vnf_index and \
2614                         vca_deployed.get("vdu_id") == vdu_id and \
2615                         vca_deployed.get("kdu_name") == kdu_name and \
2616                         vca_deployed.get("vdu_count_index", 0) == vdu_index and \
2617                         vca_deployed.get("ee_descriptor_id") == ee_descriptor_id:
2618                     break
2619             else:
2620                 # not found, create one.
2621                 target = "ns" if not member_vnf_index else "vnf/{}".format(member_vnf_index)
2622                 if vdu_id:
2623                     target += "/vdu/{}/{}".format(vdu_id, vdu_index or 0)
2624                 elif kdu_name:
2625                     target += "/kdu/{}".format(kdu_name)
2626                 vca_deployed = {
2627                     "target_element": target,
2628                     # ^ target_element will replace member-vnf-index, kdu_name, vdu_id ... in a single string
2629                     "member-vnf-index": member_vnf_index,
2630                     "vdu_id": vdu_id,
2631                     "kdu_name": kdu_name,
2632                     "vdu_count_index": vdu_index,
2633                     "operational-status": "init",  # TODO revise
2634                     "detailed-status": "",  # TODO revise
2635                     "step": "initial-deploy",   # TODO revise
2636                     "vnfd_id": vnfd_id,
2637                     "vdu_name": vdu_name,
2638                     "type": vca_type,
2639                     "ee_descriptor_id": ee_descriptor_id
2640                 }
2641                 vca_index += 1
2642
2643                 # create VCA and configurationStatus in db
2644                 db_dict = {
2645                     "_admin.deployed.VCA.{}".format(vca_index): vca_deployed,
2646                     "configurationStatus.{}".format(vca_index): dict()
2647                 }
2648                 self.update_db_2("nsrs", nsr_id, db_dict)
2649
2650                 db_nsr["_admin"]["deployed"]["VCA"].append(vca_deployed)
2651
2652             # Launch task
2653             task_n2vc = asyncio.ensure_future(
2654                 self.instantiate_N2VC(
2655                     logging_text=logging_text,
2656                     vca_index=vca_index,
2657                     nsi_id=nsi_id,
2658                     db_nsr=db_nsr,
2659                     db_vnfr=db_vnfr,
2660                     vdu_id=vdu_id,
2661                     kdu_name=kdu_name,
2662                     vdu_index=vdu_index,
2663                     deploy_params=deploy_params,
2664                     config_descriptor=descriptor_config,
2665                     base_folder=base_folder,
2666                     nslcmop_id=nslcmop_id,
2667                     stage=stage,
2668                     vca_type=vca_type,
2669                     vca_name=vca_name,
2670                     ee_config_descriptor=ee_item
2671                 )
2672             )
2673             self.lcm_tasks.register("ns", nsr_id, nslcmop_id, "instantiate_N2VC-{}".format(vca_index), task_n2vc)
2674             task_instantiation_info[task_n2vc] = self.task_name_deploy_vca + " {}.{}".format(
2675                 member_vnf_index or "", vdu_id or "")
2676
2677     @staticmethod
2678     def _get_terminate_config_primitive(primitive_list, vca_deployed):
2679         """ Get a sorted terminate config primitive list. In case ee_descriptor_id is present at vca_deployed,
2680          it get only those primitives for this execution envirom"""
2681
2682         primitive_list = primitive_list or []
2683         # filter primitives by ee_descriptor_id
2684         ee_descriptor_id = vca_deployed.get("ee_descriptor_id")
2685         primitive_list = [p for p in primitive_list if p.get("execution-environment-ref") == ee_descriptor_id]
2686
2687         if primitive_list:
2688             primitive_list.sort(key=lambda val: int(val['seq']))
2689
2690         return primitive_list
2691
2692     @staticmethod
2693     def _create_nslcmop(nsr_id, operation, params):
2694         """
2695         Creates a ns-lcm-opp content to be stored at database.
2696         :param nsr_id: internal id of the instance
2697         :param operation: instantiate, terminate, scale, action, ...
2698         :param params: user parameters for the operation
2699         :return: dictionary following SOL005 format
2700         """
2701         # Raise exception if invalid arguments
2702         if not (nsr_id and operation and params):
2703             raise LcmException(
2704                 "Parameters 'nsr_id', 'operation' and 'params' needed to create primitive not provided")
2705         now = time()
2706         _id = str(uuid4())
2707         nslcmop = {
2708             "id": _id,
2709             "_id": _id,
2710             # COMPLETED,PARTIALLY_COMPLETED,FAILED_TEMP,FAILED,ROLLING_BACK,ROLLED_BACK
2711             "operationState": "PROCESSING",
2712             "statusEnteredTime": now,
2713             "nsInstanceId": nsr_id,
2714             "lcmOperationType": operation,
2715             "startTime": now,
2716             "isAutomaticInvocation": False,
2717             "operationParams": params,
2718             "isCancelPending": False,
2719             "links": {
2720                 "self": "/osm/nslcm/v1/ns_lcm_op_occs/" + _id,
2721                 "nsInstance": "/osm/nslcm/v1/ns_instances/" + nsr_id,
2722             }
2723         }
2724         return nslcmop
2725
2726     def _format_additional_params(self, params):
2727         params = params or {}
2728         for key, value in params.items():
2729             if str(value).startswith("!!yaml "):
2730                 params[key] = yaml.safe_load(value[7:])
2731         return params
2732
2733     def _get_terminate_primitive_params(self, seq, vnf_index):
2734         primitive = seq.get('name')
2735         primitive_params = {}
2736         params = {
2737             "member_vnf_index": vnf_index,
2738             "primitive": primitive,
2739             "primitive_params": primitive_params,
2740         }
2741         desc_params = {}
2742         return self._map_primitive_params(seq, params, desc_params)
2743
2744     # sub-operations
2745
2746     def _retry_or_skip_suboperation(self, db_nslcmop, op_index):
2747         op = deep_get(db_nslcmop, ('_admin', 'operations'), [])[op_index]
2748         if op.get('operationState') == 'COMPLETED':
2749             # b. Skip sub-operation
2750             # _ns_execute_primitive() or RO.create_action() will NOT be executed
2751             return self.SUBOPERATION_STATUS_SKIP
2752         else:
2753             # c. retry executing sub-operation
2754             # The sub-operation exists, and operationState != 'COMPLETED'
2755             # Update operationState = 'PROCESSING' to indicate a retry.
2756             operationState = 'PROCESSING'
2757             detailed_status = 'In progress'
2758             self._update_suboperation_status(
2759                 db_nslcmop, op_index, operationState, detailed_status)
2760             # Return the sub-operation index
2761             # _ns_execute_primitive() or RO.create_action() will be called from scale()
2762             # with arguments extracted from the sub-operation
2763             return op_index
2764
2765     # Find a sub-operation where all keys in a matching dictionary must match
2766     # Returns the index of the matching sub-operation, or SUBOPERATION_STATUS_NOT_FOUND if no match
2767     def _find_suboperation(self, db_nslcmop, match):
2768         if db_nslcmop and match:
2769             op_list = db_nslcmop.get('_admin', {}).get('operations', [])
2770             for i, op in enumerate(op_list):
2771                 if all(op.get(k) == match[k] for k in match):
2772                     return i
2773         return self.SUBOPERATION_STATUS_NOT_FOUND
2774
2775     # Update status for a sub-operation given its index
2776     def _update_suboperation_status(self, db_nslcmop, op_index, operationState, detailed_status):
2777         # Update DB for HA tasks
2778         q_filter = {'_id': db_nslcmop['_id']}
2779         update_dict = {'_admin.operations.{}.operationState'.format(op_index): operationState,
2780                        '_admin.operations.{}.detailed-status'.format(op_index): detailed_status}
2781         self.db.set_one("nslcmops",
2782                         q_filter=q_filter,
2783                         update_dict=update_dict,
2784                         fail_on_empty=False)
2785
2786     # Add sub-operation, return the index of the added sub-operation
2787     # Optionally, set operationState, detailed-status, and operationType
2788     # Status and type are currently set for 'scale' sub-operations:
2789     # 'operationState' : 'PROCESSING' | 'COMPLETED' | 'FAILED'
2790     # 'detailed-status' : status message
2791     # 'operationType': may be any type, in the case of scaling: 'PRE-SCALE' | 'POST-SCALE'
2792     # Status and operation type are currently only used for 'scale', but NOT for 'terminate' sub-operations.
2793     def _add_suboperation(self, db_nslcmop, vnf_index, vdu_id, vdu_count_index, vdu_name, primitive,
2794                           mapped_primitive_params, operationState=None, detailed_status=None, operationType=None,
2795                           RO_nsr_id=None, RO_scaling_info=None):
2796         if not db_nslcmop:
2797             return self.SUBOPERATION_STATUS_NOT_FOUND
2798         # Get the "_admin.operations" list, if it exists
2799         db_nslcmop_admin = db_nslcmop.get('_admin', {})
2800         op_list = db_nslcmop_admin.get('operations')
2801         # Create or append to the "_admin.operations" list
2802         new_op = {'member_vnf_index': vnf_index,
2803                   'vdu_id': vdu_id,
2804                   'vdu_count_index': vdu_count_index,
2805                   'primitive': primitive,
2806                   'primitive_params': mapped_primitive_params}
2807         if operationState:
2808             new_op['operationState'] = operationState
2809         if detailed_status:
2810             new_op['detailed-status'] = detailed_status
2811         if operationType:
2812             new_op['lcmOperationType'] = operationType
2813         if RO_nsr_id:
2814             new_op['RO_nsr_id'] = RO_nsr_id
2815         if RO_scaling_info:
2816             new_op['RO_scaling_info'] = RO_scaling_info
2817         if not op_list:
2818             # No existing operations, create key 'operations' with current operation as first list element
2819             db_nslcmop_admin.update({'operations': [new_op]})
2820             op_list = db_nslcmop_admin.get('operations')
2821         else:
2822             # Existing operations, append operation to list
2823             op_list.append(new_op)
2824
2825         db_nslcmop_update = {'_admin.operations': op_list}
2826         self.update_db_2("nslcmops", db_nslcmop['_id'], db_nslcmop_update)
2827         op_index = len(op_list) - 1
2828         return op_index
2829
2830     # Helper methods for scale() sub-operations
2831
2832     # pre-scale/post-scale:
2833     # Check for 3 different cases:
2834     # a. New: First time execution, return SUBOPERATION_STATUS_NEW
2835     # b. Skip: Existing sub-operation exists, operationState == 'COMPLETED', return SUBOPERATION_STATUS_SKIP
2836     # c. retry: Existing sub-operation exists, operationState != 'COMPLETED', return op_index to re-execute
2837     def _check_or_add_scale_suboperation(self, db_nslcmop, vnf_index, vnf_config_primitive, primitive_params,
2838                                          operationType, RO_nsr_id=None, RO_scaling_info=None):
2839         # Find this sub-operation
2840         if RO_nsr_id and RO_scaling_info:
2841             operationType = 'SCALE-RO'
2842             match = {
2843                 'member_vnf_index': vnf_index,
2844                 'RO_nsr_id': RO_nsr_id,
2845                 'RO_scaling_info': RO_scaling_info,
2846             }
2847         else:
2848             match = {
2849                 'member_vnf_index': vnf_index,
2850                 'primitive': vnf_config_primitive,
2851                 'primitive_params': primitive_params,
2852                 'lcmOperationType': operationType
2853             }
2854         op_index = self._find_suboperation(db_nslcmop, match)
2855         if op_index == self.SUBOPERATION_STATUS_NOT_FOUND:
2856             # a. New sub-operation
2857             # The sub-operation does not exist, add it.
2858             # _ns_execute_primitive() will be called from scale() as usual, with non-modified arguments
2859             # The following parameters are set to None for all kind of scaling:
2860             vdu_id = None
2861             vdu_count_index = None
2862             vdu_name = None
2863             if RO_nsr_id and RO_scaling_info:
2864                 vnf_config_primitive = None
2865                 primitive_params = None
2866             else:
2867                 RO_nsr_id = None
2868                 RO_scaling_info = None
2869             # Initial status for sub-operation
2870             operationState = 'PROCESSING'
2871             detailed_status = 'In progress'
2872             # Add sub-operation for pre/post-scaling (zero or more operations)
2873             self._add_suboperation(db_nslcmop,
2874                                    vnf_index,
2875                                    vdu_id,
2876                                    vdu_count_index,
2877                                    vdu_name,
2878                                    vnf_config_primitive,
2879                                    primitive_params,
2880                                    operationState,
2881                                    detailed_status,
2882                                    operationType,
2883                                    RO_nsr_id,
2884                                    RO_scaling_info)
2885             return self.SUBOPERATION_STATUS_NEW
2886         else:
2887             # Return either SUBOPERATION_STATUS_SKIP (operationState == 'COMPLETED'),
2888             # or op_index (operationState != 'COMPLETED')
2889             return self._retry_or_skip_suboperation(db_nslcmop, op_index)
2890
2891     # Function to return execution_environment id
2892
2893     def _get_ee_id(self, vnf_index, vdu_id, vca_deployed_list):
2894         # TODO vdu_index_count
2895         for vca in vca_deployed_list:
2896             if vca["member-vnf-index"] == vnf_index and vca["vdu_id"] == vdu_id:
2897                 return vca["ee_id"]
2898
2899     async def destroy_N2VC(self, logging_text, db_nslcmop, vca_deployed, config_descriptor,
2900                            vca_index, destroy_ee=True, exec_primitives=True):
2901         """
2902         Execute the terminate primitives and destroy the execution environment (if destroy_ee=False
2903         :param logging_text:
2904         :param db_nslcmop:
2905         :param vca_deployed: Dictionary of deployment info at db_nsr._admin.depoloyed.VCA.<INDEX>
2906         :param config_descriptor: Configuration descriptor of the NSD, VNFD, VNFD.vdu or VNFD.kdu
2907         :param vca_index: index in the database _admin.deployed.VCA
2908         :param destroy_ee: False to do not destroy, because it will be destroyed all of then at once
2909         :param exec_primitives: False to do not execute terminate primitives, because the config is not completed or has
2910                             not executed properly
2911         :return: None or exception
2912         """
2913
2914         self.logger.debug(
2915             logging_text + " vca_index: {}, vca_deployed: {}, config_descriptor: {}, destroy_ee: {}".format(
2916                 vca_index, vca_deployed, config_descriptor, destroy_ee
2917             )
2918         )
2919
2920         vca_type = vca_deployed.get("type", "lxc_proxy_charm")
2921
2922         # execute terminate_primitives
2923         if exec_primitives:
2924             terminate_primitives = self._get_terminate_config_primitive(
2925                 config_descriptor.get("terminate-config-primitive"), vca_deployed)
2926             vdu_id = vca_deployed.get("vdu_id")
2927             vdu_count_index = vca_deployed.get("vdu_count_index")
2928             vdu_name = vca_deployed.get("vdu_name")
2929             vnf_index = vca_deployed.get("member-vnf-index")
2930             if terminate_primitives and vca_deployed.get("needed_terminate"):
2931                 for seq in terminate_primitives:
2932                     # For each sequence in list, get primitive and call _ns_execute_primitive()
2933                     step = "Calling terminate action for vnf_member_index={} primitive={}".format(
2934                         vnf_index, seq.get("name"))
2935                     self.logger.debug(logging_text + step)
2936                     # Create the primitive for each sequence, i.e. "primitive": "touch"
2937                     primitive = seq.get('name')
2938                     mapped_primitive_params = self._get_terminate_primitive_params(seq, vnf_index)
2939
2940                     # Add sub-operation
2941                     self._add_suboperation(db_nslcmop,
2942                                            vnf_index,
2943                                            vdu_id,
2944                                            vdu_count_index,
2945                                            vdu_name,
2946                                            primitive,
2947                                            mapped_primitive_params)
2948                     # Sub-operations: Call _ns_execute_primitive() instead of action()
2949                     try:
2950                         result, result_detail = await self._ns_execute_primitive(vca_deployed["ee_id"], primitive,
2951                                                                                  mapped_primitive_params,
2952                                                                                  vca_type=vca_type)
2953                     except LcmException:
2954                         # this happens when VCA is not deployed. In this case it is not needed to terminate
2955                         continue
2956                     result_ok = ['COMPLETED', 'PARTIALLY_COMPLETED']
2957                     if result not in result_ok:
2958                         raise LcmException("terminate_primitive {}  for vnf_member_index={} fails with "
2959                                            "error {}".format(seq.get("name"), vnf_index, result_detail))
2960                 # set that this VCA do not need terminated
2961                 db_update_entry = "_admin.deployed.VCA.{}.needed_terminate".format(vca_index)
2962                 self.update_db_2("nsrs", db_nslcmop["nsInstanceId"], {db_update_entry: False})
2963
2964         if vca_deployed.get("prometheus_jobs") and self.prometheus:
2965             await self.prometheus.update(remove_jobs=vca_deployed["prometheus_jobs"])
2966
2967         if destroy_ee:
2968             await self.vca_map[vca_type].delete_execution_environment(vca_deployed["ee_id"])
2969
2970     async def _delete_all_N2VC(self, db_nsr: dict):
2971         self._write_all_config_status(db_nsr=db_nsr, status='TERMINATING')
2972         namespace = "." + db_nsr["_id"]
2973         try:
2974             await self.n2vc.delete_namespace(namespace=namespace, total_timeout=self.timeout_charm_delete)
2975         except N2VCNotFound:  # already deleted. Skip
2976             pass
2977         self._write_all_config_status(db_nsr=db_nsr, status='DELETED')
2978
2979     async def _terminate_RO(self, logging_text, nsr_deployed, nsr_id, nslcmop_id, stage):
2980         """
2981         Terminates a deployment from RO
2982         :param logging_text:
2983         :param nsr_deployed: db_nsr._admin.deployed
2984         :param nsr_id:
2985         :param nslcmop_id:
2986         :param stage: list of string with the content to write on db_nslcmop.detailed-status.
2987             this method will update only the index 2, but it will write on database the concatenated content of the list
2988         :return:
2989         """
2990         db_nsr_update = {}
2991         failed_detail = []
2992         ro_nsr_id = ro_delete_action = None
2993         if nsr_deployed and nsr_deployed.get("RO"):
2994             ro_nsr_id = nsr_deployed["RO"].get("nsr_id")
2995             ro_delete_action = nsr_deployed["RO"].get("nsr_delete_action_id")
2996         try:
2997             if ro_nsr_id:
2998                 stage[2] = "Deleting ns from VIM."
2999                 db_nsr_update["detailed-status"] = " ".join(stage)
3000                 self._write_op_status(nslcmop_id, stage)
3001                 self.logger.debug(logging_text + stage[2])
3002                 self.update_db_2("nsrs", nsr_id, db_nsr_update)
3003                 self._write_op_status(nslcmop_id, stage)
3004                 desc = await self.RO.delete("ns", ro_nsr_id)
3005                 ro_delete_action = desc["action_id"]
3006                 db_nsr_update["_admin.deployed.RO.nsr_delete_action_id"] = ro_delete_action
3007                 db_nsr_update["_admin.deployed.RO.nsr_id"] = None
3008                 db_nsr_update["_admin.deployed.RO.nsr_status"] = "DELETED"
3009             if ro_delete_action:
3010                 # wait until NS is deleted from VIM
3011                 stage[2] = "Waiting ns deleted from VIM."
3012                 detailed_status_old = None
3013                 self.logger.debug(logging_text + stage[2] + " RO_id={} ro_delete_action={}".format(ro_nsr_id,
3014                                                                                                    ro_delete_action))
3015                 self.update_db_2("nsrs", nsr_id, db_nsr_update)
3016                 self._write_op_status(nslcmop_id, stage)
3017
3018                 delete_timeout = 20 * 60  # 20 minutes
3019                 while delete_timeout > 0:
3020                     desc = await self.RO.show(
3021                         "ns",
3022                         item_id_name=ro_nsr_id,
3023                         extra_item="action",
3024                         extra_item_id=ro_delete_action)
3025
3026                     # deploymentStatus
3027                     self._on_update_ro_db(nsrs_id=nsr_id, ro_descriptor=desc)
3028
3029                     ns_status, ns_status_info = self.RO.check_action_status(desc)
3030                     if ns_status == "ERROR":
3031                         raise ROclient.ROClientException(ns_status_info)
3032                     elif ns_status == "BUILD":
3033                         stage[2] = "Deleting from VIM {}".format(ns_status_info)
3034                     elif ns_status == "ACTIVE":
3035                         db_nsr_update["_admin.deployed.RO.nsr_delete_action_id"] = None
3036                         db_nsr_update["_admin.deployed.RO.nsr_status"] = "DELETED"
3037                         break
3038                     else:
3039                         assert False, "ROclient.check_action_status returns unknown {}".format(ns_status)
3040                     if stage[2] != detailed_status_old:
3041                         detailed_status_old = stage[2]
3042                         db_nsr_update["detailed-status"] = " ".join(stage)
3043                         self._write_op_status(nslcmop_id, stage)
3044                         self.update_db_2("nsrs", nsr_id, db_nsr_update)
3045                     await asyncio.sleep(5, loop=self.loop)
3046                     delete_timeout -= 5
3047                 else:  # delete_timeout <= 0:
3048                     raise ROclient.ROClientException("Timeout waiting ns deleted from VIM")
3049
3050         except Exception as e:
3051             self.update_db_2("nsrs", nsr_id, db_nsr_update)
3052             if isinstance(e, ROclient.ROClientException) and e.http_code == 404:  # not found
3053                 db_nsr_update["_admin.deployed.RO.nsr_id"] = None
3054                 db_nsr_update["_admin.deployed.RO.nsr_status"] = "DELETED"
3055                 db_nsr_update["_admin.deployed.RO.nsr_delete_action_id"] = None
3056                 self.logger.debug(logging_text + "RO_ns_id={} already deleted".format(ro_nsr_id))
3057             elif isinstance(e, ROclient.ROClientException) and e.http_code == 409:  # conflict
3058                 failed_detail.append("delete conflict: {}".format(e))
3059                 self.logger.debug(logging_text + "RO_ns_id={} delete conflict: {}".format(ro_nsr_id, e))
3060             else:
3061                 failed_detail.append("delete error: {}".format(e))
3062                 self.logger.error(logging_text + "RO_ns_id={} delete error: {}".format(ro_nsr_id, e))
3063
3064         # Delete nsd
3065         if not failed_detail and deep_get(nsr_deployed, ("RO", "nsd_id")):
3066             ro_nsd_id = nsr_deployed["RO"]["nsd_id"]
3067             try:
3068                 stage[2] = "Deleting nsd from RO."
3069                 db_nsr_update["detailed-status"] = " ".join(stage)
3070                 self.update_db_2("nsrs", nsr_id, db_nsr_update)
3071                 self._write_op_status(nslcmop_id, stage)
3072                 await self.RO.delete("nsd", ro_nsd_id)
3073                 self.logger.debug(logging_text + "ro_nsd_id={} deleted".format(ro_nsd_id))
3074                 db_nsr_update["_admin.deployed.RO.nsd_id"] = None
3075             except Exception as e:
3076                 if isinstance(e, ROclient.ROClientException) and e.http_code == 404:  # not found
3077                     db_nsr_update["_admin.deployed.RO.nsd_id"] = None
3078                     self.logger.debug(logging_text + "ro_nsd_id={} already deleted".format(ro_nsd_id))
3079                 elif isinstance(e, ROclient.ROClientException) and e.http_code == 409:  # conflict
3080                     failed_detail.append("ro_nsd_id={} delete conflict: {}".format(ro_nsd_id, e))
3081                     self.logger.debug(logging_text + failed_detail[-1])
3082                 else:
3083                     failed_detail.append("ro_nsd_id={} delete error: {}".format(ro_nsd_id, e))
3084                     self.logger.error(logging_text + failed_detail[-1])
3085
3086         if not failed_detail and deep_get(nsr_deployed, ("RO", "vnfd")):
3087             for index, vnf_deployed in enumerate(nsr_deployed["RO"]["vnfd"]):
3088                 if not vnf_deployed or not vnf_deployed["id"]:
3089                     continue
3090                 try:
3091                     ro_vnfd_id = vnf_deployed["id"]
3092                     stage[2] = "Deleting member_vnf_index={} ro_vnfd_id={} from RO.".format(
3093                         vnf_deployed["member-vnf-index"], ro_vnfd_id)
3094                     db_nsr_update["detailed-status"] = " ".join(stage)
3095                     self.update_db_2("nsrs", nsr_id, db_nsr_update)
3096                     self._write_op_status(nslcmop_id, stage)
3097                     await self.RO.delete("vnfd", ro_vnfd_id)
3098                     self.logger.debug(logging_text + "ro_vnfd_id={} deleted".format(ro_vnfd_id))
3099                     db_nsr_update["_admin.deployed.RO.vnfd.{}.id".format(index)] = None
3100                 except Exception as e:
3101                     if isinstance(e, ROclient.ROClientException) and e.http_code == 404:  # not found
3102                         db_nsr_update["_admin.deployed.RO.vnfd.{}.id".format(index)] = None
3103                         self.logger.debug(logging_text + "ro_vnfd_id={} already deleted ".format(ro_vnfd_id))
3104                     elif isinstance(e, ROclient.ROClientException) and e.http_code == 409:  # conflict
3105                         failed_detail.append("ro_vnfd_id={} delete conflict: {}".format(ro_vnfd_id, e))
3106                         self.logger.debug(logging_text + failed_detail[-1])
3107                     else:
3108                         failed_detail.append("ro_vnfd_id={} delete error: {}".format(ro_vnfd_id, e))
3109                         self.logger.error(logging_text + failed_detail[-1])
3110
3111         if failed_detail:
3112             stage[2] = "Error deleting from VIM"
3113         else:
3114             stage[2] = "Deleted from VIM"
3115         db_nsr_update["detailed-status"] = " ".join(stage)
3116         self.update_db_2("nsrs", nsr_id, db_nsr_update)
3117         self._write_op_status(nslcmop_id, stage)
3118
3119         if failed_detail:
3120             raise LcmException("; ".join(failed_detail))
3121
3122     async def terminate(self, nsr_id, nslcmop_id):
3123         # Try to lock HA task here
3124         task_is_locked_by_me = self.lcm_tasks.lock_HA('ns', 'nslcmops', nslcmop_id)
3125         if not task_is_locked_by_me:
3126             return
3127
3128         logging_text = "Task ns={} terminate={} ".format(nsr_id, nslcmop_id)
3129         self.logger.debug(logging_text + "Enter")
3130         timeout_ns_terminate = self.timeout_ns_terminate
3131         db_nsr = None
3132         db_nslcmop = None
3133         operation_params = None
3134         exc = None
3135         error_list = []   # annotates all failed error messages
3136         db_nslcmop_update = {}
3137         autoremove = False  # autoremove after terminated
3138         tasks_dict_info = {}
3139         db_nsr_update = {}
3140         stage = ["Stage 1/3: Preparing task.", "Waiting for previous operations to terminate.", ""]
3141         # ^ contains [stage, step, VIM-status]
3142         try:
3143             # wait for any previous tasks in process
3144             await self.lcm_tasks.waitfor_related_HA("ns", 'nslcmops', nslcmop_id)
3145
3146             stage[1] = "Getting nslcmop={} from db.".format(nslcmop_id)
3147             db_nslcmop = self.db.get_one("nslcmops", {"_id": nslcmop_id})
3148             operation_params = db_nslcmop.get("operationParams") or {}
3149             if operation_params.get("timeout_ns_terminate"):
3150                 timeout_ns_terminate = operation_params["timeout_ns_terminate"]
3151             stage[1] = "Getting nsr={} from db.".format(nsr_id)
3152             db_nsr = self.db.get_one("nsrs", {"_id": nsr_id})
3153
3154             db_nsr_update["operational-status"] = "terminating"
3155             db_nsr_update["config-status"] = "terminating"
3156             self._write_ns_status(
3157                 nsr_id=nsr_id,
3158                 ns_state="TERMINATING",
3159                 current_operation="TERMINATING",
3160                 current_operation_id=nslcmop_id,
3161                 other_update=db_nsr_update
3162             )
3163             self._write_op_status(
3164                 op_id=nslcmop_id,
3165                 queuePosition=0,
3166                 stage=stage
3167             )
3168             nsr_deployed = deepcopy(db_nsr["_admin"].get("deployed")) or {}
3169             if db_nsr["_admin"]["nsState"] == "NOT_INSTANTIATED":
3170                 return
3171
3172             stage[1] = "Getting vnf descriptors from db."
3173             db_vnfrs_list = self.db.get_list("vnfrs", {"nsr-id-ref": nsr_id})
3174             db_vnfds_from_id = {}
3175             db_vnfds_from_member_index = {}
3176             # Loop over VNFRs
3177             for vnfr in db_vnfrs_list:
3178                 vnfd_id = vnfr["vnfd-id"]
3179                 if vnfd_id not in db_vnfds_from_id:
3180                     vnfd = self.db.get_one("vnfds", {"_id": vnfd_id})
3181                     db_vnfds_from_id[vnfd_id] = vnfd
3182                 db_vnfds_from_member_index[vnfr["member-vnf-index-ref"]] = db_vnfds_from_id[vnfd_id]
3183
3184             # Destroy individual execution environments when there are terminating primitives.
3185             # Rest of EE will be deleted at once
3186             # TODO - check before calling _destroy_N2VC
3187             # if not operation_params.get("skip_terminate_primitives"):#
3188             # or not vca.get("needed_terminate"):
3189             stage[0] = "Stage 2/3 execute terminating primitives."
3190             self.logger.debug(logging_text + stage[0])
3191             stage[1] = "Looking execution environment that needs terminate."
3192             self.logger.debug(logging_text + stage[1])
3193             # self.logger.debug("nsr_deployed: {}".format(nsr_deployed))
3194             for vca_index, vca in enumerate(get_iterable(nsr_deployed, "VCA")):
3195                 self.logger.debug("vca_index: {}, vca: {}".format(vca_index, vca))
3196                 config_descriptor = None
3197                 if not vca or not vca.get("ee_id"):
3198                     continue
3199                 if not vca.get("member-vnf-index"):
3200                     # ns
3201                     config_descriptor = db_nsr.get("ns-configuration")
3202                 elif vca.get("vdu_id"):
3203                     db_vnfd = db_vnfds_from_member_index[vca["member-vnf-index"]]
3204                     vdud = next((vdu for vdu in db_vnfd.get("vdu", ()) if vdu["id"] == vca.get("vdu_id")), None)
3205                     if vdud:
3206                         config_descriptor = vdud.get("vdu-configuration")
3207                 elif vca.get("kdu_name"):
3208                     db_vnfd = db_vnfds_from_member_index[vca["member-vnf-index"]]
3209                     kdud = next((kdu for kdu in db_vnfd.get("kdu", ()) if kdu["name"] == vca.get("kdu_name")), None)
3210                     if kdud:
3211                         config_descriptor = kdud.get("kdu-configuration")
3212                 else:
3213                     config_descriptor = db_vnfds_from_member_index[vca["member-vnf-index"]].get("vnf-configuration")
3214                 vca_type = vca.get("type")
3215                 exec_terminate_primitives = (not operation_params.get("skip_terminate_primitives") and
3216                                              vca.get("needed_terminate"))
3217                 # For helm we must destroy_ee
3218                 destroy_ee = "True" if vca_type == "helm" else "False"
3219                 task = asyncio.ensure_future(
3220                     self.destroy_N2VC(logging_text, db_nslcmop, vca, config_descriptor, vca_index,
3221                                       destroy_ee, exec_terminate_primitives))
3222                 tasks_dict_info[task] = "Terminating VCA {}".format(vca.get("ee_id"))
3223
3224             # wait for pending tasks of terminate primitives
3225             if tasks_dict_info:
3226                 self.logger.debug(logging_text + 'Waiting for terminate primitive pending tasks...')
3227                 error_list = await self._wait_for_tasks(logging_text, tasks_dict_info,
3228                                                         min(self.timeout_charm_delete, timeout_ns_terminate),
3229                                                         stage, nslcmop_id)
3230                 if error_list:
3231                     return   # raise LcmException("; ".join(error_list))
3232                 tasks_dict_info.clear()
3233
3234             # remove All execution environments at once
3235             stage[0] = "Stage 3/3 delete all."
3236
3237             if nsr_deployed.get("VCA"):
3238                 stage[1] = "Deleting all execution environments."
3239                 self.logger.debug(logging_text + stage[1])
3240                 task_delete_ee = asyncio.ensure_future(asyncio.wait_for(self._delete_all_N2VC(db_nsr=db_nsr),
3241                                                                         timeout=self.timeout_charm_delete))
3242                 # task_delete_ee = asyncio.ensure_future(self.n2vc.delete_namespace(namespace="." + nsr_id))
3243                 tasks_dict_info[task_delete_ee] = "Terminating all VCA"
3244
3245             # Delete from k8scluster
3246             stage[1] = "Deleting KDUs."
3247             self.logger.debug(logging_text + stage[1])
3248             # print(nsr_deployed)
3249             for kdu in get_iterable(nsr_deployed, "K8s"):
3250                 if not kdu or not kdu.get("kdu-instance"):
3251                     continue
3252                 kdu_instance = kdu.get("kdu-instance")
3253                 if kdu.get("k8scluster-type") in self.k8scluster_map:
3254                     task_delete_kdu_instance = asyncio.ensure_future(
3255                         self.k8scluster_map[kdu["k8scluster-type"]].uninstall(
3256                             cluster_uuid=kdu.get("k8scluster-uuid"),
3257                             kdu_instance=kdu_instance))
3258                 else:
3259                     self.logger.error(logging_text + "Unknown k8s deployment type {}".
3260                                       format(kdu.get("k8scluster-type")))
3261                     continue
3262                 tasks_dict_info[task_delete_kdu_instance] = "Terminating KDU '{}'".format(kdu.get("kdu-name"))
3263
3264             # remove from RO
3265             stage[1] = "Deleting ns from VIM."
3266             if self.ng_ro:
3267                 task_delete_ro = asyncio.ensure_future(
3268                     self._terminate_ng_ro(logging_text, nsr_deployed, nsr_id, nslcmop_id, stage))
3269             else:
3270                 task_delete_ro = asyncio.ensure_future(
3271                     self._terminate_RO(logging_text, nsr_deployed, nsr_id, nslcmop_id, stage))
3272             tasks_dict_info[task_delete_ro] = "Removing deployment from VIM"
3273
3274             # rest of staff will be done at finally
3275
3276         except (ROclient.ROClientException, DbException, LcmException, N2VCException) as e:
3277             self.logger.error(logging_text + "Exit Exception {}".format(e))
3278             exc = e
3279         except asyncio.CancelledError:
3280             self.logger.error(logging_text + "Cancelled Exception while '{}'".format(stage[1]))
3281             exc = "Operation was cancelled"
3282         except Exception as e:
3283             exc = traceback.format_exc()
3284             self.logger.critical(logging_text + "Exit Exception while '{}': {}".format(stage[1], e), exc_info=True)
3285         finally:
3286             if exc:
3287                 error_list.append(str(exc))
3288             try:
3289                 # wait for pending tasks
3290                 if tasks_dict_info:
3291                     stage[1] = "Waiting for terminate pending tasks."
3292                     self.logger.debug(logging_text + stage[1])
3293                     error_list += await self._wait_for_tasks(logging_text, tasks_dict_info, timeout_ns_terminate,
3294                                                              stage, nslcmop_id)
3295                 stage[1] = stage[2] = ""
3296             except asyncio.CancelledError:
3297                 error_list.append("Cancelled")
3298                 # TODO cancell all tasks
3299             except Exception as exc:
3300                 error_list.append(str(exc))
3301             # update status at database
3302             if error_list:
3303                 error_detail = "; ".join(error_list)
3304                 # self.logger.error(logging_text + error_detail)
3305                 error_description_nslcmop = 'Stage: {}. Detail: {}'.format(stage[0], error_detail)
3306                 error_description_nsr = 'Operation: TERMINATING.{}, Stage {}.'.format(nslcmop_id, stage[0])
3307
3308                 db_nsr_update["operational-status"] = "failed"
3309                 db_nsr_update["detailed-status"] = error_description_nsr + " Detail: " + error_detail
3310                 db_nslcmop_update["detailed-status"] = error_detail
3311                 nslcmop_operation_state = "FAILED"
3312                 ns_state = "BROKEN"
3313             else:
3314                 error_detail = None
3315                 error_description_nsr = error_description_nslcmop = None
3316                 ns_state = "NOT_INSTANTIATED"
3317                 db_nsr_update["operational-status"] = "terminated"
3318                 db_nsr_update["detailed-status"] = "Done"
3319                 db_nsr_update["_admin.nsState"] = "NOT_INSTANTIATED"
3320                 db_nslcmop_update["detailed-status"] = "Done"
3321                 nslcmop_operation_state = "COMPLETED"
3322
3323             if db_nsr:
3324                 self._write_ns_status(
3325                     nsr_id=nsr_id,
3326                     ns_state=ns_state,
3327                     current_operation="IDLE",
3328                     current_operation_id=None,
3329                     error_description=error_description_nsr,
3330                     error_detail=error_detail,
3331                     other_update=db_nsr_update
3332                 )
3333             self._write_op_status(
3334                 op_id=nslcmop_id,
3335                 stage="",
3336                 error_message=error_description_nslcmop,
3337                 operation_state=nslcmop_operation_state,
3338                 other_update=db_nslcmop_update,
3339             )
3340             if operation_params:
3341                 autoremove = operation_params.get("autoremove", False)
3342             if nslcmop_operation_state:
3343                 try:
3344                     await self.msg.aiowrite("ns", "terminated", {"nsr_id": nsr_id, "nslcmop_id": nslcmop_id,
3345                                                                  "operationState": nslcmop_operation_state,
3346                                                                  "autoremove": autoremove},
3347                                             loop=self.loop)
3348                 except Exception as e:
3349                     self.logger.error(logging_text + "kafka_write notification Exception {}".format(e))
3350
3351             self.logger.debug(logging_text + "Exit")
3352             self.lcm_tasks.remove("ns", nsr_id, nslcmop_id, "ns_terminate")
3353
3354     async def _wait_for_tasks(self, logging_text, created_tasks_info, timeout, stage, nslcmop_id, nsr_id=None):
3355         time_start = time()
3356         error_detail_list = []
3357         error_list = []
3358         pending_tasks = list(created_tasks_info.keys())
3359         num_tasks = len(pending_tasks)
3360         num_done = 0
3361         stage[1] = "{}/{}.".format(num_done, num_tasks)
3362         self._write_op_status(nslcmop_id, stage)
3363         while pending_tasks:
3364             new_error = None
3365             _timeout = timeout + time_start - time()
3366             done, pending_tasks = await asyncio.wait(pending_tasks, timeout=_timeout,
3367                                                      return_when=asyncio.FIRST_COMPLETED)
3368             num_done += len(done)
3369             if not done:   # Timeout
3370                 for task in pending_tasks:
3371                     new_error = created_tasks_info[task] + ": Timeout"
3372                     error_detail_list.append(new_error)
3373                     error_list.append(new_error)
3374                 break
3375             for task in done:
3376                 if task.cancelled():
3377                     exc = "Cancelled"
3378                 else:
3379                     exc = task.exception()
3380                 if exc:
3381                     if isinstance(exc, asyncio.TimeoutError):
3382                         exc = "Timeout"
3383                     new_error = created_tasks_info[task] + ": {}".format(exc)
3384                     error_list.append(created_tasks_info[task])
3385                     error_detail_list.append(new_error)
3386                     if isinstance(exc, (str, DbException, N2VCException, ROclient.ROClientException, LcmException,
3387                                         K8sException)):
3388                         self.logger.error(logging_text + new_error)
3389                     else:
3390                         exc_traceback = "".join(traceback.format_exception(None, exc, exc.__traceback__))
3391                         self.logger.error(logging_text + created_tasks_info[task] + exc_traceback)
3392                 else:
3393                     self.logger.debug(logging_text + created_tasks_info[task] + ": Done")
3394             stage[1] = "{}/{}.".format(num_done, num_tasks)
3395             if new_error:
3396                 stage[1] += " Errors: " + ". ".join(error_detail_list) + "."
3397                 if nsr_id:  # update also nsr
3398                     self.update_db_2("nsrs", nsr_id, {"errorDescription": "Error at: " + ", ".join(error_list),
3399                                                       "errorDetail": ". ".join(error_detail_list)})
3400             self._write_op_status(nslcmop_id, stage)
3401         return error_detail_list
3402
3403     @staticmethod
3404     def _map_primitive_params(primitive_desc, params, instantiation_params):
3405         """
3406         Generates the params to be provided to charm before executing primitive. If user does not provide a parameter,
3407         The default-value is used. If it is between < > it look for a value at instantiation_params
3408         :param primitive_desc: portion of VNFD/NSD that describes primitive
3409         :param params: Params provided by user
3410         :param instantiation_params: Instantiation params provided by user
3411         :return: a dictionary with the calculated params
3412         """
3413         calculated_params = {}
3414         for parameter in primitive_desc.get("parameter", ()):
3415             param_name = parameter["name"]
3416             if param_name in params:
3417                 calculated_params[param_name] = params[param_name]
3418             elif "default-value" in parameter or "value" in parameter:
3419                 if "value" in parameter:
3420                     calculated_params[param_name] = parameter["value"]
3421                 else:
3422                     calculated_params[param_name] = parameter["default-value"]
3423                 if isinstance(calculated_params[param_name], str) and calculated_params[param_name].startswith("<") \
3424                         and calculated_params[param_name].endswith(">"):
3425                     if calculated_params[param_name][1:-1] in instantiation_params:
3426                         calculated_params[param_name] = instantiation_params[calculated_params[param_name][1:-1]]
3427                     else:
3428                         raise LcmException("Parameter {} needed to execute primitive {} not provided".
3429                                            format(calculated_params[param_name], primitive_desc["name"]))
3430             else:
3431                 raise LcmException("Parameter {} needed to execute primitive {} not provided".
3432                                    format(param_name, primitive_desc["name"]))
3433
3434             if isinstance(calculated_params[param_name], (dict, list, tuple)):
3435                 calculated_params[param_name] = yaml.safe_dump(calculated_params[param_name], default_flow_style=True,
3436                                                                width=256)
3437             elif isinstance(calculated_params[param_name], str) and calculated_params[param_name].startswith("!!yaml "):
3438                 calculated_params[param_name] = calculated_params[param_name][7:]
3439
3440         # add always ns_config_info if primitive name is config
3441         if primitive_desc["name"] == "config":
3442             if "ns_config_info" in instantiation_params:
3443                 calculated_params["ns_config_info"] = instantiation_params["ns_config_info"]
3444         return calculated_params
3445
3446     def _look_for_deployed_vca(self, deployed_vca, member_vnf_index, vdu_id, vdu_count_index, kdu_name=None,
3447                                ee_descriptor_id=None):
3448         # find vca_deployed record for this action. Raise LcmException if not found or there is not any id.
3449         for vca in deployed_vca:
3450             if not vca:
3451                 continue
3452             if member_vnf_index != vca["member-vnf-index"] or vdu_id != vca["vdu_id"]:
3453                 continue
3454             if vdu_count_index is not None and vdu_count_index != vca["vdu_count_index"]:
3455                 continue
3456             if kdu_name and kdu_name != vca["kdu_name"]:
3457                 continue
3458             if ee_descriptor_id and ee_descriptor_id != vca["ee_descriptor_id"]:
3459                 continue
3460             break
3461         else:
3462             # vca_deployed not found
3463             raise LcmException("charm for member_vnf_index={} vdu_id={}.{} kdu_name={} execution-environment-list.id={}"
3464                                " is not deployed".format(member_vnf_index, vdu_id, vdu_count_index, kdu_name,
3465                                                          ee_descriptor_id))
3466
3467         # get ee_id
3468         ee_id = vca.get("ee_id")
3469         vca_type = vca.get("type", "lxc_proxy_charm")  # default value for backward compatibility - proxy charm
3470         if not ee_id:
3471             raise LcmException("charm for member_vnf_index={} vdu_id={} kdu_name={} vdu_count_index={} has not "
3472                                "execution environment"
3473                                .format(member_vnf_index, vdu_id, kdu_name, vdu_count_index))
3474         return ee_id, vca_type
3475
3476     async def _ns_execute_primitive(self, ee_id, primitive, primitive_params, retries=0,
3477                                     retries_interval=30, timeout=None,
3478                                     vca_type=None, db_dict=None) -> (str, str):
3479         try:
3480             if primitive == "config":
3481                 primitive_params = {"params": primitive_params}
3482
3483             vca_type = vca_type or "lxc_proxy_charm"
3484
3485             while retries >= 0:
3486                 try:
3487                     output = await asyncio.wait_for(
3488                         self.vca_map[vca_type].exec_primitive(
3489                             ee_id=ee_id,
3490                             primitive_name=primitive,
3491                             params_dict=primitive_params,
3492                             progress_timeout=self.timeout_progress_primitive,
3493                             total_timeout=self.timeout_primitive,
3494                             db_dict=db_dict),
3495                         timeout=timeout or self.timeout_primitive)
3496                     # execution was OK
3497                     break
3498                 except asyncio.CancelledError:
3499                     raise
3500                 except Exception as e:  # asyncio.TimeoutError
3501                     if isinstance(e, asyncio.TimeoutError):
3502                         e = "Timeout"
3503                     retries -= 1
3504                     if retries >= 0:
3505                         self.logger.debug('Error executing action {} on {} -> {}'.format(primitive, ee_id, e))
3506                         # wait and retry
3507                         await asyncio.sleep(retries_interval, loop=self.loop)
3508                     else:
3509                         return 'FAILED', str(e)
3510
3511             return 'COMPLETED', output
3512
3513         except (LcmException, asyncio.CancelledError):
3514             raise
3515         except Exception as e:
3516             return 'FAIL', 'Error executing action {}: {}'.format(primitive, e)
3517
3518     async def action(self, nsr_id, nslcmop_id):
3519
3520         # Try to lock HA task here
3521         task_is_locked_by_me = self.lcm_tasks.lock_HA('ns', 'nslcmops', nslcmop_id)
3522         if not task_is_locked_by_me:
3523             return
3524
3525         logging_text = "Task ns={} action={} ".format(nsr_id, nslcmop_id)
3526         self.logger.debug(logging_text + "Enter")
3527         # get all needed from database
3528         db_nsr = None
3529         db_nslcmop = None
3530         db_nsr_update = {}
3531         db_nslcmop_update = {}
3532         nslcmop_operation_state = None
3533         error_description_nslcmop = None
3534         exc = None
3535         try:
3536             # wait for any previous tasks in process
3537             step = "Waiting for previous operations to terminate"
3538             await self.lcm_tasks.waitfor_related_HA('ns', 'nslcmops', nslcmop_id)
3539
3540             self._write_ns_status(
3541                 nsr_id=nsr_id,
3542                 ns_state=None,
3543                 current_operation="RUNNING ACTION",
3544                 current_operation_id=nslcmop_id
3545             )
3546
3547             step = "Getting information from database"
3548             db_nslcmop = self.db.get_one("nslcmops", {"_id": nslcmop_id})
3549             db_nsr = self.db.get_one("nsrs", {"_id": nsr_id})
3550
3551             nsr_deployed = db_nsr["_admin"].get("deployed")
3552             vnf_index = db_nslcmop["operationParams"].get("member_vnf_index")
3553             vdu_id = db_nslcmop["operationParams"].get("vdu_id")
3554             kdu_name = db_nslcmop["operationParams"].get("kdu_name")
3555             vdu_count_index = db_nslcmop["operationParams"].get("vdu_count_index")
3556             primitive = db_nslcmop["operationParams"]["primitive"]
3557             primitive_params = db_nslcmop["operationParams"]["primitive_params"]
3558             timeout_ns_action = db_nslcmop["operationParams"].get("timeout_ns_action", self.timeout_primitive)
3559
3560             if vnf_index:
3561                 step = "Getting vnfr from database"
3562                 db_vnfr = self.db.get_one("vnfrs", {"member-vnf-index-ref": vnf_index, "nsr-id-ref": nsr_id})
3563                 step = "Getting vnfd from database"
3564                 db_vnfd = self.db.get_one("vnfds", {"_id": db_vnfr["vnfd-id"]})
3565             else:
3566                 step = "Getting nsd from database"
3567                 db_nsd = self.db.get_one("nsds", {"_id": db_nsr["nsd-id"]})
3568
3569             # for backward compatibility
3570             if nsr_deployed and isinstance(nsr_deployed.get("VCA"), dict):
3571                 nsr_deployed["VCA"] = list(nsr_deployed["VCA"].values())
3572                 db_nsr_update["_admin.deployed.VCA"] = nsr_deployed["VCA"]
3573                 self.update_db_2("nsrs", nsr_id, db_nsr_update)
3574
3575             # look for primitive
3576             config_primitive_desc = descriptor_configuration = None
3577             if vdu_id:
3578                 for vdu in get_iterable(db_vnfd, "vdu"):
3579                     if vdu_id == vdu["id"]:
3580                         descriptor_configuration = vdu.get("vdu-configuration")
3581                         break
3582             elif kdu_name:
3583                 for kdu in get_iterable(db_vnfd, "kdu"):
3584                     if kdu_name == kdu["name"]:
3585                         descriptor_configuration = kdu.get("kdu-configuration")
3586                         break
3587             elif vnf_index:
3588                 descriptor_configuration = db_vnfd.get("vnf-configuration")
3589             else:
3590                 descriptor_configuration = db_nsd.get("ns-configuration")
3591
3592             if descriptor_configuration and descriptor_configuration.get("config-primitive"):
3593                 for config_primitive in descriptor_configuration["config-primitive"]:
3594                     if config_primitive["name"] == primitive:
3595                         config_primitive_desc = config_primitive
3596                         break
3597
3598             if not config_primitive_desc and not (kdu_name and primitive in ("upgrade", "rollback", "status")):
3599                 raise LcmException("Primitive {} not found at [ns|vnf|vdu]-configuration:config-primitive ".
3600                                    format(primitive))
3601             primitive_name = config_primitive_desc.get("execution-environment-primitive", primitive)
3602             ee_descriptor_id = config_primitive_desc.get("execution-environment-ref")
3603
3604             if vnf_index:
3605                 if vdu_id:
3606                     vdur = next((x for x in db_vnfr["vdur"] if x["vdu-id-ref"] == vdu_id), None)
3607                     desc_params = self._format_additional_params(vdur.get("additionalParams"))
3608                 elif kdu_name:
3609                     kdur = next((x for x in db_vnfr["kdur"] if x["kdu-name"] == kdu_name), None)
3610                     desc_params = self._format_additional_params(kdur.get("additionalParams"))
3611                 else:
3612                     desc_params = self._format_additional_params(db_vnfr.get("additionalParamsForVnf"))
3613             else:
3614                 desc_params = self._format_additional_params(db_nsr.get("additionalParamsForNs"))
3615
3616             if kdu_name:
3617                 kdu_action = True if not deep_get(kdu, ("kdu-configuration", "juju")) else False
3618
3619             # TODO check if ns is in a proper status
3620             if kdu_name and (primitive_name in ("upgrade", "rollback", "status") or kdu_action):
3621                 # kdur and desc_params already set from before
3622                 if primitive_params:
3623                     desc_params.update(primitive_params)
3624                 # TODO Check if we will need something at vnf level
3625                 for index, kdu in enumerate(get_iterable(nsr_deployed, "K8s")):
3626                     if kdu_name == kdu["kdu-name"] and kdu["member-vnf-index"] == vnf_index:
3627                         break
3628                 else:
3629                     raise LcmException("KDU '{}' for vnf '{}' not deployed".format(kdu_name, vnf_index))
3630
3631                 if kdu.get("k8scluster-type") not in self.k8scluster_map:
3632                     msg = "unknown k8scluster-type '{}'".format(kdu.get("k8scluster-type"))
3633                     raise LcmException(msg)
3634
3635                 db_dict = {"collection": "nsrs",
3636                            "filter": {"_id": nsr_id},
3637                            "path": "_admin.deployed.K8s.{}".format(index)}
3638                 self.logger.debug(logging_text + "Exec k8s {} on {}.{}".format(primitive_name, vnf_index, kdu_name))
3639                 step = "Executing kdu {}".format(primitive_name)
3640                 if primitive_name == "upgrade":
3641                     if desc_params.get("kdu_model"):
3642                         kdu_model = desc_params.get("kdu_model")
3643                         del desc_params["kdu_model"]
3644                     else:
3645                         kdu_model = kdu.get("kdu-model")
3646                         parts = kdu_model.split(sep=":")
3647                         if len(parts) == 2:
3648                             kdu_model = parts[0]
3649
3650                     detailed_status = await asyncio.wait_for(
3651                         self.k8scluster_map[kdu["k8scluster-type"]].upgrade(
3652                             cluster_uuid=kdu.get("k8scluster-uuid"),
3653                             kdu_instance=kdu.get("kdu-instance"),
3654                             atomic=True, kdu_model=kdu_model,
3655                             params=desc_params, db_dict=db_dict,
3656                             timeout=timeout_ns_action),
3657                         timeout=timeout_ns_action + 10)
3658                     self.logger.debug(logging_text + " Upgrade of kdu {} done".format(detailed_status))
3659                 elif primitive_name == "rollback":
3660                     detailed_status = await asyncio.wait_for(
3661                         self.k8scluster_map[kdu["k8scluster-type"]].rollback(
3662                             cluster_uuid=kdu.get("k8scluster-uuid"),
3663                             kdu_instance=kdu.get("kdu-instance"),
3664                             db_dict=db_dict),
3665                         timeout=timeout_ns_action)
3666                 elif primitive_name == "status":
3667                     detailed_status = await asyncio.wait_for(
3668                         self.k8scluster_map[kdu["k8scluster-type"]].status_kdu(
3669                             cluster_uuid=kdu.get("k8scluster-uuid"),
3670                             kdu_instance=kdu.get("kdu-instance")),
3671                         timeout=timeout_ns_action)
3672                 else:
3673                     kdu_instance = kdu.get("kdu-instance") or "{}-{}".format(kdu["kdu-name"], nsr_id)
3674                     params = self._map_primitive_params(config_primitive_desc, primitive_params, desc_params)
3675
3676                     detailed_status = await asyncio.wait_for(
3677                         self.k8scluster_map[kdu["k8scluster-type"]].exec_primitive(
3678                             cluster_uuid=kdu.get("k8scluster-uuid"),
3679                             kdu_instance=kdu_instance,
3680                             primitive_name=primitive_name,
3681                             params=params, db_dict=db_dict,
3682                             timeout=timeout_ns_action),
3683                         timeout=timeout_ns_action)
3684
3685                 if detailed_status:
3686                     nslcmop_operation_state = 'COMPLETED'
3687                 else:
3688                     detailed_status = ''
3689                     nslcmop_operation_state = 'FAILED'
3690             else:
3691                 ee_id, vca_type = self._look_for_deployed_vca(nsr_deployed["VCA"],
3692                                                               member_vnf_index=vnf_index,
3693                                                               vdu_id=vdu_id,
3694                                                               vdu_count_index=vdu_count_index,
3695                                                               ee_descriptor_id=ee_descriptor_id)
3696                 db_nslcmop_notif = {"collection": "nslcmops",
3697                                     "filter": {"_id": nslcmop_id},
3698                                     "path": "admin.VCA"}
3699                 nslcmop_operation_state, detailed_status = await self._ns_execute_primitive(
3700                     ee_id,
3701                     primitive=primitive_name,
3702                     primitive_params=self._map_primitive_params(config_primitive_desc, primitive_params, desc_params),
3703                     timeout=timeout_ns_action,
3704                     vca_type=vca_type,
3705                     db_dict=db_nslcmop_notif)
3706
3707             db_nslcmop_update["detailed-status"] = detailed_status
3708             error_description_nslcmop = detailed_status if nslcmop_operation_state == "FAILED" else ""
3709             self.logger.debug(logging_text + " task Done with result {} {}".format(nslcmop_operation_state,
3710                                                                                    detailed_status))
3711             return  # database update is called inside finally
3712
3713         except (DbException, LcmException, N2VCException, K8sException) as e:
3714             self.logger.error(logging_text + "Exit Exception {}".format(e))
3715             exc = e
3716         except asyncio.CancelledError:
3717             self.logger.error(logging_text + "Cancelled Exception while '{}'".format(step))
3718             exc = "Operation was cancelled"
3719         except asyncio.TimeoutError:
3720             self.logger.error(logging_text + "Timeout while '{}'".format(step))
3721             exc = "Timeout"
3722         except Exception as e:
3723             exc = traceback.format_exc()
3724             self.logger.critical(logging_text + "Exit Exception {} {}".format(type(e).__name__, e), exc_info=True)
3725         finally:
3726             if exc:
3727                 db_nslcmop_update["detailed-status"] = detailed_status = error_description_nslcmop = \
3728                     "FAILED {}: {}".format(step, exc)
3729                 nslcmop_operation_state = "FAILED"
3730             if db_nsr:
3731                 self._write_ns_status(
3732                     nsr_id=nsr_id,
3733                     ns_state=db_nsr["nsState"],   # TODO check if degraded. For the moment use previous status
3734                     current_operation="IDLE",
3735                     current_operation_id=None,
3736                     # error_description=error_description_nsr,
3737                     # error_detail=error_detail,
3738                     other_update=db_nsr_update
3739                 )
3740
3741             self._write_op_status(
3742                 op_id=nslcmop_id,
3743                 stage="",
3744                 error_message=error_description_nslcmop,
3745                 operation_state=nslcmop_operation_state,
3746                 other_update=db_nslcmop_update,
3747             )
3748
3749             if nslcmop_operation_state:
3750                 try:
3751                     await self.msg.aiowrite("ns", "actioned", {"nsr_id": nsr_id, "nslcmop_id": nslcmop_id,
3752                                                                "operationState": nslcmop_operation_state},
3753                                             loop=self.loop)
3754                 except Exception as e:
3755                     self.logger.error(logging_text + "kafka_write notification Exception {}".format(e))
3756             self.logger.debug(logging_text + "Exit")
3757             self.lcm_tasks.remove("ns", nsr_id, nslcmop_id, "ns_action")
3758             return nslcmop_operation_state, detailed_status
3759
3760     async def scale(self, nsr_id, nslcmop_id):
3761
3762         # Try to lock HA task here
3763         task_is_locked_by_me = self.lcm_tasks.lock_HA('ns', 'nslcmops', nslcmop_id)
3764         if not task_is_locked_by_me:
3765             return
3766
3767         logging_text = "Task ns={} scale={} ".format(nsr_id, nslcmop_id)
3768         self.logger.debug(logging_text + "Enter")
3769         # get all needed from database
3770         db_nsr = None
3771         db_nslcmop = None
3772         db_nslcmop_update = {}
3773         nslcmop_operation_state = None
3774         db_nsr_update = {}
3775         exc = None
3776         # in case of error, indicates what part of scale was failed to put nsr at error status
3777         scale_process = None
3778         old_operational_status = ""
3779         old_config_status = ""
3780         vnfr_scaled = False
3781         try:
3782             # wait for any previous tasks in process
3783             step = "Waiting for previous operations to terminate"
3784             await self.lcm_tasks.waitfor_related_HA('ns', 'nslcmops', nslcmop_id)
3785
3786             self._write_ns_status(
3787                 nsr_id=nsr_id,
3788                 ns_state=None,
3789                 current_operation="SCALING",
3790                 current_operation_id=nslcmop_id
3791             )
3792
3793             step = "Getting nslcmop from database"
3794             self.logger.debug(step + " after having waited for previous tasks to be completed")
3795             db_nslcmop = self.db.get_one("nslcmops", {"_id": nslcmop_id})
3796             step = "Getting nsr from database"
3797             db_nsr = self.db.get_one("nsrs", {"_id": nsr_id})
3798
3799             old_operational_status = db_nsr["operational-status"]
3800             old_config_status = db_nsr["config-status"]
3801             step = "Parsing scaling parameters"
3802             # self.logger.debug(step)
3803             db_nsr_update["operational-status"] = "scaling"
3804             self.update_db_2("nsrs", nsr_id, db_nsr_update)
3805             nsr_deployed = db_nsr["_admin"].get("deployed")
3806
3807             #######
3808             nsr_deployed = db_nsr["_admin"].get("deployed")
3809             vnf_index = db_nslcmop["operationParams"].get("member_vnf_index")
3810             # vdu_id = db_nslcmop["operationParams"].get("vdu_id")
3811             # vdu_count_index = db_nslcmop["operationParams"].get("vdu_count_index")
3812             # vdu_name = db_nslcmop["operationParams"].get("vdu_name")
3813             #######
3814
3815             RO_nsr_id = nsr_deployed["RO"]["nsr_id"]
3816             vnf_index = db_nslcmop["operationParams"]["scaleVnfData"]["scaleByStepData"]["member-vnf-index"]
3817             scaling_group = db_nslcmop["operationParams"]["scaleVnfData"]["scaleByStepData"]["scaling-group-descriptor"]
3818             scaling_type = db_nslcmop["operationParams"]["scaleVnfData"]["scaleVnfType"]
3819             # scaling_policy = db_nslcmop["operationParams"]["scaleVnfData"]["scaleByStepData"].get("scaling-policy")
3820
3821             # for backward compatibility
3822             if nsr_deployed and isinstance(nsr_deployed.get("VCA"), dict):
3823                 nsr_deployed["VCA"] = list(nsr_deployed["VCA"].values())
3824                 db_nsr_update["_admin.deployed.VCA"] = nsr_deployed["VCA"]
3825                 self.update_db_2("nsrs", nsr_id, db_nsr_update)
3826
3827             step = "Getting vnfr from database"
3828             db_vnfr = self.db.get_one("vnfrs", {"member-vnf-index-ref": vnf_index, "nsr-id-ref": nsr_id})
3829             step = "Getting vnfd from database"
3830             db_vnfd = self.db.get_one("vnfds", {"_id": db_vnfr["vnfd-id"]})
3831
3832             step = "Getting scaling-group-descriptor"
3833             for scaling_descriptor in db_vnfd["scaling-group-descriptor"]:
3834                 if scaling_descriptor["name"] == scaling_group:
3835                     break
3836             else:
3837                 raise LcmException("input parameter 'scaleByStepData':'scaling-group-descriptor':'{}' is not present "
3838                                    "at vnfd:scaling-group-descriptor".format(scaling_group))
3839
3840             # cooldown_time = 0
3841             # for scaling_policy_descriptor in scaling_descriptor.get("scaling-policy", ()):
3842             #     cooldown_time = scaling_policy_descriptor.get("cooldown-time", 0)
3843             #     if scaling_policy and scaling_policy == scaling_policy_descriptor.get("name"):
3844             #         break
3845
3846             # TODO check if ns is in a proper status
3847             step = "Sending scale order to VIM"
3848             nb_scale_op = 0
3849             if not db_nsr["_admin"].get("scaling-group"):
3850                 self.update_db_2("nsrs", nsr_id, {"_admin.scaling-group": [{"name": scaling_group, "nb-scale-op": 0}]})
3851                 admin_scale_index = 0
3852             else:
3853                 for admin_scale_index, admin_scale_info in enumerate(db_nsr["_admin"]["scaling-group"]):
3854                     if admin_scale_info["name"] == scaling_group:
3855                         nb_scale_op = admin_scale_info.get("nb-scale-op", 0)
3856                         break
3857                 else:  # not found, set index one plus last element and add new entry with the name
3858                     admin_scale_index += 1
3859                     db_nsr_update["_admin.scaling-group.{}.name".format(admin_scale_index)] = scaling_group
3860             RO_scaling_info = []
3861             vdu_scaling_info = {"scaling_group_name": scaling_group, "vdu": []}
3862             if scaling_type == "SCALE_OUT":
3863                 # count if max-instance-count is reached
3864                 max_instance_count = scaling_descriptor.get("max-instance-count", 10)
3865                 # self.logger.debug("MAX_INSTANCE_COUNT is {}".format(max_instance_count))
3866                 if nb_scale_op >= max_instance_count:
3867                     raise LcmException("reached the limit of {} (max-instance-count) "
3868                                        "scaling-out operations for the "
3869                                        "scaling-group-descriptor '{}'".format(nb_scale_op, scaling_group))
3870
3871                 nb_scale_op += 1
3872                 vdu_scaling_info["scaling_direction"] = "OUT"
3873                 vdu_scaling_info["vdu-create"] = {}
3874                 for vdu_scale_info in scaling_descriptor["vdu"]:
3875                     RO_scaling_info.append({"osm_vdu_id": vdu_scale_info["vdu-id-ref"], "member-vnf-index": vnf_index,
3876                                             "type": "create", "count": vdu_scale_info.get("count", 1)})
3877                     vdu_scaling_info["vdu-create"][vdu_scale_info["vdu-id-ref"]] = vdu_scale_info.get("count", 1)
3878
3879             elif scaling_type == "SCALE_IN":
3880                 # count if min-instance-count is reached
3881                 min_instance_count = 0
3882                 if "min-instance-count" in scaling_descriptor and scaling_descriptor["min-instance-count"] is not None:
3883                     min_instance_count = int(scaling_descriptor["min-instance-count"])
3884                 if nb_scale_op <= min_instance_count:
3885                     raise LcmException("reached the limit of {} (min-instance-count) scaling-in operations for the "
3886                                        "scaling-group-descriptor '{}'".format(nb_scale_op, scaling_group))
3887                 nb_scale_op -= 1
3888                 vdu_scaling_info["scaling_direction"] = "IN"
3889                 vdu_scaling_info["vdu-delete"] = {}
3890                 for vdu_scale_info in scaling_descriptor["vdu"]:
3891                     RO_scaling_info.append({"osm_vdu_id": vdu_scale_info["vdu-id-ref"], "member-vnf-index": vnf_index,
3892                                             "type": "delete", "count": vdu_scale_info.get("count", 1)})
3893                     vdu_scaling_info["vdu-delete"][vdu_scale_info["vdu-id-ref"]] = vdu_scale_info.get("count", 1)
3894
3895             # update VDU_SCALING_INFO with the VDUs to delete ip_addresses
3896             vdu_create = vdu_scaling_info.get("vdu-create")
3897             vdu_delete = copy(vdu_scaling_info.get("vdu-delete"))
3898             if vdu_scaling_info["scaling_direction"] == "IN":
3899                 for vdur in reversed(db_vnfr["vdur"]):
3900                     if vdu_delete.get(vdur["vdu-id-ref"]):
3901                         vdu_delete[vdur["vdu-id-ref"]] -= 1
3902                         vdu_scaling_info["vdu"].append({
3903                             "name": vdur["name"],
3904                             "vdu_id": vdur["vdu-id-ref"],
3905                             "interface": []
3906                         })
3907                         for interface in vdur["interfaces"]:
3908                             vdu_scaling_info["vdu"][-1]["interface"].append({
3909                                 "name": interface["name"],
3910                                 "ip_address": interface["ip-address"],
3911                                 "mac_address": interface.get("mac-address"),
3912                             })
3913                 vdu_delete = vdu_scaling_info.pop("vdu-delete")
3914
3915             # PRE-SCALE BEGIN
3916             step = "Executing pre-scale vnf-config-primitive"
3917             if scaling_descriptor.get("scaling-config-action"):
3918                 for scaling_config_action in scaling_descriptor["scaling-config-action"]:
3919                     if (scaling_config_action.get("trigger") == "pre-scale-in" and scaling_type == "SCALE_IN") \
3920                        or (scaling_config_action.get("trigger") == "pre-scale-out" and scaling_type == "SCALE_OUT"):
3921                         vnf_config_primitive = scaling_config_action["vnf-config-primitive-name-ref"]
3922                         step = db_nslcmop_update["detailed-status"] = \
3923                             "executing pre-scale scaling-config-action '{}'".format(vnf_config_primitive)
3924
3925                         # look for primitive
3926                         for config_primitive in db_vnfd.get("vnf-configuration", {}).get("config-primitive", ()):
3927                             if config_primitive["name"] == vnf_config_primitive:
3928                                 break
3929                         else:
3930                             raise LcmException(
3931                                 "Invalid vnfd descriptor at scaling-group-descriptor[name='{}']:scaling-config-action"
3932                                 "[vnf-config-primitive-name-ref='{}'] does not match any vnf-configuration:config-"
3933                                 "primitive".format(scaling_group, vnf_config_primitive))
3934
3935                         vnfr_params = {"VDU_SCALE_INFO": vdu_scaling_info}
3936                         if db_vnfr.get("additionalParamsForVnf"):
3937                             vnfr_params.update(db_vnfr["additionalParamsForVnf"])
3938
3939                         scale_process = "VCA"
3940                         db_nsr_update["config-status"] = "configuring pre-scaling"
3941                         primitive_params = self._map_primitive_params(config_primitive, {}, vnfr_params)
3942
3943                         # Pre-scale retry check: Check if this sub-operation has been executed before
3944                         op_index = self._check_or_add_scale_suboperation(
3945                             db_nslcmop, nslcmop_id, vnf_index, vnf_config_primitive, primitive_params, 'PRE-SCALE')
3946                         if op_index == self.SUBOPERATION_STATUS_SKIP:
3947                             # Skip sub-operation
3948                             result = 'COMPLETED'
3949                             result_detail = 'Done'
3950                             self.logger.debug(logging_text +
3951                                               "vnf_config_primitive={} Skipped sub-operation, result {} {}".format(
3952                                                   vnf_config_primitive, result, result_detail))
3953                         else:
3954                             if op_index == self.SUBOPERATION_STATUS_NEW:
3955                                 # New sub-operation: Get index of this sub-operation
3956                                 op_index = len(db_nslcmop.get('_admin', {}).get('operations')) - 1
3957                                 self.logger.debug(logging_text + "vnf_config_primitive={} New sub-operation".
3958                                                   format(vnf_config_primitive))
3959                             else:
3960                                 # retry:  Get registered params for this existing sub-operation
3961                                 op = db_nslcmop.get('_admin', {}).get('operations', [])[op_index]
3962                                 vnf_index = op.get('member_vnf_index')
3963                                 vnf_config_primitive = op.get('primitive')
3964                                 primitive_params = op.get('primitive_params')
3965                                 self.logger.debug(logging_text + "vnf_config_primitive={} Sub-operation retry".
3966                                                   format(vnf_config_primitive))
3967                             # Execute the primitive, either with new (first-time) or registered (reintent) args
3968                             ee_descriptor_id = config_primitive.get("execution-environment-ref")
3969                             primitive_name = config_primitive.get("execution-environment-primitive",
3970                                                                   vnf_config_primitive)
3971                             ee_id, vca_type = self._look_for_deployed_vca(nsr_deployed["VCA"],
3972                                                                           member_vnf_index=vnf_index,
3973                                                                           vdu_id=None,
3974                                                                           vdu_count_index=None,
3975                                                                           ee_descriptor_id=ee_descriptor_id)
3976                             result, result_detail = await self._ns_execute_primitive(
3977                                 ee_id, primitive_name, primitive_params, vca_type)
3978                             self.logger.debug(logging_text + "vnf_config_primitive={} Done with result {} {}".format(
3979                                 vnf_config_primitive, result, result_detail))
3980                             # Update operationState = COMPLETED | FAILED
3981                             self._update_suboperation_status(
3982                                 db_nslcmop, op_index, result, result_detail)
3983
3984                         if result == "FAILED":
3985                             raise LcmException(result_detail)
3986                         db_nsr_update["config-status"] = old_config_status
3987                         scale_process = None
3988             # PRE-SCALE END
3989
3990             # SCALE RO - BEGIN
3991             # Should this block be skipped if 'RO_nsr_id' == None ?
3992             # if (RO_nsr_id and RO_scaling_info):
3993             if RO_scaling_info:
3994                 scale_process = "RO"
3995                 # Scale RO retry check: Check if this sub-operation has been executed before
3996                 op_index = self._check_or_add_scale_suboperation(
3997                     db_nslcmop, vnf_index, None, None, 'SCALE-RO', RO_nsr_id, RO_scaling_info)
3998                 if op_index == self.SUBOPERATION_STATUS_SKIP:
3999                     # Skip sub-operation
4000                     result = 'COMPLETED'
4001                     result_detail = 'Done'
4002                     self.logger.debug(logging_text + "Skipped sub-operation RO, result {} {}".format(
4003                         result, result_detail))
4004                 else:
4005                     if op_index == self.SUBOPERATION_STATUS_NEW:
4006                         # New sub-operation: Get index of this sub-operation
4007                         op_index = len(db_nslcmop.get('_admin', {}).get('operations')) - 1
4008                         self.logger.debug(logging_text + "New sub-operation RO")
4009                     else:
4010                         # retry:  Get registered params for this existing sub-operation
4011                         op = db_nslcmop.get('_admin', {}).get('operations', [])[op_index]
4012                         RO_nsr_id = op.get('RO_nsr_id')
4013                         RO_scaling_info = op.get('RO_scaling_info')
4014                         self.logger.debug(logging_text + "Sub-operation RO retry for primitive {}".format(
4015                             vnf_config_primitive))
4016
4017                     RO_desc = await self.RO.create_action("ns", RO_nsr_id, {"vdu-scaling": RO_scaling_info})
4018                     db_nsr_update["_admin.scaling-group.{}.nb-scale-op".format(admin_scale_index)] = nb_scale_op
4019                     db_nsr_update["_admin.scaling-group.{}.time".format(admin_scale_index)] = time()
4020                     # wait until ready
4021                     RO_nslcmop_id = RO_desc["instance_action_id"]
4022                     db_nslcmop_update["_admin.deploy.RO"] = RO_nslcmop_id
4023
4024                     RO_task_done = False
4025                     step = detailed_status = "Waiting RO_task_id={} to complete the scale action.".format(RO_nslcmop_id)
4026                     detailed_status_old = None
4027                     self.logger.debug(logging_text + step)
4028
4029                     deployment_timeout = 1 * 3600   # One hour
4030                     while deployment_timeout > 0:
4031                         if not RO_task_done:
4032                             desc = await self.RO.show("ns", item_id_name=RO_nsr_id, extra_item="action",
4033                                                       extra_item_id=RO_nslcmop_id)
4034
4035                             # deploymentStatus
4036                             self._on_update_ro_db(nsrs_id=nsr_id, ro_descriptor=desc)
4037
4038                             ns_status, ns_status_info = self.RO.check_action_status(desc)
4039                             if ns_status == "ERROR":
4040                                 raise ROclient.ROClientException(ns_status_info)
4041                             elif ns_status == "BUILD":
4042                                 detailed_status = step + "; {}".format(ns_status_info)
4043                             elif ns_status == "ACTIVE":
4044                                 RO_task_done = True
4045                                 step = detailed_status = "Waiting ns ready at RO. RO_id={}".format(RO_nsr_id)
4046                                 self.logger.debug(logging_text + step)
4047                             else:
4048                                 assert False, "ROclient.check_action_status returns unknown {}".format(ns_status)
4049                         else:
4050
4051                             if ns_status == "ERROR":
4052                                 raise ROclient.ROClientException(ns_status_info)
4053                             elif ns_status == "BUILD":
4054                                 detailed_status = step + "; {}".format(ns_status_info)
4055                             elif ns_status == "ACTIVE":
4056                                 step = detailed_status = \
4057                                     "Waiting for management IP address reported by the VIM. Updating VNFRs"
4058                                 if not vnfr_scaled:
4059                                     self.scale_vnfr(db_vnfr, vdu_create=vdu_create, vdu_delete=vdu_delete)
4060                                     vnfr_scaled = True
4061                                 try:
4062                                     desc = await self.RO.show("ns", RO_nsr_id)
4063
4064                                     # deploymentStatus
4065                                     self._on_update_ro_db(nsrs_id=nsr_id, ro_descriptor=desc)
4066
4067                                     # nsr_deployed["nsr_ip"] = RO.get_ns_vnf_info(desc)
4068                                     self.ns_update_vnfr({db_vnfr["member-vnf-index-ref"]: db_vnfr}, desc)
4069                                     break
4070                                 except LcmExceptionNoMgmtIP:
4071                                     pass
4072                             else:
4073                                 assert False, "ROclient.check_ns_status returns unknown {}".format(ns_status)
4074                         if detailed_status != detailed_status_old:
4075                             self._update_suboperation_status(
4076                                 db_nslcmop, op_index, 'COMPLETED', detailed_status)
4077                             detailed_status_old = db_nslcmop_update["detailed-status"] = detailed_status
4078                             self.update_db_2("nslcmops", nslcmop_id, db_nslcmop_update)
4079
4080                         await asyncio.sleep(5, loop=self.loop)
4081                         deployment_timeout -= 5
4082                     if deployment_timeout <= 0:
4083                         self._update_suboperation_status(
4084                             db_nslcmop, nslcmop_id, op_index, 'FAILED', "Timeout when waiting for ns to get ready")
4085                         raise ROclient.ROClientException("Timeout waiting ns to be ready")
4086
4087                     # update VDU_SCALING_INFO with the obtained ip_addresses
4088                     if vdu_scaling_info["scaling_direction"] == "OUT":
4089                         for vdur in reversed(db_vnfr["vdur"]):
4090                             if vdu_scaling_info["vdu-create"].get(vdur["vdu-id-ref"]):
4091                                 vdu_scaling_info["vdu-create"][vdur["vdu-id-ref"]] -= 1
4092                                 vdu_scaling_info["vdu"].append({
4093                                     "name": vdur["name"],
4094                                     "vdu_id": vdur["vdu-id-ref"],
4095                                     "interface": []
4096                                 })
4097                                 for interface in vdur["interfaces"]:
4098                                     vdu_scaling_info["vdu"][-1]["interface"].append({
4099                                         "name": interface["name"],
4100                                         "ip_address": interface["ip-address"],
4101                                         "mac_address": interface.get("mac-address"),
4102                                     })
4103                         del vdu_scaling_info["vdu-create"]
4104
4105                     self._update_suboperation_status(db_nslcmop, op_index, 'COMPLETED', 'Done')
4106             # SCALE RO - END
4107
4108             scale_process = None
4109             if db_nsr_update:
4110                 self.update_db_2("nsrs", nsr_id, db_nsr_update)
4111
4112             # POST-SCALE BEGIN
4113             # execute primitive service POST-SCALING
4114             step = "Executing post-scale vnf-config-primitive"
4115             if scaling_descriptor.get("scaling-config-action"):
4116                 for scaling_config_action in scaling_descriptor["scaling-config-action"]:
4117                     if (scaling_config_action.get("trigger") == "post-scale-in" and scaling_type == "SCALE_IN") \
4118                        or (scaling_config_action.get("trigger") == "post-scale-out" and scaling_type == "SCALE_OUT"):
4119                         vnf_config_primitive = scaling_config_action["vnf-config-primitive-name-ref"]
4120                         step = db_nslcmop_update["detailed-status"] = \
4121                             "executing post-scale scaling-config-action '{}'".format(vnf_config_primitive)
4122
4123                         vnfr_params = {"VDU_SCALE_INFO": vdu_scaling_info}
4124                         if db_vnfr.get("additionalParamsForVnf"):
4125                             vnfr_params.update(db_vnfr["additionalParamsForVnf"])
4126
4127                         # look for primitive
4128                         for config_primitive in db_vnfd.get("vnf-configuration", {}).get("config-primitive", ()):
4129                             if config_primitive["name"] == vnf_config_primitive:
4130                                 break
4131                         else:
4132                             raise LcmException(
4133                                 "Invalid vnfd descriptor at scaling-group-descriptor[name='{}']:scaling-config-"
4134                                 "action[vnf-config-primitive-name-ref='{}'] does not match any vnf-configuration:"
4135                                 "config-primitive".format(scaling_group, vnf_config_primitive))
4136                         scale_process = "VCA"
4137                         db_nsr_update["config-status"] = "configuring post-scaling"
4138                         primitive_params = self._map_primitive_params(config_primitive, {}, vnfr_params)
4139
4140                         # Post-scale retry check: Check if this sub-operation has been executed before
4141                         op_index = self._check_or_add_scale_suboperation(
4142                             db_nslcmop, nslcmop_id, vnf_index, vnf_config_primitive, primitive_params, 'POST-SCALE')
4143                         if op_index == self.SUBOPERATION_STATUS_SKIP:
4144                             # Skip sub-operation
4145                             result = 'COMPLETED'
4146                             result_detail = 'Done'
4147                             self.logger.debug(logging_text +
4148                                               "vnf_config_primitive={} Skipped sub-operation, result {} {}".
4149                                               format(vnf_config_primitive, result, result_detail))
4150                         else:
4151                             if op_index == self.SUBOPERATION_STATUS_NEW:
4152                                 # New sub-operation: Get index of this sub-operation
4153                                 op_index = len(db_nslcmop.get('_admin', {}).get('operations')) - 1
4154                                 self.logger.debug(logging_text + "vnf_config_primitive={} New sub-operation".
4155                                                   format(vnf_config_primitive))
4156                             else:
4157                                 # retry:  Get registered params for this existing sub-operation
4158                                 op = db_nslcmop.get('_admin', {}).get('operations', [])[op_index]
4159                                 vnf_index = op.get('member_vnf_index')
4160                                 vnf_config_primitive = op.get('primitive')
4161                                 primitive_params = op.get('primitive_params')
4162                                 self.logger.debug(logging_text + "vnf_config_primitive={} Sub-operation retry".
4163                                                   format(vnf_config_primitive))
4164                             # Execute the primitive, either with new (first-time) or registered (reintent) args
4165                             ee_descriptor_id = config_primitive.get("execution-environment-ref")
4166                             primitive_name = config_primitive.get("execution-environment-primitive",
4167                                                                   vnf_config_primitive)
4168                             ee_id, vca_type = self._look_for_deployed_vca(nsr_deployed["VCA"],
4169                                                                           member_vnf_index=vnf_index,
4170                                                                           vdu_id=None,
4171                                                                           vdu_count_index=None,
4172                                                                           ee_descriptor_id=ee_descriptor_id)
4173                             result, result_detail = await self._ns_execute_primitive(
4174                                 ee_id, primitive_name, primitive_params, vca_type)
4175                             self.logger.debug(logging_text + "vnf_config_primitive={} Done with result {} {}".format(
4176                                 vnf_config_primitive, result, result_detail))
4177                             # Update operationState = COMPLETED | FAILED
4178                             self._update_suboperation_status(
4179                                 db_nslcmop, op_index, result, result_detail)
4180
4181                         if result == "FAILED":
4182                             raise LcmException(result_detail)
4183                         db_nsr_update["config-status"] = old_config_status
4184                         scale_process = None
4185             # POST-SCALE END
4186
4187             db_nsr_update["detailed-status"] = ""  # "scaled {} {}".format(scaling_group, scaling_type)
4188             db_nsr_update["operational-status"] = "running" if old_operational_status == "failed" \
4189                 else old_operational_status
4190             db_nsr_update["config-status"] = old_config_status
4191             return
4192         except (ROclient.ROClientException, DbException, LcmException) as e:
4193             self.logger.error(logging_text + "Exit Exception {}".format(e))
4194             exc = e
4195         except asyncio.CancelledError:
4196             self.logger.error(logging_text + "Cancelled Exception while '{}'".format(step))
4197             exc = "Operation was cancelled"
4198         except Exception as e:
4199             exc = traceback.format_exc()
4200             self.logger.critical(logging_text + "Exit Exception {} {}".format(type(e).__name__, e), exc_info=True)
4201         finally:
4202             self._write_ns_status(
4203                 nsr_id=nsr_id,
4204                 ns_state=None,
4205                 current_operation="IDLE",
4206                 current_operation_id=None
4207             )
4208             if exc:
4209                 db_nslcmop_update["detailed-status"] = error_description_nslcmop = "FAILED {}: {}".format(step, exc)
4210                 nslcmop_operation_state = "FAILED"
4211                 if db_nsr:
4212                     db_nsr_update["operational-status"] = old_operational_status
4213                     db_nsr_update["config-status"] = old_config_status
4214                     db_nsr_update["detailed-status"] = ""
4215                     if scale_process:
4216                         if "VCA" in scale_process:
4217                             db_nsr_update["config-status"] = "failed"
4218                         if "RO" in scale_process:
4219                             db_nsr_update["operational-status"] = "failed"
4220                         db_nsr_update["detailed-status"] = "FAILED scaling nslcmop={} {}: {}".format(nslcmop_id, step,
4221                                                                                                      exc)
4222             else:
4223                 error_description_nslcmop = None
4224                 nslcmop_operation_state = "COMPLETED"
4225                 db_nslcmop_update["detailed-status"] = "Done"
4226
4227             self._write_op_status(
4228                 op_id=nslcmop_id,
4229                 stage="",
4230                 error_message=error_description_nslcmop,
4231                 operation_state=nslcmop_operation_state,
4232                 other_update=db_nslcmop_update,
4233             )
4234             if db_nsr:
4235                 self._write_ns_status(
4236                     nsr_id=nsr_id,
4237                     ns_state=None,
4238                     current_operation="IDLE",
4239                     current_operation_id=None,
4240                     other_update=db_nsr_update
4241                 )
4242
4243             if nslcmop_operation_state:
4244                 try:
4245                     await self.msg.aiowrite("ns", "scaled", {"nsr_id": nsr_id, "nslcmop_id": nslcmop_id,
4246                                                              "operationState": nslcmop_operation_state},
4247                                             loop=self.loop)
4248                     # if cooldown_time:
4249                     #     await asyncio.sleep(cooldown_time, loop=self.loop)
4250                     # await self.msg.aiowrite("ns","scaled-cooldown-time", {"nsr_id": nsr_id, "nslcmop_id": nslcmop_id})
4251                 except Exception as e:
4252                     self.logger.error(logging_text + "kafka_write notification Exception {}".format(e))
4253             self.logger.debug(logging_text + "Exit")
4254             self.lcm_tasks.remove("ns", nsr_id, nslcmop_id, "ns_scale")
4255
4256     async def add_prometheus_metrics(self, ee_id, artifact_path, ee_config_descriptor, vnfr_id, nsr_id, target_ip):
4257         if not self.prometheus:
4258             return
4259         # look if exist a file called 'prometheus*.j2' and
4260         artifact_content = self.fs.dir_ls(artifact_path)
4261         job_file = next((f for f in artifact_content if f.startswith("prometheus") and f.endswith(".j2")), None)
4262         if not job_file:
4263             return
4264         with self.fs.file_open((artifact_path, job_file), "r") as f:
4265             job_data = f.read()
4266
4267         # TODO get_service
4268         _, _, service = ee_id.partition(".")   # remove prefix   "namespace."
4269         host_name = "{}-{}".format(service, ee_config_descriptor["metric-service"])
4270         host_port = "80"
4271         vnfr_id = vnfr_id.replace("-", "")
4272         variables = {
4273             "JOB_NAME": vnfr_id,
4274             "TARGET_IP": target_ip,
4275             "EXPORTER_POD_IP": host_name,
4276             "EXPORTER_POD_PORT": host_port,
4277         }
4278         job_list = self.prometheus.parse_job(job_data, variables)
4279         # ensure job_name is using the vnfr_id. Adding the metadata nsr_id
4280         for job in job_list:
4281             if not isinstance(job.get("job_name"), str) or vnfr_id not in job["job_name"]:
4282                 job["job_name"] = vnfr_id + "_" + str(randint(1, 10000))
4283             job["nsr_id"] = nsr_id
4284         job_dict = {jl["job_name"]: jl for jl in job_list}
4285         if await self.prometheus.update(job_dict):
4286             return list(job_dict.keys())