Bug 2250 fixed
[osm/NBI.git] / 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 import json
18 from uuid import uuid4
19 from http import HTTPStatus
20 from time import time
21 from copy import copy, deepcopy
22 from osm_nbi.validation import (
23 validate_input,
24 ValidationError,
25 ns_instantiate,
26 ns_terminate,
27 ns_action,
28 ns_scale,
29 ns_update,
30 ns_heal,
31 nsi_instantiate,
32 ns_migrate,
33 ns_verticalscale,
34 )
35 from osm_nbi.base_topic import (
36 BaseTopic,
37 EngineException,
38 get_iterable,
39 deep_get,
40 increment_ip_mac,
41 update_descriptor_usage_state,
42 )
43 from yaml import safe_dump
44 from osm_common.dbbase import DbException
45 from osm_common.msgbase import MsgException
46 from osm_common.fsbase import FsException
47 from osm_nbi import utils
48 from re import (
49 match,
50 ) # For checking that additional parameter names are valid Jinja2 identifiers
51
52 __author__ = "Alfonso Tierno <alfonso.tiernosepulveda@telefonica.com>"
53
54
55 class NsrTopic(BaseTopic):
56 topic = "nsrs"
57 topic_msg = "ns"
58 quota_name = "ns_instances"
59 schema_new = ns_instantiate
60
61 def __init__(self, db, fs, msg, auth):
62 BaseTopic.__init__(self, db, fs, msg, auth)
63
64 @staticmethod
65 def format_on_new(content, project_id=None, make_public=False):
66 BaseTopic.format_on_new(content, project_id=project_id, make_public=make_public)
67 content["_admin"]["nsState"] = "NOT_INSTANTIATED"
68 return None
69
70 def check_conflict_on_del(self, session, _id, db_content):
71 """
72 Check that NSR is not instantiated
73 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
74 :param _id: nsr internal id
75 :param db_content: The database content of the nsr
76 :return: None or raises EngineException with the conflict
77 """
78 if session["force"]:
79 return
80 nsr = db_content
81 if nsr["_admin"].get("nsState") == "INSTANTIATED":
82 raise EngineException(
83 "nsr '{}' cannot be deleted because it is in 'INSTANTIATED' state. "
84 "Launch 'terminate' operation first; or force deletion".format(_id),
85 http_code=HTTPStatus.CONFLICT,
86 )
87
88 def delete_extra(self, session, _id, db_content, not_send_msg=None):
89 """
90 Deletes associated nslcmops and vnfrs from database. Deletes associated filesystem.
91 Set usageState of pdu, vnfd, nsd
92 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
93 :param _id: server internal id
94 :param db_content: The database content of the descriptor
95 :param not_send_msg: To not send message (False) or store content (list) instead
96 :return: None if ok or raises EngineException with the problem
97 """
98 self.fs.file_delete(_id, ignore_non_exist=True)
99 self.db.del_list("nslcmops", {"nsInstanceId": _id})
100 self.db.del_list("vnfrs", {"nsr-id-ref": _id})
101
102 # set all used pdus as free
103 self.db.set_list(
104 "pdus",
105 {"_admin.usage.nsr_id": _id},
106 {"_admin.usageState": "NOT_IN_USE", "_admin.usage": None},
107 )
108
109 # Set NSD usageState
110 nsr = db_content
111 used_nsd_id = nsr.get("nsd-id")
112 if used_nsd_id:
113 # check if used by another NSR
114 nsrs_list = self.db.get_one(
115 "nsrs", {"nsd-id": used_nsd_id}, fail_on_empty=False, fail_on_more=False
116 )
117 if not nsrs_list:
118 self.db.set_one(
119 "nsds", {"_id": used_nsd_id}, {"_admin.usageState": "NOT_IN_USE"}
120 )
121
122 # Set VNFD usageState
123 used_vnfd_id_list = nsr.get("vnfd-id")
124 if used_vnfd_id_list:
125 for used_vnfd_id in used_vnfd_id_list:
126 # check if used by another NSR
127 nsrs_list = self.db.get_one(
128 "nsrs",
129 {"vnfd-id": used_vnfd_id},
130 fail_on_empty=False,
131 fail_on_more=False,
132 )
133 if not nsrs_list:
134 self.db.set_one(
135 "vnfds",
136 {"_id": used_vnfd_id},
137 {"_admin.usageState": "NOT_IN_USE"},
138 )
139
140 # delete extra ro_nsrs used for internal RO module
141 self.db.del_one("ro_nsrs", q_filter={"_id": _id}, fail_on_empty=False)
142
143 @staticmethod
144 def _format_ns_request(ns_request):
145 formated_request = copy(ns_request)
146 formated_request.pop("additionalParamsForNs", None)
147 formated_request.pop("additionalParamsForVnf", None)
148 return formated_request
149
150 @staticmethod
151 def _format_additional_params(
152 ns_request, member_vnf_index=None, vdu_id=None, kdu_name=None, descriptor=None
153 ):
154 """
155 Get and format user additional params for NS or VNF.
156 The vdu_id and kdu_name params are mutually exclusive! If none of them are given, then the method will
157 exclusively search for the VNF/NS LCM additional params.
158
159 :param ns_request: User instantiation additional parameters
160 :param member_vnf_index: None for extract NS params, or member_vnf_index to extract VNF params
161 :vdu_id: VDU's ID against which we want to format the additional params
162 :kdu_name: KDU's name against which we want to format the additional params
163 :param descriptor: If not None it check that needed parameters of descriptor are supplied
164 :return: tuple with a formatted copy of additional params or None if not supplied, plus other parameters
165 """
166 additional_params = None
167 other_params = None
168 if not member_vnf_index:
169 additional_params = copy(ns_request.get("additionalParamsForNs"))
170 where_ = "additionalParamsForNs"
171 elif ns_request.get("additionalParamsForVnf"):
172 where_ = "additionalParamsForVnf[member-vnf-index={}]".format(
173 member_vnf_index
174 )
175 item = next(
176 (
177 x
178 for x in ns_request["additionalParamsForVnf"]
179 if x["member-vnf-index"] == member_vnf_index
180 ),
181 None,
182 )
183 if item:
184 if not vdu_id and not kdu_name:
185 other_params = item
186 additional_params = copy(item.get("additionalParams")) or {}
187 if vdu_id and item.get("additionalParamsForVdu"):
188 item_vdu = next(
189 (
190 x
191 for x in item["additionalParamsForVdu"]
192 if x["vdu_id"] == vdu_id
193 ),
194 None,
195 )
196 other_params = item_vdu
197 if item_vdu and item_vdu.get("additionalParams"):
198 where_ += ".additionalParamsForVdu[vdu_id={}]".format(vdu_id)
199 additional_params = item_vdu["additionalParams"]
200 if kdu_name:
201 additional_params = {}
202 if item.get("additionalParamsForKdu"):
203 item_kdu = next(
204 (
205 x
206 for x in item["additionalParamsForKdu"]
207 if x["kdu_name"] == kdu_name
208 ),
209 None,
210 )
211 other_params = item_kdu
212 if item_kdu and item_kdu.get("additionalParams"):
213 where_ += ".additionalParamsForKdu[kdu_name={}]".format(
214 kdu_name
215 )
216 additional_params = item_kdu["additionalParams"]
217
218 if additional_params:
219 for k, v in additional_params.items():
220 # BEGIN Check that additional parameter names are valid Jinja2 identifiers if target is not Kdu
221 if not kdu_name and not match("^[a-zA-Z_][a-zA-Z0-9_]*$", k):
222 raise EngineException(
223 "Invalid param name at {}:{}. Must contain only alphanumeric characters "
224 "and underscores, and cannot start with a digit".format(
225 where_, k
226 )
227 )
228 # END Check that additional parameter names are valid Jinja2 identifiers
229 if not isinstance(k, str):
230 raise EngineException(
231 "Invalid param at {}:{}. Only string keys are allowed".format(
232 where_, k
233 )
234 )
235 if "$" in k:
236 raise EngineException(
237 "Invalid param at {}:{}. Keys must not contain $ symbol".format(
238 where_, k
239 )
240 )
241 if isinstance(v, (dict, tuple, list)):
242 additional_params[k] = "!!yaml " + safe_dump(v)
243 if kdu_name:
244 additional_params = json.dumps(additional_params)
245
246 # Select the VDU ID, KDU name or NS/VNF ID, depending on the method's call intent
247 selector = vdu_id if vdu_id else kdu_name if kdu_name else descriptor.get("id")
248
249 if descriptor:
250 for df in descriptor.get("df", []):
251 # check that enough parameters are supplied for the initial-config-primitive
252 # TODO: check for cloud-init
253 if member_vnf_index:
254 initial_primitives = []
255 if (
256 "lcm-operations-configuration" in df
257 and "operate-vnf-op-config"
258 in df["lcm-operations-configuration"]
259 ):
260 for config in df["lcm-operations-configuration"][
261 "operate-vnf-op-config"
262 ].get("day1-2", []):
263 # Verify the target object (VNF|NS|VDU|KDU) where we need to populate
264 # the params with the additional ones given by the user
265 if config.get("id") == selector:
266 for primitive in get_iterable(
267 config.get("initial-config-primitive")
268 ):
269 initial_primitives.append(primitive)
270 else:
271 initial_primitives = deep_get(
272 descriptor, ("ns-configuration", "initial-config-primitive")
273 )
274
275 for initial_primitive in get_iterable(initial_primitives):
276 for param in get_iterable(initial_primitive.get("parameter")):
277 if param["value"].startswith("<") and param["value"].endswith(
278 ">"
279 ):
280 if param["value"] in (
281 "<rw_mgmt_ip>",
282 "<VDU_SCALE_INFO>",
283 "<ns_config_info>",
284 "<OSM>",
285 ):
286 continue
287 if (
288 not additional_params
289 or param["value"][1:-1] not in additional_params
290 ):
291 raise EngineException(
292 "Parameter '{}' needed for vnfd[id={}]:day1-2 configuration:"
293 "initial-config-primitive[name={}] not supplied".format(
294 param["value"],
295 descriptor["id"],
296 initial_primitive["name"],
297 )
298 )
299
300 return additional_params or None, other_params or None
301
302 def new(self, rollback, session, indata=None, kwargs=None, headers=None):
303 """
304 Creates a new nsr into database. It also creates needed vnfrs
305 :param rollback: list to append the created items at database in case a rollback must be done
306 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
307 :param indata: params to be used for the nsr
308 :param kwargs: used to override the indata descriptor
309 :param headers: http request headers
310 :return: the _id of nsr descriptor created at database. Or an exception of type
311 EngineException, ValidationError, DbException, FsException, MsgException.
312 Note: Exceptions are not captured on purpose. They should be captured at called
313 """
314 step = "checking quotas" # first step must be defined outside try
315 try:
316 self.check_quota(session)
317
318 step = "validating input parameters"
319 ns_request = self._remove_envelop(indata)
320 self._update_input_with_kwargs(ns_request, kwargs)
321 ns_request = self._validate_input_new(ns_request, session["force"])
322
323 step = "getting nsd id='{}' from database".format(ns_request.get("nsdId"))
324 nsd = self._get_nsd_from_db(ns_request["nsdId"], session)
325 ns_k8s_namespace = self._get_ns_k8s_namespace(nsd, ns_request, session)
326
327 step = "checking nsdOperationalState"
328 self._check_nsd_operational_state(nsd, ns_request)
329
330 step = "filling nsr from input data"
331 nsr_id = str(uuid4())
332 nsr_descriptor = self._create_nsr_descriptor_from_nsd(
333 nsd, ns_request, nsr_id, session
334 )
335
336 # Create VNFRs
337 needed_vnfds = {}
338 # TODO: Change for multiple df support
339 vnf_profiles = nsd.get("df", [{}])[0].get("vnf-profile", ())
340 for vnfp in vnf_profiles:
341 vnfd_id = vnfp.get("vnfd-id")
342 vnf_index = vnfp.get("id")
343 step = (
344 "getting vnfd id='{}' constituent-vnfd='{}' from database".format(
345 vnfd_id, vnf_index
346 )
347 )
348 if vnfd_id not in needed_vnfds:
349 vnfd = self._get_vnfd_from_db(vnfd_id, session)
350 if "revision" in vnfd["_admin"]:
351 vnfd["revision"] = vnfd["_admin"]["revision"]
352 vnfd.pop("_admin")
353 needed_vnfds[vnfd_id] = vnfd
354 nsr_descriptor["vnfd-id"].append(vnfd["_id"])
355 else:
356 vnfd = needed_vnfds[vnfd_id]
357
358 step = "filling vnfr vnfd-id='{}' constituent-vnfd='{}'".format(
359 vnfd_id, vnf_index
360 )
361 vnfr_descriptor = self._create_vnfr_descriptor_from_vnfd(
362 nsd,
363 vnfd,
364 vnfd_id,
365 vnf_index,
366 nsr_descriptor,
367 ns_request,
368 ns_k8s_namespace,
369 )
370
371 step = "creating vnfr vnfd-id='{}' constituent-vnfd='{}' at database".format(
372 vnfd_id, vnf_index
373 )
374 self._add_vnfr_to_db(vnfr_descriptor, rollback, session)
375 nsr_descriptor["constituent-vnfr-ref"].append(vnfr_descriptor["id"])
376 step = "Updating VNFD usageState"
377 update_descriptor_usage_state(vnfd, "vnfds", self.db)
378
379 step = "creating nsr at database"
380 self._add_nsr_to_db(nsr_descriptor, rollback, session)
381 step = "Updating NSD usageState"
382 update_descriptor_usage_state(nsd, "nsds", self.db)
383
384 step = "creating nsr temporal folder"
385 self.fs.mkdir(nsr_id)
386
387 return nsr_id, None
388 except (
389 ValidationError,
390 EngineException,
391 DbException,
392 MsgException,
393 FsException,
394 ) as e:
395 raise type(e)("{} while '{}'".format(e, step), http_code=e.http_code)
396
397 def _get_nsd_from_db(self, nsd_id, session):
398 _filter = self._get_project_filter(session)
399 _filter["_id"] = nsd_id
400 return self.db.get_one("nsds", _filter)
401
402 def _get_vnfd_from_db(self, vnfd_id, session):
403 _filter = self._get_project_filter(session)
404 _filter["id"] = vnfd_id
405 vnfd = self.db.get_one("vnfds", _filter, fail_on_empty=True, fail_on_more=True)
406 return vnfd
407
408 def _add_nsr_to_db(self, nsr_descriptor, rollback, session):
409 self.format_on_new(
410 nsr_descriptor, session["project_id"], make_public=session["public"]
411 )
412 self.db.create("nsrs", nsr_descriptor)
413 rollback.append({"topic": "nsrs", "_id": nsr_descriptor["id"]})
414
415 def _add_vnfr_to_db(self, vnfr_descriptor, rollback, session):
416 self.format_on_new(
417 vnfr_descriptor, session["project_id"], make_public=session["public"]
418 )
419 self.db.create("vnfrs", vnfr_descriptor)
420 rollback.append({"topic": "vnfrs", "_id": vnfr_descriptor["id"]})
421
422 def _check_nsd_operational_state(self, nsd, ns_request):
423 if nsd["_admin"]["operationalState"] == "DISABLED":
424 raise EngineException(
425 "nsd with id '{}' is DISABLED, and thus cannot be used to create "
426 "a network service".format(ns_request["nsdId"]),
427 http_code=HTTPStatus.CONFLICT,
428 )
429
430 def _get_ns_k8s_namespace(self, nsd, ns_request, session):
431 additional_params, _ = self._format_additional_params(
432 ns_request, descriptor=nsd
433 )
434 # use for k8s-namespace from ns_request or additionalParamsForNs. By default, the project_id
435 ns_k8s_namespace = session["project_id"][0] if session["project_id"] else None
436 if ns_request and ns_request.get("k8s-namespace"):
437 ns_k8s_namespace = ns_request["k8s-namespace"]
438 if additional_params and additional_params.get("k8s-namespace"):
439 ns_k8s_namespace = additional_params["k8s-namespace"]
440
441 return ns_k8s_namespace
442
443 def _add_shared_volumes_to_nsr(
444 self, vdu, vnfd, nsr_descriptor, member_vnf_index, revision=None
445 ):
446 svsd = []
447 for vsd in vnfd.get("virtual-storage-desc", ()):
448 if vsd.get("vdu-storage-requirements"):
449 if (
450 vsd.get("vdu-storage-requirements")[0].get("key") == "multiattach"
451 and vsd.get("vdu-storage-requirements")[0].get("value") == "True"
452 ):
453 # Avoid setting the volume name multiple times
454 if not match(f"shared-.*-{vnfd['id']}", vsd["id"]):
455 vsd["id"] = f"shared-{vsd['id']}-{vnfd['id']}"
456 svsd.append(vsd)
457 if svsd:
458 nsr_descriptor["shared-volumes"] = svsd
459
460 def _add_flavor_to_nsr(
461 self, vdu, vnfd, nsr_descriptor, member_vnf_index, revision=None
462 ):
463 flavor_data = {}
464 guest_epa = {}
465 # Find this vdu compute and storage descriptors
466 vdu_virtual_compute = {}
467 vdu_virtual_storage = {}
468 for vcd in vnfd.get("virtual-compute-desc", ()):
469 if vcd.get("id") == vdu.get("virtual-compute-desc"):
470 vdu_virtual_compute = vcd
471 for vsd in vnfd.get("virtual-storage-desc", ()):
472 if vsd.get("id") == vdu.get("virtual-storage-desc", [[]])[0]:
473 vdu_virtual_storage = vsd
474 # Get this vdu vcpus, memory and storage info for flavor_data
475 if vdu_virtual_compute.get("virtual-cpu", {}).get("num-virtual-cpu"):
476 flavor_data["vcpu-count"] = vdu_virtual_compute["virtual-cpu"][
477 "num-virtual-cpu"
478 ]
479 if vdu_virtual_compute.get("virtual-memory", {}).get("size"):
480 flavor_data["memory-mb"] = (
481 float(vdu_virtual_compute["virtual-memory"]["size"]) * 1024.0
482 )
483 if vdu_virtual_storage.get("size-of-storage"):
484 flavor_data["storage-gb"] = vdu_virtual_storage["size-of-storage"]
485 # Get this vdu EPA info for guest_epa
486 if vdu_virtual_compute.get("virtual-cpu", {}).get("cpu-quota"):
487 guest_epa["cpu-quota"] = vdu_virtual_compute["virtual-cpu"]["cpu-quota"]
488 if vdu_virtual_compute.get("virtual-cpu", {}).get("pinning"):
489 vcpu_pinning = vdu_virtual_compute["virtual-cpu"]["pinning"]
490 if vcpu_pinning.get("thread-policy"):
491 guest_epa["cpu-thread-pinning-policy"] = vcpu_pinning["thread-policy"]
492 if vcpu_pinning.get("policy"):
493 cpu_policy = (
494 "SHARED" if vcpu_pinning["policy"] == "dynamic" else "DEDICATED"
495 )
496 guest_epa["cpu-pinning-policy"] = cpu_policy
497 if vdu_virtual_compute.get("virtual-memory", {}).get("mem-quota"):
498 guest_epa["mem-quota"] = vdu_virtual_compute["virtual-memory"]["mem-quota"]
499 if vdu_virtual_compute.get("virtual-memory", {}).get("mempage-size"):
500 guest_epa["mempage-size"] = vdu_virtual_compute["virtual-memory"][
501 "mempage-size"
502 ]
503 if vdu_virtual_compute.get("virtual-memory", {}).get("numa-node-policy"):
504 guest_epa["numa-node-policy"] = vdu_virtual_compute["virtual-memory"][
505 "numa-node-policy"
506 ]
507 if vdu_virtual_storage.get("disk-io-quota"):
508 guest_epa["disk-io-quota"] = vdu_virtual_storage["disk-io-quota"]
509
510 if guest_epa:
511 flavor_data["guest-epa"] = guest_epa
512
513 revision = revision if revision is not None else 1
514 flavor_data["name"] = (
515 vdu["id"][:56] + "-" + member_vnf_index + "-" + str(revision) + "-flv"
516 )
517 flavor_data["id"] = str(len(nsr_descriptor["flavor"]))
518 nsr_descriptor["flavor"].append(flavor_data)
519
520 def _create_nsr_descriptor_from_nsd(self, nsd, ns_request, nsr_id, session):
521 now = time()
522 additional_params, _ = self._format_additional_params(
523 ns_request, descriptor=nsd
524 )
525
526 nsr_descriptor = {
527 "name": ns_request["nsName"],
528 "name-ref": ns_request["nsName"],
529 "short-name": ns_request["nsName"],
530 "admin-status": "ENABLED",
531 "nsState": "NOT_INSTANTIATED",
532 "currentOperation": "IDLE",
533 "currentOperationID": None,
534 "errorDescription": None,
535 "errorDetail": None,
536 "deploymentStatus": None,
537 "configurationStatus": None,
538 "vcaStatus": None,
539 "nsd": {k: v for k, v in nsd.items()},
540 "datacenter": ns_request["vimAccountId"],
541 "resource-orchestrator": "osmopenmano",
542 "description": ns_request.get("nsDescription", ""),
543 "constituent-vnfr-ref": [],
544 "operational-status": "init", # typedef ns-operational-
545 "config-status": "init", # typedef config-states
546 "detailed-status": "scheduled",
547 "orchestration-progress": {},
548 "create-time": now,
549 "nsd-name-ref": nsd["name"],
550 "operational-events": [], # "id", "timestamp", "description", "event",
551 "nsd-ref": nsd["id"],
552 "nsd-id": nsd["_id"],
553 "vnfd-id": [],
554 "instantiate_params": self._format_ns_request(ns_request),
555 "additionalParamsForNs": additional_params,
556 "ns-instance-config-ref": nsr_id,
557 "id": nsr_id,
558 "_id": nsr_id,
559 "ssh-authorized-key": ns_request.get("ssh_keys"), # TODO remove
560 "flavor": [],
561 "image": [],
562 "affinity-or-anti-affinity-group": [],
563 "shared-volumes": [],
564 }
565 if "revision" in nsd["_admin"]:
566 nsr_descriptor["revision"] = nsd["_admin"]["revision"]
567
568 ns_request["nsr_id"] = nsr_id
569 if ns_request and ns_request.get("config-units"):
570 nsr_descriptor["config-units"] = ns_request["config-units"]
571 # Create vld
572 if nsd.get("virtual-link-desc"):
573 nsr_vld = deepcopy(nsd.get("virtual-link-desc", []))
574 # Fill each vld with vnfd-connection-point-ref data
575 # TODO: Change for multiple df support
576 all_vld_connection_point_data = {vld.get("id"): [] for vld in nsr_vld}
577 vnf_profiles = nsd.get("df", [[]])[0].get("vnf-profile", ())
578 for vnf_profile in vnf_profiles:
579 for vlc in vnf_profile.get("virtual-link-connectivity", ()):
580 for cpd in vlc.get("constituent-cpd-id", ()):
581 all_vld_connection_point_data[
582 vlc.get("virtual-link-profile-id")
583 ].append(
584 {
585 "member-vnf-index-ref": cpd.get(
586 "constituent-base-element-id"
587 ),
588 "vnfd-connection-point-ref": cpd.get(
589 "constituent-cpd-id"
590 ),
591 "vnfd-id-ref": vnf_profile.get("vnfd-id"),
592 }
593 )
594
595 vnfd = self._get_vnfd_from_db(vnf_profile.get("vnfd-id"), session)
596 vnfd.pop("_admin")
597
598 for vdu in vnfd.get("vdu", ()):
599 member_vnf_index = vnf_profile.get("id")
600 self._add_flavor_to_nsr(vdu, vnfd, nsr_descriptor, member_vnf_index)
601 self._add_shared_volumes_to_nsr(
602 vdu, vnfd, nsr_descriptor, member_vnf_index
603 )
604 sw_image_id = vdu.get("sw-image-desc")
605 if sw_image_id:
606 image_data = self._get_image_data_from_vnfd(vnfd, sw_image_id)
607 self._add_image_to_nsr(nsr_descriptor, image_data)
608
609 # also add alternative images to the list of images
610 for alt_image in vdu.get("alternative-sw-image-desc", ()):
611 image_data = self._get_image_data_from_vnfd(vnfd, alt_image)
612 self._add_image_to_nsr(nsr_descriptor, image_data)
613
614 # Add Affinity or Anti-affinity group information to NSR
615 vdu_profiles = vnfd.get("df", [[]])[0].get("vdu-profile", ())
616 affinity_group_prefix_name = "{}-{}".format(
617 nsr_descriptor["name"][:16], vnf_profile.get("id")[:16]
618 )
619
620 for vdu_profile in vdu_profiles:
621 affinity_group_data = {}
622 for affinity_group in vdu_profile.get(
623 "affinity-or-anti-affinity-group", ()
624 ):
625 affinity_group_data = (
626 self._get_affinity_or_anti_affinity_group_data_from_vnfd(
627 vnfd, affinity_group["id"]
628 )
629 )
630 affinity_group_data["member-vnf-index"] = vnf_profile.get("id")
631 self._add_affinity_or_anti_affinity_group_to_nsr(
632 nsr_descriptor,
633 affinity_group_data,
634 affinity_group_prefix_name,
635 )
636
637 for vld in nsr_vld:
638 vld["vnfd-connection-point-ref"] = all_vld_connection_point_data.get(
639 vld.get("id"), []
640 )
641 vld["name"] = vld["id"]
642 nsr_descriptor["vld"] = nsr_vld
643 return nsr_descriptor
644
645 def _get_affinity_or_anti_affinity_group_data_from_vnfd(
646 self, vnfd, affinity_group_id
647 ):
648 """
649 Gets affinity-or-anti-affinity-group info from df and returns the desired affinity group
650 """
651 affinity_group = utils.find_in_list(
652 vnfd.get("df", [[]])[0].get("affinity-or-anti-affinity-group", ()),
653 lambda ag: ag["id"] == affinity_group_id,
654 )
655 affinity_group_data = {}
656 if affinity_group:
657 if affinity_group.get("id"):
658 affinity_group_data["ag-id"] = affinity_group["id"]
659 if affinity_group.get("type"):
660 affinity_group_data["type"] = affinity_group["type"]
661 if affinity_group.get("scope"):
662 affinity_group_data["scope"] = affinity_group["scope"]
663 return affinity_group_data
664
665 def _add_affinity_or_anti_affinity_group_to_nsr(
666 self, nsr_descriptor, affinity_group_data, affinity_group_prefix_name
667 ):
668 """
669 Adds affinity-or-anti-affinity-group to nsr checking first it is not already added
670 """
671 affinity_group = next(
672 (
673 f
674 for f in nsr_descriptor["affinity-or-anti-affinity-group"]
675 if all(f.get(k) == affinity_group_data[k] for k in affinity_group_data)
676 ),
677 None,
678 )
679 if not affinity_group:
680 affinity_group_data["id"] = str(
681 len(nsr_descriptor["affinity-or-anti-affinity-group"])
682 )
683 affinity_group_data["name"] = "{}-{}".format(
684 affinity_group_prefix_name, affinity_group_data["ag-id"][:32]
685 )
686 nsr_descriptor["affinity-or-anti-affinity-group"].append(
687 affinity_group_data
688 )
689
690 def _get_image_data_from_vnfd(self, vnfd, sw_image_id):
691 sw_image_desc = utils.find_in_list(
692 vnfd.get("sw-image-desc", ()), lambda sw: sw["id"] == sw_image_id
693 )
694 image_data = {}
695 if sw_image_desc.get("image"):
696 image_data["image"] = sw_image_desc["image"]
697 if sw_image_desc.get("checksum"):
698 image_data["image_checksum"] = sw_image_desc["checksum"]["hash"]
699 if sw_image_desc.get("vim-type"):
700 image_data["vim-type"] = sw_image_desc["vim-type"]
701 return image_data
702
703 def _add_image_to_nsr(self, nsr_descriptor, image_data):
704 """
705 Adds image to nsr checking first it is not already added
706 """
707 img = next(
708 (
709 f
710 for f in nsr_descriptor["image"]
711 if all(f.get(k) == image_data[k] for k in image_data)
712 ),
713 None,
714 )
715 if not img:
716 image_data["id"] = str(len(nsr_descriptor["image"]))
717 nsr_descriptor["image"].append(image_data)
718
719 def _create_vnfr_descriptor_from_vnfd(
720 self,
721 nsd,
722 vnfd,
723 vnfd_id,
724 vnf_index,
725 nsr_descriptor,
726 ns_request,
727 ns_k8s_namespace,
728 revision=None,
729 ):
730 vnfr_id = str(uuid4())
731 nsr_id = nsr_descriptor["id"]
732 now = time()
733 additional_params, vnf_params = self._format_additional_params(
734 ns_request, vnf_index, descriptor=vnfd
735 )
736
737 vnfr_descriptor = {
738 "id": vnfr_id,
739 "_id": vnfr_id,
740 "nsr-id-ref": nsr_id,
741 "member-vnf-index-ref": vnf_index,
742 "additionalParamsForVnf": additional_params,
743 "created-time": now,
744 # "vnfd": vnfd, # at OSM model.but removed to avoid data duplication TODO: revise
745 "vnfd-ref": vnfd_id,
746 "vnfd-id": vnfd["_id"], # not at OSM model, but useful
747 "vim-account-id": None,
748 "vca-id": None,
749 "vdur": [],
750 "connection-point": [],
751 "ip-address": None, # mgmt-interface filled by LCM
752 }
753
754 # Revision backwards compatility. Only specify the revision in the record if
755 # the original VNFD has a revision.
756 if "revision" in vnfd:
757 vnfr_descriptor["revision"] = vnfd["revision"]
758
759 vnf_k8s_namespace = ns_k8s_namespace
760 if vnf_params:
761 if vnf_params.get("k8s-namespace"):
762 vnf_k8s_namespace = vnf_params["k8s-namespace"]
763 if vnf_params.get("config-units"):
764 vnfr_descriptor["config-units"] = vnf_params["config-units"]
765
766 # Create vld
767 if vnfd.get("int-virtual-link-desc"):
768 vnfr_descriptor["vld"] = []
769 for vnfd_vld in vnfd.get("int-virtual-link-desc"):
770 vnfr_descriptor["vld"].append({key: vnfd_vld[key] for key in vnfd_vld})
771
772 for cp in vnfd.get("ext-cpd", ()):
773 vnf_cp = {
774 "name": cp.get("id"),
775 "connection-point-id": cp.get("int-cpd", {}).get("cpd"),
776 "connection-point-vdu-id": cp.get("int-cpd", {}).get("vdu-id"),
777 "id": cp.get("id"),
778 # "ip-address", "mac-address" # filled by LCM
779 # vim-id # TODO it would be nice having a vim port id
780 }
781 vnfr_descriptor["connection-point"].append(vnf_cp)
782
783 # Create k8s-cluster information
784 # TODO: Validate if a k8s-cluster net can have more than one ext-cpd ?
785 if vnfd.get("k8s-cluster"):
786 vnfr_descriptor["k8s-cluster"] = vnfd["k8s-cluster"]
787 all_k8s_cluster_nets_cpds = {}
788 for cpd in get_iterable(vnfd.get("ext-cpd")):
789 if cpd.get("k8s-cluster-net"):
790 all_k8s_cluster_nets_cpds[cpd.get("k8s-cluster-net")] = cpd.get(
791 "id"
792 )
793 for net in get_iterable(vnfr_descriptor["k8s-cluster"].get("nets")):
794 if net.get("id") in all_k8s_cluster_nets_cpds:
795 net["external-connection-point-ref"] = all_k8s_cluster_nets_cpds[
796 net.get("id")
797 ]
798
799 # update kdus
800 for kdu in get_iterable(vnfd.get("kdu")):
801 additional_params, kdu_params = self._format_additional_params(
802 ns_request, vnf_index, kdu_name=kdu["name"], descriptor=vnfd
803 )
804 kdu_k8s_namespace = vnf_k8s_namespace
805 kdu_model = kdu_params.get("kdu_model") if kdu_params else None
806 if kdu_params and kdu_params.get("k8s-namespace"):
807 kdu_k8s_namespace = kdu_params["k8s-namespace"]
808
809 kdu_deployment_name = ""
810 if kdu_params and kdu_params.get("kdu-deployment-name"):
811 kdu_deployment_name = kdu_params.get("kdu-deployment-name")
812
813 kdur = {
814 "additionalParams": additional_params,
815 "k8s-namespace": kdu_k8s_namespace,
816 "kdu-deployment-name": kdu_deployment_name,
817 "kdu-name": kdu["name"],
818 # TODO "name": "" Name of the VDU in the VIM
819 "ip-address": None, # mgmt-interface filled by LCM
820 "k8s-cluster": {},
821 }
822 if kdu_params and kdu_params.get("config-units"):
823 kdur["config-units"] = kdu_params["config-units"]
824 if kdu.get("helm-version"):
825 kdur["helm-version"] = kdu["helm-version"]
826 for k8s_type in ("helm-chart", "juju-bundle"):
827 if kdu.get(k8s_type):
828 kdur[k8s_type] = kdu_model or kdu[k8s_type]
829 if not vnfr_descriptor.get("kdur"):
830 vnfr_descriptor["kdur"] = []
831 vnfr_descriptor["kdur"].append(kdur)
832
833 vnfd_mgmt_cp = vnfd.get("mgmt-cp")
834
835 for vdu in vnfd.get("vdu", ()):
836 vdu_mgmt_cp = []
837 try:
838 configs = vnfd.get("df")[0]["lcm-operations-configuration"][
839 "operate-vnf-op-config"
840 ]["day1-2"]
841 vdu_config = utils.find_in_list(
842 configs, lambda config: config["id"] == vdu["id"]
843 )
844 except Exception:
845 vdu_config = None
846
847 try:
848 vdu_instantiation_level = utils.find_in_list(
849 vnfd.get("df")[0]["instantiation-level"][0]["vdu-level"],
850 lambda a_vdu_profile: a_vdu_profile["vdu-id"] == vdu["id"],
851 )
852 except Exception:
853 vdu_instantiation_level = None
854
855 if vdu_config:
856 external_connection_ee = utils.filter_in_list(
857 vdu_config.get("execution-environment-list", []),
858 lambda ee: "external-connection-point-ref" in ee,
859 )
860 for ee in external_connection_ee:
861 vdu_mgmt_cp.append(ee["external-connection-point-ref"])
862
863 additional_params, vdu_params = self._format_additional_params(
864 ns_request, vnf_index, vdu_id=vdu["id"], descriptor=vnfd
865 )
866
867 try:
868 vdu_virtual_storage_descriptors = utils.filter_in_list(
869 vnfd.get("virtual-storage-desc", []),
870 lambda stg_desc: stg_desc["id"] in vdu["virtual-storage-desc"],
871 )
872 except Exception:
873 vdu_virtual_storage_descriptors = []
874 vdur = {
875 "vdu-id-ref": vdu["id"],
876 # TODO "name": "" Name of the VDU in the VIM
877 "ip-address": None, # mgmt-interface filled by LCM
878 # "vim-id", "flavor-id", "image-id", "management-ip" # filled by LCM
879 "internal-connection-point": [],
880 "interfaces": [],
881 "additionalParams": additional_params,
882 "vdu-name": vdu["name"],
883 "virtual-storages": vdu_virtual_storage_descriptors,
884 }
885 if vdu_params and vdu_params.get("config-units"):
886 vdur["config-units"] = vdu_params["config-units"]
887 if deep_get(vdu, ("supplemental-boot-data", "boot-data-drive")):
888 vdur["boot-data-drive"] = vdu["supplemental-boot-data"][
889 "boot-data-drive"
890 ]
891 if vdu.get("pdu-type"):
892 vdur["pdu-type"] = vdu["pdu-type"]
893 vdur["name"] = vdu["pdu-type"]
894 # TODO volumes: name, volume-id
895 for icp in vdu.get("int-cpd", ()):
896 vdu_icp = {
897 "id": icp["id"],
898 "connection-point-id": icp["id"],
899 "name": icp.get("id"),
900 }
901
902 vdur["internal-connection-point"].append(vdu_icp)
903
904 for iface in icp.get("virtual-network-interface-requirement", ()):
905 # Name, mac-address and interface position is taken from VNFD
906 # and included into VNFR. By this way RO can process this information
907 # while creating the VDU.
908 iface_fields = ("name", "mac-address", "position", "ip-address")
909 vdu_iface = {
910 x: iface[x] for x in iface_fields if iface.get(x) is not None
911 }
912
913 vdu_iface["internal-connection-point-ref"] = vdu_icp["id"]
914 if "port-security-enabled" in icp:
915 vdu_iface["port-security-enabled"] = icp[
916 "port-security-enabled"
917 ]
918
919 if "port-security-disable-strategy" in icp:
920 vdu_iface["port-security-disable-strategy"] = icp[
921 "port-security-disable-strategy"
922 ]
923
924 for ext_cp in vnfd.get("ext-cpd", ()):
925 if not ext_cp.get("int-cpd"):
926 continue
927 if ext_cp["int-cpd"].get("vdu-id") != vdu["id"]:
928 continue
929 if icp["id"] == ext_cp["int-cpd"].get("cpd"):
930 vdu_iface["external-connection-point-ref"] = ext_cp.get(
931 "id"
932 )
933
934 if "port-security-enabled" in ext_cp:
935 vdu_iface["port-security-enabled"] = ext_cp[
936 "port-security-enabled"
937 ]
938
939 if "port-security-disable-strategy" in ext_cp:
940 vdu_iface["port-security-disable-strategy"] = ext_cp[
941 "port-security-disable-strategy"
942 ]
943
944 break
945
946 if (
947 vnfd_mgmt_cp
948 and vdu_iface.get("external-connection-point-ref")
949 == vnfd_mgmt_cp
950 ):
951 vdu_iface["mgmt-vnf"] = True
952 vdu_iface["mgmt-interface"] = True
953
954 for ecp in vdu_mgmt_cp:
955 if vdu_iface.get("external-connection-point-ref") == ecp:
956 vdu_iface["mgmt-interface"] = True
957
958 if iface.get("virtual-interface"):
959 vdu_iface.update(deepcopy(iface["virtual-interface"]))
960
961 # look for network where this interface is connected
962 iface_ext_cp = vdu_iface.get("external-connection-point-ref")
963 if iface_ext_cp:
964 # TODO: Change for multiple df support
965 for df in get_iterable(nsd.get("df")):
966 for vnf_profile in get_iterable(df.get("vnf-profile")):
967 for vlc_index, vlc in enumerate(
968 get_iterable(
969 vnf_profile.get("virtual-link-connectivity")
970 )
971 ):
972 for cpd in get_iterable(
973 vlc.get("constituent-cpd-id")
974 ):
975 if (
976 cpd.get("constituent-cpd-id")
977 == iface_ext_cp
978 ) and vnf_profile.get("id") == vnf_index:
979 vdu_iface["ns-vld-id"] = vlc.get(
980 "virtual-link-profile-id"
981 )
982 # if iface type is SRIOV or PASSTHROUGH, set pci-interfaces flag to True
983 if vdu_iface.get("type") in (
984 "SR-IOV",
985 "PCI-PASSTHROUGH",
986 ):
987 nsr_descriptor["vld"][vlc_index][
988 "pci-interfaces"
989 ] = True
990 break
991 elif vdu_iface.get("internal-connection-point-ref"):
992 vdu_iface["vnf-vld-id"] = icp.get("int-virtual-link-desc")
993 # TODO: store fixed IP address in the record (if it exists in the ICP)
994 # if iface type is SRIOV or PASSTHROUGH, set pci-interfaces flag to True
995 if vdu_iface.get("type") in ("SR-IOV", "PCI-PASSTHROUGH"):
996 ivld_index = utils.find_index_in_list(
997 vnfd.get("int-virtual-link-desc", ()),
998 lambda ivld: ivld["id"]
999 == icp.get("int-virtual-link-desc"),
1000 )
1001 vnfr_descriptor["vld"][ivld_index]["pci-interfaces"] = True
1002
1003 vdur["interfaces"].append(vdu_iface)
1004
1005 if vdu.get("sw-image-desc"):
1006 sw_image = utils.find_in_list(
1007 vnfd.get("sw-image-desc", ()),
1008 lambda image: image["id"] == vdu.get("sw-image-desc"),
1009 )
1010 nsr_sw_image_data = utils.find_in_list(
1011 nsr_descriptor["image"],
1012 lambda nsr_image: (nsr_image.get("image") == sw_image.get("image")),
1013 )
1014 vdur["ns-image-id"] = nsr_sw_image_data["id"]
1015
1016 if vdu.get("alternative-sw-image-desc"):
1017 alt_image_ids = []
1018 for alt_image_id in vdu.get("alternative-sw-image-desc", ()):
1019 sw_image = utils.find_in_list(
1020 vnfd.get("sw-image-desc", ()),
1021 lambda image: image["id"] == alt_image_id,
1022 )
1023 nsr_sw_image_data = utils.find_in_list(
1024 nsr_descriptor["image"],
1025 lambda nsr_image: (
1026 nsr_image.get("image") == sw_image.get("image")
1027 ),
1028 )
1029 alt_image_ids.append(nsr_sw_image_data["id"])
1030 vdur["alt-image-ids"] = alt_image_ids
1031
1032 revision = revision if revision is not None else 1
1033 flavor_data_name = (
1034 vdu["id"][:56] + "-" + vnf_index + "-" + str(revision) + "-flv"
1035 )
1036 nsr_flavor_desc = utils.find_in_list(
1037 nsr_descriptor["flavor"],
1038 lambda flavor: flavor["name"] == flavor_data_name,
1039 )
1040
1041 if nsr_flavor_desc:
1042 vdur["ns-flavor-id"] = nsr_flavor_desc["id"]
1043
1044 # Adding Shared Volume information to vdur
1045 if vdur.get("virtual-storages"):
1046 nsr_sv = []
1047 for vsd in vdur["virtual-storages"]:
1048 if vsd.get("vdu-storage-requirements"):
1049 if (
1050 vsd["vdu-storage-requirements"][0].get("key")
1051 == "multiattach"
1052 and vsd["vdu-storage-requirements"][0].get("value")
1053 == "True"
1054 ):
1055 nsr_sv.append(vsd["id"])
1056 if nsr_sv:
1057 vdur["shared-volumes-id"] = nsr_sv
1058
1059 # Adding Affinity groups information to vdur
1060 try:
1061 vdu_profile_affinity_group = utils.find_in_list(
1062 vnfd.get("df")[0]["vdu-profile"],
1063 lambda a_vdu: a_vdu["id"] == vdu["id"],
1064 )
1065 except Exception:
1066 vdu_profile_affinity_group = None
1067
1068 if vdu_profile_affinity_group:
1069 affinity_group_ids = []
1070 for affinity_group in vdu_profile_affinity_group.get(
1071 "affinity-or-anti-affinity-group", ()
1072 ):
1073 vdu_affinity_group = utils.find_in_list(
1074 vdu_profile_affinity_group.get(
1075 "affinity-or-anti-affinity-group", ()
1076 ),
1077 lambda ag_fp: ag_fp["id"] == affinity_group["id"],
1078 )
1079 nsr_affinity_group = utils.find_in_list(
1080 nsr_descriptor["affinity-or-anti-affinity-group"],
1081 lambda nsr_ag: (
1082 nsr_ag.get("ag-id") == vdu_affinity_group.get("id")
1083 and nsr_ag.get("member-vnf-index")
1084 == vnfr_descriptor.get("member-vnf-index-ref")
1085 ),
1086 )
1087 # Update Affinity Group VIM name if VDU instantiation parameter is present
1088 if vnf_params and vnf_params.get("affinity-or-anti-affinity-group"):
1089 vnf_params_affinity_group = utils.find_in_list(
1090 vnf_params["affinity-or-anti-affinity-group"],
1091 lambda vnfp_ag: (
1092 vnfp_ag.get("id") == vdu_affinity_group.get("id")
1093 ),
1094 )
1095 if vnf_params_affinity_group.get("vim-affinity-group-id"):
1096 nsr_affinity_group[
1097 "vim-affinity-group-id"
1098 ] = vnf_params_affinity_group["vim-affinity-group-id"]
1099 affinity_group_ids.append(nsr_affinity_group["id"])
1100 vdur["affinity-or-anti-affinity-group-id"] = affinity_group_ids
1101
1102 if vdu_instantiation_level:
1103 count = vdu_instantiation_level.get("number-of-instances")
1104 else:
1105 count = 1
1106
1107 for index in range(0, count):
1108 vdur = deepcopy(vdur)
1109 for iface in vdur["interfaces"]:
1110 if iface.get("ip-address") and index != 0:
1111 iface["ip-address"] = increment_ip_mac(iface["ip-address"])
1112 if iface.get("mac-address") and index != 0:
1113 iface["mac-address"] = increment_ip_mac(iface["mac-address"])
1114
1115 vdur["_id"] = str(uuid4())
1116 vdur["id"] = vdur["_id"]
1117 vdur["count-index"] = index
1118 vnfr_descriptor["vdur"].append(vdur)
1119 return vnfr_descriptor
1120
1121 def vca_status_refresh(self, session, ns_instance_content, filter_q):
1122 """
1123 vcaStatus in ns_instance_content maybe stale, check if it is stale and create lcm op
1124 to refresh vca status by sending message to LCM when it is stale. Ignore otherwise.
1125 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1126 :param ns_instance_content: ns instance content
1127 :param filter_q: dict: query parameter containing vcaStatus-refresh as true or false
1128 :return: None
1129 """
1130 time_now, time_delta = (
1131 time(),
1132 time() - ns_instance_content["_admin"]["modified"],
1133 )
1134 force_refresh = (
1135 isinstance(filter_q, dict) and filter_q.get("vcaStatusRefresh") == "true"
1136 )
1137 threshold_reached = time_delta > 120
1138 if force_refresh or threshold_reached:
1139 operation, _id = "vca_status_refresh", ns_instance_content["_id"]
1140 ns_instance_content["_admin"]["modified"] = time_now
1141 self.db.set_one(self.topic, {"_id": _id}, ns_instance_content)
1142 nslcmop_desc = NsLcmOpTopic._create_nslcmop(_id, operation, None)
1143 self.format_on_new(
1144 nslcmop_desc, session["project_id"], make_public=session["public"]
1145 )
1146 nslcmop_desc["_admin"].pop("nsState")
1147 self.msg.write("ns", operation, nslcmop_desc)
1148 return
1149
1150 def show(self, session, _id, filter_q=None, api_req=False):
1151 """
1152 Get complete information on an ns instance.
1153 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1154 :param _id: string, ns instance id
1155 :param filter_q: dict: query parameter containing vcaStatusRefresh as true or false
1156 :param api_req: True if this call is serving an external API request. False if serving internal request.
1157 :return: dictionary, raise exception if not found.
1158 """
1159 ns_instance_content = super().show(session, _id, api_req)
1160 self.vca_status_refresh(session, ns_instance_content, filter_q)
1161 return ns_instance_content
1162
1163 def edit(self, session, _id, indata=None, kwargs=None, content=None):
1164 raise EngineException(
1165 "Method edit called directly", HTTPStatus.INTERNAL_SERVER_ERROR
1166 )
1167
1168
1169 class VnfrTopic(BaseTopic):
1170 topic = "vnfrs"
1171 topic_msg = None
1172
1173 def __init__(self, db, fs, msg, auth):
1174 BaseTopic.__init__(self, db, fs, msg, auth)
1175
1176 def delete(self, session, _id, dry_run=False, not_send_msg=None):
1177 raise EngineException(
1178 "Method delete called directly", HTTPStatus.INTERNAL_SERVER_ERROR
1179 )
1180
1181 def edit(self, session, _id, indata=None, kwargs=None, content=None):
1182 raise EngineException(
1183 "Method edit called directly", HTTPStatus.INTERNAL_SERVER_ERROR
1184 )
1185
1186 def new(self, rollback, session, indata=None, kwargs=None, headers=None):
1187 # Not used because vnfrs are created and deleted by NsrTopic class directly
1188 raise EngineException(
1189 "Method new called directly", HTTPStatus.INTERNAL_SERVER_ERROR
1190 )
1191
1192
1193 class NsLcmOpTopic(BaseTopic):
1194 topic = "nslcmops"
1195 topic_msg = "ns"
1196 operation_schema = { # mapping between operation and jsonschema to validate
1197 "instantiate": ns_instantiate,
1198 "action": ns_action,
1199 "update": ns_update,
1200 "scale": ns_scale,
1201 "heal": ns_heal,
1202 "terminate": ns_terminate,
1203 "migrate": ns_migrate,
1204 "verticalscale": ns_verticalscale,
1205 }
1206
1207 def __init__(self, db, fs, msg, auth):
1208 BaseTopic.__init__(self, db, fs, msg, auth)
1209 self.nsrtopic = NsrTopic(db, fs, msg, auth)
1210
1211 def _check_ns_operation(self, session, nsr, operation, indata):
1212 """
1213 Check that user has enter right parameters for the operation
1214 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1215 :param operation: it can be: instantiate, terminate, action, update, heal
1216 :param indata: descriptor with the parameters of the operation
1217 :return: None
1218 """
1219 if operation == "action":
1220 self._check_action_ns_operation(indata, nsr)
1221 elif operation == "scale":
1222 self._check_scale_ns_operation(indata, nsr)
1223 elif operation == "update":
1224 self._check_update_ns_operation(indata, nsr)
1225 elif operation == "heal":
1226 self._check_heal_ns_operation(indata, nsr)
1227 elif operation == "instantiate":
1228 self._check_instantiate_ns_operation(indata, nsr, session)
1229
1230 def _check_action_ns_operation(self, indata, nsr):
1231 nsd = nsr["nsd"]
1232 # check vnf_member_index
1233 if indata.get("vnf_member_index"):
1234 indata["member_vnf_index"] = indata.pop(
1235 "vnf_member_index"
1236 ) # for backward compatibility
1237 if indata.get("member_vnf_index"):
1238 vnfd = self._get_vnfd_from_vnf_member_index(
1239 indata["member_vnf_index"], nsr["_id"]
1240 )
1241 try:
1242 configs = vnfd.get("df")[0]["lcm-operations-configuration"][
1243 "operate-vnf-op-config"
1244 ]["day1-2"]
1245 except Exception:
1246 configs = []
1247
1248 if indata.get("vdu_id"):
1249 self._check_valid_vdu(vnfd, indata["vdu_id"])
1250 descriptor_configuration = utils.find_in_list(
1251 configs, lambda config: config["id"] == indata["vdu_id"]
1252 )
1253 elif indata.get("kdu_name"):
1254 self._check_valid_kdu(vnfd, indata["kdu_name"])
1255 descriptor_configuration = utils.find_in_list(
1256 configs, lambda config: config["id"] == indata.get("kdu_name")
1257 )
1258 else:
1259 descriptor_configuration = utils.find_in_list(
1260 configs, lambda config: config["id"] == vnfd["id"]
1261 )
1262 if descriptor_configuration is not None:
1263 descriptor_configuration = descriptor_configuration.get(
1264 "config-primitive"
1265 )
1266 else: # use a NSD
1267 descriptor_configuration = nsd.get("ns-configuration", {}).get(
1268 "config-primitive"
1269 )
1270
1271 # For k8s allows default primitives without validating the parameters
1272 if indata.get("kdu_name") and indata["primitive"] in (
1273 "upgrade",
1274 "rollback",
1275 "status",
1276 "inspect",
1277 "readme",
1278 ):
1279 # TODO should be checked that rollback only can contains revsision_numbe????
1280 if not indata.get("member_vnf_index"):
1281 raise EngineException(
1282 "Missing action parameter 'member_vnf_index' for default KDU primitive '{}'".format(
1283 indata["primitive"]
1284 )
1285 )
1286 return
1287 # if not, check primitive
1288 for config_primitive in get_iterable(descriptor_configuration):
1289 if indata["primitive"] == config_primitive["name"]:
1290 # check needed primitive_params are provided
1291 if indata.get("primitive_params"):
1292 in_primitive_params_copy = copy(indata["primitive_params"])
1293 else:
1294 in_primitive_params_copy = {}
1295 for paramd in get_iterable(config_primitive.get("parameter")):
1296 if paramd["name"] in in_primitive_params_copy:
1297 del in_primitive_params_copy[paramd["name"]]
1298 elif not paramd.get("default-value"):
1299 raise EngineException(
1300 "Needed parameter {} not provided for primitive '{}'".format(
1301 paramd["name"], indata["primitive"]
1302 )
1303 )
1304 # check no extra primitive params are provided
1305 if in_primitive_params_copy:
1306 raise EngineException(
1307 "parameter/s '{}' not present at vnfd /nsd for primitive '{}'".format(
1308 list(in_primitive_params_copy.keys()), indata["primitive"]
1309 )
1310 )
1311 break
1312 else:
1313 raise EngineException(
1314 "Invalid primitive '{}' is not present at vnfd/nsd".format(
1315 indata["primitive"]
1316 )
1317 )
1318
1319 def _check_update_ns_operation(self, indata, nsr) -> None:
1320 """Validates the ns-update request according to updateType
1321
1322 If updateType is CHANGE_VNFPKG:
1323 - it checks the vnfInstanceId, whether it's available under ns instance
1324 - it checks the vnfdId whether it matches with the vnfd-id in the vnf-record of specified VNF.
1325 Otherwise exception will be raised.
1326 If updateType is REMOVE_VNF:
1327 - it checks if the vnfInstanceId is available in the ns instance
1328 - Otherwise exception will be raised.
1329
1330 Args:
1331 indata: includes updateType such as CHANGE_VNFPKG,
1332 nsr: network service record
1333
1334 Raises:
1335 EngineException:
1336 a meaningful error if given update parameters are not proper such as
1337 "Error in validating ns-update request: <ID> does not match
1338 with the vnfd-id of vnfinstance
1339 http_code=HTTPStatus.UNPROCESSABLE_ENTITY"
1340
1341 """
1342 try:
1343 if indata["updateType"] == "CHANGE_VNFPKG":
1344 # vnfInstanceId, nsInstanceId, vnfdId are mandatory
1345 vnf_instance_id = indata["changeVnfPackageData"]["vnfInstanceId"]
1346 ns_instance_id = indata["nsInstanceId"]
1347 vnfd_id_2update = indata["changeVnfPackageData"]["vnfdId"]
1348
1349 if vnf_instance_id not in nsr["constituent-vnfr-ref"]:
1350 raise EngineException(
1351 f"Error in validating ns-update request: vnf {vnf_instance_id} does not "
1352 f"belong to NS {ns_instance_id}",
1353 http_code=HTTPStatus.UNPROCESSABLE_ENTITY,
1354 )
1355
1356 # Getting vnfrs through the ns_instance_id
1357 vnfrs = self.db.get_list("vnfrs", {"nsr-id-ref": ns_instance_id})
1358 constituent_vnfd_id = next(
1359 (
1360 vnfr["vnfd-id"]
1361 for vnfr in vnfrs
1362 if vnfr["id"] == vnf_instance_id
1363 ),
1364 None,
1365 )
1366
1367 # Check the given vnfd-id belongs to given vnf instance
1368 if constituent_vnfd_id and (vnfd_id_2update != constituent_vnfd_id):
1369 raise EngineException(
1370 f"Error in validating ns-update request: vnfd-id {vnfd_id_2update} does not "
1371 f"match with the vnfd-id: {constituent_vnfd_id} of VNF instance: {vnf_instance_id}",
1372 http_code=HTTPStatus.UNPROCESSABLE_ENTITY,
1373 )
1374
1375 # Validating the ns update timeout
1376 if (
1377 indata.get("timeout_ns_update")
1378 and indata["timeout_ns_update"] < 300
1379 ):
1380 raise EngineException(
1381 "Error in validating ns-update request: {} second is not enough "
1382 "to upgrade the VNF instance: {}".format(
1383 indata["timeout_ns_update"], vnf_instance_id
1384 ),
1385 http_code=HTTPStatus.UNPROCESSABLE_ENTITY,
1386 )
1387 elif indata["updateType"] == "REMOVE_VNF":
1388 vnf_instance_id = indata["removeVnfInstanceId"]
1389 ns_instance_id = indata["nsInstanceId"]
1390 if vnf_instance_id not in nsr["constituent-vnfr-ref"]:
1391 raise EngineException(
1392 "Invalid VNF Instance Id. '{}' is not "
1393 "present in the NS '{}'".format(vnf_instance_id, ns_instance_id)
1394 )
1395
1396 except (
1397 DbException,
1398 AttributeError,
1399 IndexError,
1400 KeyError,
1401 ValueError,
1402 ) as e:
1403 raise type(e)(
1404 "Ns update request could not be processed with error: {}.".format(e)
1405 )
1406
1407 def _check_scale_ns_operation(self, indata, nsr):
1408 vnfd = self._get_vnfd_from_vnf_member_index(
1409 indata["scaleVnfData"]["scaleByStepData"]["member-vnf-index"], nsr["_id"]
1410 )
1411 for scaling_aspect in get_iterable(vnfd.get("df", ())[0]["scaling-aspect"]):
1412 if (
1413 indata["scaleVnfData"]["scaleByStepData"]["scaling-group-descriptor"]
1414 == scaling_aspect["id"]
1415 ):
1416 break
1417 else:
1418 raise EngineException(
1419 "Invalid scaleVnfData:scaleByStepData:scaling-group-descriptor '{}' is not "
1420 "present at vnfd:scaling-aspect".format(
1421 indata["scaleVnfData"]["scaleByStepData"][
1422 "scaling-group-descriptor"
1423 ]
1424 )
1425 )
1426
1427 def _check_heal_ns_operation(self, indata, nsr):
1428 return
1429
1430 def _check_instantiate_ns_operation(self, indata, nsr, session):
1431 vnf_member_index_to_vnfd = {} # map between vnf_member_index to vnf descriptor.
1432 vim_accounts = []
1433 wim_accounts = []
1434 nsd = nsr["nsd"]
1435 self._check_valid_vim_account(indata["vimAccountId"], vim_accounts, session)
1436 self._check_valid_wim_account(indata.get("wimAccountId"), wim_accounts, session)
1437 for in_vnf in get_iterable(indata.get("vnf")):
1438 member_vnf_index = in_vnf["member-vnf-index"]
1439 if vnf_member_index_to_vnfd.get(member_vnf_index):
1440 vnfd = vnf_member_index_to_vnfd[member_vnf_index]
1441 else:
1442 vnfd = self._get_vnfd_from_vnf_member_index(
1443 member_vnf_index, nsr["_id"]
1444 )
1445 vnf_member_index_to_vnfd[
1446 member_vnf_index
1447 ] = vnfd # add to cache, avoiding a later look for
1448 self._check_vnf_instantiation_params(in_vnf, vnfd)
1449 if in_vnf.get("vimAccountId"):
1450 self._check_valid_vim_account(
1451 in_vnf["vimAccountId"], vim_accounts, session
1452 )
1453
1454 for in_vld in get_iterable(indata.get("vld")):
1455 self._check_valid_wim_account(
1456 in_vld.get("wimAccountId"), wim_accounts, session
1457 )
1458 for vldd in get_iterable(nsd.get("virtual-link-desc")):
1459 if in_vld["name"] == vldd["id"]:
1460 break
1461 else:
1462 raise EngineException(
1463 "Invalid parameter vld:name='{}' is not present at nsd:vld".format(
1464 in_vld["name"]
1465 )
1466 )
1467
1468 def _get_vnfd_from_vnf_member_index(self, member_vnf_index, nsr_id):
1469 # Obtain vnf descriptor. The vnfr is used to get the vnfd._id used for this member_vnf_index
1470 vnfr = self.db.get_one(
1471 "vnfrs",
1472 {"nsr-id-ref": nsr_id, "member-vnf-index-ref": member_vnf_index},
1473 fail_on_empty=False,
1474 )
1475 if not vnfr:
1476 raise EngineException(
1477 "Invalid parameter member_vnf_index='{}' is not one of the "
1478 "nsd:constituent-vnfd".format(member_vnf_index)
1479 )
1480
1481 # Backwards compatibility: if there is no revision, get it from the one and only VNFD entry
1482 if "revision" in vnfr:
1483 vnfd_revision = vnfr["vnfd-id"] + ":" + str(vnfr["revision"])
1484 vnfd = self.db.get_one(
1485 "vnfds_revisions", {"_id": vnfd_revision}, fail_on_empty=False
1486 )
1487 else:
1488 vnfd = self.db.get_one(
1489 "vnfds", {"_id": vnfr["vnfd-id"]}, fail_on_empty=False
1490 )
1491
1492 if not vnfd:
1493 raise EngineException(
1494 "vnfd id={} has been deleted!. Operation cannot be performed".format(
1495 vnfr["vnfd-id"]
1496 )
1497 )
1498 return vnfd
1499
1500 def _check_valid_vdu(self, vnfd, vdu_id):
1501 for vdud in get_iterable(vnfd.get("vdu")):
1502 if vdud["id"] == vdu_id:
1503 return vdud
1504 else:
1505 raise EngineException(
1506 "Invalid parameter vdu_id='{}' not present at vnfd:vdu:id".format(
1507 vdu_id
1508 )
1509 )
1510
1511 def _check_valid_kdu(self, vnfd, kdu_name):
1512 for kdud in get_iterable(vnfd.get("kdu")):
1513 if kdud["name"] == kdu_name:
1514 return kdud
1515 else:
1516 raise EngineException(
1517 "Invalid parameter kdu_name='{}' not present at vnfd:kdu:name".format(
1518 kdu_name
1519 )
1520 )
1521
1522 def _check_vnf_instantiation_params(self, in_vnf, vnfd):
1523 for in_vdu in get_iterable(in_vnf.get("vdu")):
1524 for vdu in get_iterable(vnfd.get("vdu")):
1525 if in_vdu["id"] == vdu["id"]:
1526 for volume in get_iterable(in_vdu.get("volume")):
1527 for volumed in get_iterable(vdu.get("virtual-storage-desc")):
1528 if volumed == volume["name"]:
1529 break
1530 else:
1531 raise EngineException(
1532 "Invalid parameter vnf[member-vnf-index='{}']:vdu[id='{}']:"
1533 "volume:name='{}' is not present at "
1534 "vnfd:vdu:virtual-storage-desc list".format(
1535 in_vnf["member-vnf-index"],
1536 in_vdu["id"],
1537 volume["id"],
1538 )
1539 )
1540
1541 vdu_if_names = set()
1542 for cpd in get_iterable(vdu.get("int-cpd")):
1543 for iface in get_iterable(
1544 cpd.get("virtual-network-interface-requirement")
1545 ):
1546 vdu_if_names.add(iface.get("name"))
1547
1548 for in_iface in get_iterable(in_vdu.get("interface")):
1549 if in_iface["name"] in vdu_if_names:
1550 break
1551 else:
1552 raise EngineException(
1553 "Invalid parameter vnf[member-vnf-index='{}']:vdu[id='{}']:"
1554 "int-cpd[id='{}'] is not present at vnfd:vdu:int-cpd".format(
1555 in_vnf["member-vnf-index"],
1556 in_vdu["id"],
1557 in_iface["name"],
1558 )
1559 )
1560 break
1561
1562 else:
1563 raise EngineException(
1564 "Invalid parameter vnf[member-vnf-index='{}']:vdu[id='{}'] is not present "
1565 "at vnfd:vdu".format(in_vnf["member-vnf-index"], in_vdu["id"])
1566 )
1567
1568 vnfd_ivlds_cpds = {
1569 ivld.get("id"): set()
1570 for ivld in get_iterable(vnfd.get("int-virtual-link-desc"))
1571 }
1572 for vdu in vnfd.get("vdu", {}):
1573 for cpd in vdu.get("int-cpd", {}):
1574 if cpd.get("int-virtual-link-desc"):
1575 vnfd_ivlds_cpds[cpd.get("int-virtual-link-desc")] = cpd.get("id")
1576
1577 for in_ivld in get_iterable(in_vnf.get("internal-vld")):
1578 if in_ivld.get("name") in vnfd_ivlds_cpds:
1579 for in_icp in get_iterable(in_ivld.get("internal-connection-point")):
1580 if in_icp["id-ref"] in vnfd_ivlds_cpds[in_ivld.get("name")]:
1581 break
1582 else:
1583 raise EngineException(
1584 "Invalid parameter vnf[member-vnf-index='{}']:internal-vld[name"
1585 "='{}']:internal-connection-point[id-ref:'{}'] is not present at "
1586 "vnfd:internal-vld:name/id:internal-connection-point".format(
1587 in_vnf["member-vnf-index"],
1588 in_ivld["name"],
1589 in_icp["id-ref"],
1590 )
1591 )
1592 else:
1593 raise EngineException(
1594 "Invalid parameter vnf[member-vnf-index='{}']:internal-vld:name='{}'"
1595 " is not present at vnfd '{}'".format(
1596 in_vnf["member-vnf-index"], in_ivld["name"], vnfd["id"]
1597 )
1598 )
1599
1600 def _check_valid_vim_account(self, vim_account, vim_accounts, session):
1601 if vim_account in vim_accounts:
1602 return
1603 try:
1604 db_filter = self._get_project_filter(session)
1605 db_filter["_id"] = vim_account
1606 self.db.get_one("vim_accounts", db_filter)
1607 except Exception:
1608 raise EngineException(
1609 "Invalid vimAccountId='{}' not present for the project".format(
1610 vim_account
1611 )
1612 )
1613 vim_accounts.append(vim_account)
1614
1615 def _get_vim_account(self, vim_id: str, session):
1616 try:
1617 db_filter = self._get_project_filter(session)
1618 db_filter["_id"] = vim_id
1619 return self.db.get_one("vim_accounts", db_filter)
1620 except Exception:
1621 raise EngineException(
1622 "Invalid vimAccountId='{}' not present for the project".format(vim_id)
1623 )
1624
1625 def _check_valid_wim_account(self, wim_account, wim_accounts, session):
1626 if not isinstance(wim_account, str):
1627 return
1628 if wim_account in wim_accounts:
1629 return
1630 try:
1631 db_filter = self._get_project_filter(session)
1632 db_filter["_id"] = wim_account
1633 self.db.get_one("wim_accounts", db_filter)
1634 except Exception:
1635 raise EngineException(
1636 "Invalid wimAccountId='{}' not present for the project".format(
1637 wim_account
1638 )
1639 )
1640 wim_accounts.append(wim_account)
1641
1642 def _look_for_pdu(
1643 self, session, rollback, vnfr, vim_account, vnfr_update, vnfr_update_rollback
1644 ):
1645 """
1646 Look for a free PDU in the catalog matching vdur type and interfaces. Fills vnfr.vdur with the interface
1647 (ip_address, ...) information.
1648 Modifies PDU _admin.usageState to 'IN_USE'
1649 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1650 :param rollback: list with the database modifications to rollback if needed
1651 :param vnfr: vnfr to be updated. It is modified with pdu interface info if pdu is found
1652 :param vim_account: vim_account where this vnfr should be deployed
1653 :param vnfr_update: dictionary filled by this method with changes to be done at database vnfr
1654 :param vnfr_update_rollback: dictionary filled by this method with original content of vnfr in case a rollback
1655 of the changed vnfr is needed
1656
1657 :return: List of PDU interfaces that are connected to an existing VIM network. Each item contains:
1658 "vim-network-name": used at VIM
1659 "name": interface name
1660 "vnf-vld-id": internal VNFD vld where this interface is connected, or
1661 "ns-vld-id": NSD vld where this interface is connected.
1662 NOTE: One, and only one between 'vnf-vld-id' and 'ns-vld-id' contains a value. The other will be None
1663 """
1664
1665 ifaces_forcing_vim_network = []
1666 for vdur_index, vdur in enumerate(get_iterable(vnfr.get("vdur"))):
1667 if not vdur.get("pdu-type"):
1668 continue
1669 pdu_type = vdur.get("pdu-type")
1670 pdu_filter = self._get_project_filter(session)
1671 pdu_filter["vim_accounts"] = vim_account
1672 pdu_filter["type"] = pdu_type
1673 pdu_filter["_admin.operationalState"] = "ENABLED"
1674 pdu_filter["_admin.usageState"] = "NOT_IN_USE"
1675 # TODO feature 1417: "shared": True,
1676
1677 available_pdus = self.db.get_list("pdus", pdu_filter)
1678 for pdu in available_pdus:
1679 # step 1 check if this pdu contains needed interfaces:
1680 match_interfaces = True
1681 for vdur_interface in vdur["interfaces"]:
1682 for pdu_interface in pdu["interfaces"]:
1683 if pdu_interface["name"] == vdur_interface["name"]:
1684 # TODO feature 1417: match per mgmt type
1685 break
1686 else: # no interface found for name
1687 match_interfaces = False
1688 break
1689 if match_interfaces:
1690 break
1691 else:
1692 raise EngineException(
1693 "No PDU of type={} at vim_account={} found for member_vnf_index={}, vdu={} matching interface "
1694 "names".format(
1695 pdu_type,
1696 vim_account,
1697 vnfr["member-vnf-index-ref"],
1698 vdur["vdu-id-ref"],
1699 )
1700 )
1701
1702 # step 2. Update pdu
1703 rollback_pdu = {
1704 "_admin.usageState": pdu["_admin"]["usageState"],
1705 "_admin.usage.vnfr_id": None,
1706 "_admin.usage.nsr_id": None,
1707 "_admin.usage.vdur": None,
1708 }
1709 self.db.set_one(
1710 "pdus",
1711 {"_id": pdu["_id"]},
1712 {
1713 "_admin.usageState": "IN_USE",
1714 "_admin.usage": {
1715 "vnfr_id": vnfr["_id"],
1716 "nsr_id": vnfr["nsr-id-ref"],
1717 "vdur": vdur["vdu-id-ref"],
1718 },
1719 },
1720 )
1721 rollback.append(
1722 {
1723 "topic": "pdus",
1724 "_id": pdu["_id"],
1725 "operation": "set",
1726 "content": rollback_pdu,
1727 }
1728 )
1729
1730 # step 3. Fill vnfr info by filling vdur
1731 vdu_text = "vdur.{}".format(vdur_index)
1732 vnfr_update_rollback[vdu_text + ".pdu-id"] = None
1733 vnfr_update[vdu_text + ".pdu-id"] = pdu["_id"]
1734 for iface_index, vdur_interface in enumerate(vdur["interfaces"]):
1735 for pdu_interface in pdu["interfaces"]:
1736 if pdu_interface["name"] == vdur_interface["name"]:
1737 iface_text = vdu_text + ".interfaces.{}".format(iface_index)
1738 for k, v in pdu_interface.items():
1739 if k in (
1740 "ip-address",
1741 "mac-address",
1742 ): # TODO: switch-xxxxx must be inserted
1743 vnfr_update[iface_text + ".{}".format(k)] = v
1744 vnfr_update_rollback[
1745 iface_text + ".{}".format(k)
1746 ] = vdur_interface.get(v)
1747 if pdu_interface.get("ip-address"):
1748 if vdur_interface.get(
1749 "mgmt-interface"
1750 ) or vdur_interface.get("mgmt-vnf"):
1751 vnfr_update_rollback[
1752 vdu_text + ".ip-address"
1753 ] = vdur.get("ip-address")
1754 vnfr_update[vdu_text + ".ip-address"] = pdu_interface[
1755 "ip-address"
1756 ]
1757 if vdur_interface.get("mgmt-vnf"):
1758 vnfr_update_rollback["ip-address"] = vnfr.get(
1759 "ip-address"
1760 )
1761 vnfr_update["ip-address"] = pdu_interface["ip-address"]
1762 vnfr_update[vdu_text + ".ip-address"] = pdu_interface[
1763 "ip-address"
1764 ]
1765 if pdu_interface.get("vim-network-name") or pdu_interface.get(
1766 "vim-network-id"
1767 ):
1768 ifaces_forcing_vim_network.append(
1769 {
1770 "name": vdur_interface.get("vnf-vld-id")
1771 or vdur_interface.get("ns-vld-id"),
1772 "vnf-vld-id": vdur_interface.get("vnf-vld-id"),
1773 "ns-vld-id": vdur_interface.get("ns-vld-id"),
1774 }
1775 )
1776 if pdu_interface.get("vim-network-id"):
1777 ifaces_forcing_vim_network[-1][
1778 "vim-network-id"
1779 ] = pdu_interface["vim-network-id"]
1780 if pdu_interface.get("vim-network-name"):
1781 ifaces_forcing_vim_network[-1][
1782 "vim-network-name"
1783 ] = pdu_interface["vim-network-name"]
1784 break
1785
1786 return ifaces_forcing_vim_network
1787
1788 def _look_for_k8scluster(
1789 self, session, rollback, vnfr, vim_account, vnfr_update, vnfr_update_rollback
1790 ):
1791 """
1792 Look for an available k8scluster for all the kuds in the vnfd matching version and cni requirements.
1793 Fills vnfr.kdur with the selected k8scluster
1794
1795 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1796 :param rollback: list with the database modifications to rollback if needed
1797 :param vnfr: vnfr to be updated. It is modified with pdu interface info if pdu is found
1798 :param vim_account: vim_account where this vnfr should be deployed
1799 :param vnfr_update: dictionary filled by this method with changes to be done at database vnfr
1800 :param vnfr_update_rollback: dictionary filled by this method with original content of vnfr in case a rollback
1801 of the changed vnfr is needed
1802
1803 :return: List of KDU interfaces that are connected to an existing VIM network. Each item contains:
1804 "vim-network-name": used at VIM
1805 "name": interface name
1806 "vnf-vld-id": internal VNFD vld where this interface is connected, or
1807 "ns-vld-id": NSD vld where this interface is connected.
1808 NOTE: One, and only one between 'vnf-vld-id' and 'ns-vld-id' contains a value. The other will be None
1809 """
1810
1811 ifaces_forcing_vim_network = []
1812 if not vnfr.get("kdur"):
1813 return ifaces_forcing_vim_network
1814
1815 kdu_filter = self._get_project_filter(session)
1816 kdu_filter["vim_account"] = vim_account
1817 # TODO kdu_filter["_admin.operationalState"] = "ENABLED"
1818 available_k8sclusters = self.db.get_list("k8sclusters", kdu_filter)
1819
1820 k8s_requirements = {} # just for logging
1821 for k8scluster in available_k8sclusters:
1822 if not vnfr.get("k8s-cluster"):
1823 break
1824 # restrict by cni
1825 if vnfr["k8s-cluster"].get("cni"):
1826 k8s_requirements["cni"] = vnfr["k8s-cluster"]["cni"]
1827 if not set(vnfr["k8s-cluster"]["cni"]).intersection(
1828 k8scluster.get("cni", ())
1829 ):
1830 continue
1831 # restrict by version
1832 if vnfr["k8s-cluster"].get("version"):
1833 k8s_requirements["version"] = vnfr["k8s-cluster"]["version"]
1834 if k8scluster.get("k8s_version") not in vnfr["k8s-cluster"]["version"]:
1835 continue
1836 # restrict by number of networks
1837 if vnfr["k8s-cluster"].get("nets"):
1838 k8s_requirements["networks"] = len(vnfr["k8s-cluster"]["nets"])
1839 if not k8scluster.get("nets") or len(k8scluster["nets"]) < len(
1840 vnfr["k8s-cluster"]["nets"]
1841 ):
1842 continue
1843 break
1844 else:
1845 raise EngineException(
1846 "No k8scluster with requirements='{}' at vim_account={} found for member_vnf_index={}".format(
1847 k8s_requirements, vim_account, vnfr["member-vnf-index-ref"]
1848 )
1849 )
1850
1851 for kdur_index, kdur in enumerate(get_iterable(vnfr.get("kdur"))):
1852 # step 3. Fill vnfr info by filling kdur
1853 kdu_text = "kdur.{}.".format(kdur_index)
1854 vnfr_update_rollback[kdu_text + "k8s-cluster.id"] = None
1855 vnfr_update[kdu_text + "k8s-cluster.id"] = k8scluster["_id"]
1856
1857 # step 4. Check VIM networks that forces the selected k8s_cluster
1858 if vnfr.get("k8s-cluster") and vnfr["k8s-cluster"].get("nets"):
1859 k8scluster_net_list = list(k8scluster.get("nets").keys())
1860 for net_index, kdur_net in enumerate(vnfr["k8s-cluster"]["nets"]):
1861 # get a network from k8s_cluster nets. If name matches use this, if not use other
1862 if kdur_net["id"] in k8scluster_net_list: # name matches
1863 vim_net = k8scluster["nets"][kdur_net["id"]]
1864 k8scluster_net_list.remove(kdur_net["id"])
1865 else:
1866 vim_net = k8scluster["nets"][k8scluster_net_list[0]]
1867 k8scluster_net_list.pop(0)
1868 vnfr_update_rollback[
1869 "k8s-cluster.nets.{}.vim_net".format(net_index)
1870 ] = None
1871 vnfr_update["k8s-cluster.nets.{}.vim_net".format(net_index)] = vim_net
1872 if vim_net and (
1873 kdur_net.get("vnf-vld-id") or kdur_net.get("ns-vld-id")
1874 ):
1875 ifaces_forcing_vim_network.append(
1876 {
1877 "name": kdur_net.get("vnf-vld-id")
1878 or kdur_net.get("ns-vld-id"),
1879 "vnf-vld-id": kdur_net.get("vnf-vld-id"),
1880 "ns-vld-id": kdur_net.get("ns-vld-id"),
1881 "vim-network-name": vim_net, # TODO can it be vim-network-id ???
1882 }
1883 )
1884 # TODO check that this forcing is not incompatible with other forcing
1885 return ifaces_forcing_vim_network
1886
1887 def _update_vnfrs_from_nsd(self, nsr):
1888 step = "Getting vnf_profiles from nsd" # first step must be defined outside try
1889 try:
1890 nsr_id = nsr["_id"]
1891 nsd = nsr["nsd"]
1892
1893 vnf_profiles = nsd.get("df", [{}])[0].get("vnf-profile", ())
1894 vld_fixed_ip_connection_point_data = {}
1895
1896 step = "Getting ip-address info from vnf_profile if it exists"
1897 for vnfp in vnf_profiles:
1898 # Checking ip-address info from nsd.vnf_profile and storing
1899 for vlc in vnfp.get("virtual-link-connectivity", ()):
1900 for cpd in vlc.get("constituent-cpd-id", ()):
1901 if cpd.get("ip-address"):
1902 step = "Storing ip-address info"
1903 vld_fixed_ip_connection_point_data.update(
1904 {
1905 vlc.get("virtual-link-profile-id")
1906 + "."
1907 + cpd.get("constituent-base-element-id"): {
1908 "vnfd-connection-point-ref": cpd.get(
1909 "constituent-cpd-id"
1910 ),
1911 "ip-address": cpd.get("ip-address"),
1912 }
1913 }
1914 )
1915
1916 # Inserting ip address to vnfr
1917 if len(vld_fixed_ip_connection_point_data) > 0:
1918 step = "Getting vnfrs"
1919 vnfrs = self.db.get_list("vnfrs", {"nsr-id-ref": nsr_id})
1920 for item in vld_fixed_ip_connection_point_data.keys():
1921 step = "Filtering vnfrs"
1922 vnfr = next(
1923 filter(
1924 lambda vnfr: vnfr["member-vnf-index-ref"]
1925 == item.split(".")[1],
1926 vnfrs,
1927 ),
1928 None,
1929 )
1930 if vnfr:
1931 vnfr_update = {}
1932 for vdur_index, vdur in enumerate(vnfr["vdur"]):
1933 for iface_index, iface in enumerate(vdur["interfaces"]):
1934 step = "Looking for matched interface"
1935 if (
1936 iface.get("external-connection-point-ref")
1937 == vld_fixed_ip_connection_point_data[item].get(
1938 "vnfd-connection-point-ref"
1939 )
1940 and iface.get("ns-vld-id") == item.split(".")[0]
1941 ):
1942 vnfr_update_text = "vdur.{}.interfaces.{}".format(
1943 vdur_index, iface_index
1944 )
1945 step = "Storing info in order to update vnfr"
1946 vnfr_update[
1947 vnfr_update_text + ".ip-address"
1948 ] = increment_ip_mac(
1949 vld_fixed_ip_connection_point_data[item].get(
1950 "ip-address"
1951 ),
1952 vdur.get("count-index", 0),
1953 )
1954 vnfr_update[vnfr_update_text + ".fixed-ip"] = True
1955
1956 step = "updating vnfr at database"
1957 self.db.set_one("vnfrs", {"_id": vnfr["_id"]}, vnfr_update)
1958 except (
1959 ValidationError,
1960 EngineException,
1961 DbException,
1962 MsgException,
1963 FsException,
1964 ) as e:
1965 raise type(e)("{} while '{}'".format(e, step), http_code=e.http_code)
1966
1967 def _update_vnfrs(self, session, rollback, nsr, indata):
1968 # get vnfr
1969 nsr_id = nsr["_id"]
1970 vnfrs = self.db.get_list("vnfrs", {"nsr-id-ref": nsr_id})
1971
1972 for vnfr in vnfrs:
1973 vnfr_update = {}
1974 vnfr_update_rollback = {}
1975 member_vnf_index = vnfr["member-vnf-index-ref"]
1976 # update vim-account-id
1977
1978 vim_account = indata["vimAccountId"]
1979 vca_id = self._get_vim_account(vim_account, session).get("vca")
1980 # check instantiate parameters
1981 for vnf_inst_params in get_iterable(indata.get("vnf")):
1982 if vnf_inst_params["member-vnf-index"] != member_vnf_index:
1983 continue
1984 if vnf_inst_params.get("vimAccountId"):
1985 vim_account = vnf_inst_params.get("vimAccountId")
1986 vca_id = self._get_vim_account(vim_account, session).get("vca")
1987
1988 # get vnf.vdu.interface instantiation params to update vnfr.vdur.interfaces ip, mac
1989 for vdu_inst_param in get_iterable(vnf_inst_params.get("vdu")):
1990 for vdur_index, vdur in enumerate(vnfr["vdur"]):
1991 if vdu_inst_param["id"] != vdur["vdu-id-ref"]:
1992 continue
1993 for iface_inst_param in get_iterable(
1994 vdu_inst_param.get("interface")
1995 ):
1996 iface_index, _ = next(
1997 i
1998 for i in enumerate(vdur["interfaces"])
1999 if i[1]["name"] == iface_inst_param["name"]
2000 )
2001 vnfr_update_text = "vdur.{}.interfaces.{}".format(
2002 vdur_index, iface_index
2003 )
2004 if iface_inst_param.get("ip-address"):
2005 vnfr_update[
2006 vnfr_update_text + ".ip-address"
2007 ] = increment_ip_mac(
2008 iface_inst_param.get("ip-address"),
2009 vdur.get("count-index", 0),
2010 )
2011 vnfr_update[vnfr_update_text + ".fixed-ip"] = True
2012 if iface_inst_param.get("mac-address"):
2013 vnfr_update[
2014 vnfr_update_text + ".mac-address"
2015 ] = increment_ip_mac(
2016 iface_inst_param.get("mac-address"),
2017 vdur.get("count-index", 0),
2018 )
2019 vnfr_update[vnfr_update_text + ".fixed-mac"] = True
2020 if iface_inst_param.get("floating-ip-required"):
2021 vnfr_update[
2022 vnfr_update_text + ".floating-ip-required"
2023 ] = True
2024 # get vnf.internal-vld.internal-conection-point instantiation params to update vnfr.vdur.interfaces
2025 # TODO update vld with the ip-profile
2026 for ivld_inst_param in get_iterable(
2027 vnf_inst_params.get("internal-vld")
2028 ):
2029 for icp_inst_param in get_iterable(
2030 ivld_inst_param.get("internal-connection-point")
2031 ):
2032 # look for iface
2033 for vdur_index, vdur in enumerate(vnfr["vdur"]):
2034 for iface_index, iface in enumerate(vdur["interfaces"]):
2035 if (
2036 iface.get("internal-connection-point-ref")
2037 == icp_inst_param["id-ref"]
2038 ):
2039 vnfr_update_text = "vdur.{}.interfaces.{}".format(
2040 vdur_index, iface_index
2041 )
2042 if icp_inst_param.get("ip-address"):
2043 vnfr_update[
2044 vnfr_update_text + ".ip-address"
2045 ] = increment_ip_mac(
2046 icp_inst_param.get("ip-address"),
2047 vdur.get("count-index", 0),
2048 )
2049 vnfr_update[
2050 vnfr_update_text + ".fixed-ip"
2051 ] = True
2052 if icp_inst_param.get("mac-address"):
2053 vnfr_update[
2054 vnfr_update_text + ".mac-address"
2055 ] = increment_ip_mac(
2056 icp_inst_param.get("mac-address"),
2057 vdur.get("count-index", 0),
2058 )
2059 vnfr_update[
2060 vnfr_update_text + ".fixed-mac"
2061 ] = True
2062 break
2063 # get ip address from instantiation parameters.vld.vnfd-connection-point-ref
2064 for vld_inst_param in get_iterable(indata.get("vld")):
2065 for vnfcp_inst_param in get_iterable(
2066 vld_inst_param.get("vnfd-connection-point-ref")
2067 ):
2068 if vnfcp_inst_param["member-vnf-index-ref"] != member_vnf_index:
2069 continue
2070 # look for iface
2071 for vdur_index, vdur in enumerate(vnfr["vdur"]):
2072 for iface_index, iface in enumerate(vdur["interfaces"]):
2073 if (
2074 iface.get("external-connection-point-ref")
2075 == vnfcp_inst_param["vnfd-connection-point-ref"]
2076 ):
2077 vnfr_update_text = "vdur.{}.interfaces.{}".format(
2078 vdur_index, iface_index
2079 )
2080 if vnfcp_inst_param.get("ip-address"):
2081 vnfr_update[
2082 vnfr_update_text + ".ip-address"
2083 ] = increment_ip_mac(
2084 vnfcp_inst_param.get("ip-address"),
2085 vdur.get("count-index", 0),
2086 )
2087 vnfr_update[vnfr_update_text + ".fixed-ip"] = True
2088 if vnfcp_inst_param.get("mac-address"):
2089 vnfr_update[
2090 vnfr_update_text + ".mac-address"
2091 ] = increment_ip_mac(
2092 vnfcp_inst_param.get("mac-address"),
2093 vdur.get("count-index", 0),
2094 )
2095 vnfr_update[vnfr_update_text + ".fixed-mac"] = True
2096 break
2097
2098 vnfr_update["vim-account-id"] = vim_account
2099 vnfr_update_rollback["vim-account-id"] = vnfr.get("vim-account-id")
2100
2101 if vca_id:
2102 vnfr_update["vca-id"] = vca_id
2103 vnfr_update_rollback["vca-id"] = vnfr.get("vca-id")
2104
2105 # get pdu
2106 ifaces_forcing_vim_network = self._look_for_pdu(
2107 session, rollback, vnfr, vim_account, vnfr_update, vnfr_update_rollback
2108 )
2109
2110 # get kdus
2111 ifaces_forcing_vim_network += self._look_for_k8scluster(
2112 session, rollback, vnfr, vim_account, vnfr_update, vnfr_update_rollback
2113 )
2114 # update database vnfr
2115 self.db.set_one("vnfrs", {"_id": vnfr["_id"]}, vnfr_update)
2116 rollback.append(
2117 {
2118 "topic": "vnfrs",
2119 "_id": vnfr["_id"],
2120 "operation": "set",
2121 "content": vnfr_update_rollback,
2122 }
2123 )
2124
2125 # Update indada in case pdu forces to use a concrete vim-network-name
2126 # TODO check if user has already insert a vim-network-name and raises an error
2127 if not ifaces_forcing_vim_network:
2128 continue
2129 for iface_info in ifaces_forcing_vim_network:
2130 if iface_info.get("ns-vld-id"):
2131 if "vld" not in indata:
2132 indata["vld"] = []
2133 indata["vld"].append(
2134 {
2135 key: iface_info[key]
2136 for key in ("name", "vim-network-name", "vim-network-id")
2137 if iface_info.get(key)
2138 }
2139 )
2140
2141 elif iface_info.get("vnf-vld-id"):
2142 if "vnf" not in indata:
2143 indata["vnf"] = []
2144 indata["vnf"].append(
2145 {
2146 "member-vnf-index": member_vnf_index,
2147 "internal-vld": [
2148 {
2149 key: iface_info[key]
2150 for key in (
2151 "name",
2152 "vim-network-name",
2153 "vim-network-id",
2154 )
2155 if iface_info.get(key)
2156 }
2157 ],
2158 }
2159 )
2160
2161 @staticmethod
2162 def _create_nslcmop(nsr_id, operation, params):
2163 """
2164 Creates a ns-lcm-opp content to be stored at database.
2165 :param nsr_id: internal id of the instance
2166 :param operation: instantiate, terminate, scale, action, update ...
2167 :param params: user parameters for the operation
2168 :return: dictionary following SOL005 format
2169 """
2170 now = time()
2171 _id = str(uuid4())
2172 nslcmop = {
2173 "id": _id,
2174 "_id": _id,
2175 "operationState": "PROCESSING", # COMPLETED,PARTIALLY_COMPLETED,FAILED_TEMP,FAILED,ROLLING_BACK,ROLLED_BACK
2176 "queuePosition": None,
2177 "stage": None,
2178 "errorMessage": None,
2179 "detailedStatus": None,
2180 "statusEnteredTime": now,
2181 "nsInstanceId": nsr_id,
2182 "lcmOperationType": operation,
2183 "startTime": now,
2184 "isAutomaticInvocation": False,
2185 "operationParams": params,
2186 "isCancelPending": False,
2187 "links": {
2188 "self": "/osm/nslcm/v1/ns_lcm_op_occs/" + _id,
2189 "nsInstance": "/osm/nslcm/v1/ns_instances/" + nsr_id,
2190 },
2191 }
2192 return nslcmop
2193
2194 def _get_enabled_vims(self, session):
2195 """
2196 Retrieve and return VIM accounts that are accessible by current user and has state ENABLE
2197 :param session: current session with user information
2198 """
2199 db_filter = self._get_project_filter(session)
2200 db_filter["_admin.operationalState"] = "ENABLED"
2201 vims = self.db.get_list("vim_accounts", db_filter)
2202 vimAccounts = []
2203 for vim in vims:
2204 vimAccounts.append(vim["_id"])
2205 return vimAccounts
2206
2207 def new(
2208 self,
2209 rollback,
2210 session,
2211 indata=None,
2212 kwargs=None,
2213 headers=None,
2214 slice_object=False,
2215 ):
2216 """
2217 Performs a new operation over a ns
2218 :param rollback: list to append created items at database in case a rollback must to be done
2219 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
2220 :param indata: descriptor with the parameters of the operation. It must contains among others
2221 nsInstanceId: _id of the nsr to perform the operation
2222 operation: it can be: instantiate, terminate, action, update TODO: heal
2223 :param kwargs: used to override the indata descriptor
2224 :param headers: http request headers
2225 :return: id of the nslcmops
2226 """
2227
2228 def check_if_nsr_is_not_slice_member(session, nsr_id):
2229 nsis = None
2230 db_filter = self._get_project_filter(session)
2231 db_filter["_admin.nsrs-detailed-list.ANYINDEX.nsrId"] = nsr_id
2232 nsis = self.db.get_one(
2233 "nsis", db_filter, fail_on_empty=False, fail_on_more=False
2234 )
2235 if nsis:
2236 raise EngineException(
2237 "The NS instance {} cannot be terminated because is used by the slice {}".format(
2238 nsr_id, nsis["_id"]
2239 ),
2240 http_code=HTTPStatus.CONFLICT,
2241 )
2242
2243 try:
2244 # Override descriptor with query string kwargs
2245 self._update_input_with_kwargs(indata, kwargs, yaml_format=True)
2246 operation = indata["lcmOperationType"]
2247 nsInstanceId = indata["nsInstanceId"]
2248
2249 validate_input(indata, self.operation_schema[operation])
2250 # get ns from nsr_id
2251 _filter = BaseTopic._get_project_filter(session)
2252 _filter["_id"] = nsInstanceId
2253 nsr = self.db.get_one("nsrs", _filter)
2254
2255 # initial checking
2256 if operation == "terminate" and slice_object is False:
2257 check_if_nsr_is_not_slice_member(session, nsr["_id"])
2258 if (
2259 not nsr["_admin"].get("nsState")
2260 or nsr["_admin"]["nsState"] == "NOT_INSTANTIATED"
2261 ):
2262 if operation == "terminate" and indata.get("autoremove"):
2263 # NSR must be deleted
2264 return (
2265 None,
2266 None,
2267 ) # a none in this case is used to indicate not instantiated. It can be removed
2268 if operation != "instantiate":
2269 raise EngineException(
2270 "ns_instance '{}' cannot be '{}' because it is not instantiated".format(
2271 nsInstanceId, operation
2272 ),
2273 HTTPStatus.CONFLICT,
2274 )
2275 else:
2276 if operation == "instantiate" and not session["force"]:
2277 raise EngineException(
2278 "ns_instance '{}' cannot be '{}' because it is already instantiated".format(
2279 nsInstanceId, operation
2280 ),
2281 HTTPStatus.CONFLICT,
2282 )
2283 self._check_ns_operation(session, nsr, operation, indata)
2284 if indata.get("primitive_params"):
2285 indata["primitive_params"] = json.dumps(indata["primitive_params"])
2286 elif indata.get("additionalParamsForVnf"):
2287 indata["additionalParamsForVnf"] = json.dumps(
2288 indata["additionalParamsForVnf"]
2289 )
2290
2291 if operation == "instantiate":
2292 self._update_vnfrs_from_nsd(nsr)
2293 self._update_vnfrs(session, rollback, nsr, indata)
2294 if (operation == "update") and (indata["updateType"] == "CHANGE_VNFPKG"):
2295 nsr_update = {}
2296 vnfd_id = indata["changeVnfPackageData"]["vnfdId"]
2297 vnfd = self.db.get_one("vnfds", {"_id": vnfd_id})
2298 nsd = self.db.get_one("nsds", {"_id": nsr["nsd-id"]})
2299 ns_request = nsr["instantiate_params"]
2300 vnfr = self.db.get_one(
2301 "vnfrs", {"_id": indata["changeVnfPackageData"]["vnfInstanceId"]}
2302 )
2303 latest_vnfd_revision = vnfd["_admin"].get("revision", 1)
2304 vnfr_vnfd_revision = vnfr.get("revision", 1)
2305 if latest_vnfd_revision != vnfr_vnfd_revision:
2306 old_vnfd_id = vnfd_id + ":" + str(vnfr_vnfd_revision)
2307 old_db_vnfd = self.db.get_one(
2308 "vnfds_revisions", {"_id": old_vnfd_id}
2309 )
2310 old_sw_version = old_db_vnfd.get("software-version", "1.0")
2311 new_sw_version = vnfd.get("software-version", "1.0")
2312 if new_sw_version != old_sw_version:
2313 vnf_index = vnfr["member-vnf-index-ref"]
2314 self.logger.info("nsr {}".format(nsr))
2315 for vdu in vnfd["vdu"]:
2316 self.nsrtopic._add_shared_volumes_to_nsr(
2317 vdu, vnfd, nsr, vnf_index, latest_vnfd_revision
2318 )
2319 self.nsrtopic._add_flavor_to_nsr(
2320 vdu, vnfd, nsr, vnf_index, latest_vnfd_revision
2321 )
2322 sw_image_id = vdu.get("sw-image-desc")
2323 if sw_image_id:
2324 image_data = self.nsrtopic._get_image_data_from_vnfd(
2325 vnfd, sw_image_id
2326 )
2327 self.nsrtopic._add_image_to_nsr(nsr, image_data)
2328 for alt_image in vdu.get("alternative-sw-image-desc", ()):
2329 image_data = self.nsrtopic._get_image_data_from_vnfd(
2330 vnfd, alt_image
2331 )
2332 self.nsrtopic._add_image_to_nsr(nsr, image_data)
2333 nsr_update["image"] = nsr["image"]
2334 nsr_update["flavor"] = nsr["flavor"]
2335 nsr_update["shared-volumes"] = nsr["shared-volumes"]
2336 self.db.set_one("nsrs", {"_id": nsr["_id"]}, nsr_update)
2337 ns_k8s_namespace = self.nsrtopic._get_ns_k8s_namespace(
2338 nsd, ns_request, session
2339 )
2340 vnfr_descriptor = (
2341 self.nsrtopic._create_vnfr_descriptor_from_vnfd(
2342 nsd,
2343 vnfd,
2344 vnfd_id,
2345 vnf_index,
2346 nsr,
2347 ns_request,
2348 ns_k8s_namespace,
2349 latest_vnfd_revision,
2350 )
2351 )
2352 indata["newVdur"] = vnfr_descriptor["vdur"]
2353 nslcmop_desc = self._create_nslcmop(nsInstanceId, operation, indata)
2354 _id = nslcmop_desc["_id"]
2355 self.format_on_new(
2356 nslcmop_desc, session["project_id"], make_public=session["public"]
2357 )
2358 if indata.get("placement-engine"):
2359 # Save valid vim accounts in lcm operation descriptor
2360 nslcmop_desc["operationParams"][
2361 "validVimAccounts"
2362 ] = self._get_enabled_vims(session)
2363 self.db.create("nslcmops", nslcmop_desc)
2364 rollback.append({"topic": "nslcmops", "_id": _id})
2365 if not slice_object:
2366 self.msg.write("ns", operation, nslcmop_desc)
2367 return _id, None
2368 except ValidationError as e: # TODO remove try Except, it is captured at nbi.py
2369 raise EngineException(e, HTTPStatus.UNPROCESSABLE_ENTITY)
2370 # except DbException as e:
2371 # raise EngineException("Cannot get ns_instance '{}': {}".format(e), HTTPStatus.NOT_FOUND)
2372
2373 def delete(self, session, _id, dry_run=False, not_send_msg=None):
2374 raise EngineException(
2375 "Method delete called directly", HTTPStatus.INTERNAL_SERVER_ERROR
2376 )
2377
2378 def edit(self, session, _id, indata=None, kwargs=None, content=None):
2379 raise EngineException(
2380 "Method edit called directly", HTTPStatus.INTERNAL_SERVER_ERROR
2381 )
2382
2383
2384 class NsiTopic(BaseTopic):
2385 topic = "nsis"
2386 topic_msg = "nsi"
2387 quota_name = "slice_instances"
2388
2389 def __init__(self, db, fs, msg, auth):
2390 BaseTopic.__init__(self, db, fs, msg, auth)
2391 self.nsrTopic = NsrTopic(db, fs, msg, auth)
2392
2393 @staticmethod
2394 def _format_ns_request(ns_request):
2395 formated_request = copy(ns_request)
2396 # TODO: Add request params
2397 return formated_request
2398
2399 @staticmethod
2400 def _format_addional_params(slice_request):
2401 """
2402 Get and format user additional params for NS or VNF
2403 :param slice_request: User instantiation additional parameters
2404 :return: a formatted copy of additional params or None if not supplied
2405 """
2406 additional_params = copy(slice_request.get("additionalParamsForNsi"))
2407 if additional_params:
2408 for k, v in additional_params.items():
2409 if not isinstance(k, str):
2410 raise EngineException(
2411 "Invalid param at additionalParamsForNsi:{}. Only string keys are allowed".format(
2412 k
2413 )
2414 )
2415 if "." in k or "$" in k:
2416 raise EngineException(
2417 "Invalid param at additionalParamsForNsi:{}. Keys must not contain dots or $".format(
2418 k
2419 )
2420 )
2421 if isinstance(v, (dict, tuple, list)):
2422 additional_params[k] = "!!yaml " + safe_dump(v)
2423 return additional_params
2424
2425 def check_conflict_on_del(self, session, _id, db_content):
2426 """
2427 Check that NSI is not instantiated
2428 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
2429 :param _id: nsi internal id
2430 :param db_content: The database content of the _id
2431 :return: None or raises EngineException with the conflict
2432 """
2433 if session["force"]:
2434 return
2435 nsi = db_content
2436 if nsi["_admin"].get("nsiState") == "INSTANTIATED":
2437 raise EngineException(
2438 "nsi '{}' cannot be deleted because it is in 'INSTANTIATED' state. "
2439 "Launch 'terminate' operation first; or force deletion".format(_id),
2440 http_code=HTTPStatus.CONFLICT,
2441 )
2442
2443 def delete_extra(self, session, _id, db_content, not_send_msg=None):
2444 """
2445 Deletes associated nsilcmops from database. Deletes associated filesystem.
2446 Set usageState of nst
2447 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
2448 :param _id: server internal id
2449 :param db_content: The database content of the descriptor
2450 :param not_send_msg: To not send message (False) or store content (list) instead
2451 :return: None if ok or raises EngineException with the problem
2452 """
2453
2454 # Deleting the nsrs belonging to nsir
2455 nsir = db_content
2456 for nsrs_detailed_item in nsir["_admin"]["nsrs-detailed-list"]:
2457 nsr_id = nsrs_detailed_item["nsrId"]
2458 if nsrs_detailed_item.get("shared"):
2459 _filter = {
2460 "_admin.nsrs-detailed-list.ANYINDEX.shared": True,
2461 "_admin.nsrs-detailed-list.ANYINDEX.nsrId": nsr_id,
2462 "_id.ne": nsir["_id"],
2463 }
2464 nsi = self.db.get_one(
2465 "nsis", _filter, fail_on_empty=False, fail_on_more=False
2466 )
2467 if nsi: # last one using nsr
2468 continue
2469 try:
2470 self.nsrTopic.delete(
2471 session, nsr_id, dry_run=False, not_send_msg=not_send_msg
2472 )
2473 except (DbException, EngineException) as e:
2474 if e.http_code == HTTPStatus.NOT_FOUND:
2475 pass
2476 else:
2477 raise
2478
2479 # delete related nsilcmops database entries
2480 self.db.del_list("nsilcmops", {"netsliceInstanceId": _id})
2481
2482 # Check and set used NST usage state
2483 nsir_admin = nsir.get("_admin")
2484 if nsir_admin and nsir_admin.get("nst-id"):
2485 # check if used by another NSI
2486 nsis_list = self.db.get_one(
2487 "nsis",
2488 {"nst-id": nsir_admin["nst-id"]},
2489 fail_on_empty=False,
2490 fail_on_more=False,
2491 )
2492 if not nsis_list:
2493 self.db.set_one(
2494 "nsts",
2495 {"_id": nsir_admin["nst-id"]},
2496 {"_admin.usageState": "NOT_IN_USE"},
2497 )
2498
2499 def new(self, rollback, session, indata=None, kwargs=None, headers=None):
2500 """
2501 Creates a new netslice instance record into database. It also creates needed nsrs and vnfrs
2502 :param rollback: list to append the created items at database in case a rollback must be done
2503 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
2504 :param indata: params to be used for the nsir
2505 :param kwargs: used to override the indata descriptor
2506 :param headers: http request headers
2507 :return: the _id of nsi descriptor created at database
2508 """
2509
2510 step = "checking quotas" # first step must be defined outside try
2511 try:
2512 self.check_quota(session)
2513
2514 step = ""
2515 slice_request = self._remove_envelop(indata)
2516 # Override descriptor with query string kwargs
2517 self._update_input_with_kwargs(slice_request, kwargs)
2518 slice_request = self._validate_input_new(slice_request, session["force"])
2519
2520 # look for nstd
2521 step = "getting nstd id='{}' from database".format(
2522 slice_request.get("nstId")
2523 )
2524 _filter = self._get_project_filter(session)
2525 _filter["_id"] = slice_request["nstId"]
2526 nstd = self.db.get_one("nsts", _filter)
2527 # check NST is not disabled
2528 step = "checking NST operationalState"
2529 if nstd["_admin"]["operationalState"] == "DISABLED":
2530 raise EngineException(
2531 "nst with id '{}' is DISABLED, and thus cannot be used to create a netslice "
2532 "instance".format(slice_request["nstId"]),
2533 http_code=HTTPStatus.CONFLICT,
2534 )
2535 del _filter["_id"]
2536
2537 # check NSD is not disabled
2538 step = "checking operationalState"
2539 if nstd["_admin"]["operationalState"] == "DISABLED":
2540 raise EngineException(
2541 "nst with id '{}' is DISABLED, and thus cannot be used to create "
2542 "a network slice".format(slice_request["nstId"]),
2543 http_code=HTTPStatus.CONFLICT,
2544 )
2545
2546 nstd.pop("_admin", None)
2547 nstd_id = nstd.pop("_id", None)
2548 nsi_id = str(uuid4())
2549 step = "filling nsi_descriptor with input data"
2550
2551 # Creating the NSIR
2552 nsi_descriptor = {
2553 "id": nsi_id,
2554 "name": slice_request["nsiName"],
2555 "description": slice_request.get("nsiDescription", ""),
2556 "datacenter": slice_request["vimAccountId"],
2557 "nst-ref": nstd["id"],
2558 "instantiation_parameters": slice_request,
2559 "network-slice-template": nstd,
2560 "nsr-ref-list": [],
2561 "vlr-list": [],
2562 "_id": nsi_id,
2563 "additionalParamsForNsi": self._format_addional_params(slice_request),
2564 }
2565
2566 step = "creating nsi at database"
2567 self.format_on_new(
2568 nsi_descriptor, session["project_id"], make_public=session["public"]
2569 )
2570 nsi_descriptor["_admin"]["nsiState"] = "NOT_INSTANTIATED"
2571 nsi_descriptor["_admin"]["netslice-subnet"] = None
2572 nsi_descriptor["_admin"]["deployed"] = {}
2573 nsi_descriptor["_admin"]["deployed"]["RO"] = []
2574 nsi_descriptor["_admin"]["nst-id"] = nstd_id
2575
2576 # Creating netslice-vld for the RO.
2577 step = "creating netslice-vld at database"
2578
2579 # Building the vlds list to be deployed
2580 # From netslice descriptors, creating the initial list
2581 nsi_vlds = []
2582
2583 for netslice_vlds in get_iterable(nstd.get("netslice-vld")):
2584 # Getting template Instantiation parameters from NST
2585 nsi_vld = deepcopy(netslice_vlds)
2586 nsi_vld["shared-nsrs-list"] = []
2587 nsi_vld["vimAccountId"] = slice_request["vimAccountId"]
2588 nsi_vlds.append(nsi_vld)
2589
2590 nsi_descriptor["_admin"]["netslice-vld"] = nsi_vlds
2591 # Creating netslice-subnet_record.
2592 needed_nsds = {}
2593 services = []
2594
2595 # Updating the nstd with the nsd["_id"] associated to the nss -> services list
2596 for member_ns in nstd["netslice-subnet"]:
2597 nsd_id = member_ns["nsd-ref"]
2598 step = "getting nstd id='{}' constituent-nsd='{}' from database".format(
2599 member_ns["nsd-ref"], member_ns["id"]
2600 )
2601 if nsd_id not in needed_nsds:
2602 # Obtain nsd
2603 _filter["id"] = nsd_id
2604 nsd = self.db.get_one(
2605 "nsds", _filter, fail_on_empty=True, fail_on_more=True
2606 )
2607 del _filter["id"]
2608 nsd.pop("_admin")
2609 needed_nsds[nsd_id] = nsd
2610 else:
2611 nsd = needed_nsds[nsd_id]
2612 member_ns["_id"] = needed_nsds[nsd_id].get("_id")
2613 services.append(member_ns)
2614
2615 step = "filling nsir nsd-id='{}' constituent-nsd='{}' from database".format(
2616 member_ns["nsd-ref"], member_ns["id"]
2617 )
2618
2619 # creates Network Services records (NSRs)
2620 step = "creating nsrs at database using NsrTopic.new()"
2621 ns_params = slice_request.get("netslice-subnet")
2622 nsrs_list = []
2623 nsi_netslice_subnet = []
2624 for service in services:
2625 # Check if the netslice-subnet is shared and if it is share if the nss exists
2626 _id_nsr = None
2627 indata_ns = {}
2628 # Is the nss shared and instantiated?
2629 _filter["_admin.nsrs-detailed-list.ANYINDEX.shared"] = True
2630 _filter["_admin.nsrs-detailed-list.ANYINDEX.nsd-id"] = service[
2631 "nsd-ref"
2632 ]
2633 _filter["_admin.nsrs-detailed-list.ANYINDEX.nss-id"] = service["id"]
2634 nsi = self.db.get_one(
2635 "nsis", _filter, fail_on_empty=False, fail_on_more=False
2636 )
2637 if nsi and service.get("is-shared-nss"):
2638 nsrs_detailed_list = nsi["_admin"]["nsrs-detailed-list"]
2639 for nsrs_detailed_item in nsrs_detailed_list:
2640 if nsrs_detailed_item["nsd-id"] == service["nsd-ref"]:
2641 if nsrs_detailed_item["nss-id"] == service["id"]:
2642 _id_nsr = nsrs_detailed_item["nsrId"]
2643 break
2644 for netslice_subnet in nsi["_admin"]["netslice-subnet"]:
2645 if netslice_subnet["nss-id"] == service["id"]:
2646 indata_ns = netslice_subnet
2647 break
2648 else:
2649 indata_ns = {}
2650 if service.get("instantiation-parameters"):
2651 indata_ns = deepcopy(service["instantiation-parameters"])
2652 # del service["instantiation-parameters"]
2653
2654 indata_ns["nsdId"] = service["_id"]
2655 indata_ns["nsName"] = (
2656 slice_request.get("nsiName") + "." + service["id"]
2657 )
2658 indata_ns["vimAccountId"] = slice_request.get("vimAccountId")
2659 indata_ns["nsDescription"] = service["description"]
2660 if slice_request.get("ssh_keys"):
2661 indata_ns["ssh_keys"] = slice_request.get("ssh_keys")
2662
2663 if ns_params:
2664 for ns_param in ns_params:
2665 if ns_param.get("id") == service["id"]:
2666 copy_ns_param = deepcopy(ns_param)
2667 del copy_ns_param["id"]
2668 indata_ns.update(copy_ns_param)
2669 break
2670
2671 # Creates Nsr objects
2672 _id_nsr, _ = self.nsrTopic.new(
2673 rollback, session, indata_ns, kwargs, headers
2674 )
2675 nsrs_item = {
2676 "nsrId": _id_nsr,
2677 "shared": service.get("is-shared-nss"),
2678 "nsd-id": service["nsd-ref"],
2679 "nss-id": service["id"],
2680 "nslcmop_instantiate": None,
2681 }
2682 indata_ns["nss-id"] = service["id"]
2683 nsrs_list.append(nsrs_item)
2684 nsi_netslice_subnet.append(indata_ns)
2685 nsr_ref = {"nsr-ref": _id_nsr}
2686 nsi_descriptor["nsr-ref-list"].append(nsr_ref)
2687
2688 # Adding the nsrs list to the nsi
2689 nsi_descriptor["_admin"]["nsrs-detailed-list"] = nsrs_list
2690 nsi_descriptor["_admin"]["netslice-subnet"] = nsi_netslice_subnet
2691 self.db.set_one(
2692 "nsts", {"_id": slice_request["nstId"]}, {"_admin.usageState": "IN_USE"}
2693 )
2694
2695 # Creating the entry in the database
2696 self.db.create("nsis", nsi_descriptor)
2697 rollback.append({"topic": "nsis", "_id": nsi_id})
2698 return nsi_id, None
2699 except ValidationError as e:
2700 raise EngineException(e, HTTPStatus.UNPROCESSABLE_ENTITY)
2701 except Exception as e: # TODO remove try Except, it is captured at nbi.py
2702 self.logger.exception(
2703 "Exception {} at NsiTopic.new()".format(e), exc_info=True
2704 )
2705 raise EngineException("Error {}: {}".format(step, e))
2706
2707 def edit(self, session, _id, indata=None, kwargs=None, content=None):
2708 raise EngineException(
2709 "Method edit called directly", HTTPStatus.INTERNAL_SERVER_ERROR
2710 )
2711
2712
2713 class NsiLcmOpTopic(BaseTopic):
2714 topic = "nsilcmops"
2715 topic_msg = "nsi"
2716 operation_schema = { # mapping between operation and jsonschema to validate
2717 "instantiate": nsi_instantiate,
2718 "terminate": None,
2719 }
2720
2721 def __init__(self, db, fs, msg, auth):
2722 BaseTopic.__init__(self, db, fs, msg, auth)
2723 self.nsi_NsLcmOpTopic = NsLcmOpTopic(self.db, self.fs, self.msg, self.auth)
2724
2725 def _check_nsi_operation(self, session, nsir, operation, indata):
2726 """
2727 Check that user has enter right parameters for the operation
2728 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
2729 :param operation: it can be: instantiate, terminate, action, TODO: update, heal
2730 :param indata: descriptor with the parameters of the operation
2731 :return: None
2732 """
2733 nsds = {}
2734 nstd = nsir["network-slice-template"]
2735
2736 def check_valid_netslice_subnet_id(nstId):
2737 # TODO change to vnfR (??)
2738 for netslice_subnet in nstd["netslice-subnet"]:
2739 if nstId == netslice_subnet["id"]:
2740 nsd_id = netslice_subnet["nsd-ref"]
2741 if nsd_id not in nsds:
2742 _filter = self._get_project_filter(session)
2743 _filter["id"] = nsd_id
2744 nsds[nsd_id] = self.db.get_one("nsds", _filter)
2745 return nsds[nsd_id]
2746 else:
2747 raise EngineException(
2748 "Invalid parameter nstId='{}' is not one of the "
2749 "nst:netslice-subnet".format(nstId)
2750 )
2751
2752 if operation == "instantiate":
2753 # check the existance of netslice-subnet items
2754 for in_nst in get_iterable(indata.get("netslice-subnet")):
2755 check_valid_netslice_subnet_id(in_nst["id"])
2756
2757 def _create_nsilcmop(self, session, netsliceInstanceId, operation, params):
2758 now = time()
2759 _id = str(uuid4())
2760 nsilcmop = {
2761 "id": _id,
2762 "_id": _id,
2763 "operationState": "PROCESSING", # COMPLETED,PARTIALLY_COMPLETED,FAILED_TEMP,FAILED,ROLLING_BACK,ROLLED_BACK
2764 "statusEnteredTime": now,
2765 "netsliceInstanceId": netsliceInstanceId,
2766 "lcmOperationType": operation,
2767 "startTime": now,
2768 "isAutomaticInvocation": False,
2769 "operationParams": params,
2770 "isCancelPending": False,
2771 "links": {
2772 "self": "/osm/nsilcm/v1/nsi_lcm_op_occs/" + _id,
2773 "netsliceInstanceId": "/osm/nsilcm/v1/netslice_instances/"
2774 + netsliceInstanceId,
2775 },
2776 }
2777 return nsilcmop
2778
2779 def add_shared_nsr_2vld(self, nsir, nsr_item):
2780 for nst_sb_item in nsir["network-slice-template"].get("netslice-subnet"):
2781 if nst_sb_item.get("is-shared-nss"):
2782 for admin_subnet_item in nsir["_admin"].get("netslice-subnet"):
2783 if admin_subnet_item["nss-id"] == nst_sb_item["id"]:
2784 for admin_vld_item in nsir["_admin"].get("netslice-vld"):
2785 for admin_vld_nss_cp_ref_item in admin_vld_item[
2786 "nss-connection-point-ref"
2787 ]:
2788 if (
2789 admin_subnet_item["nss-id"]
2790 == admin_vld_nss_cp_ref_item["nss-ref"]
2791 ):
2792 if (
2793 not nsr_item["nsrId"]
2794 in admin_vld_item["shared-nsrs-list"]
2795 ):
2796 admin_vld_item["shared-nsrs-list"].append(
2797 nsr_item["nsrId"]
2798 )
2799 break
2800 # self.db.set_one("nsis", {"_id": nsir["_id"]}, nsir)
2801 self.db.set_one(
2802 "nsis",
2803 {"_id": nsir["_id"]},
2804 {"_admin.netslice-vld": nsir["_admin"].get("netslice-vld")},
2805 )
2806
2807 def new(self, rollback, session, indata=None, kwargs=None, headers=None):
2808 """
2809 Performs a new operation over a ns
2810 :param rollback: list to append created items at database in case a rollback must to be done
2811 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
2812 :param indata: descriptor with the parameters of the operation. It must contains among others
2813 netsliceInstanceId: _id of the nsir to perform the operation
2814 operation: it can be: instantiate, terminate, action, TODO: update, heal
2815 :param kwargs: used to override the indata descriptor
2816 :param headers: http request headers
2817 :return: id of the nslcmops
2818 """
2819 try:
2820 # Override descriptor with query string kwargs
2821 self._update_input_with_kwargs(indata, kwargs)
2822 operation = indata["lcmOperationType"]
2823 netsliceInstanceId = indata["netsliceInstanceId"]
2824 validate_input(indata, self.operation_schema[operation])
2825
2826 # get nsi from netsliceInstanceId
2827 _filter = self._get_project_filter(session)
2828 _filter["_id"] = netsliceInstanceId
2829 nsir = self.db.get_one("nsis", _filter)
2830 logging_prefix = "nsi={} {} ".format(netsliceInstanceId, operation)
2831 del _filter["_id"]
2832
2833 # initial checking
2834 if (
2835 not nsir["_admin"].get("nsiState")
2836 or nsir["_admin"]["nsiState"] == "NOT_INSTANTIATED"
2837 ):
2838 if operation == "terminate" and indata.get("autoremove"):
2839 # NSIR must be deleted
2840 return (
2841 None,
2842 None,
2843 ) # a none in this case is used to indicate not instantiated. It can be removed
2844 if operation != "instantiate":
2845 raise EngineException(
2846 "netslice_instance '{}' cannot be '{}' because it is not instantiated".format(
2847 netsliceInstanceId, operation
2848 ),
2849 HTTPStatus.CONFLICT,
2850 )
2851 else:
2852 if operation == "instantiate" and not session["force"]:
2853 raise EngineException(
2854 "netslice_instance '{}' cannot be '{}' because it is already instantiated".format(
2855 netsliceInstanceId, operation
2856 ),
2857 HTTPStatus.CONFLICT,
2858 )
2859
2860 # Creating all the NS_operation (nslcmop)
2861 # Get service list from db
2862 nsrs_list = nsir["_admin"]["nsrs-detailed-list"]
2863 nslcmops = []
2864 # nslcmops_item = None
2865 for index, nsr_item in enumerate(nsrs_list):
2866 nsr_id = nsr_item["nsrId"]
2867 if nsr_item.get("shared"):
2868 _filter["_admin.nsrs-detailed-list.ANYINDEX.shared"] = True
2869 _filter["_admin.nsrs-detailed-list.ANYINDEX.nsrId"] = nsr_id
2870 _filter[
2871 "_admin.nsrs-detailed-list.ANYINDEX.nslcmop_instantiate.ne"
2872 ] = None
2873 _filter["_id.ne"] = netsliceInstanceId
2874 nsi = self.db.get_one(
2875 "nsis", _filter, fail_on_empty=False, fail_on_more=False
2876 )
2877 if operation == "terminate":
2878 _update = {
2879 "_admin.nsrs-detailed-list.{}.nslcmop_instantiate".format(
2880 index
2881 ): None
2882 }
2883 self.db.set_one("nsis", {"_id": nsir["_id"]}, _update)
2884 if (
2885 nsi
2886 ): # other nsi is using this nsr and it needs this nsr instantiated
2887 continue # do not create nsilcmop
2888 else: # instantiate
2889 # looks the first nsi fulfilling the conditions but not being the current NSIR
2890 if nsi:
2891 nsi_nsr_item = next(
2892 n
2893 for n in nsi["_admin"]["nsrs-detailed-list"]
2894 if n["nsrId"] == nsr_id
2895 and n["shared"]
2896 and n["nslcmop_instantiate"]
2897 )
2898 self.add_shared_nsr_2vld(nsir, nsr_item)
2899 nslcmops.append(nsi_nsr_item["nslcmop_instantiate"])
2900 _update = {
2901 "_admin.nsrs-detailed-list.{}".format(
2902 index
2903 ): nsi_nsr_item
2904 }
2905 self.db.set_one("nsis", {"_id": nsir["_id"]}, _update)
2906 # continue to not create nslcmop since nsrs is shared and nsrs was created
2907 continue
2908 else:
2909 self.add_shared_nsr_2vld(nsir, nsr_item)
2910
2911 # create operation
2912 try:
2913 indata_ns = {
2914 "lcmOperationType": operation,
2915 "nsInstanceId": nsr_id,
2916 # Including netslice_id in the ns instantiate Operation
2917 "netsliceInstanceId": netsliceInstanceId,
2918 }
2919 if operation == "instantiate":
2920 service = self.db.get_one("nsrs", {"_id": nsr_id})
2921 indata_ns.update(service["instantiate_params"])
2922
2923 # Creating NS_LCM_OP with the flag slice_object=True to not trigger the service instantiation
2924 # message via kafka bus
2925 nslcmop, _ = self.nsi_NsLcmOpTopic.new(
2926 rollback, session, indata_ns, None, headers, slice_object=True
2927 )
2928 nslcmops.append(nslcmop)
2929 if operation == "instantiate":
2930 _update = {
2931 "_admin.nsrs-detailed-list.{}.nslcmop_instantiate".format(
2932 index
2933 ): nslcmop
2934 }
2935 self.db.set_one("nsis", {"_id": nsir["_id"]}, _update)
2936 except (DbException, EngineException) as e:
2937 if e.http_code == HTTPStatus.NOT_FOUND:
2938 self.logger.info(
2939 logging_prefix
2940 + "skipping NS={} because not found".format(nsr_id)
2941 )
2942 pass
2943 else:
2944 raise
2945
2946 # Creates nsilcmop
2947 indata["nslcmops_ids"] = nslcmops
2948 self._check_nsi_operation(session, nsir, operation, indata)
2949
2950 nsilcmop_desc = self._create_nsilcmop(
2951 session, netsliceInstanceId, operation, indata
2952 )
2953 self.format_on_new(
2954 nsilcmop_desc, session["project_id"], make_public=session["public"]
2955 )
2956 _id = self.db.create("nsilcmops", nsilcmop_desc)
2957 rollback.append({"topic": "nsilcmops", "_id": _id})
2958 self.msg.write("nsi", operation, nsilcmop_desc)
2959 return _id, None
2960 except ValidationError as e:
2961 raise EngineException(e, HTTPStatus.UNPROCESSABLE_ENTITY)
2962
2963 def delete(self, session, _id, dry_run=False, not_send_msg=None):
2964 raise EngineException(
2965 "Method delete called directly", HTTPStatus.INTERNAL_SERVER_ERROR
2966 )
2967
2968 def edit(self, session, _id, indata=None, kwargs=None, content=None):
2969 raise EngineException(
2970 "Method edit called directly", HTTPStatus.INTERNAL_SERVER_ERROR
2971 )