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