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