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