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