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, increment_ip_mac
  24 from yaml import safe_dump
  25 from osm_common.dbbase import DbException
  26 from osm_common.msgbase import MsgException
  27 from osm_common.fsbase import FsException
  28 from osm_nbi import utils
  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         # delete extra ro_nsrs used for internal RO module
 118         self.db.del_one("ro_nsrs", q_filter={"_id": _id}, fail_on_empty=False)
 119
 120     @staticmethod
 121     def _format_ns_request(ns_request):
 122         formated_request = copy(ns_request)
 123         formated_request.pop("additionalParamsForNs", None)
 124         formated_request.pop("additionalParamsForVnf", None)
 125         return formated_request
 126
 127     @staticmethod
 128     def _format_additional_params(ns_request, member_vnf_index=None, vdu_id=None, kdu_name=None, descriptor=None):
 129         """
 130         Get and format user additional params for NS or VNF
 131         :param ns_request: User instantiation additional parameters
 132         :param member_vnf_index: None for extract NS params, or member_vnf_index to extract VNF params
 133         :param descriptor: If not None it check that needed parameters of descriptor are supplied
 134         :return: tuple with a formatted copy of additional params or None if not supplied, plus other parameters
 135         """
 136         additional_params = None
 137         other_params = None
 138         if not member_vnf_index:
 139             additional_params = copy(ns_request.get("additionalParamsForNs"))
 140             where_ = "additionalParamsForNs"
 141         elif ns_request.get("additionalParamsForVnf"):
 142             where_ = "additionalParamsForVnf[member-vnf-index={}]".format(member_vnf_index)
 143             item = next((x for x in ns_request["additionalParamsForVnf"] if x["member-vnf-index"] == member_vnf_index),
 144                         None)
 145             if item:
 146                 if not vdu_id and not kdu_name:
 147                     other_params = item
 148                 additional_params = copy(item.get("additionalParams")) or {}
 149                 if vdu_id and item.get("additionalParamsForVdu"):
 150                     item_vdu = next((x for x in item["additionalParamsForVdu"] if x["vdu_id"] == vdu_id), None)
 151                     other_params = item_vdu
 152                     if item_vdu and item_vdu.get("additionalParams"):
 153                         where_ += ".additionalParamsForVdu[vdu_id={}]".format(vdu_id)
 154                         additional_params = item_vdu["additionalParams"]
 155                 if kdu_name:
 156                     additional_params = {}
 157                     if item.get("additionalParamsForKdu"):
 158                         item_kdu = next((x for x in item["additionalParamsForKdu"] if x["kdu_name"] == kdu_name), None)
 159                         other_params = item_kdu
 160                         if item_kdu and item_kdu.get("additionalParams"):
 161                             where_ += ".additionalParamsForKdu[kdu_name={}]".format(kdu_name)
 162                             additional_params = item_kdu["additionalParams"]
 163
 164         if additional_params:
 165             for k, v in additional_params.items():
 166                 # BEGIN Check that additional parameter names are valid Jinja2 identifiers if target is not Kdu
 167                 if not kdu_name and not match('^[a-zA-Z_][a-zA-Z0-9_]*$', k):
 168                     raise EngineException("Invalid param name at {}:{}. Must contain only alphanumeric characters "
 169                                           "and underscores, and cannot start with a digit"
 170                                           .format(where_, k))
 171                 # END Check that additional parameter names are valid Jinja2 identifiers
 172                 if not isinstance(k, str):
 173                     raise EngineException("Invalid param at {}:{}. Only string keys are allowed".format(where_, k))
 174                 if "." in k or "$" in k:
 175                     raise EngineException("Invalid param at {}:{}. Keys must not contain dots or $".format(where_, k))
 176                 if isinstance(v, (dict, tuple, list)):
 177                     additional_params[k] = "!!yaml " + safe_dump(v)
 178
 179         if descriptor:
 180             for df in descriptor.get("df", []):
 181                 # check that enough parameters are supplied for the initial-config-primitive
 182                 # TODO: check for cloud-init
 183                 if member_vnf_index:
 184                     initial_primitives = []
 185                     if "lcm-operations-configuration" in df \
 186                        and "operate-vnf-op-config" in df["lcm-operations-configuration"]:
 187                         for config in df["lcm-operations-configuration"]["operate-vnf-op-config"].get("day1-2", []):
 188                             for primitive in get_iterable(config.get("initial-config-primitive")):
 189                                 initial_primitives.append(primitive)
 190                 else:
 191                     initial_primitives = deep_get(descriptor, ("ns-configuration", "initial-config-primitive"))
 192
 193                 for initial_primitive in get_iterable(initial_primitives):
 194                     for param in get_iterable(initial_primitive.get("parameter")):
 195                         if param["value"].startswith("<") and param["value"].endswith(">"):
 196                             if param["value"] in ("<rw_mgmt_ip>", "<VDU_SCALE_INFO>", "<ns_config_info>"):
 197                                 continue
 198                             if not additional_params or param["value"][1:-1] not in additional_params:
 199                                 raise EngineException("Parameter '{}' needed for vnfd[id={}]:day1-2 configuration:"
 200                                                       "initial-config-primitive[name={}] not supplied".
 201                                                       format(param["value"], descriptor["id"],
 202                                                              initial_primitive["name"]))
 203
 204         return additional_params or None, other_params or None
 205
 206     def new(self, rollback, session, indata=None, kwargs=None, headers=None):
 207         """
 208         Creates a new nsr into database. It also creates needed vnfrs
 209         :param rollback: list to append the created items at database in case a rollback must be done
 210         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
 211         :param indata: params to be used for the nsr
 212         :param kwargs: used to override the indata descriptor
 213         :param headers: http request headers
 214         :return: the _id of nsr descriptor created at database. Or an exception of type
 215             EngineException, ValidationError, DbException, FsException, MsgException.
 216             Note: Exceptions are not captured on purpose. They should be captured at called
 217         """
 218         try:
 219             step = "checking quotas"
 220             self.check_quota(session)
 221
 222             step = "validating input parameters"
 223             ns_request = self._remove_envelop(indata)
 224             self._update_input_with_kwargs(ns_request, kwargs)
 225             ns_request = self._validate_input_new(ns_request, session["force"])
 226
 227             step = "getting nsd id='{}' from database".format(ns_request.get("nsdId"))
 228             nsd = self._get_nsd_from_db(ns_request["nsdId"], session)
 229             ns_k8s_namespace = self._get_ns_k8s_namespace(nsd, ns_request, session)
 230
 231             step = "checking nsdOperationalState"
 232             self._check_nsd_operational_state(nsd, ns_request)
 233
 234             step = "filling nsr from input data"
 235             nsr_id = str(uuid4())
 236             nsr_descriptor = self._create_nsr_descriptor_from_nsd(nsd, ns_request, nsr_id)
 237
 238             # Create VNFRs
 239             needed_vnfds = {}
 240             # TODO: Change for multiple df support
 241             vnf_profiles = nsd.get("df", [[]])[0].get("vnf-profile", ())
 242             for vnfp in vnf_profiles:
 243                 vnfd_id = vnfp.get("vnfd-id")
 244                 vnf_index = vnfp.get("id")
 245                 step = "getting vnfd id='{}' constituent-vnfd='{}' from database".format(vnfd_id, vnf_index)
 246                 if vnfd_id not in needed_vnfds:
 247                     vnfd = self._get_vnfd_from_db(vnfd_id, session)
 248                     needed_vnfds[vnfd_id] = vnfd
 249                     nsr_descriptor["vnfd-id"].append(vnfd["_id"])
 250                 else:
 251                     vnfd = needed_vnfds[vnfd_id]
 252
 253                 step = "filling vnfr  vnfd-id='{}' constituent-vnfd='{}'".format(vnfd_id, vnf_index)
 254                 vnfr_descriptor = self._create_vnfr_descriptor_from_vnfd(nsd, vnfd, vnfd_id, vnf_index, nsr_descriptor,
 255                                                                          ns_request, ns_k8s_namespace)
 256
 257                 step = "creating vnfr vnfd-id='{}' constituent-vnfd='{}' at database".format(vnfd_id, vnf_index)
 258                 self._add_vnfr_to_db(vnfr_descriptor, rollback, session)
 259                 nsr_descriptor["constituent-vnfr-ref"].append(vnfr_descriptor["id"])
 260
 261             step = "creating nsr at database"
 262             self._add_nsr_to_db(nsr_descriptor, rollback, session)
 263
 264             step = "creating nsr temporal folder"
 265             self.fs.mkdir(nsr_id)
 266
 267             return nsr_id, None
 268         except (ValidationError, EngineException, DbException, MsgException, FsException) as e:
 269             raise type(e)("{} while '{}'".format(e, step), http_code=e.http_code)
 270
 271     def _get_nsd_from_db(self, nsd_id, session):
 272         _filter = self._get_project_filter(session)
 273         _filter["_id"] = nsd_id
 274         return self.db.get_one("nsds", _filter)
 275
 276     def _get_vnfd_from_db(self, vnfd_id, session):
 277         _filter = self._get_project_filter(session)
 278         _filter["id"] = vnfd_id
 279         vnfd = self.db.get_one("vnfds", _filter, fail_on_empty=True, fail_on_more=True)
 280         vnfd.pop("_admin")
 281         return vnfd
 282
 283     def _add_nsr_to_db(self, nsr_descriptor, rollback, session):
 284         self.format_on_new(nsr_descriptor, session["project_id"], make_public=session["public"])
 285         self.db.create("nsrs", nsr_descriptor)
 286         rollback.append({"topic": "nsrs", "_id": nsr_descriptor["id"]})
 287
 288     def _add_vnfr_to_db(self, vnfr_descriptor, rollback, session):
 289         self.format_on_new(vnfr_descriptor, session["project_id"], make_public=session["public"])
 290         self.db.create("vnfrs", vnfr_descriptor)
 291         rollback.append({"topic": "vnfrs", "_id": vnfr_descriptor["id"]})
 292
 293     def _check_nsd_operational_state(self, nsd, ns_request):
 294         if nsd["_admin"]["operationalState"] == "DISABLED":
 295             raise EngineException("nsd with id '{}' is DISABLED, and thus cannot be used to create "
 296                                   "a network service".format(ns_request["nsdId"]), http_code=HTTPStatus.CONFLICT)
 297
 298     def _get_ns_k8s_namespace(self, nsd, ns_request, session):
 299         additional_params, _ = self._format_additional_params(ns_request, descriptor=nsd)
 300         # use for k8s-namespace from ns_request or additionalParamsForNs. By default, the project_id
 301         ns_k8s_namespace = session["project_id"][0] if session["project_id"] else None
 302         if ns_request and ns_request.get("k8s-namespace"):
 303             ns_k8s_namespace = ns_request["k8s-namespace"]
 304         if additional_params and additional_params.get("k8s-namespace"):
 305             ns_k8s_namespace = additional_params["k8s-namespace"]
 306
 307         return ns_k8s_namespace
 308
 309     def _create_nsr_descriptor_from_nsd(self, nsd, ns_request, nsr_id):
 310         now = time()
 311         additional_params, _ = self._format_additional_params(ns_request, descriptor=nsd)
 312
 313         nsr_descriptor = {
 314             "name": ns_request["nsName"],
 315             "name-ref": ns_request["nsName"],
 316             "short-name": ns_request["nsName"],
 317             "admin-status": "ENABLED",
 318             "nsState": "NOT_INSTANTIATED",
 319             "currentOperation": "IDLE",
 320             "currentOperationID": None,
 321             "errorDescription": None,
 322             "errorDetail": None,
 323             "deploymentStatus": None,
 324             "configurationStatus": None,
 325             "vcaStatus": None,
 326             "nsd": {k: v for k, v in nsd.items()},
 327             "datacenter": ns_request["vimAccountId"],
 328             "resource-orchestrator": "osmopenmano",
 329             "description": ns_request.get("nsDescription", ""),
 330             "constituent-vnfr-ref": [],
 331             "operational-status": "init",  # typedef ns-operational-
 332             "config-status": "init",  # typedef config-states
 333             "detailed-status": "scheduled",
 334             "orchestration-progress": {},
 335             "create-time": now,
 336             "nsd-name-ref": nsd["name"],
 337             "operational-events": [],  # "id", "timestamp", "description", "event",
 338             "nsd-ref": nsd["id"],
 339             "nsd-id": nsd["_id"],
 340             "vnfd-id": [],
 341             "instantiate_params": self._format_ns_request(ns_request),
 342             "additionalParamsForNs": additional_params,
 343             "ns-instance-config-ref": nsr_id,
 344             "id": nsr_id,
 345             "_id": nsr_id,
 346             "ssh-authorized-key": ns_request.get("ssh_keys"),  # TODO remove
 347             "flavor": [],
 348             "image": [],
 349         }
 350         ns_request["nsr_id"] = nsr_id
 351         if ns_request and ns_request.get("config-units"):
 352             nsr_descriptor["config-units"] = ns_request["config-units"]
 353
 354         # Create vld
 355         if nsd.get("virtual-link-desc"):
 356             nsr_vld = deepcopy(nsd.get("virtual-link-desc", []))
 357             # Fill each vld with vnfd-connection-point-ref data
 358             # TODO: Change for multiple df support
 359             all_vld_connection_point_data = {vld.get("id"): [] for vld in nsr_vld}
 360             vnf_profiles = nsd.get("df", [[]])[0].get("vnf-profile", ())
 361             for vnf_profile in vnf_profiles:
 362                 for vlc in vnf_profile.get("virtual-link-connectivity", ()):
 363                     for cpd in vlc.get("constituent-cpd-id", ()):
 364                         all_vld_connection_point_data[vlc.get("virtual-link-profile-id")].append({
 365                             "member-vnf-index-ref": cpd.get("constituent-base-element-id"),
 366                             "vnfd-connection-point-ref": cpd.get("constituent-cpd-id"),
 367                             "vnfd-id-ref": vnf_profile.get("vnfd-id")
 368                         })
 369
 370                 vnfd = self.db.get_one("vnfds",
 371                                        {"id": vnf_profile.get("vnfd-id")},
 372                                        fail_on_empty=True,
 373                                        fail_on_more=True)
 374
 375                 for vdu in vnfd.get("vdu", ()):
 376                     flavor_data = {}
 377                     guest_epa = {}
 378                     # Find this vdu compute and storage descriptors
 379                     vdu_virtual_compute = {}
 380                     vdu_virtual_storage = {}
 381                     for vcd in vnfd.get("virtual-compute-desc", ()):
 382                         if vcd.get("id") == vdu.get("virtual-compute-desc"):
 383                             vdu_virtual_compute = vcd
 384                     for vsd in vnfd.get("virtual-storage-desc", ()):
 385                         if vsd.get("id") == vdu.get("virtual-storage-desc", [[]])[0]:
 386                             vdu_virtual_storage = vsd
 387                     # Get this vdu vcpus, memory and storage info for flavor_data
 388                     if vdu_virtual_compute.get("virtual-cpu", {}).get("num-virtual-cpu"):
 389                         flavor_data["vcpu-count"] = vdu_virtual_compute["virtual-cpu"]["num-virtual-cpu"]
 390                     if vdu_virtual_compute.get("virtual-memory", {}).get("size"):
 391                         flavor_data["memory-mb"] = float(vdu_virtual_compute["virtual-memory"]["size"]) * 1024.0
 392                     if vdu_virtual_storage.get("size-of-storage"):
 393                         flavor_data["storage-gb"] = vdu_virtual_storage["size-of-storage"]
 394                     # Get this vdu EPA info for guest_epa
 395                     if vdu_virtual_compute.get("virtual-cpu", {}).get("cpu-quota"):
 396                         guest_epa["cpu-quota"] = vdu_virtual_compute["virtual-cpu"]["cpu-quota"]
 397                     if vdu_virtual_compute.get("virtual-cpu", {}).get("pinning"):
 398                         vcpu_pinning = vdu_virtual_compute["virtual-cpu"]["pinning"]
 399                         if vcpu_pinning.get("thread-policy"):
 400                             guest_epa["cpu-thread-pinning-policy"] = vcpu_pinning["thread-policy"]
 401                         if vcpu_pinning.get("policy"):
 402                             cpu_policy = "SHARED" if vcpu_pinning["policy"] == "dynamic" else "DEDICATED"
 403                             guest_epa["cpu-pinning-policy"] = cpu_policy
 404                     if vdu_virtual_compute.get("virtual-memory", {}).get("mem-quota"):
 405                         guest_epa["mem-quota"] = vdu_virtual_compute["virtual-memory"]["mem-quota"]
 406                     if vdu_virtual_compute.get("virtual-memory", {}).get("mempage-size"):
 407                         guest_epa["mempage-size"] = vdu_virtual_compute["virtual-memory"]["mempage-size"]
 408                     if vdu_virtual_compute.get("virtual-memory", {}).get("numa-node-policy"):
 409                         guest_epa["numa-node-policy"] = vdu_virtual_compute["virtual-memory"]["numa-node-policy"]
 410                     if vdu_virtual_storage.get("disk-io-quota"):
 411                         guest_epa["disk-io-quota"] = vdu_virtual_storage["disk-io-quota"]
 412
 413                     if guest_epa:
 414                         flavor_data["guest-epa"] = guest_epa
 415
 416                     flavor_data["name"] = vdu["id"][:56] + "-flv"
 417                     flavor_data["id"] = str(len(nsr_descriptor["flavor"]))
 418                     nsr_descriptor["flavor"].append(flavor_data)
 419
 420                     sw_image_id = vdu.get("sw-image-desc")
 421                     if sw_image_id:
 422                         image_data = self._get_image_data_from_vnfd(vnfd, sw_image_id)
 423                         self._add_image_to_nsr(nsr_descriptor, image_data)
 424
 425                     # also add alternative images to the list of images
 426                     for alt_image in vdu.get("alternative-sw-image-desc", ()):
 427                         image_data = self._get_image_data_from_vnfd(vnfd, alt_image)
 428                         self._add_image_to_nsr(nsr_descriptor, image_data)
 429
 430             for vld in nsr_vld:
 431                 vld["vnfd-connection-point-ref"] = all_vld_connection_point_data.get(vld.get("id"), [])
 432                 vld["name"] = vld["id"]
 433             nsr_descriptor["vld"] = nsr_vld
 434
 435         return nsr_descriptor
 436
 437     def _get_image_data_from_vnfd(self, vnfd, sw_image_id):
 438         sw_image_desc = utils.find_in_list(vnfd.get("sw-image-desc", ()),
 439                                            lambda sw: sw["id"] == sw_image_id)
 440         image_data = {}
 441         if sw_image_desc.get("image"):
 442             image_data["image"] = sw_image_desc["image"]
 443         if sw_image_desc.get("checksum"):
 444             image_data["image_checksum"] = sw_image_desc["checksum"]["hash"]
 445         if sw_image_desc.get("vim-type"):
 446             image_data["vim-type"] = sw_image_desc["vim-type"]
 447         return image_data
 448
 449     def _add_image_to_nsr(self, nsr_descriptor, image_data):
 450         """
 451         Adds image to nsr checking first it is not already added
 452         """
 453         img = next((f for f in nsr_descriptor["image"] if
 454                     all(f.get(k) == image_data[k] for k in image_data)), None)
 455         if not img:
 456             image_data["id"] = str(len(nsr_descriptor["image"]))
 457             nsr_descriptor["image"].append(image_data)
 458
 459     def _create_vnfr_descriptor_from_vnfd(self, nsd, vnfd, vnfd_id, vnf_index, nsr_descriptor,
 460                                           ns_request, ns_k8s_namespace):
 461         vnfr_id = str(uuid4())
 462         nsr_id = nsr_descriptor["id"]
 463         now = time()
 464         additional_params, vnf_params = self._format_additional_params(ns_request, vnf_index, descriptor=vnfd)
 465
 466         vnfr_descriptor = {
 467             "id": vnfr_id,
 468             "_id": vnfr_id,
 469             "nsr-id-ref": nsr_id,
 470             "member-vnf-index-ref": vnf_index,
 471             "additionalParamsForVnf": additional_params,
 472             "created-time": now,
 473             # "vnfd": vnfd,        # at OSM model.but removed to avoid data duplication TODO: revise
 474             "vnfd-ref": vnfd_id,
 475             "vnfd-id": vnfd["_id"],  # not at OSM model, but useful
 476             "vim-account-id": None,
 477             "vdur": [],
 478             "connection-point": [],
 479             "ip-address": None,  # mgmt-interface filled by LCM
 480         }
 481         vnf_k8s_namespace = ns_k8s_namespace
 482         if vnf_params:
 483             if vnf_params.get("k8s-namespace"):
 484                 vnf_k8s_namespace = vnf_params["k8s-namespace"]
 485             if vnf_params.get("config-units"):
 486                 vnfr_descriptor["config-units"] = vnf_params["config-units"]
 487
 488         # Create vld
 489         if vnfd.get("int-virtual-link-desc"):
 490             vnfr_descriptor["vld"] = []
 491             for vnfd_vld in vnfd.get("int-virtual-link-desc"):
 492                 vnfr_descriptor["vld"].append({key: vnfd_vld[key] for key in vnfd_vld})
 493
 494         for cp in vnfd.get("ext-cpd", ()):
 495             vnf_cp = {
 496                 "name": cp.get("id"),
 497                 "connection-point-id": cp.get("int-cpd", {}).get("cpd"),
 498                 "connection-point-vdu-id": cp.get("int-cpd", {}).get("vdu-id"),
 499                 "id": cp.get("id"),
 500                 # "ip-address", "mac-address" # filled by LCM
 501                 # vim-id  # TODO it would be nice having a vim port id
 502             }
 503             vnfr_descriptor["connection-point"].append(vnf_cp)
 504
 505         # Create k8s-cluster information
 506         # TODO: Validate if a k8s-cluster net can have more than one ext-cpd ?
 507         if vnfd.get("k8s-cluster"):
 508             vnfr_descriptor["k8s-cluster"] = vnfd["k8s-cluster"]
 509             all_k8s_cluster_nets_cpds = {}
 510             for cpd in get_iterable(vnfd.get("ext-cpd")):
 511                 if cpd.get("k8s-cluster-net"):
 512                     all_k8s_cluster_nets_cpds[cpd.get("k8s-cluster-net")] = cpd.get("id")
 513             for net in get_iterable(vnfr_descriptor["k8s-cluster"].get("nets")):
 514                 if net.get("id") in all_k8s_cluster_nets_cpds:
 515                     net["external-connection-point-ref"] = all_k8s_cluster_nets_cpds[net.get("id")]
 516
 517         # update kdus
 518         for kdu in get_iterable(vnfd.get("kdu")):
 519             additional_params, kdu_params = self._format_additional_params(ns_request,
 520                                                                            vnf_index,
 521                                                                            kdu_name=kdu["name"],
 522                                                                            descriptor=vnfd)
 523             kdu_k8s_namespace = vnf_k8s_namespace
 524             kdu_model = kdu_params.get("kdu_model") if kdu_params else None
 525             if kdu_params and kdu_params.get("k8s-namespace"):
 526                 kdu_k8s_namespace = kdu_params["k8s-namespace"]
 527
 528             kdur = {
 529                 "additionalParams": additional_params,
 530                 "k8s-namespace": kdu_k8s_namespace,
 531                 "kdu-name": kdu["name"],
 532                 # TODO      "name": ""     Name of the VDU in the VIM
 533                 "ip-address": None,  # mgmt-interface filled by LCM
 534                 "k8s-cluster": {},
 535             }
 536             if kdu_params and kdu_params.get("config-units"):
 537                 kdur["config-units"] = kdu_params["config-units"]
 538             if kdu.get("helm-version"):
 539                 kdur["helm-version"] = kdu["helm-version"]
 540             for k8s_type in ("helm-chart", "juju-bundle"):
 541                 if kdu.get(k8s_type):
 542                     kdur[k8s_type] = kdu_model or kdu[k8s_type]
 543             if not vnfr_descriptor.get("kdur"):
 544                 vnfr_descriptor["kdur"] = []
 545             vnfr_descriptor["kdur"].append(kdur)
 546
 547         vnfd_mgmt_cp = vnfd.get("mgmt-cp")
 548
 549         for vdu in vnfd.get("vdu", ()):
 550             vdu_mgmt_cp = []
 551             try:
 552                 configs = vnfd.get("df")[0]["lcm-operations-configuration"]["operate-vnf-op-config"]["day1-2"]
 553                 vdu_config = utils.find_in_list(configs, lambda config: config["id"] == vdu["id"])
 554             except Exception:
 555                 vdu_config = None
 556
 557             if vdu_config:
 558                 external_connection_ee = utils.filter_in_list(
 559                     vdu_config.get("execution-environment-list", []),
 560                     lambda ee: "external-connection-point-ref" in ee
 561                 )
 562                 for ee in external_connection_ee:
 563                     vdu_mgmt_cp.append(ee["external-connection-point-ref"])
 564
 565             additional_params, vdu_params = self._format_additional_params(
 566                 ns_request, vnf_index, vdu_id=vdu["id"], descriptor=vnfd)
 567             vdur = {
 568                 "vdu-id-ref": vdu["id"],
 569                 # TODO      "name": ""     Name of the VDU in the VIM
 570                 "ip-address": None,  # mgmt-interface filled by LCM
 571                 # "vim-id", "flavor-id", "image-id", "management-ip" # filled by LCM
 572                 "internal-connection-point": [],
 573                 "interfaces": [],
 574                 "additionalParams": additional_params,
 575                 "vdu-name": vdu["name"]
 576             }
 577             if vdu_params and vdu_params.get("config-units"):
 578                 vdur["config-units"] = vdu_params["config-units"]
 579             if deep_get(vdu, ("supplemental-boot-data", "boot-data-drive")):
 580                 vdur["boot-data-drive"] = vdu["supplemental-boot-data"]["boot-data-drive"]
 581             if vdu.get("pdu-type"):
 582                 vdur["pdu-type"] = vdu["pdu-type"]
 583                 vdur["name"] = vdu["pdu-type"]
 584             # TODO volumes: name, volume-id
 585             for icp in vdu.get("int-cpd", ()):
 586                 vdu_icp = {
 587                     "id": icp["id"],
 588                     "connection-point-id": icp["id"],
 589                     "name": icp.get("id"),
 590                 }
 591
 592                 if "port-security-enabled" in icp:
 593                     vdu_icp["port-security-enabled"] = icp["port-security-enabled"]
 594
 595                 if "port-security-disable-strategy" in icp:
 596                     vdu_icp["port-security-disable-strategy"] = icp["port-security-disable-strategy"]
 597
 598                 vdur["internal-connection-point"].append(vdu_icp)
 599
 600                 for iface in icp.get("virtual-network-interface-requirement", ()):
 601                     iface_fields = ("name", "mac-address")
 602                     vdu_iface = {x: iface[x] for x in iface_fields if iface.get(x) is not None}
 603
 604                     vdu_iface["internal-connection-point-ref"] = vdu_icp["id"]
 605                     for ext_cp in vnfd.get("ext-cpd", ()):
 606                         if not ext_cp.get("int-cpd"):
 607                             continue
 608                         if ext_cp["int-cpd"].get("vdu-id") != vdu["id"]:
 609                             continue
 610                         if icp["id"] == ext_cp["int-cpd"].get("cpd"):
 611                             vdu_iface["external-connection-point-ref"] = ext_cp.get("id")
 612                             break
 613
 614                     if vnfd_mgmt_cp and vdu_iface.get("external-connection-point-ref") == vnfd_mgmt_cp:
 615                         vdu_iface["mgmt-vnf"] = True
 616                         vdu_iface["mgmt-interface"] = True
 617
 618                     for ecp in vdu_mgmt_cp:
 619                         if vdu_iface.get("external-connection-point-ref") == ecp:
 620                             vdu_iface["mgmt-interface"] = True
 621
 622                     if iface.get("virtual-interface"):
 623                         vdu_iface.update(deepcopy(iface["virtual-interface"]))
 624
 625                     # look for network where this interface is connected
 626                     iface_ext_cp = vdu_iface.get("external-connection-point-ref")
 627                     if iface_ext_cp:
 628                         # TODO: Change for multiple df support
 629                         for df in get_iterable(nsd.get("df")):
 630                             for vnf_profile in get_iterable(df.get("vnf-profile")):
 631                                 for vlc_index, vlc in \
 632                                         enumerate(get_iterable(vnf_profile.get("virtual-link-connectivity"))):
 633                                     for cpd in get_iterable(vlc.get("constituent-cpd-id")):
 634                                         if cpd.get("constituent-cpd-id") == iface_ext_cp:
 635                                             vdu_iface["ns-vld-id"] = vlc.get("virtual-link-profile-id")
 636                                             # if iface type is SRIOV or PASSTHROUGH, set pci-interfaces flag to True
 637                                             if vdu_iface.get("type") in ("SR-IOV", "PCI-PASSTHROUGH"):
 638                                                 nsr_descriptor["vld"][vlc_index]["pci-interfaces"] = True
 639                                             break
 640                     elif vdu_iface.get("internal-connection-point-ref"):
 641                         vdu_iface["vnf-vld-id"] = icp.get("int-virtual-link-desc")
 642                         # TODO: store fixed IP address in the record (if it exists in the ICP)
 643                         # if iface type is SRIOV or PASSTHROUGH, set pci-interfaces flag to True
 644                         if vdu_iface.get("type") in ("SR-IOV", "PCI-PASSTHROUGH"):
 645                             ivld_index = utils.find_index_in_list(vnfd.get("int-virtual-link-desc", ()),
 646                                                                   lambda ivld:
 647                                                                   ivld["id"] == icp.get("int-virtual-link-desc")
 648                                                                   )
 649                             vnfr_descriptor["vld"][ivld_index]["pci-interfaces"] = True
 650
 651                     vdur["interfaces"].append(vdu_iface)
 652
 653             if vdu.get("sw-image-desc"):
 654                 sw_image = utils.find_in_list(
 655                     vnfd.get("sw-image-desc", ()),
 656                     lambda image: image["id"] == vdu.get("sw-image-desc"))
 657                 nsr_sw_image_data = utils.find_in_list(
 658                     nsr_descriptor["image"],
 659                     lambda nsr_image: (nsr_image.get("image") == sw_image.get("image"))
 660                 )
 661                 vdur["ns-image-id"] = nsr_sw_image_data["id"]
 662
 663             if vdu.get("alternative-sw-image-desc"):
 664                 alt_image_ids = []
 665                 for alt_image_id in vdu.get("alternative-sw-image-desc", ()):
 666                     sw_image = utils.find_in_list(
 667                         vnfd.get("sw-image-desc", ()),
 668                         lambda image: image["id"] == alt_image_id)
 669                     nsr_sw_image_data = utils.find_in_list(
 670                         nsr_descriptor["image"],
 671                         lambda nsr_image: (nsr_image.get("image") == sw_image.get("image"))
 672                     )
 673                     alt_image_ids.append(nsr_sw_image_data["id"])
 674                 vdur["alt-image-ids"] = alt_image_ids
 675
 676             flavor_data_name = vdu["id"][:56] + "-flv"
 677             nsr_flavor_desc = utils.find_in_list(
 678                 nsr_descriptor["flavor"],
 679                 lambda flavor: flavor["name"] == flavor_data_name)
 680
 681             if nsr_flavor_desc:
 682                 vdur["ns-flavor-id"] = nsr_flavor_desc["id"]
 683
 684             count = int(vdu.get("count", 1))
 685             for index in range(0, count):
 686                 vdur = deepcopy(vdur)
 687                 for iface in vdur["interfaces"]:
 688                     if iface.get("ip-address"):
 689                         iface["ip-address"] = increment_ip_mac(iface["ip-address"])
 690                     if iface.get("mac-address"):
 691                         iface["mac-address"] = increment_ip_mac(iface["mac-address"])
 692
 693                 vdur["_id"] = str(uuid4())
 694                 vdur["id"] = vdur["_id"]
 695                 vdur["count-index"] = index
 696                 vnfr_descriptor["vdur"].append(vdur)
 697
 698         return vnfr_descriptor
 699
 700     def edit(self, session, _id, indata=None, kwargs=None, content=None):
 701         raise EngineException("Method edit called directly", HTTPStatus.INTERNAL_SERVER_ERROR)
 702
 703
 704 class VnfrTopic(BaseTopic):
 705     topic = "vnfrs"
 706     topic_msg = None
 707
 708     def __init__(self, db, fs, msg, auth):
 709         BaseTopic.__init__(self, db, fs, msg, auth)
 710
 711     def delete(self, session, _id, dry_run=False, not_send_msg=None):
 712         raise EngineException("Method delete called directly", HTTPStatus.INTERNAL_SERVER_ERROR)
 713
 714     def edit(self, session, _id, indata=None, kwargs=None, content=None):
 715         raise EngineException("Method edit called directly", HTTPStatus.INTERNAL_SERVER_ERROR)
 716
 717     def new(self, rollback, session, indata=None, kwargs=None, headers=None):
 718         # Not used because vnfrs are created and deleted by NsrTopic class directly
 719         raise EngineException("Method new called directly", HTTPStatus.INTERNAL_SERVER_ERROR)
 720
 721
 722 class NsLcmOpTopic(BaseTopic):
 723     topic = "nslcmops"
 724     topic_msg = "ns"
 725     operation_schema = {    # mapping between operation and jsonschema to validate
 726         "instantiate": ns_instantiate,
 727         "action": ns_action,
 728         "scale": ns_scale,
 729         "terminate": ns_terminate,
 730     }
 731
 732     def __init__(self, db, fs, msg, auth):
 733         BaseTopic.__init__(self, db, fs, msg, auth)
 734
 735     def _check_ns_operation(self, session, nsr, operation, indata):
 736         """
 737         Check that user has enter right parameters for the operation
 738         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
 739         :param operation: it can be: instantiate, terminate, action, TODO: update, heal
 740         :param indata: descriptor with the parameters of the operation
 741         :return: None
 742         """
 743         if operation == "action":
 744             self._check_action_ns_operation(indata, nsr)
 745         elif operation == "scale":
 746             self._check_scale_ns_operation(indata, nsr)
 747         elif operation == "instantiate":
 748             self._check_instantiate_ns_operation(indata, nsr, session)
 749
 750     def _check_action_ns_operation(self, indata, nsr):
 751         nsd = nsr["nsd"]
 752         # check vnf_member_index
 753         if indata.get("vnf_member_index"):
 754             indata["member_vnf_index"] = indata.pop("vnf_member_index")  # for backward compatibility
 755         if indata.get("member_vnf_index"):
 756             vnfd = self._get_vnfd_from_vnf_member_index(indata["member_vnf_index"], nsr["_id"])
 757             try:
 758                 configs = vnfd.get("df")[0]["lcm-operations-configuration"]["operate-vnf-op-config"]["day1-2"]
 759             except Exception:
 760                 configs = []
 761
 762             if indata.get("vdu_id"):
 763                 self._check_valid_vdu(vnfd, indata["vdu_id"])
 764                 descriptor_configuration = utils.find_in_list(
 765                     configs,
 766                     lambda config: config["id"] == indata["vdu_id"]
 767                 )
 768             elif indata.get("kdu_name"):
 769                 self._check_valid_kdu(vnfd, indata["kdu_name"])
 770                 descriptor_configuration = utils.find_in_list(
 771                     configs,
 772                     lambda config: config["id"] == indata.get("kdu_name")
 773                 )
 774             else:
 775                 descriptor_configuration = utils.find_in_list(
 776                     configs,
 777                     lambda config: config["id"] == vnfd["id"]
 778                 )
 779             if descriptor_configuration is not None:
 780                 descriptor_configuration = descriptor_configuration.get("config-primitive")
 781         else:  # use a NSD
 782             descriptor_configuration = nsd.get("ns-configuration", {}).get("config-primitive")
 783
 784         # For k8s allows default primitives without validating the parameters
 785         if indata.get("kdu_name") and indata["primitive"] in ("upgrade", "rollback", "status", "inspect", "readme"):
 786             # TODO should be checked that rollback only can contains revsision_numbe????
 787             if not indata.get("member_vnf_index"):
 788                 raise EngineException("Missing action parameter 'member_vnf_index' for default KDU primitive '{}'"
 789                                       .format(indata["primitive"]))
 790             return
 791         # if not, check primitive
 792         for config_primitive in get_iterable(descriptor_configuration):
 793             if indata["primitive"] == config_primitive["name"]:
 794                 # check needed primitive_params are provided
 795                 if indata.get("primitive_params"):
 796                     in_primitive_params_copy = copy(indata["primitive_params"])
 797                 else:
 798                     in_primitive_params_copy = {}
 799                 for paramd in get_iterable(config_primitive.get("parameter")):
 800                     if paramd["name"] in in_primitive_params_copy:
 801                         del in_primitive_params_copy[paramd["name"]]
 802                     elif not paramd.get("default-value"):
 803                         raise EngineException("Needed parameter {} not provided for primitive '{}'".format(
 804                             paramd["name"], indata["primitive"]))
 805                 # check no extra primitive params are provided
 806                 if in_primitive_params_copy:
 807                     raise EngineException("parameter/s '{}' not present at vnfd /nsd for primitive '{}'".format(
 808                         list(in_primitive_params_copy.keys()), indata["primitive"]))
 809                 break
 810         else:
 811             raise EngineException("Invalid primitive '{}' is not present at vnfd/nsd".format(indata["primitive"]))
 812
 813     def _check_scale_ns_operation(self, indata, nsr):
 814         vnfd = self._get_vnfd_from_vnf_member_index(indata["scaleVnfData"]["scaleByStepData"]["member-vnf-index"],
 815                                                     nsr["_id"])
 816         for scaling_aspect in get_iterable(vnfd.get("df", ())[0]["scaling-aspect"]):
 817             if indata["scaleVnfData"]["scaleByStepData"]["scaling-group-descriptor"] == scaling_aspect["id"]:
 818                 break
 819         else:
 820             raise EngineException("Invalid scaleVnfData:scaleByStepData:scaling-group-descriptor '{}' is not "
 821                                   "present at vnfd:scaling-aspect"
 822                                   .format(indata["scaleVnfData"]["scaleByStepData"]["scaling-group-descriptor"]))
 823
 824     def _check_instantiate_ns_operation(self, indata, nsr, session):
 825         vnf_member_index_to_vnfd = {}  # map between vnf_member_index to vnf descriptor.
 826         vim_accounts = []
 827         wim_accounts = []
 828         nsd = nsr["nsd"]
 829         self._check_valid_vim_account(indata["vimAccountId"], vim_accounts, session)
 830         self._check_valid_wim_account(indata.get("wimAccountId"), wim_accounts, session)
 831         for in_vnf in get_iterable(indata.get("vnf")):
 832             member_vnf_index = in_vnf["member-vnf-index"]
 833             if vnf_member_index_to_vnfd.get(member_vnf_index):
 834                 vnfd = vnf_member_index_to_vnfd[member_vnf_index]
 835             else:
 836                 vnfd = self._get_vnfd_from_vnf_member_index(member_vnf_index, nsr["_id"])
 837                 vnf_member_index_to_vnfd[member_vnf_index] = vnfd  # add to cache, avoiding a later look for
 838             self._check_vnf_instantiation_params(in_vnf, vnfd)
 839             if in_vnf.get("vimAccountId"):
 840                 self._check_valid_vim_account(in_vnf["vimAccountId"], vim_accounts, session)
 841
 842         for in_vld in get_iterable(indata.get("vld")):
 843             self._check_valid_wim_account(in_vld.get("wimAccountId"), wim_accounts, session)
 844             for vldd in get_iterable(nsd.get("virtual-link-desc")):
 845                 if in_vld["name"] == vldd["id"]:
 846                     break
 847             else:
 848                 raise EngineException("Invalid parameter vld:name='{}' is not present at nsd:vld".format(
 849                     in_vld["name"]))
 850
 851     def _get_vnfd_from_vnf_member_index(self, member_vnf_index, nsr_id):
 852         # Obtain vnf descriptor. The vnfr is used to get the vnfd._id used for this member_vnf_index
 853         vnfr = self.db.get_one("vnfrs",
 854                                {"nsr-id-ref": nsr_id, "member-vnf-index-ref": member_vnf_index},
 855                                fail_on_empty=False)
 856         if not vnfr:
 857             raise EngineException("Invalid parameter member_vnf_index='{}' is not one of the "
 858                                   "nsd:constituent-vnfd".format(member_vnf_index))
 859         vnfd = self.db.get_one("vnfds", {"_id": vnfr["vnfd-id"]}, fail_on_empty=False)
 860         if not vnfd:
 861             raise EngineException("vnfd id={} has been deleted!. Operation cannot be performed".
 862                                   format(vnfr["vnfd-id"]))
 863         return vnfd
 864
 865     def _check_valid_vdu(self, vnfd, vdu_id):
 866         for vdud in get_iterable(vnfd.get("vdu")):
 867             if vdud["id"] == vdu_id:
 868                 return vdud
 869         else:
 870             raise EngineException("Invalid parameter vdu_id='{}' not present at vnfd:vdu:id".format(vdu_id))
 871
 872     def _check_valid_kdu(self, vnfd, kdu_name):
 873         for kdud in get_iterable(vnfd.get("kdu")):
 874             if kdud["name"] == kdu_name:
 875                 return kdud
 876         else:
 877             raise EngineException("Invalid parameter kdu_name='{}' not present at vnfd:kdu:name".format(kdu_name))
 878
 879     def _check_vnf_instantiation_params(self, in_vnf, vnfd):
 880         for in_vdu in get_iterable(in_vnf.get("vdu")):
 881             for vdu in get_iterable(vnfd.get("vdu")):
 882                 if in_vdu["id"] == vdu["id"]:
 883                     for volume in get_iterable(in_vdu.get("volume")):
 884                         for volumed in get_iterable(vdu.get("virtual-storage-desc")):
 885                             if volumed["id"] == volume["name"]:
 886                                 break
 887                         else:
 888                             raise EngineException("Invalid parameter vnf[member-vnf-index='{}']:vdu[id='{}']:"
 889                                                   "volume:name='{}' is not present at "
 890                                                   "vnfd:vdu:virtual-storage-desc list".
 891                                                   format(in_vnf["member-vnf-index"], in_vdu["id"],
 892                                                          volume["id"]))
 893
 894                     vdu_if_names = set()
 895                     for cpd in get_iterable(vdu.get("int-cpd")):
 896                         for iface in get_iterable(cpd.get("virtual-network-interface-requirement")):
 897                             vdu_if_names.add(iface.get("name"))
 898
 899                     for in_iface in get_iterable(in_vdu["interface"]):
 900                         if in_iface["name"] in vdu_if_names:
 901                             break
 902                         else:
 903                             raise EngineException("Invalid parameter vnf[member-vnf-index='{}']:vdu[id='{}']:"
 904                                                   "int-cpd[id='{}'] is not present at vnfd:vdu:int-cpd"
 905                                                   .format(in_vnf["member-vnf-index"], in_vdu["id"],
 906                                                           in_iface["name"]))
 907                     break
 908
 909             else:
 910                 raise EngineException("Invalid parameter vnf[member-vnf-index='{}']:vdu[id='{}'] is not present "
 911                                       "at vnfd:vdu".format(in_vnf["member-vnf-index"], in_vdu["id"]))
 912
 913         vnfd_ivlds_cpds = {ivld.get("id"): set() for ivld in get_iterable(vnfd.get("int-virtual-link-desc"))}
 914         for vdu in get_iterable(vnfd.get("vdu")):
 915             for cpd in get_iterable(vnfd.get("int-cpd")):
 916                 if cpd.get("int-virtual-link-desc"):
 917                     vnfd_ivlds_cpds[cpd.get("int-virtual-link-desc")] = cpd.get("id")
 918
 919         for in_ivld in get_iterable(in_vnf.get("internal-vld")):
 920             if in_ivld.get("name") in vnfd_ivlds_cpds:
 921                 for in_icp in get_iterable(in_ivld.get("internal-connection-point")):
 922                     if in_icp["id-ref"] in vnfd_ivlds_cpds[in_ivld.get("name")]:
 923                         break
 924                     else:
 925                         raise EngineException("Invalid parameter vnf[member-vnf-index='{}']:internal-vld[name"
 926                                               "='{}']:internal-connection-point[id-ref:'{}'] is not present at "
 927                                               "vnfd:internal-vld:name/id:internal-connection-point"
 928                                               .format(in_vnf["member-vnf-index"], in_ivld["name"],
 929                                                       in_icp["id-ref"]))
 930             else:
 931                 raise EngineException("Invalid parameter vnf[member-vnf-index='{}']:internal-vld:name='{}'"
 932                                       " is not present at vnfd '{}'".format(in_vnf["member-vnf-index"],
 933                                                                             in_ivld["name"], vnfd["id"]))
 934
 935     def _check_valid_vim_account(self, vim_account, vim_accounts, session):
 936         if vim_account in vim_accounts:
 937             return
 938         try:
 939             db_filter = self._get_project_filter(session)
 940             db_filter["_id"] = vim_account
 941             self.db.get_one("vim_accounts", db_filter)
 942         except Exception:
 943             raise EngineException("Invalid vimAccountId='{}' not present for the project".format(vim_account))
 944         vim_accounts.append(vim_account)
 945
 946     def _check_valid_wim_account(self, wim_account, wim_accounts, session):
 947         if not isinstance(wim_account, str):
 948             return
 949         if wim_account in wim_accounts:
 950             return
 951         try:
 952             db_filter = self._get_project_filter(session, write=False, show_all=True)
 953             db_filter["_id"] = wim_account
 954             self.db.get_one("wim_accounts", db_filter)
 955         except Exception:
 956             raise EngineException("Invalid wimAccountId='{}' not present for the project".format(wim_account))
 957         wim_accounts.append(wim_account)
 958
 959     def _look_for_pdu(self, session, rollback, vnfr, vim_account, vnfr_update, vnfr_update_rollback):
 960         """
 961         Look for a free PDU in the catalog matching vdur type and interfaces. Fills vnfr.vdur with the interface
 962         (ip_address, ...) information.
 963         Modifies PDU _admin.usageState to 'IN_USE'
 964         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
 965         :param rollback: list with the database modifications to rollback if needed
 966         :param vnfr: vnfr to be updated. It is modified with pdu interface info if pdu is found
 967         :param vim_account: vim_account where this vnfr should be deployed
 968         :param vnfr_update: dictionary filled by this method with changes to be done at database vnfr
 969         :param vnfr_update_rollback: dictionary filled by this method with original content of vnfr in case a rollback
 970                                      of the changed vnfr is needed
 971
 972         :return: List of PDU interfaces that are connected to an existing VIM network. Each item contains:
 973                  "vim-network-name": used at VIM
 974                   "name": interface name
 975                   "vnf-vld-id": internal VNFD vld where this interface is connected, or
 976                   "ns-vld-id": NSD vld where this interface is connected.
 977                   NOTE: One, and only one between 'vnf-vld-id' and 'ns-vld-id' contains a value. The other will be None
 978         """
 979
 980         ifaces_forcing_vim_network = []
 981         for vdur_index, vdur in enumerate(get_iterable(vnfr.get("vdur"))):
 982             if not vdur.get("pdu-type"):
 983                 continue
 984             pdu_type = vdur.get("pdu-type")
 985             pdu_filter = self._get_project_filter(session)
 986             pdu_filter["vim_accounts"] = vim_account
 987             pdu_filter["type"] = pdu_type
 988             pdu_filter["_admin.operationalState"] = "ENABLED"
 989             pdu_filter["_admin.usageState"] = "NOT_IN_USE"
 990             # TODO feature 1417: "shared": True,
 991
 992             available_pdus = self.db.get_list("pdus", pdu_filter)
 993             for pdu in available_pdus:
 994                 # step 1 check if this pdu contains needed interfaces:
 995                 match_interfaces = True
 996                 for vdur_interface in vdur["interfaces"]:
 997                     for pdu_interface in pdu["interfaces"]:
 998                         if pdu_interface["name"] == vdur_interface["name"]:
 999                             # TODO feature 1417: match per mgmt type
