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