osm_nbi/instance_topics.py

   1 # -*- coding: utf-8 -*-
   2
   3 # Licensed under the Apache License, Version 2.0 (the "License");
   4 # you may not use this file except in compliance with the License.
   5 # You may obtain a copy of the License at
   6 #
   7 #    http://www.apache.org/licenses/LICENSE-2.0
   8 #
   9 # Unless required by applicable law or agreed to in writing, software
  10 # distributed under the License is distributed on an "AS IS" BASIS,
  11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
  12 # implied.
  13 # See the License for the specific language governing permissions and
  14 # limitations under the License.
  15
  16 # import logging
  17 from uuid import uuid4
  18 from http import HTTPStatus
  19 from time import time
  20 from copy import copy, deepcopy
  21 from osm_nbi.validation import validate_input, ValidationError, ns_instantiate, ns_terminate, ns_action, ns_scale,\
  22     nsi_instantiate
  23 from osm_nbi.base_topic import BaseTopic, EngineException, get_iterable, deep_get
  24 # from descriptor_topics import DescriptorTopic
  25 from yaml import safe_dump
  26 from osm_common.dbbase import DbException
  27 from osm_common.msgbase import MsgException
  28 from osm_common.fsbase import FsException
  29 from re import match  # For checking that additional parameter names are valid Jinja2 identifiers
  30
  31 __author__ = "Alfonso Tierno <alfonso.tiernosepulveda@telefonica.com>"
  32
  33
  34 class NsrTopic(BaseTopic):
  35     topic = "nsrs"
  36     topic_msg = "ns"
  37     quota_name = "ns_instances"
  38     schema_new = ns_instantiate
  39
  40     def __init__(self, db, fs, msg, auth):
  41         BaseTopic.__init__(self, db, fs, msg, auth)
  42
  43     def _check_descriptor_dependencies(self, session, descriptor):
  44         """
  45         Check that the dependent descriptors exist on a new descriptor or edition
  46         :param session: client session information
  47         :param descriptor: descriptor to be inserted or edit
  48         :return: None or raises exception
  49         """
  50         if not descriptor.get("nsdId"):
  51             return
  52         nsd_id = descriptor["nsdId"]
  53         if not self.get_item_list(session, "nsds", {"id": nsd_id}):
  54             raise EngineException("Descriptor error at nsdId='{}' references a non exist nsd".format(nsd_id),
  55                                   http_code=HTTPStatus.CONFLICT)
  56
  57     @staticmethod
  58     def format_on_new(content, project_id=None, make_public=False):
  59         BaseTopic.format_on_new(content, project_id=project_id, make_public=make_public)
  60         content["_admin"]["nsState"] = "NOT_INSTANTIATED"
  61         return None
  62
  63     def check_conflict_on_del(self, session, _id, db_content):
  64         """
  65         Check that NSR is not instantiated
  66         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
  67         :param _id: nsr internal id
  68         :param db_content: The database content of the nsr
  69         :return: None or raises EngineException with the conflict
  70         """
  71         if session["force"]:
  72             return
  73         nsr = db_content
  74         if nsr["_admin"].get("nsState") == "INSTANTIATED":
  75             raise EngineException("nsr '{}' cannot be deleted because it is in 'INSTANTIATED' state. "
  76                                   "Launch 'terminate' operation first; or force deletion".format(_id),
  77                                   http_code=HTTPStatus.CONFLICT)
  78
  79     def delete_extra(self, session, _id, db_content, not_send_msg=None):
  80         """
  81         Deletes associated nslcmops and vnfrs from database. Deletes associated filesystem.
  82          Set usageState of pdu, vnfd, nsd
  83         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
  84         :param _id: server internal id
  85         :param db_content: The database content of the descriptor
  86         :param not_send_msg: To not send message (False) or store content (list) instead
  87         :return: None if ok or raises EngineException with the problem
  88         """
  89         self.fs.file_delete(_id, ignore_non_exist=True)
  90         self.db.del_list("nslcmops", {"nsInstanceId": _id})
  91         self.db.del_list("vnfrs", {"nsr-id-ref": _id})
  92
  93         # set all used pdus as free
  94         self.db.set_list("pdus", {"_admin.usage.nsr_id": _id},
  95                          {"_admin.usageState": "NOT_IN_USE", "_admin.usage": None})
  96
  97         # Set NSD usageState
  98         nsr = db_content
  99         used_nsd_id = nsr.get("nsd-id")
 100         if used_nsd_id:
 101             # check if used by another NSR
 102             nsrs_list = self.db.get_one("nsrs", {"nsd-id": used_nsd_id},
 103                                         fail_on_empty=False, fail_on_more=False)
 104             if not nsrs_list:
 105                 self.db.set_one("nsds", {"_id": used_nsd_id}, {"_admin.usageState": "NOT_IN_USE"})
 106
 107         # Set VNFD usageState
 108         used_vnfd_id_list = nsr.get("vnfd-id")
 109         if used_vnfd_id_list:
 110             for used_vnfd_id in used_vnfd_id_list:
 111                 # check if used by another NSR
 112                 nsrs_list = self.db.get_one("nsrs", {"vnfd-id": used_vnfd_id},
 113                                             fail_on_empty=False, fail_on_more=False)
 114                 if not nsrs_list:
 115                     self.db.set_one("vnfds", {"_id": used_vnfd_id}, {"_admin.usageState": "NOT_IN_USE"})
 116
 117     @staticmethod
 118     def _format_ns_request(ns_request):
 119         formated_request = copy(ns_request)
 120         formated_request.pop("additionalParamsForNs", None)
 121         formated_request.pop("additionalParamsForVnf", None)
 122         return formated_request
 123
 124     @staticmethod
 125     def _format_additional_params(ns_request, member_vnf_index=None, vdu_id=None, kdu_name=None, descriptor=None):
 126         """
 127         Get and format user additional params for NS or VNF
 128         :param ns_request: User instantiation additional parameters
 129         :param member_vnf_index: None for extract NS params, or member_vnf_index to extract VNF params
 130         :param descriptor: If not None it check that needed parameters of descriptor are supplied
 131         :return: tuple with a formatted copy of additional params or None if not supplied, plus other parameters
 132         """
 133         additional_params = None
 134         other_params = None
 135         if not member_vnf_index:
 136             additional_params = copy(ns_request.get("additionalParamsForNs"))
 137             where_ = "additionalParamsForNs"
 138         elif ns_request.get("additionalParamsForVnf"):
 139             where_ = "additionalParamsForVnf[member-vnf-index={}]".format(member_vnf_index)
 140             item = next((x for x in ns_request["additionalParamsForVnf"] if x["member-vnf-index"] == member_vnf_index),
 141                         None)
 142             if item:
 143                 if not vdu_id and not kdu_name:
 144                     other_params = item
 145                 additional_params = copy(item.get("additionalParams")) or {}
 146                 if vdu_id and item.get("additionalParamsForVdu"):
 147                     item_vdu = next((x for x in item["additionalParamsForVdu"] if x["vdu_id"] == vdu_id), None)
 148                     other_params = item_vdu
 149                     if item_vdu and item_vdu.get("additionalParams"):
 150                         where_ += ".additionalParamsForVdu[vdu_id={}]".format(vdu_id)
 151                         additional_params = item_vdu["additionalParams"]
 152                 if kdu_name:
 153                     additional_params = {}
 154                     if item.get("additionalParamsForKdu"):
 155                         item_kdu = next((x for x in item["additionalParamsForKdu"] if x["kdu_name"] == kdu_name), None)
 156                         other_params = item_kdu
 157                         if item_kdu and item_kdu.get("additionalParams"):
 158                             where_ += ".additionalParamsForKdu[kdu_name={}]".format(kdu_name)
 159                             additional_params = item_kdu["additionalParams"]
 160
 161         if additional_params:
 162             for k, v in additional_params.items():
 163                 # BEGIN Check that additional parameter names are valid Jinja2 identifiers if target is not Kdu
 164                 if not kdu_name and not match('^[a-zA-Z_][a-zA-Z0-9_]*$', k):
 165                     raise EngineException("Invalid param name at {}:{}. Must contain only alphanumeric characters "
 166                                           "and underscores, and cannot start with a digit"
 167                                           .format(where_, k))
 168                 # END Check that additional parameter names are valid Jinja2 identifiers
 169                 if not isinstance(k, str):
 170                     raise EngineException("Invalid param at {}:{}. Only string keys are allowed".format(where_, k))
 171                 if "." in k or "$" in k:
 172                     raise EngineException("Invalid param at {}:{}. Keys must not contain dots or $".format(where_, k))
 173                 if isinstance(v, (dict, tuple, list)):
 174                     additional_params[k] = "!!yaml " + safe_dump(v)
 175
 176         if descriptor:
 177             # check that enough parameters are supplied for the initial-config-primitive
 178             # TODO: check for cloud-init
 179             if member_vnf_index:
 180                 if kdu_name:
 181                     initial_primitives = None
 182                 elif vdu_id:
 183                     vdud = next(x for x in descriptor["vdu"] if x["id"] == vdu_id)
 184                     initial_primitives = deep_get(vdud, ("vdu-configuration", "initial-config-primitive"))
 185                 else:
 186                     initial_primitives = deep_get(descriptor, ("vnf-configuration", "initial-config-primitive"))
 187             else:
 188                 initial_primitives = deep_get(descriptor, ("ns-configuration", "initial-config-primitive"))
 189
 190             for initial_primitive in get_iterable(initial_primitives):
 191                 for param in get_iterable(initial_primitive.get("parameter")):
 192                     if param["value"].startswith("<") and param["value"].endswith(">"):
 193                         if param["value"] in ("<rw_mgmt_ip>", "<VDU_SCALE_INFO>", "<ns_config_info>"):
 194                             continue
 195                         if not additional_params or param["value"][1:-1] not in additional_params:
 196                             raise EngineException("Parameter '{}' needed for vnfd[id={}]:vnf-configuration:"
 197                                                   "initial-config-primitive[name={}] not supplied".
 198                                                   format(param["value"], descriptor["id"],
 199                                                          initial_primitive["name"]))
 200
 201         return additional_params or None, other_params or None
 202
 203     def new(self, rollback, session, indata=None, kwargs=None, headers=None):
 204         """
 205         Creates a new nsr into database. It also creates needed vnfrs
 206         :param rollback: list to append the created items at database in case a rollback must be done
 207         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
 208         :param indata: params to be used for the nsr
 209         :param kwargs: used to override the indata descriptor
 210         :param headers: http request headers
 211         :return: the _id of nsr descriptor created at database. Or an exception of type
 212             EngineException, ValidationError, DbException, FsException, MsgException.
 213             Note: Exceptions are not captured on purpose. They should be captured at called
 214         """
 215
 216         try:
 217             step = "checking quotas"
 218             self.check_quota(session)
 219
 220             step = "validating input parameters"
 221             ns_request = self._remove_envelop(indata)
 222             # Override descriptor with query string kwargs
 223             self._update_input_with_kwargs(ns_request, kwargs)
 224             self._validate_input_new(ns_request, session["force"])
 225
 226             # look for nsd
 227             step = "getting nsd id='{}' from database".format(ns_request.get("nsdId"))
 228             _filter = self._get_project_filter(session)
 229             _filter["_id"] = ns_request["nsdId"]
 230             nsd = self.db.get_one("nsds", _filter)
 231             del _filter["_id"]
 232
 233             nsr_id = str(uuid4())
 234
 235             now = time()
 236             step = "filling nsr from input data"
 237             additional_params, _ = self._format_additional_params(ns_request, descriptor=nsd)
 238
 239             # use for k8s-namespace from ns_request or additionalParamsForNs. By default, the project_id
 240             ns_k8s_namespace = session["project_id"][0] if session["project_id"] else None
 241             if ns_request and ns_request.get("k8s-namespace"):
 242                 ns_k8s_namespace = ns_request["k8s-namespace"]
 243             if additional_params and additional_params.get("k8s-namespace"):
 244                 ns_k8s_namespace = additional_params["k8s-namespace"]
 245
 246             nsr_descriptor = {
 247                 "name": ns_request["nsName"],
 248                 "name-ref": ns_request["nsName"],
 249                 "short-name": ns_request["nsName"],
 250                 "admin-status": "ENABLED",
 251                 "nsState": "NOT_INSTANTIATED",
 252                 "currentOperation": "IDLE",
 253                 "currentOperationID": None,
 254                 "errorDescription": None,
 255                 "errorDetail": None,
 256                 "deploymentStatus": None,
 257                 "configurationStatus": None,
 258                 "vcaStatus": None,
 259                 "nsd": {k: v for k, v in nsd.items() if k in ("vld", "_id", "id", "constituent-vnfd", "name",
 260                                                               "ns-configuration")},
 261                 "datacenter": ns_request["vimAccountId"],
 262                 "resource-orchestrator": "osmopenmano",
 263                 "description": ns_request.get("nsDescription", ""),
 264                 "constituent-vnfr-ref": [],
 265
 266                 "operational-status": "init",    # typedef ns-operational-
 267                 "config-status": "init",         # typedef config-states
 268                 "detailed-status": "scheduled",
 269
 270                 "orchestration-progress": {},
 271                 # {"networks": {"active": 0, "total": 0}, "vms": {"active": 0, "total": 0}},
 272
 273                 "create-time": now,
 274                 "nsd-name-ref": nsd["name"],
 275                 "operational-events": [],   # "id", "timestamp", "description", "event",
 276                 "nsd-ref": nsd["id"],
 277                 "nsd-id": nsd["_id"],
 278                 "vnfd-id": [],
 279                 "instantiate_params": self._format_ns_request(ns_request),
 280                 "additionalParamsForNs": additional_params,
 281                 "ns-instance-config-ref": nsr_id,
 282                 "id": nsr_id,
 283                 "_id": nsr_id,
 284                 # "input-parameter": xpath, value,
 285                 "ssh-authorized-key": ns_request.get("ssh_keys"),  # TODO remove
 286             }
 287             ns_request["nsr_id"] = nsr_id
 288             if ns_request and ns_request.get("config-units"):
 289                 nsr_descriptor["config-units"] = ns_request["config-units"]
 290
 291             # Create vld
 292             if nsd.get("vld"):
 293                 nsr_descriptor["vld"] = nsd["vld"]
 294
 295             # Create VNFR
 296             needed_vnfds = {}
 297             for member_vnf in nsd.get("constituent-vnfd", ()):
 298                 vnfd_id = member_vnf["vnfd-id-ref"]
 299                 step = "getting vnfd id='{}' constituent-vnfd='{}' from database".format(
 300                     member_vnf["vnfd-id-ref"], member_vnf["member-vnf-index"])
 301                 if vnfd_id not in needed_vnfds:
 302                     # Obtain vnfd
 303                     _filter["id"] = vnfd_id
 304                     vnfd = self.db.get_one("vnfds", _filter, fail_on_empty=True, fail_on_more=True)
 305                     del _filter["id"]
 306                     vnfd.pop("_admin")
 307                     needed_vnfds[vnfd_id] = vnfd
 308                     nsr_descriptor["vnfd-id"].append(vnfd["_id"])
 309                 else:
 310                     vnfd = needed_vnfds[vnfd_id]
 311                 step = "filling vnfr  vnfd-id='{}' constituent-vnfd='{}'".format(
 312                     member_vnf["vnfd-id-ref"], member_vnf["member-vnf-index"])
 313                 vnfr_id = str(uuid4())
 314                 additional_params, vnf_params = self._format_additional_params(ns_request,
 315                                                                                member_vnf["member-vnf-index"],
 316                                                                                descriptor=vnfd)
 317                 vnfr_descriptor = {
 318                     "id": vnfr_id,
 319                     "_id": vnfr_id,
 320                     "nsr-id-ref": nsr_id,
 321                     "member-vnf-index-ref": member_vnf["member-vnf-index"],
 322                     "additionalParamsForVnf": additional_params,
 323                     "created-time": now,
 324                     # "vnfd": vnfd,        # at OSM model.but removed to avoid data duplication TODO: revise
 325                     "vnfd-ref": vnfd_id,
 326                     "vnfd-id": vnfd["_id"],    # not at OSM model, but useful
 327                     "vim-account-id": None,
 328                     "vdur": [],
 329                     "connection-point": [],
 330                     "ip-address": None,  # mgmt-interface filled by LCM
 331                 }
 332                 vnf_k8s_namespace = ns_k8s_namespace
 333                 if vnf_params:
 334                     if vnf_params.get("k8s-namespace"):
 335                         vnf_k8s_namespace = vnf_params["k8s-namespace"]
 336                     if vnf_params.get("config-units"):
 337                         vnfr_descriptor["config-units"] = vnf_params["config-units"]
 338
 339                 # Create vld
 340                 if vnfd.get("internal-vld"):
 341                     vnfr_descriptor["vld"] = []
 342                     for vnfd_vld in vnfd.get("internal-vld"):
 343                         vnfr_descriptor["vld"].append(
 344                             {key: vnfd_vld[key] for key in ("id", "vim-network-name", "vim-network-id") if key in
 345                              vnfd_vld})
 346
 347                 vnfd_mgmt_cp = vnfd["mgmt-interface"].get("cp")
 348                 for cp in vnfd.get("connection-point", ()):
 349                     vnf_cp = {
 350                         "name": cp["name"],
 351                         "connection-point-id": cp.get("id"),
 352                         "id": cp.get("id"),
 353                         # "ip-address", "mac-address" # filled by LCM
 354                         # vim-id  # TODO it would be nice having a vim port id
 355                     }
 356                     vnfr_descriptor["connection-point"].append(vnf_cp)
 357
 358                 # Create k8s-cluster information
 359                 if vnfd.get("k8s-cluster"):
 360                     vnfr_descriptor["k8s-cluster"] = vnfd["k8s-cluster"]
 361                     for net in get_iterable(vnfr_descriptor["k8s-cluster"].get("nets")):
 362                         if net.get("external-connection-point-ref"):
 363                             for nsd_vld in get_iterable(nsd.get("vld")):
 364                                 for nsd_vld_cp in get_iterable(nsd_vld.get("vnfd-connection-point-ref")):
 365                                     if nsd_vld_cp.get("vnfd-connection-point-ref") == \
 366                                             net["external-connection-point-ref"] and \
 367                                             nsd_vld_cp.get("member-vnf-index-ref") == member_vnf["member-vnf-index"]:
 368                                         net["ns-vld-id"] = nsd_vld["id"]
 369                                         break
 370                                 else:
 371                                     continue
 372                                 break
 373                         elif net.get("internal-connection-point-ref"):
 374                             for vnfd_ivld in get_iterable(vnfd.get("internal-vld")):
 375                                 for vnfd_ivld_icp in get_iterable(vnfd_ivld.get("internal-connection-point")):
 376                                     if vnfd_ivld_icp.get("id-ref") == net["internal-connection-point-ref"]:
 377                                         net["vnf-vld-id"] = vnfd_ivld["id"]
 378                                         break
 379                                 else:
 380                                     continue
 381                                 break
 382                 # update kdus
 383                 for kdu in get_iterable(vnfd.get("kdu")):
 384                     additional_params, kdu_params = self._format_additional_params(ns_request,
 385                                                                                    member_vnf["member-vnf-index"],
 386                                                                                    kdu_name=kdu["name"],
 387                                                                                    descriptor=vnfd)
 388                     kdu_k8s_namespace = vnf_k8s_namespace
 389                     kdu_model = kdu_params.get("kdu_model") if kdu_params else None
 390                     if kdu_params and kdu_params.get("k8s-namespace"):
 391                         kdu_k8s_namespace = kdu_params["k8s-namespace"]
 392
 393                     kdur = {
 394                         "additionalParams": additional_params,
 395                         "k8s-namespace": kdu_k8s_namespace,
 396                         "kdu-name": kdu["name"],
 397                         # TODO      "name": ""     Name of the VDU in the VIM
 398                         "ip-address": None,  # mgmt-interface filled by LCM
 399                         "k8s-cluster": {},
 400                     }
 401                     if kdu_params and kdu_params.get("config-units"):
 402                         kdur["config-units"] = kdu_params["config-units"]
 403                     for k8s_type in ("helm-chart", "juju-bundle"):
 404                         if kdu.get(k8s_type):
 405                             kdur[k8s_type] = kdu_model or kdu[k8s_type]
 406                     if not vnfr_descriptor.get("kdur"):
 407                         vnfr_descriptor["kdur"] = []
 408                     vnfr_descriptor["kdur"].append(kdur)
 409
 410                 for vdu in vnfd.get("vdu", ()):
 411                     additional_params, vdu_params = self._format_additional_params(
 412                         ns_request, member_vnf["member-vnf-index"], vdu_id=vdu["id"], descriptor=vnfd)
 413                     vdur = {
 414                         "vdu-id-ref": vdu["id"],
 415                         # TODO      "name": ""     Name of the VDU in the VIM
 416                         "ip-address": None,  # mgmt-interface filled by LCM
 417                         # "vim-id", "flavor-id", "image-id", "management-ip" # filled by LCM
 418                         "internal-connection-point": [],
 419                         "interfaces": [],
 420                         "additionalParams": additional_params
 421                     }
 422                     if vdu_params and vdu_params.get("config-units"):
 423                         vdur["config-units"] = vdu_params["config-units"]
 424                     if deep_get(vdu, ("supplemental-boot-data", "boot-data-drive")):
 425                         vdur["boot-data-drive"] = vdu["supplemental-boot-data"]["boot-data-drive"]
 426                     if vdu.get("pdu-type"):
 427                         vdur["pdu-type"] = vdu["pdu-type"]
 428                     # TODO volumes: name, volume-id
 429                     for icp in vdu.get("internal-connection-point", ()):
 430                         vdu_icp = {
 431                             "id": icp["id"],
 432                             "connection-point-id": icp["id"],
 433                             "name": icp.get("name"),
 434                             # "ip-address", "mac-address" # filled by LCM
 435                             # vim-id  # TODO it would be nice having a vim port id
 436                         }
 437                         vdur["internal-connection-point"].append(vdu_icp)
 438                     for iface in vdu.get("interface", ()):
 439                         vdu_iface = {
 440                             "name": iface.get("name"),
 441                             # "ip-address", "mac-address" # filled by LCM
 442                             # vim-id  # TODO it would be nice having a vim port id
 443                         }
 444                         if vnfd_mgmt_cp and iface.get("external-connection-point-ref") == vnfd_mgmt_cp:
 445                             vdu_iface["mgmt-vnf"] = True
 446                         if iface.get("mgmt-interface"):
 447                             vdu_iface["mgmt-interface"] = True  # TODO change to mgmt-vdu
 448
 449                         # look for network where this interface is connected
 450                         if iface.get("external-connection-point-ref"):
 451                             for nsd_vld in get_iterable(nsd.get("vld")):
 452                                 for nsd_vld_cp in get_iterable(nsd_vld.get("vnfd-connection-point-ref")):
 453                                     if nsd_vld_cp.get("vnfd-connection-point-ref") == \
 454                                             iface["external-connection-point-ref"] and \
 455                                             nsd_vld_cp.get("member-vnf-index-ref") == member_vnf["member-vnf-index"]:
 456                                         vdu_iface["ns-vld-id"] = nsd_vld["id"]
 457                                         break
 458                                 else:
 459                                     continue
 460                                 break
 461                         elif iface.get("internal-connection-point-ref"):
 462                             for vnfd_ivld in get_iterable(vnfd.get("internal-vld")):
 463                                 for vnfd_ivld_icp in get_iterable(vnfd_ivld.get("internal-connection-point")):
 464                                     if vnfd_ivld_icp.get("id-ref") == iface["internal-connection-point-ref"]:
 465                                         vdu_iface["vnf-vld-id"] = vnfd_ivld["id"]
 466                                         break
 467                                 else:
 468                                     continue
 469                                 break
 470
 471                         vdur["interfaces"].append(vdu_iface)
 472                     count = vdu.get("count", 1)
 473                     if count is None:
 474                         count = 1
 475                     count = int(count)    # TODO remove when descriptor serialized with payngbind
 476                     for index in range(0, count):
 477                         if index:
 478                             vdur = deepcopy(vdur)
 479                         vdur["_id"] = str(uuid4())
 480                         vdur["count-index"] = index
 481                         vnfr_descriptor["vdur"].append(vdur)
 482
 483                 step = "creating vnfr vnfd-id='{}' constituent-vnfd='{}' at database".format(
 484                     member_vnf["vnfd-id-ref"], member_vnf["member-vnf-index"])
 485
 486                 # add at database
 487                 self.format_on_new(vnfr_descriptor, session["project_id"], make_public=session["public"])
 488                 self.db.create("vnfrs", vnfr_descriptor)
 489                 rollback.append({"topic": "vnfrs", "_id": vnfr_id})
 490                 nsr_descriptor["constituent-vnfr-ref"].append(vnfr_id)
 491
 492             step = "creating nsr at database"
 493             self.format_on_new(nsr_descriptor, session["project_id"], make_public=session["public"])
 494             self.db.create("nsrs", nsr_descriptor)
 495             rollback.append({"topic": "nsrs", "_id": nsr_id})
 496
 497             step = "creating nsr temporal folder"
 498             self.fs.mkdir(nsr_id)
 499
 500             return nsr_id, None
 501         except (ValidationError, EngineException, DbException, MsgException, FsException) as e:
 502             raise type(e)("{} while '{}".format(e, step), http_code=e.http_code)
 503
 504     def edit(self, session, _id, indata=None, kwargs=None, content=None):
 505         raise EngineException("Method edit called directly", HTTPStatus.INTERNAL_SERVER_ERROR)
 506
 507
 508 class VnfrTopic(BaseTopic):
 509     topic = "vnfrs"
 510     topic_msg = None
 511
 512     def __init__(self, db, fs, msg, auth):
 513         BaseTopic.__init__(self, db, fs, msg, auth)
 514
 515     def delete(self, session, _id, dry_run=False, not_send_msg=None):
 516         raise EngineException("Method delete called directly", HTTPStatus.INTERNAL_SERVER_ERROR)
 517
 518     def edit(self, session, _id, indata=None, kwargs=None, content=None):
 519         raise EngineException("Method edit called directly", HTTPStatus.INTERNAL_SERVER_ERROR)
 520
 521     def new(self, rollback, session, indata=None, kwargs=None, headers=None):
 522         # Not used because vnfrs are created and deleted by NsrTopic class directly
 523         raise EngineException("Method new called directly", HTTPStatus.INTERNAL_SERVER_ERROR)
 524
 525
 526 class NsLcmOpTopic(BaseTopic):
 527     topic = "nslcmops"
 528     topic_msg = "ns"
 529     operation_schema = {    # mapping between operation and jsonschema to validate
 530         "instantiate": ns_instantiate,
 531         "action": ns_action,
 532         "scale": ns_scale,
 533         "terminate": ns_terminate,
 534     }
 535
 536     def __init__(self, db, fs, msg, auth):
 537         BaseTopic.__init__(self, db, fs, msg, auth)
 538
 539     def _check_ns_operation(self, session, nsr, operation, indata):
 540         """
 541         Check that user has enter right parameters for the operation
 542         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
 543         :param operation: it can be: instantiate, terminate, action, TODO: update, heal
 544         :param indata: descriptor with the parameters of the operation
 545         :return: None
 546         """
 547         vnf_member_index_to_vnfd = {}  # map between vnf_member_index to vnf descriptor.
 548         vim_accounts = []
 549         wim_accounts = []
 550         nsd = nsr["nsd"]
 551
 552         def check_valid_vnf_member_index(member_vnf_index):
 553             # Obtain vnf descriptor. The vnfr is used to get the vnfd._id used for this member_vnf_index
 554             if vnf_member_index_to_vnfd.get(member_vnf_index):
 555                 return vnf_member_index_to_vnfd[member_vnf_index]
 556             vnfr = self.db.get_one("vnfrs",
 557                                    {"nsr-id-ref": nsr["_id"], "member-vnf-index-ref": member_vnf_index},
 558                                    fail_on_empty=False)
 559             if not vnfr:
 560                 raise EngineException("Invalid parameter member_vnf_index='{}' is not one of the "
 561                                       "nsd:constituent-vnfd".format(member_vnf_index))
 562             vnfd = self.db.get_one("vnfds", {"_id": vnfr["vnfd-id"]}, fail_on_empty=False)
 563             if not vnfd:
 564                 raise EngineException("vnfd id={} has been deleted!. Operation cannot be performed".
 565                                       format(vnfr["vnfd-id"]))
 566             vnf_member_index_to_vnfd[member_vnf_index] = vnfd  # add to cache, avoiding a later look for
 567             return vnfd
 568
 569         def check_valid_vdu(vnfd, vdu_id):
 570             for vdud in get_iterable(vnfd.get("vdu")):
 571                 if vdud["id"] == vdu_id:
 572                     return vdud
 573             else:
 574                 raise EngineException("Invalid parameter vdu_id='{}' not present at vnfd:vdu:id".format(vdu_id))
 575
 576         def check_valid_kdu(vnfd, kdu_name):
 577             for kdud in get_iterable(vnfd.get("kdu")):
 578                 if kdud["name"] == kdu_name:
 579                     return kdud
 580             else:
 581                 raise EngineException("Invalid parameter kdu_name='{}' not present at vnfd:kdu:name".format(kdu_name))
 582
 583         def _check_vnf_instantiation_params(in_vnfd, vnfd):
 584
 585             for in_vdu in get_iterable(in_vnfd.get("vdu")):
 586                 for vdu in get_iterable(vnfd.get("vdu")):
 587                     if in_vdu["id"] == vdu["id"]:
 588                         for volume in get_iterable(in_vdu.get("volume")):
 589                             for volumed in get_iterable(vdu.get("volumes")):
 590                                 if volumed["name"] == volume["name"]:
 591                                     break
 592                             else:
 593                                 raise EngineException("Invalid parameter vnf[member-vnf-index='{}']:vdu[id='{}']:"
 594                                                       "volume:name='{}' is not present at vnfd:vdu:volumes list".
 595                                                       format(in_vnf["member-vnf-index"], in_vdu["id"],
 596                                                              volume["name"]))
 597                         for in_iface in get_iterable(in_vdu["interface"]):
 598                             for iface in get_iterable(vdu.get("interface")):
 599                                 if in_iface["name"] == iface["name"]:
 600                                     break
 601                             else:
 602                                 raise EngineException("Invalid parameter vnf[member-vnf-index='{}']:vdu[id='{}']:"
 603                                                       "interface[name='{}'] is not present at vnfd:vdu:interface"
 604                                                       .format(in_vnf["member-vnf-index"], in_vdu["id"],
 605                                                               in_iface["name"]))
 606                         break
 607                 else:
 608                     raise EngineException("Invalid parameter vnf[member-vnf-index='{}']:vdu[id='{}'] is is not present "
 609                                           "at vnfd:vdu".format(in_vnf["member-vnf-index"], in_vdu["id"]))
 610
 611             for in_ivld in get_iterable(in_vnfd.get("internal-vld")):
 612                 for ivld in get_iterable(vnfd.get("internal-vld")):
 613                     if in_ivld["name"] in (ivld["id"], ivld.get("name")):
 614                         for in_icp in get_iterable(in_ivld.get("internal-connection-point")):
 615                             for icp in ivld["internal-connection-point"]:
 616                                 if in_icp["id-ref"] == icp["id-ref"]:
 617                                     break
 618                             else:
 619                                 raise EngineException("Invalid parameter vnf[member-vnf-index='{}']:internal-vld[name"
 620                                                       "='{}']:internal-connection-point[id-ref:'{}'] is not present at "
 621                                                       "vnfd:internal-vld:name/id:internal-connection-point"
 622                                                       .format(in_vnf["member-vnf-index"], in_ivld["name"],
 623                                                               in_icp["id-ref"]))
 624                         break
 625                 else:
 626                     raise EngineException("Invalid parameter vnf[member-vnf-index='{}']:internal-vld:name='{}'"
 627                                           " is not present at vnfd '{}'".format(in_vnf["member-vnf-index"],
 628                                                                                 in_ivld["name"], vnfd["id"]))
 629
 630         def check_valid_vim_account(vim_account):
 631             if vim_account in vim_accounts:
 632                 return
 633             try:
 634                 db_filter = self._get_project_filter(session)
 635                 db_filter["_id"] = vim_account
 636                 self.db.get_one("vim_accounts", db_filter)
 637             except Exception:
 638                 raise EngineException("Invalid vimAccountId='{}' not present for the project".format(vim_account))
 639             vim_accounts.append(vim_account)
 640
 641         def check_valid_wim_account(wim_account):
 642             if not isinstance(wim_account, str):
 643                 return
 644             elif wim_account in wim_accounts:
 645                 return
 646             try:
 647                 db_filter = self._get_project_filter(session, write=False, show_all=True)
 648                 db_filter["_id"] = wim_account
 649                 self.db.get_one("wim_accounts", db_filter)
 650             except Exception:
 651                 raise EngineException("Invalid wimAccountId='{}' not present for the project".format(wim_account))
 652             wim_accounts.append(wim_account)
 653
 654         if operation == "action":
 655             # check vnf_member_index
 656             if indata.get("vnf_member_index"):
 657                 indata["member_vnf_index"] = indata.pop("vnf_member_index")    # for backward compatibility
 658             if indata.get("member_vnf_index"):
 659                 vnfd = check_valid_vnf_member_index(indata["member_vnf_index"])
 660                 if indata.get("vdu_id"):
 661                     vdud = check_valid_vdu(vnfd, indata["vdu_id"])
 662                     descriptor_configuration = vdud.get("vdu-configuration", {}).get("config-primitive")
 663                 elif indata.get("kdu_name"):
 664                     kdud = check_valid_kdu(vnfd, indata["kdu_name"])
 665                     descriptor_configuration = kdud.get("kdu-configuration", {}).get("config-primitive")
 666                 else:
 667                     descriptor_configuration = vnfd.get("vnf-configuration", {}).get("config-primitive")
 668             else:  # use a NSD
 669                 descriptor_configuration = nsd.get("ns-configuration", {}).get("config-primitive")
 670
 671             # For k8s allows default primitives without validating the parameters
 672             if indata.get("kdu_name") and indata["primitive"] in ("upgrade", "rollback", "status", "inspect", "readme"):
 673                 # TODO should be checked that rollback only can contains revsision_numbe????
 674                 if not indata.get("member_vnf_index"):
 675                     raise EngineException("Missing action parameter 'member_vnf_index' for default KDU primitive '{}'"
 676                                           .format(indata["primitive"]))
 677                 return
 678             # if not, check primitive
 679             for config_primitive in get_iterable(descriptor_configuration):
 680                 if indata["primitive"] == config_primitive["name"]:
 681                     # check needed primitive_params are provided
 682                     if indata.get("primitive_params"):
 683                         in_primitive_params_copy = copy(indata["primitive_params"])
 684                     else:
 685                         in_primitive_params_copy = {}
 686                     for paramd in get_iterable(config_primitive.get("parameter")):
 687                         if paramd["name"] in in_primitive_params_copy:
 688                             del in_primitive_params_copy[paramd["name"]]
 689                         elif not paramd.get("default-value"):
 690                             raise EngineException("Needed parameter {} not provided for primitive '{}'".format(
 691                                 paramd["name"], indata["primitive"]))
 692                     # check no extra primitive params are provided
 693                     if in_primitive_params_copy:
 694                         raise EngineException("parameter/s '{}' not present at vnfd /nsd for primitive '{}'".format(
 695                             list(in_primitive_params_copy.keys()), indata["primitive"]))
 696                     break
 697             else:
 698                 raise EngineException("Invalid primitive '{}' is not present at vnfd/nsd".format(indata["primitive"]))
 699         if operation == "scale":
 700             vnfd = check_valid_vnf_member_index(indata["scaleVnfData"]["scaleByStepData"]["member-vnf-index"])
 701             for scaling_group in get_iterable(vnfd.get("scaling-group-descriptor")):
 702                 if indata["scaleVnfData"]["scaleByStepData"]["scaling-group-descriptor"] == scaling_group["name"]:
 703                     break
 704             else:
 705                 raise EngineException("Invalid scaleVnfData:scaleByStepData:scaling-group-descriptor '{}' is not "
 706                                       "present at vnfd:scaling-group-descriptor".format(
 707                                           indata["scaleVnfData"]["scaleByStepData"]["scaling-group-descriptor"]))
 708         if operation == "instantiate":
 709             # check vim_account
 710             check_valid_vim_account(indata["vimAccountId"])
 711             check_valid_wim_account(indata.get("wimAccountId"))
 712             for in_vnf in get_iterable(indata.get("vnf")):
 713                 vnfd = check_valid_vnf_member_index(in_vnf["member-vnf-index"])
 714                 _check_vnf_instantiation_params(in_vnf, vnfd)
 715                 if in_vnf.get("vimAccountId"):
 716                     check_valid_vim_account(in_vnf["vimAccountId"])
 717
 718             for in_vld in get_iterable(indata.get("vld")):
 719                 check_valid_wim_account(in_vld.get("wimAccountId"))
 720                 for vldd in get_iterable(nsd.get("vld")):
 721                     if in_vld["name"] == vldd["name"] or in_vld["name"] == vldd["id"]:
 722                         break
 723                 else:
 724                     raise EngineException("Invalid parameter vld:name='{}' is not present at nsd:vld".format(
 725                         in_vld["name"]))
 726
 727     def _look_for_pdu(self, session, rollback, vnfr, vim_account, vnfr_update, vnfr_update_rollback):
 728         """
 729         Look for a free PDU in the catalog matching vdur type and interfaces. Fills vnfr.vdur with the interface
 730         (ip_address, ...) information.
 731         Modifies PDU _admin.usageState to 'IN_USE'
 732         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
 733         :param rollback: list with the database modifications to rollback if needed
 734         :param vnfr: vnfr to be updated. It is modified with pdu interface info if pdu is found
 735         :param vim_account: vim_account where this vnfr should be deployed
 736         :param vnfr_update: dictionary filled by this method with changes to be done at database vnfr
 737         :param vnfr_update_rollback: dictionary filled by this method with original content of vnfr in case a rollback
 738                                      of the changed vnfr is needed
 739
 740         :return: List of PDU interfaces that are connected to an existing VIM network. Each item contains:
 741                  "vim-network-name": used at VIM
 742                   "name": interface name
 743                   "vnf-vld-id": internal VNFD vld where this interface is connected, or
 744                   "ns-vld-id": NSD vld where this interface is connected.
 745                   NOTE: One, and only one between 'vnf-vld-id' and 'ns-vld-id' contains a value. The other will be None
 746         """
 747
 748         ifaces_forcing_vim_network = []
 749         for vdur_index, vdur in enumerate(get_iterable(vnfr.get("vdur"))):
 750             if not vdur.get("pdu-type"):
 751                 continue
 752             pdu_type = vdur.get("pdu-type")
 753             pdu_filter = self._get_project_filter(session)
 754             pdu_filter["vim_accounts"] = vim_account
 755             pdu_filter["type"] = pdu_type
 756             pdu_filter["_admin.operationalState"] = "ENABLED"
 757             pdu_filter["_admin.usageState"] = "NOT_IN_USE"
 758             # TODO feature 1417: "shared": True,
 759
 760             available_pdus = self.db.get_list("pdus", pdu_filter)
 761             for pdu in available_pdus:
 762                 # step 1 check if this pdu contains needed interfaces:
 763                 match_interfaces = True
 764                 for vdur_interface in vdur["interfaces"]:
 765                     for pdu_interface in pdu["interfaces"]:
 766                         if pdu_interface["name"] == vdur_interface["name"]:
 767                             # TODO feature 1417: match per mgmt type
 768                             break
 769                     else:  # no interface found for name
 770                         match_interfaces = False
 771                         break
 772                 if match_interfaces:
 773                     break
 774             else:
 775                 raise EngineException(
 776                     "No PDU of type={} at vim_account={} found for member_vnf_index={}, vdu={} matching interface "
 777                     "names".format(pdu_type, vim_account, vnfr["member-vnf-index-ref"], vdur["vdu-id-ref"]))
 778
 779             # step 2. Update pdu
 780             rollback_pdu = {
 781                 "_admin.usageState": pdu["_admin"]["usageState"],
 782                 "_admin.usage.vnfr_id": None,
 783                 "_admin.usage.nsr_id": None,
 784                 "_admin.usage.vdur": None,
 785             }
 786             self.db.set_one("pdus", {"_id": pdu["_id"]},
 787                             {"_admin.usageState": "IN_USE",
 788                              "_admin.usage": {"vnfr_id": vnfr["_id"],
 789                                               "nsr_id": vnfr["nsr-id-ref"],
 790                                               "vdur": vdur["vdu-id-ref"]}
 791                              })
 792             rollback.append({"topic": "pdus", "_id": pdu["_id"], "operation": "set", "content": rollback_pdu})
 793
 794             # step 3. Fill vnfr info by filling vdur
 795             vdu_text = "vdur.{}".format(vdur_index)
 796             vnfr_update_rollback[vdu_text + ".pdu-id"] = None
 797             vnfr_update[vdu_text + ".pdu-id"] = pdu["_id"]
 798             for iface_index, vdur_interface in enumerate(vdur["interfaces"]):
 799                 for pdu_interface in pdu["interfaces"]:
 800                     if pdu_interface["name"] == vdur_interface["name"]:
 801                         iface_text = vdu_text + ".interfaces.{}".format(iface_index)
 802                         for k, v in pdu_interface.items():
 803                             if k in ("ip-address", "mac-address"):  # TODO: switch-xxxxx must be inserted
 804                                 vnfr_update[iface_text + ".{}".format(k)] = v
 805                                 vnfr_update_rollback[iface_text + ".{}".format(k)] = vdur_interface.get(v)
 806                         if pdu_interface.get("ip-address"):
 807                             if vdur_interface.get("mgmt-interface") or vdur_interface.get("mgmt-vnf"):
 808                                 vnfr_update_rollback[vdu_text + ".ip-address"] = vdur.get("ip-address")
 809                                 vnfr_update[vdu_text + ".ip-address"] = pdu_interface["ip-address"]
 810                             if vdur_interface.get("mgmt-vnf"):
 811                                 vnfr_update_rollback["ip-address"] = vnfr.get("ip-address")
 812                                 vnfr_update["ip-address"] = pdu_interface["ip-address"]
 813                                 vnfr_update[vdu_text + ".ip-address"] = pdu_interface["ip-address"]
 814                         if pdu_interface.get("vim-network-name") or pdu_interface.get("vim-network-id"):
 815                             ifaces_forcing_vim_network.append({
 816                                 "name": vdur_interface.get("vnf-vld-id") or vdur_interface.get("ns-vld-id"),
 817                                 "vnf-vld-id": vdur_interface.get("vnf-vld-id"),
 818                                 "ns-vld-id": vdur_interface.get("ns-vld-id")})
 819                             if pdu_interface.get("vim-network-id"):
 820                                 ifaces_forcing_vim_network[-1]["vim-network-id"] = pdu_interface["vim-network-id"]
 821                             if pdu_interface.get("vim-network-name"):
 822                                 ifaces_forcing_vim_network[-1]["vim-network-name"] = pdu_interface["vim-network-name"]
 823                         break
 824
 825         return ifaces_forcing_vim_network
 826
 827     def _look_for_k8scluster(self, session, rollback, vnfr, vim_account, vnfr_update, vnfr_update_rollback):
 828         """
 829         Look for an available k8scluster for all the kuds in the vnfd matching version and cni requirements.
 830         Fills vnfr.kdur with the selected k8scluster
 831
 832         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
 833         :param rollback: list with the database modifications to rollback if needed
 834         :param vnfr: vnfr to be updated. It is modified with pdu interface info if pdu is found
 835         :param vim_account: vim_account where this vnfr should be deployed
 836         :param vnfr_update: dictionary filled by this method with changes to be done at database vnfr
 837         :param vnfr_update_rollback: dictionary filled by this method with original content of vnfr in case a rollback
 838                                      of the changed vnfr is needed
 839
 840         :return: List of KDU interfaces that are connected to an existing VIM network. Each item contains:
 841                  "vim-network-name": used at VIM
 842                   "name": interface name
 843                   "vnf-vld-id": internal VNFD vld where this interface is connected, or
 844                   "ns-vld-id": NSD vld where this interface is connected.
 845                   NOTE: One, and only one between 'vnf-vld-id' and 'ns-vld-id' contains a value. The other will be None
 846         """
 847
 848         ifaces_forcing_vim_network = []
 849         if not vnfr.get("kdur"):
 850             return ifaces_forcing_vim_network
 851
 852         kdu_filter = self._get_project_filter(session)
 853         kdu_filter["vim_account"] = vim_account
 854         # TODO kdu_filter["_admin.operationalState"] = "ENABLED"
 855         available_k8sclusters = self.db.get_list("k8sclusters", kdu_filter)
 856
 857         k8s_requirements = {}  # just for logging
 858         for k8scluster in available_k8sclusters:
 859             if not vnfr.get("k8s-cluster"):
 860                 break
 861             # restrict by cni
 862             if vnfr["k8s-cluster"].get("cni"):
 863                 k8s_requirements["cni"] = vnfr["k8s-cluster"]["cni"]
 864                 if not set(vnfr["k8s-cluster"]["cni"]).intersection(k8scluster.get("cni", ())):
 865                     continue
 866             # restrict by version
 867             if vnfr["k8s-cluster"].get("version"):
 868                 k8s_requirements["version"] = vnfr["k8s-cluster"]["version"]
 869                 if k8scluster.get("k8s_version") not in vnfr["k8s-cluster"]["version"]:
 870                     continue
 871             # restrict by number of networks
 872             if vnfr["k8s-cluster"].get("nets"):
 873                 k8s_requirements["networks"] = len(vnfr["k8s-cluster"]["nets"])
 874                 if not k8scluster.get("nets") or len(k8scluster["nets"]) < len(vnfr["k8s-cluster"]["nets"]):
 875                     continue
 876             break
 877         else:
 878             raise EngineException("No k8scluster with requirements='{}' at vim_account={} found for member_vnf_index={}"
 879                                   .format(k8s_requirements, vim_account, vnfr["member-vnf-index-ref"]))
 880
 881         for kdur_index, kdur in enumerate(get_iterable(vnfr.get("kdur"))):
 882             # step 3. Fill vnfr info by filling kdur
 883             kdu_text = "kdur.{}.".format(kdur_index)
 884             vnfr_update_rollback[kdu_text + "k8s-cluster.id"] = None
 885             vnfr_update[kdu_text + "k8s-cluster.id"] = k8scluster["_id"]
 886
 887         # step 4. Check VIM networks that forces the selected k8s_cluster
 888         if vnfr.get("k8s-cluster") and vnfr["k8s-cluster"].get("nets"):
 889             k8scluster_net_list = list(k8scluster.get("nets").keys())
 890             for net_index, kdur_net in enumerate(vnfr["k8s-cluster"]["nets"]):
 891                 # get a network from k8s_cluster nets. If name matches use this, if not use other
 892                 if kdur_net["id"] in k8scluster_net_list:  # name matches
 893                     vim_net = k8scluster["nets"][kdur_net["id"]]
 894                     k8scluster_net_list.remove(kdur_net["id"])
 895                 else:
 896                     vim_net = k8scluster["nets"][k8scluster_net_list[0]]
 897                     k8scluster_net_list.pop(0)
 898                 vnfr_update_rollback["k8s-cluster.nets.{}.vim_net".format(net_index)] = None
 899                 vnfr_update["k8s-cluster.nets.{}.vim_net".format(net_index)] = vim_net
 900                 if vim_net and (kdur_net.get("vnf-vld-id") or kdur_net.get("ns-vld-id")):
 901                     ifaces_forcing_vim_network.append({
 902                         "name": kdur_net.get("vnf-vld-id") or kdur_net.get("ns-vld-id"),
 903                         "vnf-vld-id": kdur_net.get("vnf-vld-id"),
 904                         "ns-vld-id": kdur_net.get("ns-vld-id"),
 905                         "vim-network-name": vim_net,   # TODO can it be vim-network-id ???
 906                     })
 907             # TODO check that this forcing is not incompatible with other forcing
 908         return ifaces_forcing_vim_network
 909
 910     def _update_vnfrs(self, session, rollback, nsr, indata):
 911         # get vnfr
 912         nsr_id = nsr["_id"]
 913         vnfrs = self.db.get_list("vnfrs", {"nsr-id-ref": nsr_id})
 914
 915         for vnfr in vnfrs:
 916             vnfr_update = {}
 917             vnfr_update_rollback = {}
 918             member_vnf_index = vnfr["member-vnf-index-ref"]
 919             # update vim-account-id
 920
 921             vim_account = indata["vimAccountId"]
 922             # check instantiate parameters
 923             for vnf_inst_params in get_iterable(indata.get("vnf")):
 924                 if vnf_inst_params["member-vnf-index"] != member_vnf_index:
 925                     continue
 926                 if vnf_inst_params.get("vimAccountId"):
 927                     vim_account = vnf_inst_params.get("vimAccountId")
 928
 929             vnfr_update["vim-account-id"] = vim_account
 930             vnfr_update_rollback["vim-account-id"] = vnfr.get("vim-account-id")
 931
 932             # get pdu
 933             ifaces_forcing_vim_network = self._look_for_pdu(session, rollback, vnfr, vim_account, vnfr_update,
 934                                                             vnfr_update_rollback)
 935
 936             # get kdus
 937             ifaces_forcing_vim_network += self._look_for_k8scluster(session, rollback, vnfr, vim_account, vnfr_update,
 938                                                                     vnfr_update_rollback)
 939             # update database vnfr
 940             self.db.set_one("vnfrs", {"_id": vnfr["_id"]}, vnfr_update)
 941             rollback.append({"topic": "vnfrs", "_id": vnfr["_id"], "operation": "set", "content": vnfr_update_rollback})
 942
 943             # Update indada in case pdu forces to use a concrete vim-network-name
 944             # TODO check if user has already insert a vim-network-name and raises an error
 945             if not ifaces_forcing_vim_network:
 946                 continue
 947             for iface_info in ifaces_forcing_vim_network:
 948                 if iface_info.get("ns-vld-id"):
 949                     if "vld" not in indata:
 950                         indata["vld"] = []
 951                     indata["vld"].append({key: iface_info[key] for key in
 952                                           ("name", "vim-network-name", "vim-network-id") if iface_info.get(key)})
 953
 954                 elif iface_info.get("vnf-vld-id"):
 955                     if "vnf" not in indata:
 956                         indata["vnf"] = []
 957                     indata["vnf"].append({
 958                         "member-vnf-index": member_vnf_index,
 959                         "internal-vld": [{key: iface_info[key] for key in
 960                                           ("name", "vim-network-name", "vim-network-id") if iface_info.get(key)}]
 961                     })
 962
 963     @staticmethod
 964     def _create_nslcmop(nsr_id, operation, params):
 965         """
 966         Creates a ns-lcm-opp content to be stored at database.
 967         :param nsr_id: internal id of the instance
 968         :param operation: instantiate, terminate, scale, action, ...
 969         :param params: user parameters for the operation
 970         :return: dictionary following SOL005 format
 971         """
 972         now = time()
 973         _id = str(uuid4())
 974         nslcmop = {
 975             "id": _id,
 976             "_id": _id,
 977             "operationState": "PROCESSING",  # COMPLETED,PARTIALLY_COMPLETED,FAILED_TEMP,FAILED,ROLLING_BACK,ROLLED_BACK
 978             "queuePosition": None,
 979             "stage": None,
 980             "errorMessage": None,
 981             "detailedStatus": None,
 982             "statusEnteredTime": now,
 983             "nsInstanceId": nsr_id,
 984             "lcmOperationType": operation,
 985             "startTime": now,
 986             "isAutomaticInvocation": False,
 987             "operationParams": params,
 988             "isCancelPending": False,
 989             "links": {
 990                 "self": "/osm/nslcm/v1/ns_lcm_op_occs/" + _id,
 991                 "nsInstance": "/osm/nslcm/v1/ns_instances/" + nsr_id,
 992             }
 993         }
 994         return nslcmop
 995
 996     def _get_enabled_vims(self, session):
 997         """
 998         Retrieve and return VIM accounts that are accessible by current user and has state ENABLE
 999         :param session: current session with user information
1000         """
1001         db_filter = self._get_project_filter(session)
1002         db_filter["_admin.operationalState"] = "ENABLED"
1003         vims = self.db.get_list("vim_accounts", db_filter)
1004         vimAccounts = []
1005         for vim in vims:
1006             vimAccounts.append(vim['_id'])
1007         return vimAccounts
1008
1009     def new(self, rollback, session, indata=None, kwargs=None, headers=None, slice_object=False):
1010         """
1011         Performs a new operation over a ns
1012         :param rollback: list to append created items at database in case a rollback must to be done
1013         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1014         :param indata: descriptor with the parameters of the operation. It must contains among others
1015             nsInstanceId: _id of the nsr to perform the operation
1016             operation: it can be: instantiate, terminate, action, TODO: update, heal
1017         :param kwargs: used to override the indata descriptor
1018         :param headers: http request headers
1019         :return: id of the nslcmops
1020         """
1021         def check_if_nsr_is_not_slice_member(session, nsr_id):
1022             nsis = None
1023             db_filter = self._get_project_filter(session)
1024             db_filter["_admin.nsrs-detailed-list.ANYINDEX.nsrId"] = nsr_id
1025             nsis = self.db.get_one("nsis", db_filter, fail_on_empty=False, fail_on_more=False)
1026             if nsis:
1027                 raise EngineException("The NS instance {} cannot be terminate because is used by the slice {}".format(
1028                                       nsr_id, nsis["_id"]), http_code=HTTPStatus.CONFLICT)
1029
1030         try:
1031             # Override descriptor with query string kwargs
1032             self._update_input_with_kwargs(indata, kwargs, yaml_format=True)
1033             operation = indata["lcmOperationType"]
1034             nsInstanceId = indata["nsInstanceId"]
1035
1036             validate_input(indata, self.operation_schema[operation])
1037             # get ns from nsr_id
1038             _filter = BaseTopic._get_project_filter(session)
1039             _filter["_id"] = nsInstanceId
1040             nsr = self.db.get_one("nsrs", _filter)
1041
1042             # initial checking
1043             if operation == "terminate" and slice_object is False:
1044                 check_if_nsr_is_not_slice_member(session, nsr["_id"])
1045             if not nsr["_admin"].get("nsState") or nsr["_admin"]["nsState"] == "NOT_INSTANTIATED":
1046                 if operation == "terminate" and indata.get("autoremove"):
1047                     # NSR must be deleted
1048                     return None, None    # a none in this case is used to indicate not instantiated. It can be removed
1049                 if operation != "instantiate":
1050                     raise EngineException("ns_instance '{}' cannot be '{}' because it is not instantiated".format(
1051                         nsInstanceId, operation), HTTPStatus.CONFLICT)
1052             else:
1053                 if operation == "instantiate" and not session["force"]:
1054                     raise EngineException("ns_instance '{}' cannot be '{}' because it is already instantiated".format(
1055                         nsInstanceId, operation), HTTPStatus.CONFLICT)
1056             self._check_ns_operation(session, nsr, operation, indata)
1057
1058             if operation == "instantiate":
1059                 self._update_vnfrs(session, rollback, nsr, indata)
1060
1061             nslcmop_desc = self._create_nslcmop(nsInstanceId, operation, indata)
1062             _id = nslcmop_desc["_id"]
1063             self.format_on_new(nslcmop_desc, session["project_id"], make_public=session["public"])
1064             if indata.get("placement-engine"):
1065                 # Save valid vim accounts in lcm operation descriptor
1066                 nslcmop_desc['operationParams']['validVimAccounts'] = self._get_enabled_vims(session)
1067             self.db.create("nslcmops", nslcmop_desc)
1068             rollback.append({"topic": "nslcmops", "_id": _id})
1069             if not slice_object:
1070                 self.msg.write("ns", operation, nslcmop_desc)
1071             return _id, None
1072         except ValidationError as e:  # TODO remove try Except, it is captured at nbi.py
1073             raise EngineException(e, HTTPStatus.UNPROCESSABLE_ENTITY)
1074         # except DbException as e:
1075         #     raise EngineException("Cannot get ns_instance '{}': {}".format(e), HTTPStatus.NOT_FOUND)
1076
1077     def delete(self, session, _id, dry_run=False, not_send_msg=None):
1078         raise EngineException("Method delete called directly", HTTPStatus.INTERNAL_SERVER_ERROR)
1079
1080     def edit(self, session, _id, indata=None, kwargs=None, content=None):
1081         raise EngineException("Method edit called directly", HTTPStatus.INTERNAL_SERVER_ERROR)
1082
1083
1084 class NsiTopic(BaseTopic):
1085     topic = "nsis"
1086     topic_msg = "nsi"
1087     quota_name = "slice_instances"
1088
1089     def __init__(self, db, fs, msg, auth):
1090         BaseTopic.__init__(self, db, fs, msg, auth)
1091         self.nsrTopic = NsrTopic(db, fs, msg, auth)
1092
1093     @staticmethod
1094     def _format_ns_request(ns_request):
1095         formated_request = copy(ns_request)
1096         # TODO: Add request params
1097         return formated_request
1098
1099     @staticmethod
1100     def _format_addional_params(slice_request):
1101         """
1102         Get and format user additional params for NS or VNF
1103         :param slice_request: User instantiation additional parameters
1104         :return: a formatted copy of additional params or None if not supplied
1105         """
1106         additional_params = copy(slice_request.get("additionalParamsForNsi"))
1107         if additional_params:
1108             for k, v in additional_params.items():
1109                 if not isinstance(k, str):
1110                     raise EngineException("Invalid param at additionalParamsForNsi:{}. Only string keys are allowed".
1111                                           format(k))
1112                 if "." in k or "$" in k:
1113                     raise EngineException("Invalid param at additionalParamsForNsi:{}. Keys must not contain dots or $".
1114                                           format(k))
1115                 if isinstance(v, (dict, tuple, list)):
1116                     additional_params[k] = "!!yaml " + safe_dump(v)
1117         return additional_params
1118
1119     def _check_descriptor_dependencies(self, session, descriptor):
1120         """
1121         Check that the dependent descriptors exist on a new descriptor or edition
1122         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1123         :param descriptor: descriptor to be inserted or edit
1124         :return: None or raises exception
1125         """
1126         if not descriptor.get("nst-ref"):
1127             return
1128         nstd_id = descriptor["nst-ref"]
1129         if not self.get_item_list(session, "nsts", {"id": nstd_id}):
1130             raise EngineException("Descriptor error at nst-ref='{}' references a non exist nstd".format(nstd_id),
1131                                   http_code=HTTPStatus.CONFLICT)
1132
1133     def check_conflict_on_del(self, session, _id, db_content):
1134         """
1135         Check that NSI is not instantiated
1136         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1137         :param _id: nsi internal id
1138         :param db_content: The database content of the _id
1139         :return: None or raises EngineException with the conflict
1140         """
1141         if session["force"]:
1142             return
1143         nsi = db_content
1144         if nsi["_admin"].get("nsiState") == "INSTANTIATED":
1145             raise EngineException("nsi '{}' cannot be deleted because it is in 'INSTANTIATED' state. "
1146                                   "Launch 'terminate' operation first; or force deletion".format(_id),
1147                                   http_code=HTTPStatus.CONFLICT)
1148
1149     def delete_extra(self, session, _id, db_content, not_send_msg=None):
1150         """
1151         Deletes associated nsilcmops from database. Deletes associated filesystem.
1152          Set usageState of nst
1153         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1154         :param _id: server internal id
1155         :param db_content: The database content of the descriptor
1156         :param not_send_msg: To not send message (False) or store content (list) instead
1157         :return: None if ok or raises EngineException with the problem
1158         """
1159
1160         # Deleting the nsrs belonging to nsir
1161         nsir = db_content
1162         for nsrs_detailed_item in nsir["_admin"]["nsrs-detailed-list"]:
1163             nsr_id = nsrs_detailed_item["nsrId"]
1164             if nsrs_detailed_item.get("shared"):
1165                 _filter = {"_admin.nsrs-detailed-list.ANYINDEX.shared": True,
1166                            "_admin.nsrs-detailed-list.ANYINDEX.nsrId": nsr_id,
1167                            "_id.ne": nsir["_id"]}
1168                 nsi = self.db.get_one("nsis", _filter, fail_on_empty=False, fail_on_more=False)
1169                 if nsi:  # last one using nsr
1170                     continue
1171             try:
1172                 self.nsrTopic.delete(session, nsr_id, dry_run=False, not_send_msg=not_send_msg)
1173             except (DbException, EngineException) as e:
1174                 if e.http_code == HTTPStatus.NOT_FOUND:
1175                     pass
1176                 else:
1177                     raise
1178
1179         # delete related nsilcmops database entries
1180         self.db.del_list("nsilcmops", {"netsliceInstanceId": _id})
1181
1182         # Check and set used NST usage state
1183         nsir_admin = nsir.get("_admin")
1184         if nsir_admin and nsir_admin.get("nst-id"):
1185             # check if used by another NSI
1186             nsis_list = self.db.get_one("nsis", {"nst-id": nsir_admin["nst-id"]},
1187                                         fail_on_empty=False, fail_on_more=False)
1188             if not nsis_list:
1189                 self.db.set_one("nsts", {"_id": nsir_admin["nst-id"]}, {"_admin.usageState": "NOT_IN_USE"})
1190
1191     # def delete(self, session, _id, dry_run=False):
1192     #     """
1193     #     Delete item by its internal _id
1194     #     :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1195     #     :param _id: server internal id
1196     #     :param dry_run: make checking but do not delete
1197     #     :return: dictionary with deleted item _id. It raises EngineException on error: not found, conflict, ...
1198     #     """
1199     #     # TODO add admin to filter, validate rights
1200     #     BaseTopic.delete(self, session, _id, dry_run=True)
1201     #     if dry_run:
1202     #         return
1203     #
1204     #     # Deleting the nsrs belonging to nsir
1205     #     nsir = self.db.get_one("nsis", {"_id": _id})
1206     #     for nsrs_detailed_item in nsir["_admin"]["nsrs-detailed-list"]:
1207     #         nsr_id = nsrs_detailed_item["nsrId"]
1208     #         if nsrs_detailed_item.get("shared"):
1209     #             _filter = {"_admin.nsrs-detailed-list.ANYINDEX.shared": True,
1210     #                        "_admin.nsrs-detailed-list.ANYINDEX.nsrId": nsr_id,
1211     #                        "_id.ne": nsir["_id"]}
1212     #             nsi = self.db.get_one("nsis", _filter, fail_on_empty=False, fail_on_more=False)
1213     #             if nsi:  # last one using nsr
1214     #                 continue
1215     #         try:
1216     #             self.nsrTopic.delete(session, nsr_id, dry_run=False)
1217     #         except (DbException, EngineException) as e:
1218     #             if e.http_code == HTTPStatus.NOT_FOUND:
1219     #                 pass
1220     #             else:
1221     #                 raise
1222     #     # deletes NetSlice instance object
1223     #     v = self.db.del_one("nsis", {"_id": _id})
1224     #
1225     #     # makes a temporal list of nsilcmops objects related to the _id given and deletes them from db
1226     #     _filter = {"netsliceInstanceId": _id}
1227     #     self.db.del_list("nsilcmops", _filter)
1228     #
1229     #     # Search if nst is being used by other nsi
1230     #     nsir_admin = nsir.get("_admin")
1231     #     if nsir_admin:
1232     #         if nsir_admin.get("nst-id"):
1233     #             nsis_list = self.db.get_one("nsis", {"nst-id": nsir_admin["nst-id"]},
1234     #                                         fail_on_empty=False, fail_on_more=False)
1235     #             if not nsis_list:
1236     #                 self.db.set_one("nsts", {"_id": nsir_admin["nst-id"]}, {"_admin.usageState": "NOT_IN_USE"})
1237     #     return v
1238
1239     def new(self, rollback, session, indata=None, kwargs=None, headers=None):
1240         """
1241         Creates a new netslice instance record into database. It also creates needed nsrs and vnfrs
1242         :param rollback: list to append the created items at database in case a rollback must be done
1243         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1244         :param indata: params to be used for the nsir
1245         :param kwargs: used to override the indata descriptor
1246         :param headers: http request headers
1247         :return: the _id of nsi descriptor created at database
1248         """
1249
1250         try:
1251             step = "checking quotas"
1252             self.check_quota(session)
1253
1254             step = ""
1255             slice_request = self._remove_envelop(indata)
1256             # Override descriptor with query string kwargs
1257             self._update_input_with_kwargs(slice_request, kwargs)
1258             self._validate_input_new(slice_request, session["force"])
1259
1260             # look for nstd
1261             step = "getting nstd id='{}' from database".format(slice_request.get("nstId"))
1262             _filter = self._get_project_filter(session)
1263             _filter["_id"] = slice_request["nstId"]
1264             nstd = self.db.get_one("nsts", _filter)
1265             del _filter["_id"]
1266
1267             nstd.pop("_admin", None)
1268             nstd_id = nstd.pop("_id", None)
1269             nsi_id = str(uuid4())
1270             step = "filling nsi_descriptor with input data"
1271
1272             # Creating the NSIR
1273             nsi_descriptor = {
1274                 "id": nsi_id,
1275                 "name": slice_request["nsiName"],
1276                 "description": slice_request.get("nsiDescription", ""),
1277                 "datacenter": slice_request["vimAccountId"],
1278                 "nst-ref": nstd["id"],
1279                 "instantiation_parameters": slice_request,
1280                 "network-slice-template": nstd,
1281                 "nsr-ref-list": [],
1282                 "vlr-list": [],
1283                 "_id": nsi_id,
1284                 "additionalParamsForNsi": self._format_addional_params(slice_request)
1285             }
1286
1287             step = "creating nsi at database"
1288             self.format_on_new(nsi_descriptor, session["project_id"], make_public=session["public"])
1289             nsi_descriptor["_admin"]["nsiState"] = "NOT_INSTANTIATED"
1290             nsi_descriptor["_admin"]["netslice-subnet"] = None
1291             nsi_descriptor["_admin"]["deployed"] = {}
1292             nsi_descriptor["_admin"]["deployed"]["RO"] = []
1293             nsi_descriptor["_admin"]["nst-id"] = nstd_id
1294
1295             # Creating netslice-vld for the RO.
1296             step = "creating netslice-vld at database"
1297
1298             # Building the vlds list to be deployed
1299             # From netslice descriptors, creating the initial list
1300             nsi_vlds = []
1301
1302             for netslice_vlds in get_iterable(nstd.get("netslice-vld")):
1303                 # Getting template Instantiation parameters from NST
1304                 nsi_vld = deepcopy(netslice_vlds)
1305                 nsi_vld["shared-nsrs-list"] = []
1306                 nsi_vld["vimAccountId"] = slice_request["vimAccountId"]
1307                 nsi_vlds.append(nsi_vld)
1308
1309             nsi_descriptor["_admin"]["netslice-vld"] = nsi_vlds
1310             # Creating netslice-subnet_record.
1311             needed_nsds = {}
1312             services = []
1313
1314             # Updating the nstd with the nsd["_id"] associated to the nss -> services list
1315             for member_ns in nstd["netslice-subnet"]:
1316                 nsd_id = member_ns["nsd-ref"]
1317                 step = "getting nstd id='{}' constituent-nsd='{}' from database".format(
1318                     member_ns["nsd-ref"], member_ns["id"])
1319                 if nsd_id not in needed_nsds:
1320                     # Obtain nsd
1321                     _filter["id"] = nsd_id
1322                     nsd = self.db.get_one("nsds", _filter, fail_on_empty=True, fail_on_more=True)
1323                     del _filter["id"]
1324                     nsd.pop("_admin")
1325                     needed_nsds[nsd_id] = nsd
1326                 else:
1327                     nsd = needed_nsds[nsd_id]
1328                 member_ns["_id"] = needed_nsds[nsd_id].get("_id")
1329                 services.append(member_ns)
1330
1331                 step = "filling nsir nsd-id='{}' constituent-nsd='{}' from database".format(
1332                     member_ns["nsd-ref"], member_ns["id"])
1333
1334             # creates Network Services records (NSRs)
1335             step = "creating nsrs at database using NsrTopic.new()"
1336             ns_params = slice_request.get("netslice-subnet")
1337             nsrs_list = []
1338             nsi_netslice_subnet = []
1339             for service in services:
1340                 # Check if the netslice-subnet is shared and if it is share if the nss exists
1341                 _id_nsr = None
1342                 indata_ns = {}
1343                 # Is the nss shared and instantiated?
1344                 _filter["_admin.nsrs-detailed-list.ANYINDEX.shared"] = True
1345                 _filter["_admin.nsrs-detailed-list.ANYINDEX.nsd-id"] = service["nsd-ref"]
1346                 _filter["_admin.nsrs-detailed-list.ANYINDEX.nss-id"] = service["id"]
1347                 nsi = self.db.get_one("nsis", _filter, fail_on_empty=False, fail_on_more=False)
1348                 if nsi and service.get("is-shared-nss"):
1349                     nsrs_detailed_list = nsi["_admin"]["nsrs-detailed-list"]
1350                     for nsrs_detailed_item in nsrs_detailed_list:
1351                         if nsrs_detailed_item["nsd-id"] == service["nsd-ref"]:
1352                             if nsrs_detailed_item["nss-id"] == service["id"]:
1353                                 _id_nsr = nsrs_detailed_item["nsrId"]
1354                                 break
1355                     for netslice_subnet in nsi["_admin"]["netslice-subnet"]:
1356                         if netslice_subnet["nss-id"] == service["id"]:
1357                             indata_ns = netslice_subnet
1358                             break
1359                 else:
1360                     indata_ns = {}
1361                     if service.get("instantiation-parameters"):
1362                         indata_ns = deepcopy(service["instantiation-parameters"])
1363                         # del service["instantiation-parameters"]
1364
1365                     indata_ns["nsdId"] = service["_id"]
1366                     indata_ns["nsName"] = slice_request.get("nsiName") + "." + service["id"]
1367                     indata_ns["vimAccountId"] = slice_request.get("vimAccountId")
1368                     indata_ns["nsDescription"] = service["description"]
1369                     if slice_request.get("ssh_keys"):
1370                         indata_ns["ssh_keys"] = slice_request.get("ssh_keys")
1371
1372                     if ns_params:
1373                         for ns_param in ns_params:
1374                             if ns_param.get("id") == service["id"]:
1375                                 copy_ns_param = deepcopy(ns_param)
1376                                 del copy_ns_param["id"]
1377                                 indata_ns.update(copy_ns_param)
1378                                 break
1379
1380                     # Creates Nsr objects
1381                     _id_nsr, _ = self.nsrTopic.new(rollback, session, indata_ns, kwargs, headers)
1382                 nsrs_item = {"nsrId": _id_nsr, "shared": service.get("is-shared-nss"), "nsd-id": service["nsd-ref"],
1383                              "nss-id": service["id"], "nslcmop_instantiate": None}
1384                 indata_ns["nss-id"] = service["id"]
1385                 nsrs_list.append(nsrs_item)
1386                 nsi_netslice_subnet.append(indata_ns)
1387                 nsr_ref = {"nsr-ref": _id_nsr}
1388                 nsi_descriptor["nsr-ref-list"].append(nsr_ref)
1389
1390             # Adding the nsrs list to the nsi
1391             nsi_descriptor["_admin"]["nsrs-detailed-list"] = nsrs_list
1392             nsi_descriptor["_admin"]["netslice-subnet"] = nsi_netslice_subnet
1393             self.db.set_one("nsts", {"_id": slice_request["nstId"]}, {"_admin.usageState": "IN_USE"})
1394
1395             # Creating the entry in the database
1396             self.db.create("nsis", nsi_descriptor)
1397             rollback.append({"topic": "nsis", "_id": nsi_id})
1398             return nsi_id, None
1399         except Exception as e:   # TODO remove try Except, it is captured at nbi.py
1400             self.logger.exception("Exception {} at NsiTopic.new()".format(e), exc_info=True)
1401             raise EngineException("Error {}: {}".format(step, e))
1402         except ValidationError as e:
1403             raise EngineException(e, HTTPStatus.UNPROCESSABLE_ENTITY)
1404
1405     def edit(self, session, _id, indata=None, kwargs=None, content=None):
1406         raise EngineException("Method edit called directly", HTTPStatus.INTERNAL_SERVER_ERROR)
1407
1408
1409 class NsiLcmOpTopic(BaseTopic):
1410     topic = "nsilcmops"
1411     topic_msg = "nsi"
1412     operation_schema = {  # mapping between operation and jsonschema to validate
1413         "instantiate": nsi_instantiate,
1414         "terminate": None
1415     }
1416
1417     def __init__(self, db, fs, msg, auth):
1418         BaseTopic.__init__(self, db, fs, msg, auth)
1419         self.nsi_NsLcmOpTopic = NsLcmOpTopic(self.db, self.fs, self.msg, self.auth)
1420
1421     def _check_nsi_operation(self, session, nsir, operation, indata):
1422         """
1423         Check that user has enter right parameters for the operation
1424         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1425         :param operation: it can be: instantiate, terminate, action, TODO: update, heal
1426         :param indata: descriptor with the parameters of the operation
1427         :return: None
1428         """
1429         nsds = {}
1430         nstd = nsir["network-slice-template"]
1431
1432         def check_valid_netslice_subnet_id(nstId):
1433             # TODO change to vnfR (??)
1434             for netslice_subnet in nstd["netslice-subnet"]:
1435                 if nstId == netslice_subnet["id"]:
1436                     nsd_id = netslice_subnet["nsd-ref"]
1437                     if nsd_id not in nsds:
1438                         _filter = self._get_project_filter(session)
1439                         _filter["id"] = nsd_id
1440                         nsds[nsd_id] = self.db.get_one("nsds", _filter)
1441                     return nsds[nsd_id]
1442             else:
1443                 raise EngineException("Invalid parameter nstId='{}' is not one of the "
1444                                       "nst:netslice-subnet".format(nstId))
1445         if operation == "instantiate":
1446             # check the existance of netslice-subnet items
1447             for in_nst in get_iterable(indata.get("netslice-subnet")):
1448                 check_valid_netslice_subnet_id(in_nst["id"])
1449
1450     def _create_nsilcmop(self, session, netsliceInstanceId, operation, params):
1451         now = time()
1452         _id = str(uuid4())
1453         nsilcmop = {
1454             "id": _id,
1455             "_id": _id,
1456             "operationState": "PROCESSING",  # COMPLETED,PARTIALLY_COMPLETED,FAILED_TEMP,FAILED,ROLLING_BACK,ROLLED_BACK
1457             "statusEnteredTime": now,
1458             "netsliceInstanceId": netsliceInstanceId,
1459             "lcmOperationType": operation,
1460             "startTime": now,
1461             "isAutomaticInvocation": False,
1462             "operationParams": params,
1463             "isCancelPending": False,
1464             "links": {
1465                 "self": "/osm/nsilcm/v1/nsi_lcm_op_occs/" + _id,
1466                 "netsliceInstanceId": "/osm/nsilcm/v1/netslice_instances/" + netsliceInstanceId,
1467             }
1468         }
1469         return nsilcmop
1470
1471     def add_shared_nsr_2vld(self, nsir, nsr_item):
1472         for nst_sb_item in nsir["network-slice-template"].get("netslice-subnet"):
1473             if nst_sb_item.get("is-shared-nss"):
1474                 for admin_subnet_item in nsir["_admin"].get("netslice-subnet"):
1475                     if admin_subnet_item["nss-id"] == nst_sb_item["id"]:
1476                         for admin_vld_item in nsir["_admin"].get("netslice-vld"):
1477                             for admin_vld_nss_cp_ref_item in admin_vld_item["nss-connection-point-ref"]:
1478                                 if admin_subnet_item["nss-id"] == admin_vld_nss_cp_ref_item["nss-ref"]:
1479                                     if not nsr_item["nsrId"] in admin_vld_item["shared-nsrs-list"]:
1480                                         admin_vld_item["shared-nsrs-list"].append(nsr_item["nsrId"])
1481                                     break
1482         # self.db.set_one("nsis", {"_id": nsir["_id"]}, nsir)
1483         self.db.set_one("nsis", {"_id": nsir["_id"]}, {"_admin.netslice-vld": nsir["_admin"].get("netslice-vld")})
1484
1485     def new(self, rollback, session, indata=None, kwargs=None, headers=None):
1486         """
1487         Performs a new operation over a ns
1488         :param rollback: list to append created items at database in case a rollback must to be done
1489         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1490         :param indata: descriptor with the parameters of the operation. It must contains among others
1491             netsliceInstanceId: _id of the nsir to perform the operation
1492             operation: it can be: instantiate, terminate, action, TODO: update, heal
1493         :param kwargs: used to override the indata descriptor
1494         :param headers: http request headers
1495         :return: id of the nslcmops
1496         """
1497         try:
1498             # Override descriptor with query string kwargs
1499             self._update_input_with_kwargs(indata, kwargs)
1500             operation = indata["lcmOperationType"]
1501             netsliceInstanceId = indata["netsliceInstanceId"]
1502             validate_input(indata, self.operation_schema[operation])
1503
1504             # get nsi from netsliceInstanceId
1505             _filter = self._get_project_filter(session)
1506             _filter["_id"] = netsliceInstanceId
1507             nsir = self.db.get_one("nsis", _filter)
1508             del _filter["_id"]
1509
1510             # initial checking
1511             if not nsir["_admin"].get("nsiState") or nsir["_admin"]["nsiState"] == "NOT_INSTANTIATED":
1512                 if operation == "terminate" and indata.get("autoremove"):
1513                     # NSIR must be deleted
1514                     return None, None    # a none in this case is used to indicate not instantiated. It can be removed
1515                 if operation != "instantiate":
1516                     raise EngineException("netslice_instance '{}' cannot be '{}' because it is not instantiated".format(
1517                         netsliceInstanceId, operation), HTTPStatus.CONFLICT)
1518             else:
1519                 if operation == "instantiate" and not session["force"]:
1520                     raise EngineException("netslice_instance '{}' cannot be '{}' because it is already instantiated".
1521                                           format(netsliceInstanceId, operation), HTTPStatus.CONFLICT)
1522
1523             # Creating all the NS_operation (nslcmop)
1524             # Get service list from db
1525             nsrs_list = nsir["_admin"]["nsrs-detailed-list"]
1526             nslcmops = []
1527             # nslcmops_item = None
1528             for index, nsr_item in enumerate(nsrs_list):
1529                 nsi = None
1530                 if nsr_item.get("shared"):
1531                     _filter["_admin.nsrs-detailed-list.ANYINDEX.shared"] = True
1532                     _filter["_admin.nsrs-detailed-list.ANYINDEX.nsrId"] = nsr_item["nsrId"]
1533                     _filter["_admin.nsrs-detailed-list.ANYINDEX.nslcmop_instantiate.ne"] = None
1534                     _filter["_id.ne"] = netsliceInstanceId
1535                     nsi = self.db.get_one("nsis", _filter, fail_on_empty=False, fail_on_more=False)
1536                     if operation == "terminate":
1537                         _update = {"_admin.nsrs-detailed-list.{}.nslcmop_instantiate".format(index): None}
1538                         self.db.set_one("nsis", {"_id": nsir["_id"]}, _update)
1539
1540                     # looks the first nsi fulfilling the conditions but not being the current NSIR
1541                     if nsi:
1542                         nsi_admin_shared = nsi["_admin"]["nsrs-detailed-list"]
1543                         for nsi_nsr_item in nsi_admin_shared:
1544                             if nsi_nsr_item["nsd-id"] == nsr_item["nsd-id"] and nsi_nsr_item["shared"]:
1545                                 self.add_shared_nsr_2vld(nsir, nsr_item)
1546                                 nslcmops.append(nsi_nsr_item["nslcmop_instantiate"])
1547                                 _update = {"_admin.nsrs-detailed-list.{}".format(index): nsi_nsr_item}
1548                                 self.db.set_one("nsis", {"_id": nsir["_id"]}, _update)
1549                                 break
1550                         # continue to not create nslcmop since nsrs is shared and nsrs was created
1551                         continue
1552                     else:
1553                         self.add_shared_nsr_2vld(nsir, nsr_item)
1554
1555                 try:
1556                     service = self.db.get_one("nsrs", {"_id": nsr_item["nsrId"]})
1557                     indata_ns = {
1558                         "lcmOperationType": operation,
1559                         "nsInstanceId": service["_id"],
1560                         # Including netslice_id in the ns instantiate Operation
1561                         "netsliceInstanceId": netsliceInstanceId,
1562                     }
1563                     if operation == "instantiate":
1564                         indata_ns.update(service["instantiate_params"])
1565
1566                     # Creating NS_LCM_OP with the flag slice_object=True to not trigger the service instantiation
1567                     # message via kafka bus
1568                     nslcmop, _ = self.nsi_NsLcmOpTopic.new(rollback, session, indata_ns, kwargs, headers,
1569                                                            slice_object=True)
1570                     nslcmops.append(nslcmop)
1571                     if operation == "terminate":
1572                         nslcmop = None
1573                     _update = {"_admin.nsrs-detailed-list.{}.nslcmop_instantiate".format(index): nslcmop}
1574                     self.db.set_one("nsis", {"_id": nsir["_id"]}, _update)
1575                 except (DbException, EngineException) as e:
1576                     if e.http_code == HTTPStatus.NOT_FOUND:
1577                         self.logger.info("HTTPStatus.NOT_FOUND")
1578                         pass
1579                     else:
1580                         raise
1581
1582             # Creates nsilcmop
1583             indata["nslcmops_ids"] = nslcmops
1584             self._check_nsi_operation(session, nsir, operation, indata)
1585
1586             nsilcmop_desc = self._create_nsilcmop(session, netsliceInstanceId, operation, indata)
1587             self.format_on_new(nsilcmop_desc, session["project_id"], make_public=session["public"])
1588             _id = self.db.create("nsilcmops", nsilcmop_desc)
1589             rollback.append({"topic": "nsilcmops", "_id": _id})
1590             self.msg.write("nsi", operation, nsilcmop_desc)
1591             return _id, None
1592         except ValidationError as e:
1593             raise EngineException(e, HTTPStatus.UNPROCESSABLE_ENTITY)
1594
1595     def delete(self, session, _id, dry_run=False, not_send_msg=None):
1596         raise EngineException("Method delete called directly", HTTPStatus.INTERNAL_SERVER_ERROR)
1597
1598     def edit(self, session, _id, indata=None, kwargs=None, content=None):
1599         raise EngineException("Method edit called directly", HTTPStatus.INTERNAL_SERVER_ERROR)