1000                             break
1001                     else:  # no interface found for name
1002                         match_interfaces = False
1003                         break
1004                 if match_interfaces:
1005                     break
1006             else:
1007                 raise EngineException(
1008                     "No PDU of type={} at vim_account={} found for member_vnf_index={}, vdu={} matching interface "
1009                     "names".format(pdu_type, vim_account, vnfr["member-vnf-index-ref"], vdur["vdu-id-ref"]))
1010
1011             # step 2. Update pdu
1012             rollback_pdu = {
1013                 "_admin.usageState": pdu["_admin"]["usageState"],
1014                 "_admin.usage.vnfr_id": None,
1015                 "_admin.usage.nsr_id": None,
1016                 "_admin.usage.vdur": None,
1017             }
1018             self.db.set_one("pdus", {"_id": pdu["_id"]},
1019                             {"_admin.usageState": "IN_USE",
1020                              "_admin.usage": {"vnfr_id": vnfr["_id"],
1021                                               "nsr_id": vnfr["nsr-id-ref"],
1022                                               "vdur": vdur["vdu-id-ref"]}
1023                              })
1024             rollback.append({"topic": "pdus", "_id": pdu["_id"], "operation": "set", "content": rollback_pdu})
1025
1026             # step 3. Fill vnfr info by filling vdur
1027             vdu_text = "vdur.{}".format(vdur_index)
1028             vnfr_update_rollback[vdu_text + ".pdu-id"] = None
1029             vnfr_update[vdu_text + ".pdu-id"] = pdu["_id"]
1030             for iface_index, vdur_interface in enumerate(vdur["interfaces"]):
1031                 for pdu_interface in pdu["interfaces"]:
1032                     if pdu_interface["name"] == vdur_interface["name"]:
1033                         iface_text = vdu_text + ".interfaces.{}".format(iface_index)
1034                         for k, v in pdu_interface.items():
1035                             if k in ("ip-address", "mac-address"):  # TODO: switch-xxxxx must be inserted
1036                                 vnfr_update[iface_text + ".{}".format(k)] = v
1037                                 vnfr_update_rollback[iface_text + ".{}".format(k)] = vdur_interface.get(v)
1038                         if pdu_interface.get("ip-address"):
1039                             if vdur_interface.get("mgmt-interface") or vdur_interface.get("mgmt-vnf"):
1040                                 vnfr_update_rollback[vdu_text + ".ip-address"] = vdur.get("ip-address")
1041                                 vnfr_update[vdu_text + ".ip-address"] = pdu_interface["ip-address"]
1042                             if vdur_interface.get("mgmt-vnf"):
1043                                 vnfr_update_rollback["ip-address"] = vnfr.get("ip-address")
1044                                 vnfr_update["ip-address"] = pdu_interface["ip-address"]
1045                                 vnfr_update[vdu_text + ".ip-address"] = pdu_interface["ip-address"]
1046                         if pdu_interface.get("vim-network-name") or pdu_interface.get("vim-network-id"):
1047                             ifaces_forcing_vim_network.append({
1048                                 "name": vdur_interface.get("vnf-vld-id") or vdur_interface.get("ns-vld-id"),
1049                                 "vnf-vld-id": vdur_interface.get("vnf-vld-id"),
1050                                 "ns-vld-id": vdur_interface.get("ns-vld-id")})
1051                             if pdu_interface.get("vim-network-id"):
1052                                 ifaces_forcing_vim_network[-1]["vim-network-id"] = pdu_interface["vim-network-id"]
1053                             if pdu_interface.get("vim-network-name"):
1054                                 ifaces_forcing_vim_network[-1]["vim-network-name"] = pdu_interface["vim-network-name"]
1055                         break
1056
1057         return ifaces_forcing_vim_network
1058
1059     def _look_for_k8scluster(self, session, rollback, vnfr, vim_account, vnfr_update, vnfr_update_rollback):
1060         """
1061         Look for an available k8scluster for all the kuds in the vnfd matching version and cni requirements.
1062         Fills vnfr.kdur with the selected k8scluster
1063
1064         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1065         :param rollback: list with the database modifications to rollback if needed
1066         :param vnfr: vnfr to be updated. It is modified with pdu interface info if pdu is found
1067         :param vim_account: vim_account where this vnfr should be deployed
1068         :param vnfr_update: dictionary filled by this method with changes to be done at database vnfr
1069         :param vnfr_update_rollback: dictionary filled by this method with original content of vnfr in case a rollback
1070                                      of the changed vnfr is needed
1071
1072         :return: List of KDU interfaces that are connected to an existing VIM network. Each item contains:
1073                  "vim-network-name": used at VIM
1074                   "name": interface name
1075                   "vnf-vld-id": internal VNFD vld where this interface is connected, or
1076                   "ns-vld-id": NSD vld where this interface is connected.
1077                   NOTE: One, and only one between 'vnf-vld-id' and 'ns-vld-id' contains a value. The other will be None
1078         """
1079
1080         ifaces_forcing_vim_network = []
1081         if not vnfr.get("kdur"):
1082             return ifaces_forcing_vim_network
1083
1084         kdu_filter = self._get_project_filter(session)
1085         kdu_filter["vim_account"] = vim_account
1086         # TODO kdu_filter["_admin.operationalState"] = "ENABLED"
1087         available_k8sclusters = self.db.get_list("k8sclusters", kdu_filter)
1088
1089         k8s_requirements = {}  # just for logging
1090         for k8scluster in available_k8sclusters:
1091             if not vnfr.get("k8s-cluster"):
1092                 break
1093             # restrict by cni
1094             if vnfr["k8s-cluster"].get("cni"):
1095                 k8s_requirements["cni"] = vnfr["k8s-cluster"]["cni"]
1096                 if not set(vnfr["k8s-cluster"]["cni"]).intersection(k8scluster.get("cni", ())):
1097                     continue
1098             # restrict by version
1099             if vnfr["k8s-cluster"].get("version"):
1100                 k8s_requirements["version"] = vnfr["k8s-cluster"]["version"]
1101                 if k8scluster.get("k8s_version") not in vnfr["k8s-cluster"]["version"]:
1102                     continue
1103             # restrict by number of networks
1104             if vnfr["k8s-cluster"].get("nets"):
1105                 k8s_requirements["networks"] = len(vnfr["k8s-cluster"]["nets"])
1106                 if not k8scluster.get("nets") or len(k8scluster["nets"]) < len(vnfr["k8s-cluster"]["nets"]):
1107                     continue
1108             break
1109         else:
1110             raise EngineException("No k8scluster with requirements='{}' at vim_account={} found for member_vnf_index={}"
1111                                   .format(k8s_requirements, vim_account, vnfr["member-vnf-index-ref"]))
1112
1113         for kdur_index, kdur in enumerate(get_iterable(vnfr.get("kdur"))):
1114             # step 3. Fill vnfr info by filling kdur
1115             kdu_text = "kdur.{}.".format(kdur_index)
1116             vnfr_update_rollback[kdu_text + "k8s-cluster.id"] = None
1117             vnfr_update[kdu_text + "k8s-cluster.id"] = k8scluster["_id"]
1118
1119         # step 4. Check VIM networks that forces the selected k8s_cluster
1120         if vnfr.get("k8s-cluster") and vnfr["k8s-cluster"].get("nets"):
1121             k8scluster_net_list = list(k8scluster.get("nets").keys())
1122             for net_index, kdur_net in enumerate(vnfr["k8s-cluster"]["nets"]):
1123                 # get a network from k8s_cluster nets. If name matches use this, if not use other
1124                 if kdur_net["id"] in k8scluster_net_list:  # name matches
1125                     vim_net = k8scluster["nets"][kdur_net["id"]]
1126                     k8scluster_net_list.remove(kdur_net["id"])
1127                 else:
1128                     vim_net = k8scluster["nets"][k8scluster_net_list[0]]
1129                     k8scluster_net_list.pop(0)
1130                 vnfr_update_rollback["k8s-cluster.nets.{}.vim_net".format(net_index)] = None
1131                 vnfr_update["k8s-cluster.nets.{}.vim_net".format(net_index)] = vim_net
1132                 if vim_net and (kdur_net.get("vnf-vld-id") or kdur_net.get("ns-vld-id")):
1133                     ifaces_forcing_vim_network.append({
1134                         "name": kdur_net.get("vnf-vld-id") or kdur_net.get("ns-vld-id"),
1135                         "vnf-vld-id": kdur_net.get("vnf-vld-id"),
1136                         "ns-vld-id": kdur_net.get("ns-vld-id"),
1137                         "vim-network-name": vim_net,   # TODO can it be vim-network-id ???
1138                     })
1139             # TODO check that this forcing is not incompatible with other forcing
1140         return ifaces_forcing_vim_network
1141
1142     def _update_vnfrs(self, session, rollback, nsr, indata):
1143         # get vnfr
1144         nsr_id = nsr["_id"]
1145         vnfrs = self.db.get_list("vnfrs", {"nsr-id-ref": nsr_id})
1146
1147         for vnfr in vnfrs:
1148             vnfr_update = {}
1149             vnfr_update_rollback = {}
1150             member_vnf_index = vnfr["member-vnf-index-ref"]
1151             # update vim-account-id
1152
1153             vim_account = indata["vimAccountId"]
1154             # check instantiate parameters
1155             for vnf_inst_params in get_iterable(indata.get("vnf")):
1156                 if vnf_inst_params["member-vnf-index"] != member_vnf_index:
1157                     continue
1158                 if vnf_inst_params.get("vimAccountId"):
1159                     vim_account = vnf_inst_params.get("vimAccountId")
1160
1161                 # get vnf.vdu.interface instantiation params to update vnfr.vdur.interfaces ip, mac
1162                 for vdu_inst_param in get_iterable(vnf_inst_params.get("vdu")):
1163                     for vdur_index, vdur in enumerate(vnfr["vdur"]):
1164                         if vdu_inst_param["id"] != vdur["vdu-id-ref"]:
1165                             continue
1166                         for iface_inst_param in get_iterable(vdu_inst_param.get("interface")):
1167                             iface_index, _ = next(i for i in enumerate(vdur["interfaces"])
1168                                                   if i[1]["name"] == iface_inst_param["name"])
1169                             vnfr_update_text = "vdur.{}.interfaces.{}".format(vdur_index, iface_index)
1170                             if iface_inst_param.get("ip-address"):
1171                                 vnfr_update[vnfr_update_text + ".ip-address"] = increment_ip_mac(
1172                                     iface_inst_param.get("ip-address"), vdur.get("count-index", 0))
1173                                 vnfr_update[vnfr_update_text + ".fixed-ip"] = True
1174                             if iface_inst_param.get("mac-address"):
1175                                 vnfr_update[vnfr_update_text + ".mac-address"] = increment_ip_mac(
1176                                     iface_inst_param.get("mac-address"), vdur.get("count-index", 0))
1177                                 vnfr_update[vnfr_update_text + ".fixed-mac"] = True
1178                             if iface_inst_param.get("floating-ip-required"):
1179                                 vnfr_update[vnfr_update_text + ".floating-ip-required"] = True
1180                 # get vnf.internal-vld.internal-conection-point instantiation params to update vnfr.vdur.interfaces
1181                 # TODO update vld with the ip-profile
1182                 for ivld_inst_param in get_iterable(vnf_inst_params.get("internal-vld")):
1183                     for icp_inst_param in get_iterable(ivld_inst_param.get("internal-connection-point")):
1184                         # look for iface
1185                         for vdur_index, vdur in enumerate(vnfr["vdur"]):
1186                             for iface_index, iface in enumerate(vdur["interfaces"]):
1187                                 if iface.get("internal-connection-point-ref") == icp_inst_param["id-ref"]:
1188                                     vnfr_update_text = "vdur.{}.interfaces.{}".format(vdur_index, iface_index)
1189                                     if icp_inst_param.get("ip-address"):
1190                                         vnfr_update[vnfr_update_text + ".ip-address"] = increment_ip_mac(
1191                                             icp_inst_param.get("ip-address"), vdur.get("count-index", 0))
1192                                         vnfr_update[vnfr_update_text + ".fixed-ip"] = True
1193                                     if icp_inst_param.get("mac-address"):
1194                                         vnfr_update[vnfr_update_text + ".mac-address"] = increment_ip_mac(
1195                                             icp_inst_param.get("mac-address"), vdur.get("count-index", 0))
1196                                         vnfr_update[vnfr_update_text + ".fixed-mac"] = True
1197                                     break
1198             # get ip address from instantiation parameters.vld.vnfd-connection-point-ref
1199             for vld_inst_param in get_iterable(indata.get("vld")):
1200                 for vnfcp_inst_param in get_iterable(vld_inst_param.get("vnfd-connection-point-ref")):
1201                     if vnfcp_inst_param["member-vnf-index-ref"] != member_vnf_index:
1202                         continue
1203                     # look for iface
1204                     for vdur_index, vdur in enumerate(vnfr["vdur"]):
1205                         for iface_index, iface in enumerate(vdur["interfaces"]):
1206                             if iface.get("external-connection-point-ref") == \
1207                                     vnfcp_inst_param["vnfd-connection-point-ref"]:
1208                                 vnfr_update_text = "vdur.{}.interfaces.{}".format(vdur_index, iface_index)
1209                                 if vnfcp_inst_param.get("ip-address"):
1210                                     vnfr_update[vnfr_update_text + ".ip-address"] = increment_ip_mac(
1211                                         vnfcp_inst_param.get("ip-address"), vdur.get("count-index", 0))
1212                                     vnfr_update[vnfr_update_text + ".fixed-ip"] = True
1213                                 if vnfcp_inst_param.get("mac-address"):
1214                                     vnfr_update[vnfr_update_text + ".mac-address"] = increment_ip_mac(
1215                                         vnfcp_inst_param.get("mac-address"), vdur.get("count-index", 0))
1216                                     vnfr_update[vnfr_update_text + ".fixed-mac"] = True
1217                                 break
1218
1219             vnfr_update["vim-account-id"] = vim_account
1220             vnfr_update_rollback["vim-account-id"] = vnfr.get("vim-account-id")
1221
1222             # get pdu
1223             ifaces_forcing_vim_network = self._look_for_pdu(session, rollback, vnfr, vim_account, vnfr_update,
1224                                                             vnfr_update_rollback)
1225
1226             # get kdus
1227             ifaces_forcing_vim_network += self._look_for_k8scluster(session, rollback, vnfr, vim_account, vnfr_update,
1228                                                                     vnfr_update_rollback)
1229             # update database vnfr
1230             self.db.set_one("vnfrs", {"_id": vnfr["_id"]}, vnfr_update)
1231             rollback.append({"topic": "vnfrs", "_id": vnfr["_id"], "operation": "set", "content": vnfr_update_rollback})
1232
1233             # Update indada in case pdu forces to use a concrete vim-network-name
1234             # TODO check if user has already insert a vim-network-name and raises an error
1235             if not ifaces_forcing_vim_network:
1236                 continue
1237             for iface_info in ifaces_forcing_vim_network:
1238                 if iface_info.get("ns-vld-id"):
1239                     if "vld" not in indata:
1240                         indata["vld"] = []
1241                     indata["vld"].append({key: iface_info[key] for key in
1242                                           ("name", "vim-network-name", "vim-network-id") if iface_info.get(key)})
1243
1244                 elif iface_info.get("vnf-vld-id"):
1245                     if "vnf" not in indata:
1246                         indata["vnf"] = []
1247                     indata["vnf"].append({
1248                         "member-vnf-index": member_vnf_index,
1249                         "internal-vld": [{key: iface_info[key] for key in
1250                                           ("name", "vim-network-name", "vim-network-id") if iface_info.get(key)}]
1251                     })
1252
1253     @staticmethod
1254     def _create_nslcmop(nsr_id, operation, params):
1255         """
1256         Creates a ns-lcm-opp content to be stored at database.
1257         :param nsr_id: internal id of the instance
1258         :param operation: instantiate, terminate, scale, action, ...
1259         :param params: user parameters for the operation
1260         :return: dictionary following SOL005 format
1261         """
1262         now = time()
1263         _id = str(uuid4())
1264         nslcmop = {
1265             "id": _id,
1266             "_id": _id,
1267             "operationState": "PROCESSING",  # COMPLETED,PARTIALLY_COMPLETED,FAILED_TEMP,FAILED,ROLLING_BACK,ROLLED_BACK
1268             "queuePosition": None,
1269             "stage": None,
1270             "errorMessage": None,
1271             "detailedStatus": None,
1272             "statusEnteredTime": now,
1273             "nsInstanceId": nsr_id,
1274             "lcmOperationType": operation,
1275             "startTime": now,
1276             "isAutomaticInvocation": False,
1277             "operationParams": params,
1278             "isCancelPending": False,
1279             "links": {
1280                 "self": "/osm/nslcm/v1/ns_lcm_op_occs/" + _id,
1281                 "nsInstance": "/osm/nslcm/v1/ns_instances/" + nsr_id,
1282             }
1283         }
1284         return nslcmop
1285
1286     def _get_enabled_vims(self, session):
1287         """
1288         Retrieve and return VIM accounts that are accessible by current user and has state ENABLE
1289         :param session: current session with user information
1290         """
1291         db_filter = self._get_project_filter(session)
1292         db_filter["_admin.operationalState"] = "ENABLED"
1293         vims = self.db.get_list("vim_accounts", db_filter)
1294         vimAccounts = []
1295         for vim in vims:
1296             vimAccounts.append(vim['_id'])
1297         return vimAccounts
1298
1299     def new(self, rollback, session, indata=None, kwargs=None, headers=None, slice_object=False):
1300         """
1301         Performs a new operation over a ns
1302         :param rollback: list to append created items at database in case a rollback must to be done
1303         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1304         :param indata: descriptor with the parameters of the operation. It must contains among others
1305             nsInstanceId: _id of the nsr to perform the operation
1306             operation: it can be: instantiate, terminate, action, TODO: update, heal
1307         :param kwargs: used to override the indata descriptor
1308         :param headers: http request headers
1309         :return: id of the nslcmops
1310         """
1311         def check_if_nsr_is_not_slice_member(session, nsr_id):
1312             nsis = None
1313             db_filter = self._get_project_filter(session)
1314             db_filter["_admin.nsrs-detailed-list.ANYINDEX.nsrId"] = nsr_id
1315             nsis = self.db.get_one("nsis", db_filter, fail_on_empty=False, fail_on_more=False)
1316             if nsis:
1317                 raise EngineException("The NS instance {} cannot be terminated because is used by the slice {}".format(
1318                                       nsr_id, nsis["_id"]), http_code=HTTPStatus.CONFLICT)
1319
1320         try:
1321             # Override descriptor with query string kwargs
1322             self._update_input_with_kwargs(indata, kwargs, yaml_format=True)
1323             operation = indata["lcmOperationType"]
1324             nsInstanceId = indata["nsInstanceId"]
1325
1326             validate_input(indata, self.operation_schema[operation])
1327             # get ns from nsr_id
1328             _filter = BaseTopic._get_project_filter(session)
1329             _filter["_id"] = nsInstanceId
1330             nsr = self.db.get_one("nsrs", _filter)
1331
1332             # initial checking
1333             if operation == "terminate" and slice_object is False:
1334                 check_if_nsr_is_not_slice_member(session, nsr["_id"])
1335             if not nsr["_admin"].get("nsState") or nsr["_admin"]["nsState"] == "NOT_INSTANTIATED":
1336                 if operation == "terminate" and indata.get("autoremove"):
1337                     # NSR must be deleted
1338                     return None, None    # a none in this case is used to indicate not instantiated. It can be removed
1339                 if operation != "instantiate":
1340                     raise EngineException("ns_instance '{}' cannot be '{}' because it is not instantiated".format(
1341                         nsInstanceId, operation), HTTPStatus.CONFLICT)
1342             else:
1343                 if operation == "instantiate" and not session["force"]:
1344                     raise EngineException("ns_instance '{}' cannot be '{}' because it is already instantiated".format(
1345                         nsInstanceId, operation), HTTPStatus.CONFLICT)
1346             self._check_ns_operation(session, nsr, operation, indata)
1347
1348             if operation == "instantiate":
1349                 self._update_vnfrs(session, rollback, nsr, indata)
1350
1351             nslcmop_desc = self._create_nslcmop(nsInstanceId, operation, indata)
1352             _id = nslcmop_desc["_id"]
1353             self.format_on_new(nslcmop_desc, session["project_id"], make_public=session["public"])
1354             if indata.get("placement-engine"):
1355                 # Save valid vim accounts in lcm operation descriptor
1356                 nslcmop_desc['operationParams']['validVimAccounts'] = self._get_enabled_vims(session)
1357             self.db.create("nslcmops", nslcmop_desc)
1358             rollback.append({"topic": "nslcmops", "_id": _id})
1359             if not slice_object:
1360                 self.msg.write("ns", operation, nslcmop_desc)
1361             return _id, None
1362         except ValidationError as e:  # TODO remove try Except, it is captured at nbi.py
1363             raise EngineException(e, HTTPStatus.UNPROCESSABLE_ENTITY)
1364         # except DbException as e:
1365         #     raise EngineException("Cannot get ns_instance '{}': {}".format(e), HTTPStatus.NOT_FOUND)
1366
1367     def delete(self, session, _id, dry_run=False, not_send_msg=None):
1368         raise EngineException("Method delete called directly", HTTPStatus.INTERNAL_SERVER_ERROR)
1369
1370     def edit(self, session, _id, indata=None, kwargs=None, content=None):
1371         raise EngineException("Method edit called directly", HTTPStatus.INTERNAL_SERVER_ERROR)
1372
1373
1374 class NsiTopic(BaseTopic):
1375     topic = "nsis"
1376     topic_msg = "nsi"
1377     quota_name = "slice_instances"
1378
1379     def __init__(self, db, fs, msg, auth):
1380         BaseTopic.__init__(self, db, fs, msg, auth)
1381         self.nsrTopic = NsrTopic(db, fs, msg, auth)
1382
1383     @staticmethod
1384     def _format_ns_request(ns_request):
1385         formated_request = copy(ns_request)
1386         # TODO: Add request params
1387         return formated_request
1388
1389     @staticmethod
1390     def _format_addional_params(slice_request):
1391         """
1392         Get and format user additional params for NS or VNF
1393         :param slice_request: User instantiation additional parameters
1394         :return: a formatted copy of additional params or None if not supplied
1395         """
1396         additional_params = copy(slice_request.get("additionalParamsForNsi"))
1397         if additional_params:
1398             for k, v in additional_params.items():
1399                 if not isinstance(k, str):
1400                     raise EngineException("Invalid param at additionalParamsForNsi:{}. Only string keys are allowed".
1401                                           format(k))
1402                 if "." in k or "$" in k:
1403                     raise EngineException("Invalid param at additionalParamsForNsi:{}. Keys must not contain dots or $".
1404                                           format(k))
1405                 if isinstance(v, (dict, tuple, list)):
1406                     additional_params[k] = "!!yaml " + safe_dump(v)
1407         return additional_params
1408
1409     def _check_descriptor_dependencies(self, session, descriptor):
1410         """
1411         Check that the dependent descriptors exist on a new descriptor or edition
1412         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1413         :param descriptor: descriptor to be inserted or edit
1414         :return: None or raises exception
1415         """
1416         if not descriptor.get("nst-ref"):
1417             return
1418         nstd_id = descriptor["nst-ref"]
1419         if not self.get_item_list(session, "nsts", {"id": nstd_id}):
1420             raise EngineException("Descriptor error at nst-ref='{}' references a non exist nstd".format(nstd_id),
1421                                   http_code=HTTPStatus.CONFLICT)
1422
1423     def check_conflict_on_del(self, session, _id, db_content):
1424         """
1425         Check that NSI is not instantiated
1426         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1427         :param _id: nsi internal id
1428         :param db_content: The database content of the _id
1429         :return: None or raises EngineException with the conflict
1430         """
1431         if session["force"]:
1432             return
1433         nsi = db_content
1434         if nsi["_admin"].get("nsiState") == "INSTANTIATED":
1435             raise EngineException("nsi '{}' cannot be deleted because it is in 'INSTANTIATED' state. "
1436                                   "Launch 'terminate' operation first; or force deletion".format(_id),
1437                                   http_code=HTTPStatus.CONFLICT)
1438
1439     def delete_extra(self, session, _id, db_content, not_send_msg=None):
1440         """
1441         Deletes associated nsilcmops from database. Deletes associated filesystem.
1442          Set usageState of nst
1443         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1444         :param _id: server internal id
1445         :param db_content: The database content of the descriptor
1446         :param not_send_msg: To not send message (False) or store content (list) instead
1447         :return: None if ok or raises EngineException with the problem
1448         """
1449
1450         # Deleting the nsrs belonging to nsir
1451         nsir = db_content
1452         for nsrs_detailed_item in nsir["_admin"]["nsrs-detailed-list"]:
1453             nsr_id = nsrs_detailed_item["nsrId"]
1454             if nsrs_detailed_item.get("shared"):
1455                 _filter = {"_admin.nsrs-detailed-list.ANYINDEX.shared": True,
1456                            "_admin.nsrs-detailed-list.ANYINDEX.nsrId": nsr_id,
1457                            "_id.ne": nsir["_id"]}
1458                 nsi = self.db.get_one("nsis", _filter, fail_on_empty=False, fail_on_more=False)
1459                 if nsi:  # last one using nsr
1460                     continue
1461             try:
1462                 self.nsrTopic.delete(session, nsr_id, dry_run=False, not_send_msg=not_send_msg)
1463             except (DbException, EngineException) as e:
1464                 if e.http_code == HTTPStatus.NOT_FOUND:
1465                     pass
1466                 else:
1467                     raise
1468
1469         # delete related nsilcmops database entries
1470         self.db.del_list("nsilcmops", {"netsliceInstanceId": _id})
1471
1472         # Check and set used NST usage state
1473         nsir_admin = nsir.get("_admin")
1474         if nsir_admin and nsir_admin.get("nst-id"):
1475             # check if used by another NSI
1476             nsis_list = self.db.get_one("nsis", {"nst-id": nsir_admin["nst-id"]},
1477                                         fail_on_empty=False, fail_on_more=False)
1478             if not nsis_list:
1479                 self.db.set_one("nsts", {"_id": nsir_admin["nst-id"]}, {"_admin.usageState": "NOT_IN_USE"})
1480
1481     def new(self, rollback, session, indata=None, kwargs=None, headers=None):
1482         """
1483         Creates a new netslice instance record into database. It also creates needed nsrs and vnfrs
1484         :param rollback: list to append the created items at database in case a rollback must be done
1485         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1486         :param indata: params to be used for the nsir
1487         :param kwargs: used to override the indata descriptor
1488         :param headers: http request headers
1489         :return: the _id of nsi descriptor created at database
1490         """
1491
1492         try:
1493             step = "checking quotas"
1494             self.check_quota(session)
1495
1496             step = ""
1497             slice_request = self._remove_envelop(indata)
1498             # Override descriptor with query string kwargs
1499             self._update_input_with_kwargs(slice_request, kwargs)
1500             slice_request = self._validate_input_new(slice_request, session["force"])
1501
1502             # look for nstd
1503             step = "getting nstd id='{}' from database".format(slice_request.get("nstId"))
1504             _filter = self._get_project_filter(session)
1505             _filter["_id"] = slice_request["nstId"]
1506             nstd = self.db.get_one("nsts", _filter)
1507             # check NST is not disabled
1508             step = "checking NST operationalState"
1509             if nstd["_admin"]["operationalState"] == "DISABLED":
1510                 raise EngineException("nst with id '{}' is DISABLED, and thus cannot be used to create a netslice "
1511                                       "instance".format(slice_request["nstId"]), http_code=HTTPStatus.CONFLICT)
1512             del _filter["_id"]
1513
1514             # check NSD is not disabled
1515             step = "checking operationalState"
1516             if nstd["_admin"]["operationalState"] == "DISABLED":
1517                 raise EngineException("nst with id '{}' is DISABLED, and thus cannot be used to create "
1518                                       "a network slice".format(slice_request["nstId"]), http_code=HTTPStatus.CONFLICT)
1519
1520             nstd.pop("_admin", None)
1521             nstd_id = nstd.pop("_id", None)
1522             nsi_id = str(uuid4())
1523             step = "filling nsi_descriptor with input data"
1524
1525             # Creating the NSIR
1526             nsi_descriptor = {
1527                 "id": nsi_id,
1528                 "name": slice_request["nsiName"],
1529                 "description": slice_request.get("nsiDescription", ""),
1530                 "datacenter": slice_request["vimAccountId"],
1531                 "nst-ref": nstd["id"],
1532                 "instantiation_parameters": slice_request,
1533                 "network-slice-template": nstd,
1534                 "nsr-ref-list": [],
1535                 "vlr-list": [],
1536                 "_id": nsi_id,
1537                 "additionalParamsForNsi": self._format_addional_params(slice_request)
1538             }
1539
1540             step = "creating nsi at database"
1541             self.format_on_new(nsi_descriptor, session["project_id"], make_public=session["public"])
1542             nsi_descriptor["_admin"]["nsiState"] = "NOT_INSTANTIATED"
1543             nsi_descriptor["_admin"]["netslice-subnet"] = None
1544             nsi_descriptor["_admin"]["deployed"] = {}
1545             nsi_descriptor["_admin"]["deployed"]["RO"] = []
1546             nsi_descriptor["_admin"]["nst-id"] = nstd_id
1547
1548             # Creating netslice-vld for the RO.
1549             step = "creating netslice-vld at database"
1550
1551             # Building the vlds list to be deployed
1552             # From netslice descriptors, creating the initial list
1553             nsi_vlds = []
1554
1555             for netslice_vlds in get_iterable(nstd.get("netslice-vld")):
1556                 # Getting template Instantiation parameters from NST
1557                 nsi_vld = deepcopy(netslice_vlds)
1558                 nsi_vld["shared-nsrs-list"] = []
1559                 nsi_vld["vimAccountId"] = slice_request["vimAccountId"]
1560                 nsi_vlds.append(nsi_vld)
1561
1562             nsi_descriptor["_admin"]["netslice-vld"] = nsi_vlds
1563             # Creating netslice-subnet_record.
1564             needed_nsds = {}
1565             services = []
1566
1567             # Updating the nstd with the nsd["_id"] associated to the nss -> services list
1568             for member_ns in nstd["netslice-subnet"]:
1569                 nsd_id = member_ns["nsd-ref"]
1570                 step = "getting nstd id='{}' constituent-nsd='{}' from database".format(
1571                     member_ns["nsd-ref"], member_ns["id"])
1572                 if nsd_id not in needed_nsds:
1573                     # Obtain nsd
1574                     _filter["id"] = nsd_id
1575                     nsd = self.db.get_one("nsds", _filter, fail_on_empty=True, fail_on_more=True)
1576                     del _filter["id"]
1577                     nsd.pop("_admin")
1578                     needed_nsds[nsd_id] = nsd
1579                 else:
1580                     nsd = needed_nsds[nsd_id]
1581                 member_ns["_id"] = needed_nsds[nsd_id].get("_id")
1582                 services.append(member_ns)
1583
1584                 step = "filling nsir nsd-id='{}' constituent-nsd='{}' from database".format(
1585                     member_ns["nsd-ref"], member_ns["id"])
1586
1587             # creates Network Services records (NSRs)
1588             step = "creating nsrs at database using NsrTopic.new()"
1589             ns_params = slice_request.get("netslice-subnet")
1590             nsrs_list = []
1591             nsi_netslice_subnet = []
1592             for service in services:
1593                 # Check if the netslice-subnet is shared and if it is share if the nss exists
1594                 _id_nsr = None
1595                 indata_ns = {}
1596                 # Is the nss shared and instantiated?
1597                 _filter["_admin.nsrs-detailed-list.ANYINDEX.shared"] = True
1598                 _filter["_admin.nsrs-detailed-list.ANYINDEX.nsd-id"] = service["nsd-ref"]
1599                 _filter["_admin.nsrs-detailed-list.ANYINDEX.nss-id"] = service["id"]
1600                 nsi = self.db.get_one("nsis", _filter, fail_on_empty=False, fail_on_more=False)
1601                 if nsi and service.get("is-shared-nss"):
1602                     nsrs_detailed_list = nsi["_admin"]["nsrs-detailed-list"]
1603                     for nsrs_detailed_item in nsrs_detailed_list:
1604                         if nsrs_detailed_item["nsd-id"] == service["nsd-ref"]:
1605                             if nsrs_detailed_item["nss-id"] == service["id"]:
1606                                 _id_nsr = nsrs_detailed_item["nsrId"]
1607                                 break
1608                     for netslice_subnet in nsi["_admin"]["netslice-subnet"]:
1609                         if netslice_subnet["nss-id"] == service["id"]:
1610                             indata_ns = netslice_subnet
1611                             break
1612                 else:
1613                     indata_ns = {}
1614                     if service.get("instantiation-parameters"):
1615                         indata_ns = deepcopy(service["instantiation-parameters"])
1616                         # del service["instantiation-parameters"]
1617
1618                     indata_ns["nsdId"] = service["_id"]
1619                     indata_ns["nsName"] = slice_request.get("nsiName") + "." + service["id"]
1620                     indata_ns["vimAccountId"] = slice_request.get("vimAccountId")
1621                     indata_ns["nsDescription"] = service["description"]
1622                     if slice_request.get("ssh_keys"):
1623                         indata_ns["ssh_keys"] = slice_request.get("ssh_keys")
1624
1625                     if ns_params:
1626                         for ns_param in ns_params:
1627                             if ns_param.get("id") == service["id"]:
1628                                 copy_ns_param = deepcopy(ns_param)
1629                                 del copy_ns_param["id"]
1630                                 indata_ns.update(copy_ns_param)
1631                                 break
1632
1633                     # Creates Nsr objects
1634                     _id_nsr, _ = self.nsrTopic.new(rollback, session, indata_ns, kwargs, headers)
1635                 nsrs_item = {"nsrId": _id_nsr, "shared": service.get("is-shared-nss"), "nsd-id": service["nsd-ref"],
1636                              "nss-id": service["id"], "nslcmop_instantiate": None}
1637                 indata_ns["nss-id"] = service["id"]
1638                 nsrs_list.append(nsrs_item)
1639                 nsi_netslice_subnet.append(indata_ns)
1640                 nsr_ref = {"nsr-ref": _id_nsr}
1641                 nsi_descriptor["nsr-ref-list"].append(nsr_ref)
1642
1643             # Adding the nsrs list to the nsi
1644             nsi_descriptor["_admin"]["nsrs-detailed-list"] = nsrs_list
1645             nsi_descriptor["_admin"]["netslice-subnet"] = nsi_netslice_subnet
1646             self.db.set_one("nsts", {"_id": slice_request["nstId"]}, {"_admin.usageState": "IN_USE"})
1647
1648             # Creating the entry in the database
1649             self.db.create("nsis", nsi_descriptor)
1650             rollback.append({"topic": "nsis", "_id": nsi_id})
1651             return nsi_id, None
1652         except Exception as e:   # TODO remove try Except, it is captured at nbi.py
1653             self.logger.exception("Exception {} at NsiTopic.new()".format(e), exc_info=True)
1654             raise EngineException("Error {}: {}".format(step, e))
1655         except ValidationError as e:
1656             raise EngineException(e, HTTPStatus.UNPROCESSABLE_ENTITY)
1657
1658     def edit(self, session, _id, indata=None, kwargs=None, content=None):
1659         raise EngineException("Method edit called directly", HTTPStatus.INTERNAL_SERVER_ERROR)
1660
1661
1662 class NsiLcmOpTopic(BaseTopic):
1663     topic = "nsilcmops"
1664     topic_msg = "nsi"
1665     operation_schema = {  # mapping between operation and jsonschema to validate
1666         "instantiate": nsi_instantiate,
1667         "terminate": None
1668     }
1669
1670     def __init__(self, db, fs, msg, auth):
1671         BaseTopic.__init__(self, db, fs, msg, auth)
1672         self.nsi_NsLcmOpTopic = NsLcmOpTopic(self.db, self.fs, self.msg, self.auth)
1673
1674     def _check_nsi_operation(self, session, nsir, operation, indata):
1675         """
1676         Check that user has enter right parameters for the operation
1677         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1678         :param operation: it can be: instantiate, terminate, action, TODO: update, heal
1679         :param indata: descriptor with the parameters of the operation
1680         :return: None
1681         """
1682         nsds = {}
1683         nstd = nsir["network-slice-template"]
1684
1685         def check_valid_netslice_subnet_id(nstId):
1686             # TODO change to vnfR (??)
1687             for netslice_subnet in nstd["netslice-subnet"]:
1688                 if nstId == netslice_subnet["id"]:
1689                     nsd_id = netslice_subnet["nsd-ref"]
1690                     if nsd_id not in nsds:
1691                         _filter = self._get_project_filter(session)
1692                         _filter["id"] = nsd_id
1693                         nsds[nsd_id] = self.db.get_one("nsds", _filter)
1694                     return nsds[nsd_id]
1695             else:
1696                 raise EngineException("Invalid parameter nstId='{}' is not one of the "
1697                                       "nst:netslice-subnet".format(nstId))
1698         if operation == "instantiate":
1699             # check the existance of netslice-subnet items
1700             for in_nst in get_iterable(indata.get("netslice-subnet")):
1701                 check_valid_netslice_subnet_id(in_nst["id"])
1702
1703     def _create_nsilcmop(self, session, netsliceInstanceId, operation, params):
1704         now = time()
1705         _id = str(uuid4())
1706         nsilcmop = {
1707             "id": _id,
1708             "_id": _id,
1709             "operationState": "PROCESSING",  # COMPLETED,PARTIALLY_COMPLETED,FAILED_TEMP,FAILED,ROLLING_BACK,ROLLED_BACK
1710             "statusEnteredTime": now,
1711             "netsliceInstanceId": netsliceInstanceId,
1712             "lcmOperationType": operation,
1713             "startTime": now,
1714             "isAutomaticInvocation": False,
1715             "operationParams": params,
1716             "isCancelPending": False,
1717             "links": {
1718                 "self": "/osm/nsilcm/v1/nsi_lcm_op_occs/" + _id,
1719                 "netsliceInstanceId": "/osm/nsilcm/v1/netslice_instances/" + netsliceInstanceId,
1720             }
1721         }
1722         return nsilcmop
1723
1724     def add_shared_nsr_2vld(self, nsir, nsr_item):
1725         for nst_sb_item in nsir["network-slice-template"].get("netslice-subnet"):
1726             if nst_sb_item.get("is-shared-nss"):
1727                 for admin_subnet_item in nsir["_admin"].get("netslice-subnet"):
1728                     if admin_subnet_item["nss-id"] == nst_sb_item["id"]:
1729                         for admin_vld_item in nsir["_admin"].get("netslice-vld"):
1730                             for admin_vld_nss_cp_ref_item in admin_vld_item["nss-connection-point-ref"]:
1731                                 if admin_subnet_item["nss-id"] == admin_vld_nss_cp_ref_item["nss-ref"]:
1732                                     if not nsr_item["nsrId"] in admin_vld_item["shared-nsrs-list"]:
1733                                         admin_vld_item["shared-nsrs-list"].append(nsr_item["nsrId"])
1734                                     break
1735         # self.db.set_one("nsis", {"_id": nsir["_id"]}, nsir)
1736         self.db.set_one("nsis", {"_id": nsir["_id"]}, {"_admin.netslice-vld": nsir["_admin"].get("netslice-vld")})
1737
1738     def new(self, rollback, session, indata=None, kwargs=None, headers=None):
1739         """
1740         Performs a new operation over a ns
1741         :param rollback: list to append created items at database in case a rollback must to be done
1742         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1743         :param indata: descriptor with the parameters of the operation. It must contains among others
1744             netsliceInstanceId: _id of the nsir to perform the operation
1745             operation: it can be: instantiate, terminate, action, TODO: update, heal
1746         :param kwargs: used to override the indata descriptor
1747         :param headers: http request headers
1748         :return: id of the nslcmops
1749         """
1750         try:
1751             # Override descriptor with query string kwargs
1752             self._update_input_with_kwargs(indata, kwargs)
1753             operation = indata["lcmOperationType"]
1754             netsliceInstanceId = indata["netsliceInstanceId"]
1755             validate_input(indata, self.operation_schema[operation])
1756
1757             # get nsi from netsliceInstanceId
1758             _filter = self._get_project_filter(session)
1759             _filter["_id"] = netsliceInstanceId
1760             nsir = self.db.get_one("nsis", _filter)
1761             logging_prefix = "nsi={} {} ".format(netsliceInstanceId, operation)
1762             del _filter["_id"]
1763
1764             # initial checking
1765             if not nsir["_admin"].get("nsiState") or nsir["_admin"]["nsiState"] == "NOT_INSTANTIATED":
1766                 if operation == "terminate" and indata.get("autoremove"):
1767                     # NSIR must be deleted
1768                     return None, None    # a none in this case is used to indicate not instantiated. It can be removed
1769                 if operation != "instantiate":
1770                     raise EngineException("netslice_instance '{}' cannot be '{}' because it is not instantiated".format(
1771                         netsliceInstanceId, operation), HTTPStatus.CONFLICT)
1772             else:
1773                 if operation == "instantiate" and not session["force"]:
1774                     raise EngineException("netslice_instance '{}' cannot be '{}' because it is already instantiated".
1775                                           format(netsliceInstanceId, operation), HTTPStatus.CONFLICT)
1776
1777             # Creating all the NS_operation (nslcmop)
1778             # Get service list from db
1779             nsrs_list = nsir["_admin"]["nsrs-detailed-list"]
1780             nslcmops = []
1781             # nslcmops_item = None
1782             for index, nsr_item in enumerate(nsrs_list):
1783                 nsr_id = nsr_item["nsrId"]
1784                 if nsr_item.get("shared"):
1785                     _filter["_admin.nsrs-detailed-list.ANYINDEX.shared"] = True
1786                     _filter["_admin.nsrs-detailed-list.ANYINDEX.nsrId"] = nsr_id
1787                     _filter["_admin.nsrs-detailed-list.ANYINDEX.nslcmop_instantiate.ne"] = None
1788                     _filter["_id.ne"] = netsliceInstanceId
1789                     nsi = self.db.get_one("nsis", _filter, fail_on_empty=False, fail_on_more=False)
1790                     if operation == "terminate":
1791                         _update = {"_admin.nsrs-detailed-list.{}.nslcmop_instantiate".format(index): None}
1792                         self.db.set_one("nsis", {"_id": nsir["_id"]}, _update)
1793                         if nsi:  # other nsi is using this nsr and it needs this nsr instantiated
1794                             continue  # do not create nsilcmop
1795                     else:  # instantiate
1796                         # looks the first nsi fulfilling the conditions but not being the current NSIR
1797                         if nsi:
1798                             nsi_nsr_item = next(n for n in nsi["_admin"]["nsrs-detailed-list"] if
1799                                                 n["nsrId"] == nsr_id and n["shared"] and
1800                                                 n["nslcmop_instantiate"])
1801                             self.add_shared_nsr_2vld(nsir, nsr_item)
1802                             nslcmops.append(nsi_nsr_item["nslcmop_instantiate"])
1803                             _update = {"_admin.nsrs-detailed-list.{}".format(index): nsi_nsr_item}
1804                             self.db.set_one("nsis", {"_id": nsir["_id"]}, _update)
1805                             # continue to not create nslcmop since nsrs is shared and nsrs was created
1806                             continue
1807                         else:
1808                             self.add_shared_nsr_2vld(nsir, nsr_item)
1809
1810                 # create operation
1811                 try:
1812                     indata_ns = {
1813                         "lcmOperationType": operation,
1814                         "nsInstanceId": nsr_id,
1815                         # Including netslice_id in the ns instantiate Operation
1816                         "netsliceInstanceId": netsliceInstanceId,
1817                     }
1818                     if operation == "instantiate":
1819                         service = self.db.get_one("nsrs", {"_id": nsr_id})
1820                         indata_ns.update(service["instantiate_params"])
1821
1822                     # Creating NS_LCM_OP with the flag slice_object=True to not trigger the service instantiation
1823                     # message via kafka bus
1824                     nslcmop, _ = self.nsi_NsLcmOpTopic.new(rollback, session, indata_ns, None, headers,
1825                                                            slice_object=True)
1826                     nslcmops.append(nslcmop)
1827                     if operation == "instantiate":
1828                         _update = {"_admin.nsrs-detailed-list.{}.nslcmop_instantiate".format(index): nslcmop}
1829                         self.db.set_one("nsis", {"_id": nsir["_id"]}, _update)
1830                 except (DbException, EngineException) as e:
1831                     if e.http_code == HTTPStatus.NOT_FOUND:
1832                         self.logger.info(logging_prefix + "skipping NS={} because not found".format(nsr_id))
1833                         pass
1834                     else:
1835                         raise
1836
1837             # Creates nsilcmop
1838             indata["nslcmops_ids"] = nslcmops
1839             self._check_nsi_operation(session, nsir, operation, indata)
1840
1841             nsilcmop_desc = self._create_nsilcmop(session, netsliceInstanceId, operation, indata)
1842             self.format_on_new(nsilcmop_desc, session["project_id"], make_public=session["public"])
1843             _id = self.db.create("nsilcmops", nsilcmop_desc)
1844             rollback.append({"topic": "nsilcmops", "_id": _id})
1845             self.msg.write("nsi", operation, nsilcmop_desc)
1846             return _id, None
1847         except ValidationError as e:
1848             raise EngineException(e, HTTPStatus.UNPROCESSABLE_ENTITY)
1849
1850     def delete(self, session, _id, dry_run=False, not_send_msg=None):
1851         raise EngineException("Method delete called directly", HTTPStatus.INTERNAL_SERVER_ERROR)
1852
1853     def edit(self, session, _id, indata=None, kwargs=None, content=None):
1854         raise EngineException("Method edit called directly", HTTPStatus.INTERNAL_SERVER_ERROR)