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             additional_params, vdu_params = self._format_additional_params(
 551                 ns_request, vnf_index, vdu_id=vdu["id"], descriptor=vnfd)
 552             vdur = {
 553                 "vdu-id-ref": vdu["id"],
 554                 # TODO      "name": ""     Name of the VDU in the VIM
 555                 "ip-address": None,  # mgmt-interface filled by LCM
 556                 # "vim-id", "flavor-id", "image-id", "management-ip" # filled by LCM
 557                 "internal-connection-point": [],
 558                 "interfaces": [],
 559                 "additionalParams": additional_params,
 560                 "vdu-name": vdu["name"]
 561             }
 562             if vdu_params and vdu_params.get("config-units"):
 563                 vdur["config-units"] = vdu_params["config-units"]
 564             if deep_get(vdu, ("supplemental-boot-data", "boot-data-drive")):
 565                 vdur["boot-data-drive"] = vdu["supplemental-boot-data"]["boot-data-drive"]
 566             if vdu.get("pdu-type"):
 567                 vdur["pdu-type"] = vdu["pdu-type"]
 568                 vdur["name"] = vdu["pdu-type"]
 569             # TODO volumes: name, volume-id
 570             for icp in vdu.get("int-cpd", ()):
 571                 vdu_icp = {
 572                     "id": icp["id"],
 573                     "connection-point-id": icp["id"],
 574                     "name": icp.get("id"),
 575                 }
 576
 577                 if "port-security-enabled" in icp:
 578                     vdu_icp["port-security-enabled"] = icp["port-security-enabled"]
 579
 580                 if "port-security-disable-strategy" in icp:
 581                     vdu_icp["port-security-disable-strategy"] = icp["port-security-disable-strategy"]
 582
 583                 vdur["internal-connection-point"].append(vdu_icp)
 584
 585                 for iface in icp.get("virtual-network-interface-requirement", ()):
 586                     iface_fields = ("name", "mac-address")
 587                     vdu_iface = {x: iface[x] for x in iface_fields if iface.get(x) is not None}
 588
 589                     vdu_iface["internal-connection-point-ref"] = vdu_icp["id"]
 590                     for ext_cp in vnfd.get("ext-cpd", ()):
 591                         if not ext_cp.get("int-cpd"):
 592                             continue
 593                         if ext_cp["int-cpd"].get("vdu-id") != vdu["id"]:
 594                             continue
 595                         if icp["id"] == ext_cp["int-cpd"].get("cpd"):
 596                             vdu_iface["external-connection-point-ref"] = ext_cp.get("id")
 597                             break
 598
 599                     if vnfd_mgmt_cp and vdu_iface.get("external-connection-point-ref") == vnfd_mgmt_cp:
 600                         vdu_iface["mgmt-vnf"] = True
 601                         vdu_iface["mgmt-interface"] = True  # TODO change to mgmt-vdu
 602
 603                     if iface.get("virtual-interface"):
 604                         vdu_iface.update(deepcopy(iface["virtual-interface"]))
 605
 606                     # look for network where this interface is connected
 607                     iface_ext_cp = vdu_iface.get("external-connection-point-ref")
 608                     if iface_ext_cp:
 609                         # TODO: Change for multiple df support
 610                         for df in get_iterable(nsd.get("df")):
 611                             for vnf_profile in get_iterable(df.get("vnf-profile")):
 612                                 for vlc_index, vlc in \
 613                                         enumerate(get_iterable(vnf_profile.get("virtual-link-connectivity"))):
 614                                     for cpd in get_iterable(vlc.get("constituent-cpd-id")):
 615                                         if cpd.get("constituent-cpd-id") == iface_ext_cp:
 616                                             vdu_iface["ns-vld-id"] = vlc.get("virtual-link-profile-id")
 617                                             # if iface type is SRIOV or PASSTHROUGH, set pci-interfaces flag to True
 618                                             if vdu_iface.get("type") in ("SR-IOV", "PCI-PASSTHROUGH"):
 619                                                 nsr_descriptor["vld"][vlc_index]["pci-interfaces"] = True
 620                                             break
 621                     elif vdu_iface.get("internal-connection-point-ref"):
 622                         vdu_iface["vnf-vld-id"] = icp.get("int-virtual-link-desc")
 623                         # TODO: store fixed IP address in the record (if it exists in the ICP)
 624                         # if iface type is SRIOV or PASSTHROUGH, set pci-interfaces flag to True
 625                         if vdu_iface.get("type") in ("SR-IOV", "PCI-PASSTHROUGH"):
 626                             ivld_index = utils.find_index_in_list(vnfd.get("int-virtual-link-desc", ()),
 627                                                                   lambda ivld:
 628                                                                   ivld["id"] == icp.get("int-virtual-link-desc")
 629                                                                   )
 630                             vnfr_descriptor["vld"][ivld_index]["pci-interfaces"] = True
 631
 632                     vdur["interfaces"].append(vdu_iface)
 633
 634             if vdu.get("sw-image-desc"):
 635                 sw_image = utils.find_in_list(
 636                     vnfd.get("sw-image-desc", ()),
 637                     lambda image: image["id"] == vdu.get("sw-image-desc"))
 638                 nsr_sw_image_data = utils.find_in_list(
 639                     nsr_descriptor["image"],
 640                     lambda nsr_image: (nsr_image.get("image") == sw_image.get("image"))
 641                 )
 642                 vdur["ns-image-id"] = nsr_sw_image_data["id"]
 643
 644             if vdu.get("alternative-sw-image-desc"):
 645                 alt_image_ids = []
 646                 for alt_image_id in vdu.get("alternative-sw-image-desc", ()):
 647                     sw_image = utils.find_in_list(
 648                         vnfd.get("sw-image-desc", ()),
 649                         lambda image: image["id"] == alt_image_id)
 650                     nsr_sw_image_data = utils.find_in_list(
 651                         nsr_descriptor["image"],
 652                         lambda nsr_image: (nsr_image.get("image") == sw_image.get("image"))
 653                     )
 654                     alt_image_ids.append(nsr_sw_image_data["id"])
 655                 vdur["alt-image-ids"] = alt_image_ids
 656
 657             flavor_data_name = vdu["id"][:56] + "-flv"
 658             nsr_flavor_desc = utils.find_in_list(
 659                 nsr_descriptor["flavor"],
 660                 lambda flavor: flavor["name"] == flavor_data_name)
 661
 662             if nsr_flavor_desc:
 663                 vdur["ns-flavor-id"] = nsr_flavor_desc["id"]
 664
 665             count = int(vdu.get("count", 1))
 666             for index in range(0, count):
 667                 vdur = deepcopy(vdur)
 668                 for iface in vdur["interfaces"]:
 669                     if iface.get("ip-address"):
 670                         iface["ip-address"] = increment_ip_mac(iface["ip-address"])
 671                     if iface.get("mac-address"):
 672                         iface["mac-address"] = increment_ip_mac(iface["mac-address"])
 673
 674                 vdur["_id"] = str(uuid4())
 675                 vdur["id"] = vdur["_id"]
 676                 vdur["count-index"] = index
 677                 vnfr_descriptor["vdur"].append(vdur)
 678
 679         return vnfr_descriptor
 680
 681     def edit(self, session, _id, indata=None, kwargs=None, content=None):
 682         raise EngineException("Method edit called directly", HTTPStatus.INTERNAL_SERVER_ERROR)
 683
 684
 685 class VnfrTopic(BaseTopic):
 686     topic = "vnfrs"
 687     topic_msg = None
 688
 689     def __init__(self, db, fs, msg, auth):
 690         BaseTopic.__init__(self, db, fs, msg, auth)
 691
 692     def delete(self, session, _id, dry_run=False, not_send_msg=None):
 693         raise EngineException("Method delete called directly", HTTPStatus.INTERNAL_SERVER_ERROR)
 694
 695     def edit(self, session, _id, indata=None, kwargs=None, content=None):
 696         raise EngineException("Method edit called directly", HTTPStatus.INTERNAL_SERVER_ERROR)
 697
 698     def new(self, rollback, session, indata=None, kwargs=None, headers=None):
 699         # Not used because vnfrs are created and deleted by NsrTopic class directly
 700         raise EngineException("Method new called directly", HTTPStatus.INTERNAL_SERVER_ERROR)
 701
 702
 703 class NsLcmOpTopic(BaseTopic):
 704     topic = "nslcmops"
 705     topic_msg = "ns"
 706     operation_schema = {    # mapping between operation and jsonschema to validate
 707         "instantiate": ns_instantiate,
 708         "action": ns_action,
 709         "scale": ns_scale,
 710         "terminate": ns_terminate,
 711     }
 712
 713     def __init__(self, db, fs, msg, auth):
 714         BaseTopic.__init__(self, db, fs, msg, auth)
 715
 716     def _check_ns_operation(self, session, nsr, operation, indata):
 717         """
 718         Check that user has enter right parameters for the operation
 719         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
 720         :param operation: it can be: instantiate, terminate, action, TODO: update, heal
 721         :param indata: descriptor with the parameters of the operation
 722         :return: None
 723         """
 724         if operation == "action":
 725             self._check_action_ns_operation(indata, nsr)
 726         elif operation == "scale":
 727             self._check_scale_ns_operation(indata, nsr)
 728         elif operation == "instantiate":
 729             self._check_instantiate_ns_operation(indata, nsr, session)
 730
 731     def _check_action_ns_operation(self, indata, nsr):
 732         nsd = nsr["nsd"]
 733         # check vnf_member_index
 734         if indata.get("vnf_member_index"):
 735             indata["member_vnf_index"] = indata.pop("vnf_member_index")  # for backward compatibility
 736         if indata.get("member_vnf_index"):
 737             vnfd = self._get_vnfd_from_vnf_member_index(indata["member_vnf_index"], nsr["_id"])
 738             try:
 739                 configs = vnfd.get("df")[0]["lcm-operations-configuration"]["operate-vnf-op-config"]["day1-2"]
 740             except Exception:
 741                 configs = []
 742
 743             if indata.get("vdu_id"):
 744                 self._check_valid_vdu(vnfd, indata["vdu_id"])
 745                 descriptor_configuration = utils.find_in_list(
 746                     configs,
 747                     lambda config: config["id"] == indata["vdu_id"]
 748                 ).get("config-primitive")
 749             elif indata.get("kdu_name"):
 750                 self._check_valid_kdu(vnfd, indata["kdu_name"])
 751                 descriptor_configuration = utils.find_in_list(
 752                     configs,
 753                     lambda config: config["id"] == indata.get("kdu_name")
 754                 ).get("config-primitive")
 755             else:
 756                 descriptor_configuration = utils.find_in_list(
 757                     configs,
 758                     lambda config: config["id"] == vnfd["id"]
 759                 ).get("config-primitive")
 760         else:  # use a NSD
 761             descriptor_configuration = nsd.get("ns-configuration", {}).get("config-primitive")
 762
 763         # For k8s allows default primitives without validating the parameters
 764         if indata.get("kdu_name") and indata["primitive"] in ("upgrade", "rollback", "status", "inspect", "readme"):
 765             # TODO should be checked that rollback only can contains revsision_numbe????
 766             if not indata.get("member_vnf_index"):
 767                 raise EngineException("Missing action parameter 'member_vnf_index' for default KDU primitive '{}'"
 768                                       .format(indata["primitive"]))
 769             return
 770         # if not, check primitive
 771         for config_primitive in get_iterable(descriptor_configuration):
 772             if indata["primitive"] == config_primitive["name"]:
 773                 # check needed primitive_params are provided
 774                 if indata.get("primitive_params"):
 775                     in_primitive_params_copy = copy(indata["primitive_params"])
 776                 else:
 777                     in_primitive_params_copy = {}
 778                 for paramd in get_iterable(config_primitive.get("parameter")):
 779                     if paramd["name"] in in_primitive_params_copy:
 780                         del in_primitive_params_copy[paramd["name"]]
 781                     elif not paramd.get("default-value"):
 782                         raise EngineException("Needed parameter {} not provided for primitive '{}'".format(
 783                             paramd["name"], indata["primitive"]))
 784                 # check no extra primitive params are provided
 785                 if in_primitive_params_copy:
 786                     raise EngineException("parameter/s '{}' not present at vnfd /nsd for primitive '{}'".format(
 787                         list(in_primitive_params_copy.keys()), indata["primitive"]))
 788                 break
 789         else:
 790             raise EngineException("Invalid primitive '{}' is not present at vnfd/nsd".format(indata["primitive"]))
 791
 792     def _check_scale_ns_operation(self, indata, nsr):
 793         vnfd = self._get_vnfd_from_vnf_member_index(indata["scaleVnfData"]["scaleByStepData"]["member-vnf-index"],
 794                                                     nsr["_id"])
 795         for scaling_aspect in get_iterable(vnfd.get("df", ())[0]["scaling-aspect"]):
 796             if indata["scaleVnfData"]["scaleByStepData"]["scaling-group-descriptor"] == scaling_aspect["id"]:
 797                 break
 798         else:
 799             raise EngineException("Invalid scaleVnfData:scaleByStepData:scaling-group-descriptor '{}' is not "
 800                                   "present at vnfd:scaling-aspect"
 801                                   .format(indata["scaleVnfData"]["scaleByStepData"]["scaling-group-descriptor"]))
 802
 803     def _check_instantiate_ns_operation(self, indata, nsr, session):
 804         vnf_member_index_to_vnfd = {}  # map between vnf_member_index to vnf descriptor.
 805         vim_accounts = []
 806         wim_accounts = []
 807         nsd = nsr["nsd"]
 808         self._check_valid_vim_account(indata["vimAccountId"], vim_accounts, session)
 809         self._check_valid_wim_account(indata.get("wimAccountId"), wim_accounts, session)
 810         for in_vnf in get_iterable(indata.get("vnf")):
 811             member_vnf_index = in_vnf["member-vnf-index"]
 812             if vnf_member_index_to_vnfd.get(member_vnf_index):
 813                 vnfd = vnf_member_index_to_vnfd[member_vnf_index]
 814             else:
 815                 vnfd = self._get_vnfd_from_vnf_member_index(member_vnf_index, nsr["_id"])
 816                 vnf_member_index_to_vnfd[member_vnf_index] = vnfd  # add to cache, avoiding a later look for
 817             self._check_vnf_instantiation_params(in_vnf, vnfd)
 818             if in_vnf.get("vimAccountId"):
 819                 self._check_valid_vim_account(in_vnf["vimAccountId"], vim_accounts, session)
 820
 821         for in_vld in get_iterable(indata.get("vld")):
 822             self._check_valid_wim_account(in_vld.get("wimAccountId"), wim_accounts, session)
 823             for vldd in get_iterable(nsd.get("virtual-link-desc")):
 824                 if in_vld["name"] == vldd["id"]:
 825                     break
 826             else:
 827                 raise EngineException("Invalid parameter vld:name='{}' is not present at nsd:vld".format(
 828                     in_vld["name"]))
 829
 830     def _get_vnfd_from_vnf_member_index(self, member_vnf_index, nsr_id):
 831         # Obtain vnf descriptor. The vnfr is used to get the vnfd._id used for this member_vnf_index
 832         vnfr = self.db.get_one("vnfrs",
 833                                {"nsr-id-ref": nsr_id, "member-vnf-index-ref": member_vnf_index},
 834                                fail_on_empty=False)
 835         if not vnfr:
 836             raise EngineException("Invalid parameter member_vnf_index='{}' is not one of the "
 837                                   "nsd:constituent-vnfd".format(member_vnf_index))
 838         vnfd = self.db.get_one("vnfds", {"_id": vnfr["vnfd-id"]}, fail_on_empty=False)
 839         if not vnfd:
 840             raise EngineException("vnfd id={} has been deleted!. Operation cannot be performed".
 841                                   format(vnfr["vnfd-id"]))
 842         return vnfd
 843
 844     def _check_valid_vdu(self, vnfd, vdu_id):
 845         for vdud in get_iterable(vnfd.get("vdu")):
 846             if vdud["id"] == vdu_id:
 847                 return vdud
 848         else:
 849             raise EngineException("Invalid parameter vdu_id='{}' not present at vnfd:vdu:id".format(vdu_id))
 850
 851     def _check_valid_kdu(self, vnfd, kdu_name):
 852         for kdud in get_iterable(vnfd.get("kdu")):
 853             if kdud["name"] == kdu_name:
 854                 return kdud
 855         else:
 856             raise EngineException("Invalid parameter kdu_name='{}' not present at vnfd:kdu:name".format(kdu_name))
 857
 858     def _check_vnf_instantiation_params(self, in_vnf, vnfd):
 859         for in_vdu in get_iterable(in_vnf.get("vdu")):
 860             for vdu in get_iterable(vnfd.get("vdu")):
 861                 if in_vdu["id"] == vdu["id"]:
 862                     for volume in get_iterable(in_vdu.get("volume")):
 863                         for volumed in get_iterable(vdu.get("virtual-storage-desc")):
 864                             if volumed["id"] == volume["name"]:
 865                                 break
 866                         else:
 867                             raise EngineException("Invalid parameter vnf[member-vnf-index='{}']:vdu[id='{}']:"
 868                                                   "volume:name='{}' is not present at "
 869                                                   "vnfd:vdu:virtual-storage-desc list".
 870                                                   format(in_vnf["member-vnf-index"], in_vdu["id"],
 871                                                          volume["id"]))
 872
 873                     vdu_if_names = set()
 874                     for cpd in get_iterable(vdu.get("int-cpd")):
 875                         for iface in get_iterable(cpd.get("virtual-network-interface-requirement")):
 876                             vdu_if_names.add(iface.get("name"))
 877
 878                     for in_iface in get_iterable(in_vdu["interface"]):
 879                         if in_iface["name"] in vdu_if_names:
 880                             break
 881                         else:
 882                             raise EngineException("Invalid parameter vnf[member-vnf-index='{}']:vdu[id='{}']:"
 883                                                   "int-cpd[id='{}'] is not present at vnfd:vdu:int-cpd"
 884                                                   .format(in_vnf["member-vnf-index"], in_vdu["id"],
 885                                                           in_iface["name"]))
 886                     break
 887
 888             else:
 889                 raise EngineException("Invalid parameter vnf[member-vnf-index='{}']:vdu[id='{}'] is not present "
 890                                       "at vnfd:vdu".format(in_vnf["member-vnf-index"], in_vdu["id"]))
 891
 892         vnfd_ivlds_cpds = {ivld.get("id"): set() for ivld in get_iterable(vnfd.get("int-virtual-link-desc"))}
 893         for vdu in get_iterable(vnfd.get("vdu")):
 894             for cpd in get_iterable(vnfd.get("int-cpd")):
 895                 if cpd.get("int-virtual-link-desc"):
 896                     vnfd_ivlds_cpds[cpd.get("int-virtual-link-desc")] = cpd.get("id")
 897
 898         for in_ivld in get_iterable(in_vnf.get("internal-vld")):
 899             if in_ivld.get("name") in vnfd_ivlds_cpds:
 900                 for in_icp in get_iterable(in_ivld.get("internal-connection-point")):
 901                     if in_icp["id-ref"] in vnfd_ivlds_cpds[in_ivld.get("name")]:
 902                         break
 903                     else:
 904                         raise EngineException("Invalid parameter vnf[member-vnf-index='{}']:internal-vld[name"
 905                                               "='{}']:internal-connection-point[id-ref:'{}'] is not present at "
 906                                               "vnfd:internal-vld:name/id:internal-connection-point"
 907                                               .format(in_vnf["member-vnf-index"], in_ivld["name"],
 908                                                       in_icp["id-ref"]))
 909             else:
 910                 raise EngineException("Invalid parameter vnf[member-vnf-index='{}']:internal-vld:name='{}'"
 911                                       " is not present at vnfd '{}'".format(in_vnf["member-vnf-index"],
 912                                                                             in_ivld["name"], vnfd["id"]))
 913
 914     def _check_valid_vim_account(self, vim_account, vim_accounts, session):
 915         if vim_account in vim_accounts:
 916             return
 917         try:
 918             db_filter = self._get_project_filter(session)
 919             db_filter["_id"] = vim_account
 920             self.db.get_one("vim_accounts", db_filter)
 921         except Exception:
 922             raise EngineException("Invalid vimAccountId='{}' not present for the project".format(vim_account))
 923         vim_accounts.append(vim_account)
 924
 925     def _check_valid_wim_account(self, wim_account, wim_accounts, session):
 926         if not isinstance(wim_account, str):
 927             return
 928         if wim_account in wim_accounts:
 929             return
 930         try:
 931             db_filter = self._get_project_filter(session, write=False, show_all=True)
 932             db_filter["_id"] = wim_account
 933             self.db.get_one("wim_accounts", db_filter)
 934         except Exception:
 935             raise EngineException("Invalid wimAccountId='{}' not present for the project".format(wim_account))
 936         wim_accounts.append(wim_account)
 937
 938     def _look_for_pdu(self, session, rollback, vnfr, vim_account, vnfr_update, vnfr_update_rollback):
 939         """
 940         Look for a free PDU in the catalog matching vdur type and interfaces. Fills vnfr.vdur with the interface
 941         (ip_address, ...) information.
 942         Modifies PDU _admin.usageState to 'IN_USE'
 943         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
 944         :param rollback: list with the database modifications to rollback if needed
 945         :param vnfr: vnfr to be updated. It is modified with pdu interface info if pdu is found
 946         :param vim_account: vim_account where this vnfr should be deployed
 947         :param vnfr_update: dictionary filled by this method with changes to be done at database vnfr
 948         :param vnfr_update_rollback: dictionary filled by this method with original content of vnfr in case a rollback
 949                                      of the changed vnfr is needed
 950
 951         :return: List of PDU interfaces that are connected to an existing VIM network. Each item contains:
 952                  "vim-network-name": used at VIM
 953                   "name": interface name
 954                   "vnf-vld-id": internal VNFD vld where this interface is connected, or
 955                   "ns-vld-id": NSD vld where this interface is connected.
 956                   NOTE: One, and only one between 'vnf-vld-id' and 'ns-vld-id' contains a value. The other will be None
 957         """
 958
 959         ifaces_forcing_vim_network = []
 960         for vdur_index, vdur in enumerate(get_iterable(vnfr.get("vdur"))):
 961             if not vdur.get("pdu-type"):
 962                 continue
 963             pdu_type = vdur.get("pdu-type")
 964             pdu_filter = self._get_project_filter(session)
 965             pdu_filter["vim_accounts"] = vim_account
 966             pdu_filter["type"] = pdu_type
 967             pdu_filter["_admin.operationalState"] = "ENABLED"
 968             pdu_filter["_admin.usageState"] = "NOT_IN_USE"
 969             # TODO feature 1417: "shared": True,
 970
 971             available_pdus = self.db.get_list("pdus", pdu_filter)
 972             for pdu in available_pdus:
 973                 # step 1 check if this pdu contains needed interfaces:
 974                 match_interfaces = True
 975                 for vdur_interface in vdur["interfaces"]:
 976                     for pdu_interface in pdu["interfaces"]:
 977                         if pdu_interface["name"] == vdur_interface["name"]:
 978                             # TODO feature 1417: match per mgmt type
 979                             break
 980                     else:  # no interface found for name
 981                         match_interfaces = False
 982                         break
 983                 if match_interfaces:
 984                     break
 985             else:
 986                 raise EngineException(
 987                     "No PDU of type={} at vim_account={} found for member_vnf_index={}, vdu={} matching interface "
 988                     "names".format(pdu_type, vim_account, vnfr["member-vnf-index-ref"], vdur["vdu-id-ref"]))
 989
 990             # step 2. Update pdu
 991             rollback_pdu = {
 992                 "_admin.usageState": pdu["_admin"]["usageState"],
 993                 "_admin.usage.vnfr_id": None,
 994                 "_admin.usage.nsr_id": None,
 995                 "_admin.usage.vdur": None,
 996             }
 997             self.db.set_one("pdus", {"_id": pdu["_id"]},
 998                             {"_admin.usageState": "IN_USE",
 999                              "_admin.usage": {"vnfr_id": vnfr["_id"],
1000                                               "nsr_id": vnfr["nsr-id-ref"],
1001                                               "vdur": vdur["vdu-id-ref"]}
1002                              })
1003             rollback.append({"topic": "pdus", "_id": pdu["_id"], "operation": "set", "content": rollback_pdu})
1004
1005             # step 3. Fill vnfr info by filling vdur
1006             vdu_text = "vdur.{}".format(vdur_index)
1007             vnfr_update_rollback[vdu_text + ".pdu-id"] = None
1008             vnfr_update[vdu_text + ".pdu-id"] = pdu["_id"]
1009             for iface_index, vdur_interface in enumerate(vdur["interfaces"]):
1010                 for pdu_interface in pdu["interfaces"]:
1011                     if pdu_interface["name"] == vdur_interface["name"]:
1012                         iface_text = vdu_text + ".interfaces.{}".format(iface_index)
1013                         for k, v in pdu_interface.items():
1014                             if k in ("ip-address", "mac-address"):  # TODO: switch-xxxxx must be inserted
1015                                 vnfr_update[iface_text + ".{}".format(k)] = v
1016                                 vnfr_update_rollback[iface_text + ".{}".format(k)] = vdur_interface.get(v)
1017                         if pdu_interface.get("ip-address"):
1018                             if vdur_interface.get("mgmt-interface") or vdur_interface.get("mgmt-vnf"):
1019                                 vnfr_update_rollback[vdu_text + ".ip-address"] = vdur.get("ip-address")
1020                                 vnfr_update[vdu_text + ".ip-address"] = pdu_interface["ip-address"]
1021                             if vdur_interface.get("mgmt-vnf"):
1022                                 vnfr_update_rollback["ip-address"] = vnfr.get("ip-address")
1023                                 vnfr_update["ip-address"] = pdu_interface["ip-address"]
1024                                 vnfr_update[vdu_text + ".ip-address"] = pdu_interface["ip-address"]
1025                         if pdu_interface.get("vim-network-name") or pdu_interface.get("vim-network-id"):
1026                             ifaces_forcing_vim_network.append({
1027                                 "name": vdur_interface.get("vnf-vld-id") or vdur_interface.get("ns-vld-id"),
1028                                 "vnf-vld-id": vdur_interface.get("vnf-vld-id"),
1029                                 "ns-vld-id": vdur_interface.get("ns-vld-id")})
1030                             if pdu_interface.get("vim-network-id"):
1031                                 ifaces_forcing_vim_network[-1]["vim-network-id"] = pdu_interface["vim-network-id"]
1032                             if pdu_interface.get("vim-network-name"):
1033                                 ifaces_forcing_vim_network[-1]["vim-network-name"] = pdu_interface["vim-network-name"]
1034                         break
1035
1036         return ifaces_forcing_vim_network
1037
1038     def _look_for_k8scluster(self, session, rollback, vnfr, vim_account, vnfr_update, vnfr_update_rollback):
1039         """
1040         Look for an available k8scluster for all the kuds in the vnfd matching version and cni requirements.
1041         Fills vnfr.kdur with the selected k8scluster
1042
1043         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1044         :param rollback: list with the database modifications to rollback if needed
1045         :param vnfr: vnfr to be updated. It is modified with pdu interface info if pdu is found
1046         :param vim_account: vim_account where this vnfr should be deployed
1047         :param vnfr_update: dictionary filled by this method with changes to be done at database vnfr
1048         :param vnfr_update_rollback: dictionary filled by this method with original content of vnfr in case a rollback
1049                                      of the changed vnfr is needed
1050
1051         :return: List of KDU interfaces that are connected to an existing VIM network. Each item contains:
1052                  "vim-network-name": used at VIM
1053                   "name": interface name
1054                   "vnf-vld-id": internal VNFD vld where this interface is connected, or
1055                   "ns-vld-id": NSD vld where this interface is connected.
1056                   NOTE: One, and only one between 'vnf-vld-id' and 'ns-vld-id' contains a value. The other will be None
1057         """
1058
1059         ifaces_forcing_vim_network = []
1060         if not vnfr.get("kdur"):
1061             return ifaces_forcing_vim_network
1062
1063         kdu_filter = self._get_project_filter(session)
1064         kdu_filter["vim_account"] = vim_account
1065         # TODO kdu_filter["_admin.operationalState"] = "ENABLED"
1066         available_k8sclusters = self.db.get_list("k8sclusters", kdu_filter)
1067
1068         k8s_requirements = {}  # just for logging
1069         for k8scluster in available_k8sclusters:
1070             if not vnfr.get("k8s-cluster"):
1071                 break
1072             # restrict by cni
1073             if vnfr["k8s-cluster"].get("cni"):
1074                 k8s_requirements["cni"] = vnfr["k8s-cluster"]["cni"]
1075                 if not set(vnfr["k8s-cluster"]["cni"]).intersection(k8scluster.get("cni", ())):
1076                     continue
1077             # restrict by version
1078             if vnfr["k8s-cluster"].get("version"):
1079                 k8s_requirements["version"] = vnfr["k8s-cluster"]["version"]
1080                 if k8scluster.get("k8s_version") not in vnfr["k8s-cluster"]["version"]:
1081                     continue
1082             # restrict by number of networks
1083             if vnfr["k8s-cluster"].get("nets"):
1084                 k8s_requirements["networks"] = len(vnfr["k8s-cluster"]["nets"])
1085                 if not k8scluster.get("nets") or len(k8scluster["nets"]) < len(vnfr["k8s-cluster"]["nets"]):
1086                     continue
1087             break
1088         else:
1089             raise EngineException("No k8scluster with requirements='{}' at vim_account={} found for member_vnf_index={}"
1090                                   .format(k8s_requirements, vim_account, vnfr["member-vnf-index-ref"]))
1091
1092         for kdur_index, kdur in enumerate(get_iterable(vnfr.get("kdur"))):
1093             # step 3. Fill vnfr info by filling kdur
1094             kdu_text = "kdur.{}.".format(kdur_index)
1095             vnfr_update_rollback[kdu_text + "k8s-cluster.id"] = None
1096             vnfr_update[kdu_text + "k8s-cluster.id"] = k8scluster["_id"]
1097
1098         # step 4. Check VIM networks that forces the selected k8s_cluster
1099         if vnfr.get("k8s-cluster") and vnfr["k8s-cluster"].get("nets"):
1100             k8scluster_net_list = list(k8scluster.get("nets").keys())
1101             for net_index, kdur_net in enumerate(vnfr["k8s-cluster"]["nets"]):
1102                 # get a network from k8s_cluster nets. If name matches use this, if not use other
1103                 if kdur_net["id"] in k8scluster_net_list:  # name matches
1104                     vim_net = k8scluster["nets"][kdur_net["id"]]
1105                     k8scluster_net_list.remove(kdur_net["id"])
1106                 else:
1107                     vim_net = k8scluster["nets"][k8scluster_net_list[0]]
1108                     k8scluster_net_list.pop(0)
1109                 vnfr_update_rollback["k8s-cluster.nets.{}.vim_net".format(net_index)] = None
1110                 vnfr_update["k8s-cluster.nets.{}.vim_net".format(net_index)] = vim_net
1111                 if vim_net and (kdur_net.get("vnf-vld-id") or kdur_net.get("ns-vld-id")):
1112                     ifaces_forcing_vim_network.append({
1113                         "name": kdur_net.get("vnf-vld-id") or kdur_net.get("ns-vld-id"),
1114                         "vnf-vld-id": kdur_net.get("vnf-vld-id"),
1115                         "ns-vld-id": kdur_net.get("ns-vld-id"),
1116                         "vim-network-name": vim_net,   # TODO can it be vim-network-id ???
1117                     })
1118             # TODO check that this forcing is not incompatible with other forcing
1119         return ifaces_forcing_vim_network
1120
1121     def _update_vnfrs(self, session, rollback, nsr, indata):
1122         # get vnfr
1123         nsr_id = nsr["_id"]
1124         vnfrs = self.db.get_list("vnfrs", {"nsr-id-ref": nsr_id})
1125
1126         for vnfr in vnfrs:
1127             vnfr_update = {}
1128             vnfr_update_rollback = {}
1129             member_vnf_index = vnfr["member-vnf-index-ref"]
1130             # update vim-account-id
1131
1132             vim_account = indata["vimAccountId"]
1133             # check instantiate parameters
1134             for vnf_inst_params in get_iterable(indata.get("vnf")):
1135                 if vnf_inst_params["member-vnf-index"] != member_vnf_index:
1136                     continue
1137                 if vnf_inst_params.get("vimAccountId"):
1138                     vim_account = vnf_inst_params.get("vimAccountId")
1139
1140                 # get vnf.vdu.interface instantiation params to update vnfr.vdur.interfaces ip, mac
1141                 for vdu_inst_param in get_iterable(vnf_inst_params.get("vdu")):
1142                     for vdur_index, vdur in enumerate(vnfr["vdur"]):
1143                         if vdu_inst_param["id"] != vdur["vdu-id-ref"]:
1144                             continue
1145                         for iface_inst_param in get_iterable(vdu_inst_param.get("interface")):
1146                             iface_index, _ = next(i for i in enumerate(vdur["interfaces"])
1147                                                   if i[1]["name"] == iface_inst_param["name"])
1148                             vnfr_update_text = "vdur.{}.interfaces.{}".format(vdur_index, iface_index)
1149                             if iface_inst_param.get("ip-address"):
1150                                 vnfr_update[vnfr_update_text + ".ip-address"] = increment_ip_mac(
1151                                     iface_inst_param.get("ip-address"), vdur.get("count-index", 0))
1152                                 vnfr_update[vnfr_update_text + ".fixed-ip"] = True
1153                             if iface_inst_param.get("mac-address"):
1154                                 vnfr_update[vnfr_update_text + ".mac-address"] = increment_ip_mac(
1155                                     iface_inst_param.get("mac-address"), vdur.get("count-index", 0))
1156                                 vnfr_update[vnfr_update_text + ".fixed-mac"] = True
1157                             if iface_inst_param.get("floating-ip-required"):
1158                                 vnfr_update[vnfr_update_text + ".floating-ip-required"] = True
1159                 # get vnf.internal-vld.internal-conection-point instantiation params to update vnfr.vdur.interfaces
1160                 # TODO update vld with the ip-profile
1161                 for ivld_inst_param in get_iterable(vnf_inst_params.get("internal-vld")):
1162                     for icp_inst_param in get_iterable(ivld_inst_param.get("internal-connection-point")):
1163                         # look for iface
1164                         for vdur_index, vdur in enumerate(vnfr["vdur"]):
1165                             for iface_index, iface in enumerate(vdur["interfaces"]):
1166                                 if iface.get("internal-connection-point-ref") == icp_inst_param["id-ref"]:
1167                                     vnfr_update_text = "vdur.{}.interfaces.{}".format(vdur_index, iface_index)
1168                                     if icp_inst_param.get("ip-address"):
1169                                         vnfr_update[vnfr_update_text + ".ip-address"] = increment_ip_mac(
1170                                             icp_inst_param.get("ip-address"), vdur.get("count-index", 0))
1171                                         vnfr_update[vnfr_update_text + ".fixed-ip"] = True
1172                                     if icp_inst_param.get("mac-address"):
1173                                         vnfr_update[vnfr_update_text + ".mac-address"] = increment_ip_mac(
1174                                             icp_inst_param.get("mac-address"), vdur.get("count-index", 0))
1175                                         vnfr_update[vnfr_update_text + ".fixed-mac"] = True
1176                                     break
1177             # get ip address from instantiation parameters.vld.vnfd-connection-point-ref
1178             for vld_inst_param in get_iterable(indata.get("vld")):
1179                 for vnfcp_inst_param in get_iterable(vld_inst_param.get("vnfd-connection-point-ref")):
1180                     if vnfcp_inst_param["member-vnf-index-ref"] != member_vnf_index:
1181                         continue
1182                     # look for iface
1183                     for vdur_index, vdur in enumerate(vnfr["vdur"]):
1184                         for iface_index, iface in enumerate(vdur["interfaces"]):
1185                             if iface.get("external-connection-point-ref") == \
1186                                     vnfcp_inst_param["vnfd-connection-point-ref"]:
1187                                 vnfr_update_text = "vdur.{}.interfaces.{}".format(vdur_index, iface_index)
1188                                 if vnfcp_inst_param.get("ip-address"):
1189                                     vnfr_update[vnfr_update_text + ".ip-address"] = increment_ip_mac(
1190                                         vnfcp_inst_param.get("ip-address"), vdur.get("count-index", 0))
1191                                     vnfr_update[vnfr_update_text + ".fixed-ip"] = True
1192                                 if vnfcp_inst_param.get("mac-address"):
1193                                     vnfr_update[vnfr_update_text + ".mac-address"] = increment_ip_mac(
1194                                         vnfcp_inst_param.get("mac-address"), vdur.get("count-index", 0))
1195                                     vnfr_update[vnfr_update_text + ".fixed-mac"] = True
1196                                 break
1197
1198             vnfr_update["vim-account-id"] = vim_account
1199             vnfr_update_rollback["vim-account-id"] = vnfr.get("vim-account-id")
1200
1201             # get pdu
1202             ifaces_forcing_vim_network = self._look_for_pdu(session, rollback, vnfr, vim_account, vnfr_update,
1203                                                             vnfr_update_rollback)
1204
1205             # get kdus
1206             ifaces_forcing_vim_network += self._look_for_k8scluster(session, rollback, vnfr, vim_account, vnfr_update,
1207                                                                     vnfr_update_rollback)
1208             # update database vnfr
1209             self.db.set_one("vnfrs", {"_id": vnfr["_id"]}, vnfr_update)
1210             rollback.append({"topic": "vnfrs", "_id": vnfr["_id"], "operation": "set", "content": vnfr_update_rollback})
1211
1212             # Update indada in case pdu forces to use a concrete vim-network-name
1213             # TODO check if user has already insert a vim-network-name and raises an error
1214             if not ifaces_forcing_vim_network:
1215                 continue
1216             for iface_info in ifaces_forcing_vim_network:
1217                 if iface_info.get("ns-vld-id"):
1218                     if "vld" not in indata:
1219                         indata["vld"] = []
1220                     indata["vld"].append({key: iface_info[key] for key in
1221                                           ("name", "vim-network-name", "vim-network-id") if iface_info.get(key)})
1222
1223                 elif iface_info.get("vnf-vld-id"):
1224                     if "vnf" not in indata:
1225                         indata["vnf"] = []
1226                     indata["vnf"].append({
1227                         "member-vnf-index": member_vnf_index,
1228                         "internal-vld": [{key: iface_info[key] for key in
1229                                           ("name", "vim-network-name", "vim-network-id") if iface_info.get(key)}]
1230                     })
1231
1232     @staticmethod
1233     def _create_nslcmop(nsr_id, operation, params):
1234         """
1235         Creates a ns-lcm-opp content to be stored at database.
1236         :param nsr_id: internal id of the instance
1237         :param operation: instantiate, terminate, scale, action, ...
1238         :param params: user parameters for the operation
1239         :return: dictionary following SOL005 format
1240         """
1241         now = time()
1242         _id = str(uuid4())
1243         nslcmop = {
1244             "id": _id,
1245             "_id": _id,
1246             "operationState": "PROCESSING",  # COMPLETED,PARTIALLY_COMPLETED,FAILED_TEMP,FAILED,ROLLING_BACK,ROLLED_BACK
1247             "queuePosition": None,
1248             "stage": None,
1249             "errorMessage": None,
1250             "detailedStatus": None,
1251             "statusEnteredTime": now,
1252             "nsInstanceId": nsr_id,
1253             "lcmOperationType": operation,
1254             "startTime": now,
1255             "isAutomaticInvocation": False,
1256             "operationParams": params,
1257             "isCancelPending": False,
1258             "links": {
1259                 "self": "/osm/nslcm/v1/ns_lcm_op_occs/" + _id,
1260                 "nsInstance": "/osm/nslcm/v1/ns_instances/" + nsr_id,
1261             }
1262         }
1263         return nslcmop
1264
1265     def _get_enabled_vims(self, session):
1266         """
1267         Retrieve and return VIM accounts that are accessible by current user and has state ENABLE
1268         :param session: current session with user information
1269         """
1270         db_filter = self._get_project_filter(session)
1271         db_filter["_admin.operationalState"] = "ENABLED"
1272         vims = self.db.get_list("vim_accounts", db_filter)
1273         vimAccounts = []
1274         for vim in vims:
1275             vimAccounts.append(vim['_id'])
1276         return vimAccounts
1277
1278     def new(self, rollback, session, indata=None, kwargs=None, headers=None, slice_object=False):
1279         """
1280         Performs a new operation over a ns
1281         :param rollback: list to append created items at database in case a rollback must to be done
1282         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1283         :param indata: descriptor with the parameters of the operation. It must contains among others
1284             nsInstanceId: _id of the nsr to perform the operation
1285             operation: it can be: instantiate, terminate, action, TODO: update, heal
1286         :param kwargs: used to override the indata descriptor
1287         :param headers: http request headers
1288         :return: id of the nslcmops
1289         """
1290         def check_if_nsr_is_not_slice_member(session, nsr_id):
1291             nsis = None
1292             db_filter = self._get_project_filter(session)
1293             db_filter["_admin.nsrs-detailed-list.ANYINDEX.nsrId"] = nsr_id
1294             nsis = self.db.get_one("nsis", db_filter, fail_on_empty=False, fail_on_more=False)
1295             if nsis:
1296                 raise EngineException("The NS instance {} cannot be terminated because is used by the slice {}".format(
1297                                       nsr_id, nsis["_id"]), http_code=HTTPStatus.CONFLICT)
1298
1299         try:
1300             # Override descriptor with query string kwargs
1301             self._update_input_with_kwargs(indata, kwargs, yaml_format=True)
1302             operation = indata["lcmOperationType"]
1303             nsInstanceId = indata["nsInstanceId"]
1304
1305             validate_input(indata, self.operation_schema[operation])
1306             # get ns from nsr_id
1307             _filter = BaseTopic._get_project_filter(session)
1308             _filter["_id"] = nsInstanceId
1309             nsr = self.db.get_one("nsrs", _filter)
1310
1311             # initial checking
1312             if operation == "terminate" and slice_object is False:
1313                 check_if_nsr_is_not_slice_member(session, nsr["_id"])
1314             if not nsr["_admin"].get("nsState") or nsr["_admin"]["nsState"] == "NOT_INSTANTIATED":
1315                 if operation == "terminate" and indata.get("autoremove"):
1316                     # NSR must be deleted
1317                     return None, None    # a none in this case is used to indicate not instantiated. It can be removed
1318                 if operation != "instantiate":
1319                     raise EngineException("ns_instance '{}' cannot be '{}' because it is not instantiated".format(
1320                         nsInstanceId, operation), HTTPStatus.CONFLICT)
1321             else:
1322                 if operation == "instantiate" and not session["force"]:
1323                     raise EngineException("ns_instance '{}' cannot be '{}' because it is already instantiated".format(
1324                         nsInstanceId, operation), HTTPStatus.CONFLICT)
1325             self._check_ns_operation(session, nsr, operation, indata)
1326
1327             if operation == "instantiate":
1328                 self._update_vnfrs(session, rollback, nsr, indata)
1329
1330             nslcmop_desc = self._create_nslcmop(nsInstanceId, operation, indata)
1331             _id = nslcmop_desc["_id"]
1332             self.format_on_new(nslcmop_desc, session["project_id"], make_public=session["public"])
1333             if indata.get("placement-engine"):
1334                 # Save valid vim accounts in lcm operation descriptor
1335                 nslcmop_desc['operationParams']['validVimAccounts'] = self._get_enabled_vims(session)
1336             self.db.create("nslcmops", nslcmop_desc)
1337             rollback.append({"topic": "nslcmops", "_id": _id})
1338             if not slice_object:
1339                 self.msg.write("ns", operation, nslcmop_desc)
1340             return _id, None
1341         except ValidationError as e:  # TODO remove try Except, it is captured at nbi.py
1342             raise EngineException(e, HTTPStatus.UNPROCESSABLE_ENTITY)
1343         # except DbException as e:
1344         #     raise EngineException("Cannot get ns_instance '{}': {}".format(e), HTTPStatus.NOT_FOUND)
1345
1346     def delete(self, session, _id, dry_run=False, not_send_msg=None):
1347         raise EngineException("Method delete called directly", HTTPStatus.INTERNAL_SERVER_ERROR)
1348
1349     def edit(self, session, _id, indata=None, kwargs=None, content=None):
1350         raise EngineException("Method edit called directly", HTTPStatus.INTERNAL_SERVER_ERROR)
1351
1352
1353 class NsiTopic(BaseTopic):
1354     topic = "nsis"
1355     topic_msg = "nsi"
1356     quota_name = "slice_instances"
1357
1358     def __init__(self, db, fs, msg, auth):
1359         BaseTopic.__init__(self, db, fs, msg, auth)
1360         self.nsrTopic = NsrTopic(db, fs, msg, auth)
1361
1362     @staticmethod
1363     def _format_ns_request(ns_request):
1364         formated_request = copy(ns_request)
1365         # TODO: Add request params
1366         return formated_request
1367
1368     @staticmethod
1369     def _format_addional_params(slice_request):
1370         """
1371         Get and format user additional params for NS or VNF
1372         :param slice_request: User instantiation additional parameters
1373         :return: a formatted copy of additional params or None if not supplied
1374         """
1375         additional_params = copy(slice_request.get("additionalParamsForNsi"))
1376         if additional_params:
1377             for k, v in additional_params.items():
1378                 if not isinstance(k, str):
1379                     raise EngineException("Invalid param at additionalParamsForNsi:{}. Only string keys are allowed".
1380                                           format(k))
1381                 if "." in k or "$" in k:
1382                     raise EngineException("Invalid param at additionalParamsForNsi:{}. Keys must not contain dots or $".
1383                                           format(k))
1384                 if isinstance(v, (dict, tuple, list)):
1385                     additional_params[k] = "!!yaml " + safe_dump(v)
1386         return additional_params
1387
1388     def _check_descriptor_dependencies(self, session, descriptor):
1389         """
1390         Check that the dependent descriptors exist on a new descriptor or edition
1391         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1392         :param descriptor: descriptor to be inserted or edit
1393         :return: None or raises exception
1394         """
1395         if not descriptor.get("nst-ref"):
1396             return
1397         nstd_id = descriptor["nst-ref"]
1398         if not self.get_item_list(session, "nsts", {"id": nstd_id}):
1399             raise EngineException("Descriptor error at nst-ref='{}' references a non exist nstd".format(nstd_id),
1400                                   http_code=HTTPStatus.CONFLICT)
1401
1402     def check_conflict_on_del(self, session, _id, db_content):
1403         """
1404         Check that NSI is not instantiated
1405         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1406         :param _id: nsi internal id
1407         :param db_content: The database content of the _id
1408         :return: None or raises EngineException with the conflict
1409         """
1410         if session["force"]:
1411             return
1412         nsi = db_content
1413         if nsi["_admin"].get("nsiState") == "INSTANTIATED":
1414             raise EngineException("nsi '{}' cannot be deleted because it is in 'INSTANTIATED' state. "
1415                                   "Launch 'terminate' operation first; or force deletion".format(_id),
1416                                   http_code=HTTPStatus.CONFLICT)
1417
1418     def delete_extra(self, session, _id, db_content, not_send_msg=None):
1419         """
1420         Deletes associated nsilcmops from database. Deletes associated filesystem.
1421          Set usageState of nst
1422         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1423         :param _id: server internal id
1424         :param db_content: The database content of the descriptor
1425         :param not_send_msg: To not send message (False) or store content (list) instead
1426         :return: None if ok or raises EngineException with the problem
1427         """
1428
1429         # Deleting the nsrs belonging to nsir
1430         nsir = db_content
1431         for nsrs_detailed_item in nsir["_admin"]["nsrs-detailed-list"]:
1432             nsr_id = nsrs_detailed_item["nsrId"]
1433             if nsrs_detailed_item.get("shared"):
1434                 _filter = {"_admin.nsrs-detailed-list.ANYINDEX.shared": True,
1435                            "_admin.nsrs-detailed-list.ANYINDEX.nsrId": nsr_id,
1436                            "_id.ne": nsir["_id"]}
1437                 nsi = self.db.get_one("nsis", _filter, fail_on_empty=False, fail_on_more=False)
1438                 if nsi:  # last one using nsr
1439                     continue
1440             try:
1441                 self.nsrTopic.delete(session, nsr_id, dry_run=False, not_send_msg=not_send_msg)
1442             except (DbException, EngineException) as e:
1443                 if e.http_code == HTTPStatus.NOT_FOUND:
1444                     pass
1445                 else:
1446                     raise
1447
1448         # delete related nsilcmops database entries
1449         self.db.del_list("nsilcmops", {"netsliceInstanceId": _id})
1450
1451         # Check and set used NST usage state
1452         nsir_admin = nsir.get("_admin")
1453         if nsir_admin and nsir_admin.get("nst-id"):
1454             # check if used by another NSI
1455             nsis_list = self.db.get_one("nsis", {"nst-id": nsir_admin["nst-id"]},
1456                                         fail_on_empty=False, fail_on_more=False)
1457             if not nsis_list:
1458                 self.db.set_one("nsts", {"_id": nsir_admin["nst-id"]}, {"_admin.usageState": "NOT_IN_USE"})
1459
1460     def new(self, rollback, session, indata=None, kwargs=None, headers=None):
1461         """
1462         Creates a new netslice instance record into database. It also creates needed nsrs and vnfrs
1463         :param rollback: list to append the created items at database in case a rollback must be done
1464         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1465         :param indata: params to be used for the nsir
1466         :param kwargs: used to override the indata descriptor
1467         :param headers: http request headers
1468         :return: the _id of nsi descriptor created at database
1469         """
1470
1471         try:
1472             step = "checking quotas"
1473             self.check_quota(session)
1474
1475             step = ""
1476             slice_request = self._remove_envelop(indata)
1477             # Override descriptor with query string kwargs
1478             self._update_input_with_kwargs(slice_request, kwargs)
1479             slice_request = self._validate_input_new(slice_request, session["force"])
1480
1481             # look for nstd
1482             step = "getting nstd id='{}' from database".format(slice_request.get("nstId"))
1483             _filter = self._get_project_filter(session)
1484             _filter["_id"] = slice_request["nstId"]
1485             nstd = self.db.get_one("nsts", _filter)
1486             # check NST is not disabled
1487             step = "checking NST operationalState"
1488             if nstd["_admin"]["operationalState"] == "DISABLED":
1489                 raise EngineException("nst with id '{}' is DISABLED, and thus cannot be used to create a netslice "
1490                                       "instance".format(slice_request["nstId"]), http_code=HTTPStatus.CONFLICT)
1491             del _filter["_id"]
1492
1493             # check NSD is not disabled
1494             step = "checking operationalState"
1495             if nstd["_admin"]["operationalState"] == "DISABLED":
1496                 raise EngineException("nst with id '{}' is DISABLED, and thus cannot be used to create "
1497                                       "a network slice".format(slice_request["nstId"]), http_code=HTTPStatus.CONFLICT)
1498
1499             nstd.pop("_admin", None)
1500             nstd_id = nstd.pop("_id", None)
1501             nsi_id = str(uuid4())
1502             step = "filling nsi_descriptor with input data"
1503
1504             # Creating the NSIR
1505             nsi_descriptor = {
1506                 "id": nsi_id,
1507                 "name": slice_request["nsiName"],
1508                 "description": slice_request.get("nsiDescription", ""),
1509                 "datacenter": slice_request["vimAccountId"],
1510                 "nst-ref": nstd["id"],
1511                 "instantiation_parameters": slice_request,
1512                 "network-slice-template": nstd,
1513                 "nsr-ref-list": [],
1514                 "vlr-list": [],
1515                 "_id": nsi_id,
1516                 "additionalParamsForNsi": self._format_addional_params(slice_request)
1517             }
1518
1519             step = "creating nsi at database"
1520             self.format_on_new(nsi_descriptor, session["project_id"], make_public=session["public"])
1521             nsi_descriptor["_admin"]["nsiState"] = "NOT_INSTANTIATED"
1522             nsi_descriptor["_admin"]["netslice-subnet"] = None
1523             nsi_descriptor["_admin"]["deployed"] = {}
1524             nsi_descriptor["_admin"]["deployed"]["RO"] = []
1525             nsi_descriptor["_admin"]["nst-id"] = nstd_id
1526
1527             # Creating netslice-vld for the RO.
1528             step = "creating netslice-vld at database"
1529
1530             # Building the vlds list to be deployed
1531             # From netslice descriptors, creating the initial list
1532             nsi_vlds = []
1533
1534             for netslice_vlds in get_iterable(nstd.get("netslice-vld")):
1535                 # Getting template Instantiation parameters from NST
1536                 nsi_vld = deepcopy(netslice_vlds)
1537                 nsi_vld["shared-nsrs-list"] = []
1538                 nsi_vld["vimAccountId"] = slice_request["vimAccountId"]
1539                 nsi_vlds.append(nsi_vld)
1540
1541             nsi_descriptor["_admin"]["netslice-vld"] = nsi_vlds
1542             # Creating netslice-subnet_record.
1543             needed_nsds = {}
1544             services = []
1545
1546             # Updating the nstd with the nsd["_id"] associated to the nss -> services list
1547             for member_ns in nstd["netslice-subnet"]:
1548                 nsd_id = member_ns["nsd-ref"]
1549                 step = "getting nstd id='{}' constituent-nsd='{}' from database".format(
1550                     member_ns["nsd-ref"], member_ns["id"])
1551                 if nsd_id not in needed_nsds:
1552                     # Obtain nsd
1553                     _filter["id"] = nsd_id
1554                     nsd = self.db.get_one("nsds", _filter, fail_on_empty=True, fail_on_more=True)
1555                     del _filter["id"]
1556                     nsd.pop("_admin")
1557                     needed_nsds[nsd_id] = nsd
1558                 else:
1559                     nsd = needed_nsds[nsd_id]
1560                 member_ns["_id"] = needed_nsds[nsd_id].get("_id")
1561                 services.append(member_ns)
1562
1563                 step = "filling nsir nsd-id='{}' constituent-nsd='{}' from database".format(
1564                     member_ns["nsd-ref"], member_ns["id"])
1565
1566             # creates Network Services records (NSRs)
1567             step = "creating nsrs at database using NsrTopic.new()"
1568             ns_params = slice_request.get("netslice-subnet")
1569             nsrs_list = []
1570             nsi_netslice_subnet = []
1571             for service in services:
1572                 # Check if the netslice-subnet is shared and if it is share if the nss exists
1573                 _id_nsr = None
1574                 indata_ns = {}
1575                 # Is the nss shared and instantiated?
1576                 _filter["_admin.nsrs-detailed-list.ANYINDEX.shared"] = True
1577                 _filter["_admin.nsrs-detailed-list.ANYINDEX.nsd-id"] = service["nsd-ref"]
1578                 _filter["_admin.nsrs-detailed-list.ANYINDEX.nss-id"] = service["id"]
1579                 nsi = self.db.get_one("nsis", _filter, fail_on_empty=False, fail_on_more=False)
1580                 if nsi and service.get("is-shared-nss"):
1581                     nsrs_detailed_list = nsi["_admin"]["nsrs-detailed-list"]
1582                     for nsrs_detailed_item in nsrs_detailed_list:
1583                         if nsrs_detailed_item["nsd-id"] == service["nsd-ref"]:
1584                             if nsrs_detailed_item["nss-id"] == service["id"]:
1585                                 _id_nsr = nsrs_detailed_item["nsrId"]
1586                                 break
1587                     for netslice_subnet in nsi["_admin"]["netslice-subnet"]:
1588                         if netslice_subnet["nss-id"] == service["id"]:
1589                             indata_ns = netslice_subnet
1590                             break
1591                 else:
1592                     indata_ns = {}
1593                     if service.get("instantiation-parameters"):
1594                         indata_ns = deepcopy(service["instantiation-parameters"])
1595                         # del service["instantiation-parameters"]
1596
1597                     indata_ns["nsdId"] = service["_id"]
1598                     indata_ns["nsName"] = slice_request.get("nsiName") + "." + service["id"]
1599                     indata_ns["vimAccountId"] = slice_request.get("vimAccountId")
1600                     indata_ns["nsDescription"] = service["description"]
1601                     if slice_request.get("ssh_keys"):
1602                         indata_ns["ssh_keys"] = slice_request.get("ssh_keys")
1603
1604                     if ns_params:
1605                         for ns_param in ns_params:
1606                             if ns_param.get("id") == service["id"]:
1607                                 copy_ns_param = deepcopy(ns_param)
1608                                 del copy_ns_param["id"]
1609                                 indata_ns.update(copy_ns_param)
1610                                 break
1611
1612                     # Creates Nsr objects
1613                     _id_nsr, _ = self.nsrTopic.new(rollback, session, indata_ns, kwargs, headers)
1614                 nsrs_item = {"nsrId": _id_nsr, "shared": service.get("is-shared-nss"), "nsd-id": service["nsd-ref"],
1615                              "nss-id": service["id"], "nslcmop_instantiate": None}
1616                 indata_ns["nss-id"] = service["id"]
1617                 nsrs_list.append(nsrs_item)
1618                 nsi_netslice_subnet.append(indata_ns)
1619                 nsr_ref = {"nsr-ref": _id_nsr}
1620                 nsi_descriptor["nsr-ref-list"].append(nsr_ref)
1621
1622             # Adding the nsrs list to the nsi
1623             nsi_descriptor["_admin"]["nsrs-detailed-list"] = nsrs_list
1624             nsi_descriptor["_admin"]["netslice-subnet"] = nsi_netslice_subnet
1625             self.db.set_one("nsts", {"_id": slice_request["nstId"]}, {"_admin.usageState": "IN_USE"})
1626
1627             # Creating the entry in the database
1628             self.db.create("nsis", nsi_descriptor)
1629             rollback.append({"topic": "nsis", "_id": nsi_id})
1630             return nsi_id, None
1631         except Exception as e:   # TODO remove try Except, it is captured at nbi.py
1632             self.logger.exception("Exception {} at NsiTopic.new()".format(e), exc_info=True)
1633             raise EngineException("Error {}: {}".format(step, e))
1634         except ValidationError as e:
1635             raise EngineException(e, HTTPStatus.UNPROCESSABLE_ENTITY)
1636
1637     def edit(self, session, _id, indata=None, kwargs=None, content=None):
1638         raise EngineException("Method edit called directly", HTTPStatus.INTERNAL_SERVER_ERROR)
1639
1640
1641 class NsiLcmOpTopic(BaseTopic):
1642     topic = "nsilcmops"
1643     topic_msg = "nsi"
1644     operation_schema = {  # mapping between operation and jsonschema to validate
1645         "instantiate": nsi_instantiate,
1646         "terminate": None
1647     }
1648
1649     def __init__(self, db, fs, msg, auth):
1650         BaseTopic.__init__(self, db, fs, msg, auth)
1651         self.nsi_NsLcmOpTopic = NsLcmOpTopic(self.db, self.fs, self.msg, self.auth)
1652
1653     def _check_nsi_operation(self, session, nsir, operation, indata):
1654         """
1655         Check that user has enter right parameters for the operation
1656         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1657         :param operation: it can be: instantiate, terminate, action, TODO: update, heal
1658         :param indata: descriptor with the parameters of the operation
1659         :return: None
1660         """
1661         nsds = {}
1662         nstd = nsir["network-slice-template"]
1663
1664         def check_valid_netslice_subnet_id(nstId):
1665             # TODO change to vnfR (??)
1666             for netslice_subnet in nstd["netslice-subnet"]:
1667                 if nstId == netslice_subnet["id"]:
1668                     nsd_id = netslice_subnet["nsd-ref"]
1669                     if nsd_id not in nsds:
1670                         _filter = self._get_project_filter(session)
1671                         _filter["id"] = nsd_id
1672                         nsds[nsd_id] = self.db.get_one("nsds", _filter)
1673                     return nsds[nsd_id]
1674             else:
1675                 raise EngineException("Invalid parameter nstId='{}' is not one of the "
1676                                       "nst:netslice-subnet".format(nstId))
1677         if operation == "instantiate":
1678             # check the existance of netslice-subnet items
1679             for in_nst in get_iterable(indata.get("netslice-subnet")):
1680                 check_valid_netslice_subnet_id(in_nst["id"])
1681
1682     def _create_nsilcmop(self, session, netsliceInstanceId, operation, params):
1683         now = time()
1684         _id = str(uuid4())
1685         nsilcmop = {
1686             "id": _id,
1687             "_id": _id,
1688             "operationState": "PROCESSING",  # COMPLETED,PARTIALLY_COMPLETED,FAILED_TEMP,FAILED,ROLLING_BACK,ROLLED_BACK
1689             "statusEnteredTime": now,
1690             "netsliceInstanceId": netsliceInstanceId,
1691             "lcmOperationType": operation,
1692             "startTime": now,
1693             "isAutomaticInvocation": False,
1694             "operationParams": params,
1695             "isCancelPending": False,
1696             "links": {
1697                 "self": "/osm/nsilcm/v1/nsi_lcm_op_occs/" + _id,
1698                 "netsliceInstanceId": "/osm/nsilcm/v1/netslice_instances/" + netsliceInstanceId,
1699             }
1700         }
1701         return nsilcmop
1702
1703     def add_shared_nsr_2vld(self, nsir, nsr_item):
1704         for nst_sb_item in nsir["network-slice-template"].get("netslice-subnet"):
1705             if nst_sb_item.get("is-shared-nss"):
1706                 for admin_subnet_item in nsir["_admin"].get("netslice-subnet"):
1707                     if admin_subnet_item["nss-id"] == nst_sb_item["id"]:
1708                         for admin_vld_item in nsir["_admin"].get("netslice-vld"):
1709                             for admin_vld_nss_cp_ref_item in admin_vld_item["nss-connection-point-ref"]:
1710                                 if admin_subnet_item["nss-id"] == admin_vld_nss_cp_ref_item["nss-ref"]:
1711                                     if not nsr_item["nsrId"] in admin_vld_item["shared-nsrs-list"]:
1712                                         admin_vld_item["shared-nsrs-list"].append(nsr_item["nsrId"])
1713                                     break
1714         # self.db.set_one("nsis", {"_id": nsir["_id"]}, nsir)
1715         self.db.set_one("nsis", {"_id": nsir["_id"]}, {"_admin.netslice-vld": nsir["_admin"].get("netslice-vld")})
1716
1717     def new(self, rollback, session, indata=None, kwargs=None, headers=None):
1718         """
1719         Performs a new operation over a ns
1720         :param rollback: list to append created items at database in case a rollback must to be done
1721         :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1722         :param indata: descriptor with the parameters of the operation. It must contains among others
1723             netsliceInstanceId: _id of the nsir to perform the operation
1724             operation: it can be: instantiate, terminate, action, TODO: update, heal
1725         :param kwargs: used to override the indata descriptor
1726         :param headers: http request headers
1727         :return: id of the nslcmops
1728         """
1729         try:
1730             # Override descriptor with query string kwargs
1731             self._update_input_with_kwargs(indata, kwargs)
1732             operation = indata["lcmOperationType"]
1733             netsliceInstanceId = indata["netsliceInstanceId"]
1734             validate_input(indata, self.operation_schema[operation])
1735
1736             # get nsi from netsliceInstanceId
1737             _filter = self._get_project_filter(session)
1738             _filter["_id"] = netsliceInstanceId
1739             nsir = self.db.get_one("nsis", _filter)
1740             logging_prefix = "nsi={} {} ".format(netsliceInstanceId, operation)
1741             del _filter["_id"]
1742
1743             # initial checking
1744             if not nsir["_admin"].get("nsiState") or nsir["_admin"]["nsiState"] == "NOT_INSTANTIATED":
1745                 if operation == "terminate" and indata.get("autoremove"):
1746                     # NSIR must be deleted
1747                     return None, None    # a none in this case is used to indicate not instantiated. It can be removed
1748                 if operation != "instantiate":
1749                     raise EngineException("netslice_instance '{}' cannot be '{}' because it is not instantiated".format(
1750                         netsliceInstanceId, operation), HTTPStatus.CONFLICT)
1751             else:
1752                 if operation == "instantiate" and not session["force"]:
1753                     raise EngineException("netslice_instance '{}' cannot be '{}' because it is already instantiated".
1754                                           format(netsliceInstanceId, operation), HTTPStatus.CONFLICT)
1755
1756             # Creating all the NS_operation (nslcmop)
1757             # Get service list from db
1758             nsrs_list = nsir["_admin"]["nsrs-detailed-list"]
1759             nslcmops = []
1760             # nslcmops_item = None
1761             for index, nsr_item in enumerate(nsrs_list):
1762                 nsr_id = nsr_item["nsrId"]
1763                 if nsr_item.get("shared"):
1764                     _filter["_admin.nsrs-detailed-list.ANYINDEX.shared"] = True
1765                     _filter["_admin.nsrs-detailed-list.ANYINDEX.nsrId"] = nsr_id
1766                     _filter["_admin.nsrs-detailed-list.ANYINDEX.nslcmop_instantiate.ne"] = None
1767                     _filter["_id.ne"] = netsliceInstanceId
1768                     nsi = self.db.get_one("nsis", _filter, fail_on_empty=False, fail_on_more=False)
1769                     if operation == "terminate":
1770                         _update = {"_admin.nsrs-detailed-list.{}.nslcmop_instantiate".format(index): None}
1771                         self.db.set_one("nsis", {"_id": nsir["_id"]}, _update)
1772                         if nsi:  # other nsi is using this nsr and it needs this nsr instantiated
1773                             continue  # do not create nsilcmop
1774                     else:  # instantiate
1775                         # looks the first nsi fulfilling the conditions but not being the current NSIR
1776                         if nsi:
1777                             nsi_nsr_item = next(n for n in nsi["_admin"]["nsrs-detailed-list"] if
1778                                                 n["nsrId"] == nsr_id and n["shared"] and
1779                                                 n["nslcmop_instantiate"])
1780                             self.add_shared_nsr_2vld(nsir, nsr_item)
1781                             nslcmops.append(nsi_nsr_item["nslcmop_instantiate"])
1782                             _update = {"_admin.nsrs-detailed-list.{}".format(index): nsi_nsr_item}
1783                             self.db.set_one("nsis", {"_id": nsir["_id"]}, _update)
1784                             # continue to not create nslcmop since nsrs is shared and nsrs was created
1785                             continue
1786                         else:
1787                             self.add_shared_nsr_2vld(nsir, nsr_item)
1788
1789                 # create operation
1790                 try:
1791                     indata_ns = {
1792                         "lcmOperationType": operation,
1793                         "nsInstanceId": nsr_id,
1794                         # Including netslice_id in the ns instantiate Operation
1795                         "netsliceInstanceId": netsliceInstanceId,
1796                     }
1797                     if operation == "instantiate":
1798                         service = self.db.get_one("nsrs", {"_id": nsr_id})
1799                         indata_ns.update(service["instantiate_params"])
1800
1801                     # Creating NS_LCM_OP with the flag slice_object=True to not trigger the service instantiation
1802                     # message via kafka bus
1803                     nslcmop, _ = self.nsi_NsLcmOpTopic.new(rollback, session, indata_ns, None, headers,
1804                                                            slice_object=True)
1805                     nslcmops.append(nslcmop)
1806                     if operation == "instantiate":
1807                         _update = {"_admin.nsrs-detailed-list.{}.nslcmop_instantiate".format(index): nslcmop}
1808                         self.db.set_one("nsis", {"_id": nsir["_id"]}, _update)
1809                 except (DbException, EngineException) as e:
1810                     if e.http_code == HTTPStatus.NOT_FOUND:
1811                         self.logger.info(logging_prefix + "skipping NS={} because not found".format(nsr_id))
1812                         pass
1813                     else:
1814                         raise
1815
1816             # Creates nsilcmop
1817             indata["nslcmops_ids"] = nslcmops
1818             self._check_nsi_operation(session, nsir, operation, indata)
1819
1820             nsilcmop_desc = self._create_nsilcmop(session, netsliceInstanceId, operation, indata)
1821             self.format_on_new(nsilcmop_desc, session["project_id"], make_public=session["public"])
1822             _id = self.db.create("nsilcmops", nsilcmop_desc)
1823             rollback.append({"topic": "nsilcmops", "_id": _id})
1824             self.msg.write("nsi", operation, nsilcmop_desc)
1825             return _id, None
1826         except ValidationError as e:
1827             raise EngineException(e, HTTPStatus.UNPROCESSABLE_ENTITY)
1828
1829     def delete(self, session, _id, dry_run=False, not_send_msg=None):
1830         raise EngineException("Method delete called directly", HTTPStatus.INTERNAL_SERVER_ERROR)
1831
1832     def edit(self, session, _id, indata=None, kwargs=None, content=None):
1833         raise EngineException("Method edit called directly", HTTPStatus.INTERNAL_SERVER_ERROR)