1 # -*- coding: utf-8 -*-
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
7 # http://www.apache.org/licenses/LICENSE-2.0
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
13 # See the License for the specific language governing permissions and
14 # limitations under the License.
17 from uuid
import uuid4
18 from http
import HTTPStatus
20 from copy
import copy
, deepcopy
21 from osm_nbi
.validation
import (
30 from osm_nbi
.base_topic
import (
37 from yaml
import safe_dump
38 from osm_common
.dbbase
import DbException
39 from osm_common
.msgbase
import MsgException
40 from osm_common
.fsbase
import FsException
41 from osm_nbi
import utils
44 ) # For checking that additional parameter names are valid Jinja2 identifiers
46 __author__
= "Alfonso Tierno <alfonso.tiernosepulveda@telefonica.com>"
49 class NsrTopic(BaseTopic
):
52 quota_name
= "ns_instances"
53 schema_new
= ns_instantiate
55 def __init__(self
, db
, fs
, msg
, auth
):
56 BaseTopic
.__init
__(self
, db
, fs
, msg
, auth
)
58 def _check_descriptor_dependencies(self
, session
, descriptor
):
60 Check that the dependent descriptors exist on a new descriptor or edition
61 :param session: client session information
62 :param descriptor: descriptor to be inserted or edit
63 :return: None or raises exception
65 if not descriptor
.get("nsdId"):
67 nsd_id
= descriptor
["nsdId"]
68 if not self
.get_item_list(session
, "nsds", {"id": nsd_id
}):
69 raise EngineException(
70 "Descriptor error at nsdId='{}' references a non exist nsd".format(
73 http_code
=HTTPStatus
.CONFLICT
,
77 def format_on_new(content
, project_id
=None, make_public
=False):
78 BaseTopic
.format_on_new(content
, project_id
=project_id
, make_public
=make_public
)
79 content
["_admin"]["nsState"] = "NOT_INSTANTIATED"
82 def check_conflict_on_del(self
, session
, _id
, db_content
):
84 Check that NSR is not instantiated
85 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
86 :param _id: nsr internal id
87 :param db_content: The database content of the nsr
88 :return: None or raises EngineException with the conflict
93 if nsr
["_admin"].get("nsState") == "INSTANTIATED":
94 raise EngineException(
95 "nsr '{}' cannot be deleted because it is in 'INSTANTIATED' state. "
96 "Launch 'terminate' operation first; or force deletion".format(_id
),
97 http_code
=HTTPStatus
.CONFLICT
,
100 def delete_extra(self
, session
, _id
, db_content
, not_send_msg
=None):
102 Deletes associated nslcmops and vnfrs from database. Deletes associated filesystem.
103 Set usageState of pdu, vnfd, nsd
104 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
105 :param _id: server internal id
106 :param db_content: The database content of the descriptor
107 :param not_send_msg: To not send message (False) or store content (list) instead
108 :return: None if ok or raises EngineException with the problem
110 self
.fs
.file_delete(_id
, ignore_non_exist
=True)
111 self
.db
.del_list("nslcmops", {"nsInstanceId": _id
})
112 self
.db
.del_list("vnfrs", {"nsr-id-ref": _id
})
114 # set all used pdus as free
117 {"_admin.usage.nsr_id": _id
},
118 {"_admin.usageState": "NOT_IN_USE", "_admin.usage": None},
123 used_nsd_id
= nsr
.get("nsd-id")
125 # check if used by another NSR
126 nsrs_list
= self
.db
.get_one(
127 "nsrs", {"nsd-id": used_nsd_id
}, fail_on_empty
=False, fail_on_more
=False
131 "nsds", {"_id": used_nsd_id
}, {"_admin.usageState": "NOT_IN_USE"}
134 # Set VNFD usageState
135 used_vnfd_id_list
= nsr
.get("vnfd-id")
136 if used_vnfd_id_list
:
137 for used_vnfd_id
in used_vnfd_id_list
:
138 # check if used by another NSR
139 nsrs_list
= self
.db
.get_one(
141 {"vnfd-id": used_vnfd_id
},
148 {"_id": used_vnfd_id
},
149 {"_admin.usageState": "NOT_IN_USE"},
152 # delete extra ro_nsrs used for internal RO module
153 self
.db
.del_one("ro_nsrs", q_filter
={"_id": _id
}, fail_on_empty
=False)
156 def _format_ns_request(ns_request
):
157 formated_request
= copy(ns_request
)
158 formated_request
.pop("additionalParamsForNs", None)
159 formated_request
.pop("additionalParamsForVnf", None)
160 return formated_request
163 def _format_additional_params(
164 ns_request
, member_vnf_index
=None, vdu_id
=None, kdu_name
=None, descriptor
=None
167 Get and format user additional params for NS or VNF
168 :param ns_request: User instantiation additional parameters
169 :param member_vnf_index: None for extract NS params, or member_vnf_index to extract VNF params
170 :param descriptor: If not None it check that needed parameters of descriptor are supplied
171 :return: tuple with a formatted copy of additional params or None if not supplied, plus other parameters
173 additional_params
= None
175 if not member_vnf_index
:
176 additional_params
= copy(ns_request
.get("additionalParamsForNs"))
177 where_
= "additionalParamsForNs"
178 elif ns_request
.get("additionalParamsForVnf"):
179 where_
= "additionalParamsForVnf[member-vnf-index={}]".format(
185 for x
in ns_request
["additionalParamsForVnf"]
186 if x
["member-vnf-index"] == member_vnf_index
191 if not vdu_id
and not kdu_name
:
193 additional_params
= copy(item
.get("additionalParams")) or {}
194 if vdu_id
and item
.get("additionalParamsForVdu"):
198 for x
in item
["additionalParamsForVdu"]
199 if x
["vdu_id"] == vdu_id
203 other_params
= item_vdu
204 if item_vdu
and item_vdu
.get("additionalParams"):
205 where_
+= ".additionalParamsForVdu[vdu_id={}]".format(vdu_id
)
206 additional_params
= item_vdu
["additionalParams"]
208 additional_params
= {}
209 if item
.get("additionalParamsForKdu"):
213 for x
in item
["additionalParamsForKdu"]
214 if x
["kdu_name"] == kdu_name
218 other_params
= item_kdu
219 if item_kdu
and item_kdu
.get("additionalParams"):
220 where_
+= ".additionalParamsForKdu[kdu_name={}]".format(
223 additional_params
= item_kdu
["additionalParams"]
225 if additional_params
:
226 for k
, v
in additional_params
.items():
227 # BEGIN Check that additional parameter names are valid Jinja2 identifiers if target is not Kdu
228 if not kdu_name
and not match("^[a-zA-Z_][a-zA-Z0-9_]*$", k
):
229 raise EngineException(
230 "Invalid param name at {}:{}. Must contain only alphanumeric characters "
231 "and underscores, and cannot start with a digit".format(
235 # END Check that additional parameter names are valid Jinja2 identifiers
236 if not isinstance(k
, str):
237 raise EngineException(
238 "Invalid param at {}:{}. Only string keys are allowed".format(
242 if "." in k
or "$" in k
:
243 raise EngineException(
244 "Invalid param at {}:{}. Keys must not contain dots or $".format(
248 if isinstance(v
, (dict, tuple, list)):
249 additional_params
[k
] = "!!yaml " + safe_dump(v
)
252 for df
in descriptor
.get("df", []):
253 # check that enough parameters are supplied for the initial-config-primitive
254 # TODO: check for cloud-init
256 initial_primitives
= []
258 "lcm-operations-configuration" in df
259 and "operate-vnf-op-config"
260 in df
["lcm-operations-configuration"]
262 for config
in df
["lcm-operations-configuration"][
263 "operate-vnf-op-config"
265 for primitive
in get_iterable(
266 config
.get("initial-config-primitive")
268 initial_primitives
.append(primitive
)
270 initial_primitives
= deep_get(
271 descriptor
, ("ns-configuration", "initial-config-primitive")
274 for initial_primitive
in get_iterable(initial_primitives
):
275 for param
in get_iterable(initial_primitive
.get("parameter")):
276 if param
["value"].startswith("<") and param
["value"].endswith(
279 if param
["value"] in (
286 not additional_params
287 or param
["value"][1:-1] not in additional_params
289 raise EngineException(
290 "Parameter '{}' needed for vnfd[id={}]:day1-2 configuration:"
291 "initial-config-primitive[name={}] not supplied".format(
294 initial_primitive
["name"],
298 return additional_params
or None, other_params
or None
300 def new(self
, rollback
, session
, indata
=None, kwargs
=None, headers
=None):
302 Creates a new nsr into database. It also creates needed vnfrs
303 :param rollback: list to append the created items at database in case a rollback must be done
304 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
305 :param indata: params to be used for the nsr
306 :param kwargs: used to override the indata descriptor
307 :param headers: http request headers
308 :return: the _id of nsr descriptor created at database. Or an exception of type
309 EngineException, ValidationError, DbException, FsException, MsgException.
310 Note: Exceptions are not captured on purpose. They should be captured at called
313 step
= "checking quotas"
314 self
.check_quota(session
)
316 step
= "validating input parameters"
317 ns_request
= self
._remove
_envelop
(indata
)
318 self
._update
_input
_with
_kwargs
(ns_request
, kwargs
)
319 ns_request
= self
._validate
_input
_new
(ns_request
, session
["force"])
321 step
= "getting nsd id='{}' from database".format(ns_request
.get("nsdId"))
322 nsd
= self
._get
_nsd
_from
_db
(ns_request
["nsdId"], session
)
323 ns_k8s_namespace
= self
._get
_ns
_k
8s
_namespace
(nsd
, ns_request
, session
)
325 step
= "checking nsdOperationalState"
326 self
._check
_nsd
_operational
_state
(nsd
, ns_request
)
328 step
= "filling nsr from input data"
329 nsr_id
= str(uuid4())
330 nsr_descriptor
= self
._create
_nsr
_descriptor
_from
_nsd
(
331 nsd
, ns_request
, nsr_id
, session
336 # TODO: Change for multiple df support
337 vnf_profiles
= nsd
.get("df", [[]])[0].get("vnf-profile", ())
338 for vnfp
in vnf_profiles
:
339 vnfd_id
= vnfp
.get("vnfd-id")
340 vnf_index
= vnfp
.get("id")
342 "getting vnfd id='{}' constituent-vnfd='{}' from database".format(
346 if vnfd_id
not in needed_vnfds
:
347 vnfd
= self
._get
_vnfd
_from
_db
(vnfd_id
, session
)
348 needed_vnfds
[vnfd_id
] = vnfd
349 nsr_descriptor
["vnfd-id"].append(vnfd
["_id"])
351 vnfd
= needed_vnfds
[vnfd_id
]
353 step
= "filling vnfr vnfd-id='{}' constituent-vnfd='{}'".format(
356 vnfr_descriptor
= self
._create
_vnfr
_descriptor
_from
_vnfd
(
366 step
= "creating vnfr vnfd-id='{}' constituent-vnfd='{}' at database".format(
369 self
._add
_vnfr
_to
_db
(vnfr_descriptor
, rollback
, session
)
370 nsr_descriptor
["constituent-vnfr-ref"].append(vnfr_descriptor
["id"])
372 step
= "creating nsr at database"
373 self
._add
_nsr
_to
_db
(nsr_descriptor
, rollback
, session
)
375 step
= "creating nsr temporal folder"
376 self
.fs
.mkdir(nsr_id
)
386 raise type(e
)("{} while '{}'".format(e
, step
), http_code
=e
.http_code
)
388 def _get_nsd_from_db(self
, nsd_id
, session
):
389 _filter
= self
._get
_project
_filter
(session
)
390 _filter
["_id"] = nsd_id
391 return self
.db
.get_one("nsds", _filter
)
393 def _get_vnfd_from_db(self
, vnfd_id
, session
):
394 _filter
= self
._get
_project
_filter
(session
)
395 _filter
["id"] = vnfd_id
396 vnfd
= self
.db
.get_one("vnfds", _filter
, fail_on_empty
=True, fail_on_more
=True)
400 def _add_nsr_to_db(self
, nsr_descriptor
, rollback
, session
):
402 nsr_descriptor
, session
["project_id"], make_public
=session
["public"]
404 self
.db
.create("nsrs", nsr_descriptor
)
405 rollback
.append({"topic": "nsrs", "_id": nsr_descriptor
["id"]})
407 def _add_vnfr_to_db(self
, vnfr_descriptor
, rollback
, session
):
409 vnfr_descriptor
, session
["project_id"], make_public
=session
["public"]
411 self
.db
.create("vnfrs", vnfr_descriptor
)
412 rollback
.append({"topic": "vnfrs", "_id": vnfr_descriptor
["id"]})
414 def _check_nsd_operational_state(self
, nsd
, ns_request
):
415 if nsd
["_admin"]["operationalState"] == "DISABLED":
416 raise EngineException(
417 "nsd with id '{}' is DISABLED, and thus cannot be used to create "
418 "a network service".format(ns_request
["nsdId"]),
419 http_code
=HTTPStatus
.CONFLICT
,
422 def _get_ns_k8s_namespace(self
, nsd
, ns_request
, session
):
423 additional_params
, _
= self
._format
_additional
_params
(
424 ns_request
, descriptor
=nsd
426 # use for k8s-namespace from ns_request or additionalParamsForNs. By default, the project_id
427 ns_k8s_namespace
= session
["project_id"][0] if session
["project_id"] else None
428 if ns_request
and ns_request
.get("k8s-namespace"):
429 ns_k8s_namespace
= ns_request
["k8s-namespace"]
430 if additional_params
and additional_params
.get("k8s-namespace"):
431 ns_k8s_namespace
= additional_params
["k8s-namespace"]
433 return ns_k8s_namespace
435 def _create_nsr_descriptor_from_nsd(self
, nsd
, ns_request
, nsr_id
, session
):
437 additional_params
, _
= self
._format
_additional
_params
(
438 ns_request
, descriptor
=nsd
442 "name": ns_request
["nsName"],
443 "name-ref": ns_request
["nsName"],
444 "short-name": ns_request
["nsName"],
445 "admin-status": "ENABLED",
446 "nsState": "NOT_INSTANTIATED",
447 "currentOperation": "IDLE",
448 "currentOperationID": None,
449 "errorDescription": None,
451 "deploymentStatus": None,
452 "configurationStatus": None,
454 "nsd": {k
: v
for k
, v
in nsd
.items()},
455 "datacenter": ns_request
["vimAccountId"],
456 "resource-orchestrator": "osmopenmano",
457 "description": ns_request
.get("nsDescription", ""),
458 "constituent-vnfr-ref": [],
459 "operational-status": "init", # typedef ns-operational-
460 "config-status": "init", # typedef config-states
461 "detailed-status": "scheduled",
462 "orchestration-progress": {},
464 "nsd-name-ref": nsd
["name"],
465 "operational-events": [], # "id", "timestamp", "description", "event",
466 "nsd-ref": nsd
["id"],
467 "nsd-id": nsd
["_id"],
469 "instantiate_params": self
._format
_ns
_request
(ns_request
),
470 "additionalParamsForNs": additional_params
,
471 "ns-instance-config-ref": nsr_id
,
474 "ssh-authorized-key": ns_request
.get("ssh_keys"), # TODO remove
478 ns_request
["nsr_id"] = nsr_id
479 if ns_request
and ns_request
.get("config-units"):
480 nsr_descriptor
["config-units"] = ns_request
["config-units"]
483 if nsd
.get("virtual-link-desc"):
484 nsr_vld
= deepcopy(nsd
.get("virtual-link-desc", []))
485 # Fill each vld with vnfd-connection-point-ref data
486 # TODO: Change for multiple df support
487 all_vld_connection_point_data
= {vld
.get("id"): [] for vld
in nsr_vld
}
488 vnf_profiles
= nsd
.get("df", [[]])[0].get("vnf-profile", ())
489 for vnf_profile
in vnf_profiles
:
490 for vlc
in vnf_profile
.get("virtual-link-connectivity", ()):
491 for cpd
in vlc
.get("constituent-cpd-id", ()):
492 all_vld_connection_point_data
[
493 vlc
.get("virtual-link-profile-id")
496 "member-vnf-index-ref": cpd
.get(
497 "constituent-base-element-id"
499 "vnfd-connection-point-ref": cpd
.get(
502 "vnfd-id-ref": vnf_profile
.get("vnfd-id"),
506 vnfd
= self
._get
_vnfd
_from
_db
(vnf_profile
.get("vnfd-id"), session
)
508 for vdu
in vnfd
.get("vdu", ()):
511 # Find this vdu compute and storage descriptors
512 vdu_virtual_compute
= {}
513 vdu_virtual_storage
= {}
514 for vcd
in vnfd
.get("virtual-compute-desc", ()):
515 if vcd
.get("id") == vdu
.get("virtual-compute-desc"):
516 vdu_virtual_compute
= vcd
517 for vsd
in vnfd
.get("virtual-storage-desc", ()):
518 if vsd
.get("id") == vdu
.get("virtual-storage-desc", [[]])[0]:
519 vdu_virtual_storage
= vsd
520 # Get this vdu vcpus, memory and storage info for flavor_data
521 if vdu_virtual_compute
.get("virtual-cpu", {}).get(
524 flavor_data
["vcpu-count"] = vdu_virtual_compute
["virtual-cpu"][
527 if vdu_virtual_compute
.get("virtual-memory", {}).get("size"):
528 flavor_data
["memory-mb"] = (
529 float(vdu_virtual_compute
["virtual-memory"]["size"])
532 if vdu_virtual_storage
.get("size-of-storage"):
533 flavor_data
["storage-gb"] = vdu_virtual_storage
[
536 # Get this vdu EPA info for guest_epa
537 if vdu_virtual_compute
.get("virtual-cpu", {}).get("cpu-quota"):
538 guest_epa
["cpu-quota"] = vdu_virtual_compute
["virtual-cpu"][
541 if vdu_virtual_compute
.get("virtual-cpu", {}).get("pinning"):
542 vcpu_pinning
= vdu_virtual_compute
["virtual-cpu"]["pinning"]
543 if vcpu_pinning
.get("thread-policy"):
544 guest_epa
["cpu-thread-pinning-policy"] = vcpu_pinning
[
547 if vcpu_pinning
.get("policy"):
550 if vcpu_pinning
["policy"] == "dynamic"
553 guest_epa
["cpu-pinning-policy"] = cpu_policy
554 if vdu_virtual_compute
.get("virtual-memory", {}).get("mem-quota"):
555 guest_epa
["mem-quota"] = vdu_virtual_compute
["virtual-memory"][
558 if vdu_virtual_compute
.get("virtual-memory", {}).get(
561 guest_epa
["mempage-size"] = vdu_virtual_compute
[
564 if vdu_virtual_compute
.get("virtual-memory", {}).get(
567 guest_epa
["numa-node-policy"] = vdu_virtual_compute
[
569 ]["numa-node-policy"]
570 if vdu_virtual_storage
.get("disk-io-quota"):
571 guest_epa
["disk-io-quota"] = vdu_virtual_storage
[
576 flavor_data
["guest-epa"] = guest_epa
578 flavor_data
["name"] = vdu
["id"][:56] + "-flv"
579 flavor_data
["id"] = str(len(nsr_descriptor
["flavor"]))
580 nsr_descriptor
["flavor"].append(flavor_data
)
582 sw_image_id
= vdu
.get("sw-image-desc")
584 image_data
= self
._get
_image
_data
_from
_vnfd
(vnfd
, sw_image_id
)
585 self
._add
_image
_to
_nsr
(nsr_descriptor
, image_data
)
587 # also add alternative images to the list of images
588 for alt_image
in vdu
.get("alternative-sw-image-desc", ()):
589 image_data
= self
._get
_image
_data
_from
_vnfd
(vnfd
, alt_image
)
590 self
._add
_image
_to
_nsr
(nsr_descriptor
, image_data
)
593 vld
["vnfd-connection-point-ref"] = all_vld_connection_point_data
.get(
596 vld
["name"] = vld
["id"]
597 nsr_descriptor
["vld"] = nsr_vld
599 return nsr_descriptor
601 def _get_image_data_from_vnfd(self
, vnfd
, sw_image_id
):
602 sw_image_desc
= utils
.find_in_list(
603 vnfd
.get("sw-image-desc", ()), lambda sw
: sw
["id"] == sw_image_id
606 if sw_image_desc
.get("image"):
607 image_data
["image"] = sw_image_desc
["image"]
608 if sw_image_desc
.get("checksum"):
609 image_data
["image_checksum"] = sw_image_desc
["checksum"]["hash"]
610 if sw_image_desc
.get("vim-type"):
611 image_data
["vim-type"] = sw_image_desc
["vim-type"]
614 def _add_image_to_nsr(self
, nsr_descriptor
, image_data
):
616 Adds image to nsr checking first it is not already added
621 for f
in nsr_descriptor
["image"]
622 if all(f
.get(k
) == image_data
[k
] for k
in image_data
)
627 image_data
["id"] = str(len(nsr_descriptor
["image"]))
628 nsr_descriptor
["image"].append(image_data
)
630 def _create_vnfr_descriptor_from_vnfd(
640 vnfr_id
= str(uuid4())
641 nsr_id
= nsr_descriptor
["id"]
643 additional_params
, vnf_params
= self
._format
_additional
_params
(
644 ns_request
, vnf_index
, descriptor
=vnfd
650 "nsr-id-ref": nsr_id
,
651 "member-vnf-index-ref": vnf_index
,
652 "additionalParamsForVnf": additional_params
,
654 # "vnfd": vnfd, # at OSM model.but removed to avoid data duplication TODO: revise
656 "vnfd-id": vnfd
["_id"], # not at OSM model, but useful
657 "vim-account-id": None,
660 "connection-point": [],
661 "ip-address": None, # mgmt-interface filled by LCM
663 vnf_k8s_namespace
= ns_k8s_namespace
665 if vnf_params
.get("k8s-namespace"):
666 vnf_k8s_namespace
= vnf_params
["k8s-namespace"]
667 if vnf_params
.get("config-units"):
668 vnfr_descriptor
["config-units"] = vnf_params
["config-units"]
671 if vnfd
.get("int-virtual-link-desc"):
672 vnfr_descriptor
["vld"] = []
673 for vnfd_vld
in vnfd
.get("int-virtual-link-desc"):
674 vnfr_descriptor
["vld"].append({key
: vnfd_vld
[key
] for key
in vnfd_vld
})
676 for cp
in vnfd
.get("ext-cpd", ()):
678 "name": cp
.get("id"),
679 "connection-point-id": cp
.get("int-cpd", {}).get("cpd"),
680 "connection-point-vdu-id": cp
.get("int-cpd", {}).get("vdu-id"),
682 # "ip-address", "mac-address" # filled by LCM
683 # vim-id # TODO it would be nice having a vim port id
685 vnfr_descriptor
["connection-point"].append(vnf_cp
)
687 # Create k8s-cluster information
688 # TODO: Validate if a k8s-cluster net can have more than one ext-cpd ?
689 if vnfd
.get("k8s-cluster"):
690 vnfr_descriptor
["k8s-cluster"] = vnfd
["k8s-cluster"]
691 all_k8s_cluster_nets_cpds
= {}
692 for cpd
in get_iterable(vnfd
.get("ext-cpd")):
693 if cpd
.get("k8s-cluster-net"):
694 all_k8s_cluster_nets_cpds
[cpd
.get("k8s-cluster-net")] = cpd
.get(
697 for net
in get_iterable(vnfr_descriptor
["k8s-cluster"].get("nets")):
698 if net
.get("id") in all_k8s_cluster_nets_cpds
:
699 net
["external-connection-point-ref"] = all_k8s_cluster_nets_cpds
[
704 for kdu
in get_iterable(vnfd
.get("kdu")):
705 additional_params
, kdu_params
= self
._format
_additional
_params
(
706 ns_request
, vnf_index
, kdu_name
=kdu
["name"], descriptor
=vnfd
708 kdu_k8s_namespace
= vnf_k8s_namespace
709 kdu_model
= kdu_params
.get("kdu_model") if kdu_params
else None
710 if kdu_params
and kdu_params
.get("k8s-namespace"):
711 kdu_k8s_namespace
= kdu_params
["k8s-namespace"]
714 "additionalParams": additional_params
,
715 "k8s-namespace": kdu_k8s_namespace
,
716 "kdu-name": kdu
["name"],
717 # TODO "name": "" Name of the VDU in the VIM
718 "ip-address": None, # mgmt-interface filled by LCM
721 if kdu_params
and kdu_params
.get("config-units"):
722 kdur
["config-units"] = kdu_params
["config-units"]
723 if kdu
.get("helm-version"):
724 kdur
["helm-version"] = kdu
["helm-version"]
725 for k8s_type
in ("helm-chart", "juju-bundle"):
726 if kdu
.get(k8s_type
):
727 kdur
[k8s_type
] = kdu_model
or kdu
[k8s_type
]
728 if not vnfr_descriptor
.get("kdur"):
729 vnfr_descriptor
["kdur"] = []
730 vnfr_descriptor
["kdur"].append(kdur
)
732 vnfd_mgmt_cp
= vnfd
.get("mgmt-cp")
734 for vdu
in vnfd
.get("vdu", ()):
737 configs
= vnfd
.get("df")[0]["lcm-operations-configuration"][
738 "operate-vnf-op-config"
740 vdu_config
= utils
.find_in_list(
741 configs
, lambda config
: config
["id"] == vdu
["id"]
747 vdu_instantiation_level
= utils
.find_in_list(
748 vnfd
.get("df")[0]["instantiation-level"][0]["vdu-level"],
749 lambda a_vdu_profile
: a_vdu_profile
["vdu-id"] == vdu
["id"],
752 vdu_instantiation_level
= None
755 external_connection_ee
= utils
.filter_in_list(
756 vdu_config
.get("execution-environment-list", []),
757 lambda ee
: "external-connection-point-ref" in ee
,
759 for ee
in external_connection_ee
:
760 vdu_mgmt_cp
.append(ee
["external-connection-point-ref"])
762 additional_params
, vdu_params
= self
._format
_additional
_params
(
763 ns_request
, vnf_index
, vdu_id
=vdu
["id"], descriptor
=vnfd
766 "vdu-id-ref": vdu
["id"],
767 # TODO "name": "" Name of the VDU in the VIM
768 "ip-address": None, # mgmt-interface filled by LCM
769 # "vim-id", "flavor-id", "image-id", "management-ip" # filled by LCM
770 "internal-connection-point": [],
772 "additionalParams": additional_params
,
773 "vdu-name": vdu
["name"],
775 if vdu_params
and vdu_params
.get("config-units"):
776 vdur
["config-units"] = vdu_params
["config-units"]
777 if deep_get(vdu
, ("supplemental-boot-data", "boot-data-drive")):
778 vdur
["boot-data-drive"] = vdu
["supplemental-boot-data"][
781 if vdu
.get("pdu-type"):
782 vdur
["pdu-type"] = vdu
["pdu-type"]
783 vdur
["name"] = vdu
["pdu-type"]
784 # TODO volumes: name, volume-id
785 for icp
in vdu
.get("int-cpd", ()):
788 "connection-point-id": icp
["id"],
789 "name": icp
.get("id"),
792 vdur
["internal-connection-point"].append(vdu_icp
)
794 for iface
in icp
.get("virtual-network-interface-requirement", ()):
795 iface_fields
= ("name", "mac-address")
797 x
: iface
[x
] for x
in iface_fields
if iface
.get(x
) is not None
800 vdu_iface
["internal-connection-point-ref"] = vdu_icp
["id"]
801 if "port-security-enabled" in icp
:
802 vdu_iface
["port-security-enabled"] = icp
[
803 "port-security-enabled"
806 if "port-security-disable-strategy" in icp
:
807 vdu_iface
["port-security-disable-strategy"] = icp
[
808 "port-security-disable-strategy"
811 for ext_cp
in vnfd
.get("ext-cpd", ()):
812 if not ext_cp
.get("int-cpd"):
814 if ext_cp
["int-cpd"].get("vdu-id") != vdu
["id"]:
816 if icp
["id"] == ext_cp
["int-cpd"].get("cpd"):
817 vdu_iface
["external-connection-point-ref"] = ext_cp
.get(
821 if "port-security-enabled" in ext_cp
:
822 vdu_iface
["port-security-enabled"] = ext_cp
[
823 "port-security-enabled"
826 if "port-security-disable-strategy" in ext_cp
:
827 vdu_iface
["port-security-disable-strategy"] = ext_cp
[
828 "port-security-disable-strategy"
835 and vdu_iface
.get("external-connection-point-ref")
838 vdu_iface
["mgmt-vnf"] = True
839 vdu_iface
["mgmt-interface"] = True
841 for ecp
in vdu_mgmt_cp
:
842 if vdu_iface
.get("external-connection-point-ref") == ecp
:
843 vdu_iface
["mgmt-interface"] = True
845 if iface
.get("virtual-interface"):
846 vdu_iface
.update(deepcopy(iface
["virtual-interface"]))
848 # look for network where this interface is connected
849 iface_ext_cp
= vdu_iface
.get("external-connection-point-ref")
851 # TODO: Change for multiple df support
852 for df
in get_iterable(nsd
.get("df")):
853 for vnf_profile
in get_iterable(df
.get("vnf-profile")):
854 for vlc_index
, vlc
in enumerate(
856 vnf_profile
.get("virtual-link-connectivity")
859 for cpd
in get_iterable(
860 vlc
.get("constituent-cpd-id")
863 cpd
.get("constituent-cpd-id")
866 vdu_iface
["ns-vld-id"] = vlc
.get(
867 "virtual-link-profile-id"
869 # if iface type is SRIOV or PASSTHROUGH, set pci-interfaces flag to True
870 if vdu_iface
.get("type") in (
874 nsr_descriptor
["vld"][vlc_index
][
878 elif vdu_iface
.get("internal-connection-point-ref"):
879 vdu_iface
["vnf-vld-id"] = icp
.get("int-virtual-link-desc")
880 # TODO: store fixed IP address in the record (if it exists in the ICP)
881 # if iface type is SRIOV or PASSTHROUGH, set pci-interfaces flag to True
882 if vdu_iface
.get("type") in ("SR-IOV", "PCI-PASSTHROUGH"):
883 ivld_index
= utils
.find_index_in_list(
884 vnfd
.get("int-virtual-link-desc", ()),
885 lambda ivld
: ivld
["id"]
886 == icp
.get("int-virtual-link-desc"),
888 vnfr_descriptor
["vld"][ivld_index
]["pci-interfaces"] = True
890 vdur
["interfaces"].append(vdu_iface
)
892 if vdu
.get("sw-image-desc"):
893 sw_image
= utils
.find_in_list(
894 vnfd
.get("sw-image-desc", ()),
895 lambda image
: image
["id"] == vdu
.get("sw-image-desc"),
897 nsr_sw_image_data
= utils
.find_in_list(
898 nsr_descriptor
["image"],
899 lambda nsr_image
: (nsr_image
.get("image") == sw_image
.get("image")),
901 vdur
["ns-image-id"] = nsr_sw_image_data
["id"]
903 if vdu
.get("alternative-sw-image-desc"):
905 for alt_image_id
in vdu
.get("alternative-sw-image-desc", ()):
906 sw_image
= utils
.find_in_list(
907 vnfd
.get("sw-image-desc", ()),
908 lambda image
: image
["id"] == alt_image_id
,
910 nsr_sw_image_data
= utils
.find_in_list(
911 nsr_descriptor
["image"],
913 nsr_image
.get("image") == sw_image
.get("image")
916 alt_image_ids
.append(nsr_sw_image_data
["id"])
917 vdur
["alt-image-ids"] = alt_image_ids
919 flavor_data_name
= vdu
["id"][:56] + "-flv"
920 nsr_flavor_desc
= utils
.find_in_list(
921 nsr_descriptor
["flavor"],
922 lambda flavor
: flavor
["name"] == flavor_data_name
,
926 vdur
["ns-flavor-id"] = nsr_flavor_desc
["id"]
928 if vdu_instantiation_level
:
929 count
= vdu_instantiation_level
.get("number-of-instances")
933 for index
in range(0, count
):
934 vdur
= deepcopy(vdur
)
935 for iface
in vdur
["interfaces"]:
936 if iface
.get("ip-address"):
937 iface
["ip-address"] = increment_ip_mac(iface
["ip-address"])
938 if iface
.get("mac-address"):
939 iface
["mac-address"] = increment_ip_mac(iface
["mac-address"])
941 vdur
["_id"] = str(uuid4())
942 vdur
["id"] = vdur
["_id"]
943 vdur
["count-index"] = index
944 vnfr_descriptor
["vdur"].append(vdur
)
946 return vnfr_descriptor
948 def vca_status_refresh(self
, session
, ns_instance_content
, filter_q
):
950 vcaStatus in ns_instance_content maybe stale, check if it is stale and create lcm op
951 to refresh vca status by sending message to LCM when it is stale. Ignore otherwise.
952 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
953 :param ns_instance_content: ns instance content
954 :param filter_q: dict: query parameter containing vcaStatus-refresh as true or false
957 time_now
, time_delta
= time(), time() - ns_instance_content
["_admin"]["modified"]
958 force_refresh
= isinstance(filter_q
, dict) and filter_q
.get('vcaStatusRefresh') == 'true'
959 threshold_reached
= time_delta
> 120
960 if force_refresh
or threshold_reached
:
961 operation
, _id
= "vca_status_refresh", ns_instance_content
["_id"]
962 ns_instance_content
["_admin"]["modified"] = time_now
963 self
.db
.set_one(self
.topic
, {"_id": _id
}, ns_instance_content
)
964 nslcmop_desc
= NsLcmOpTopic
._create
_nslcmop
(_id
, operation
, None)
965 self
.format_on_new(nslcmop_desc
, session
["project_id"], make_public
=session
["public"])
966 nslcmop_desc
["_admin"].pop("nsState")
967 self
.msg
.write("ns", operation
, nslcmop_desc
)
970 def show(self
, session
, _id
, filter_q
=None, api_req
=False):
972 Get complete information on an ns instance.
973 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
974 :param _id: string, ns instance id
975 :param filter_q: dict: query parameter containing vcaStatusRefresh as true or false
976 :param api_req: True if this call is serving an external API request. False if serving internal request.
977 :return: dictionary, raise exception if not found.
979 ns_instance_content
= super().show(session
, _id
, api_req
)
980 self
.vca_status_refresh(session
, ns_instance_content
, filter_q
)
981 return ns_instance_content
983 def edit(self
, session
, _id
, indata
=None, kwargs
=None, content
=None):
984 raise EngineException(
985 "Method edit called directly", HTTPStatus
.INTERNAL_SERVER_ERROR
989 class VnfrTopic(BaseTopic
):
993 def __init__(self
, db
, fs
, msg
, auth
):
994 BaseTopic
.__init
__(self
, db
, fs
, msg
, auth
)
996 def delete(self
, session
, _id
, dry_run
=False, not_send_msg
=None):
997 raise EngineException(
998 "Method delete called directly", HTTPStatus
.INTERNAL_SERVER_ERROR
1001 def edit(self
, session
, _id
, indata
=None, kwargs
=None, content
=None):
1002 raise EngineException(
1003 "Method edit called directly", HTTPStatus
.INTERNAL_SERVER_ERROR
1006 def new(self
, rollback
, session
, indata
=None, kwargs
=None, headers
=None):
1007 # Not used because vnfrs are created and deleted by NsrTopic class directly
1008 raise EngineException(
1009 "Method new called directly", HTTPStatus
.INTERNAL_SERVER_ERROR
1013 class NsLcmOpTopic(BaseTopic
):
1016 operation_schema
= { # mapping between operation and jsonschema to validate
1017 "instantiate": ns_instantiate
,
1018 "action": ns_action
,
1020 "terminate": ns_terminate
,
1023 def __init__(self
, db
, fs
, msg
, auth
):
1024 BaseTopic
.__init
__(self
, db
, fs
, msg
, auth
)
1026 def _check_ns_operation(self
, session
, nsr
, operation
, indata
):
1028 Check that user has enter right parameters for the operation
1029 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1030 :param operation: it can be: instantiate, terminate, action, TODO: update, heal
1031 :param indata: descriptor with the parameters of the operation
1034 if operation
== "action":
1035 self
._check
_action
_ns
_operation
(indata
, nsr
)
1036 elif operation
== "scale":
1037 self
._check
_scale
_ns
_operation
(indata
, nsr
)
1038 elif operation
== "instantiate":
1039 self
._check
_instantiate
_ns
_operation
(indata
, nsr
, session
)
1041 def _check_action_ns_operation(self
, indata
, nsr
):
1043 # check vnf_member_index
1044 if indata
.get("vnf_member_index"):
1045 indata
["member_vnf_index"] = indata
.pop(
1047 ) # for backward compatibility
1048 if indata
.get("member_vnf_index"):
1049 vnfd
= self
._get
_vnfd
_from
_vnf
_member
_index
(
1050 indata
["member_vnf_index"], nsr
["_id"]
1053 configs
= vnfd
.get("df")[0]["lcm-operations-configuration"][
1054 "operate-vnf-op-config"
1059 if indata
.get("vdu_id"):
1060 self
._check
_valid
_vdu
(vnfd
, indata
["vdu_id"])
1061 descriptor_configuration
= utils
.find_in_list(
1062 configs
, lambda config
: config
["id"] == indata
["vdu_id"]
1064 elif indata
.get("kdu_name"):
1065 self
._check
_valid
_kdu
(vnfd
, indata
["kdu_name"])
1066 descriptor_configuration
= utils
.find_in_list(
1067 configs
, lambda config
: config
["id"] == indata
.get("kdu_name")
1070 descriptor_configuration
= utils
.find_in_list(
1071 configs
, lambda config
: config
["id"] == vnfd
["id"]
1073 if descriptor_configuration
is not None:
1074 descriptor_configuration
= descriptor_configuration
.get(
1078 descriptor_configuration
= nsd
.get("ns-configuration", {}).get(
1082 # For k8s allows default primitives without validating the parameters
1083 if indata
.get("kdu_name") and indata
["primitive"] in (
1090 # TODO should be checked that rollback only can contains revsision_numbe????
1091 if not indata
.get("member_vnf_index"):
1092 raise EngineException(
1093 "Missing action parameter 'member_vnf_index' for default KDU primitive '{}'".format(
1098 # if not, check primitive
1099 for config_primitive
in get_iterable(descriptor_configuration
):
1100 if indata
["primitive"] == config_primitive
["name"]:
1101 # check needed primitive_params are provided
1102 if indata
.get("primitive_params"):
1103 in_primitive_params_copy
= copy(indata
["primitive_params"])
1105 in_primitive_params_copy
= {}
1106 for paramd
in get_iterable(config_primitive
.get("parameter")):
1107 if paramd
["name"] in in_primitive_params_copy
:
1108 del in_primitive_params_copy
[paramd
["name"]]
1109 elif not paramd
.get("default-value"):
1110 raise EngineException(
1111 "Needed parameter {} not provided for primitive '{}'".format(
1112 paramd
["name"], indata
["primitive"]
1115 # check no extra primitive params are provided
1116 if in_primitive_params_copy
:
1117 raise EngineException(
1118 "parameter/s '{}' not present at vnfd /nsd for primitive '{}'".format(
1119 list(in_primitive_params_copy
.keys()), indata
["primitive"]
1124 raise EngineException(
1125 "Invalid primitive '{}' is not present at vnfd/nsd".format(
1130 def _check_scale_ns_operation(self
, indata
, nsr
):
1131 vnfd
= self
._get
_vnfd
_from
_vnf
_member
_index
(
1132 indata
["scaleVnfData"]["scaleByStepData"]["member-vnf-index"], nsr
["_id"]
1134 for scaling_aspect
in get_iterable(vnfd
.get("df", ())[0]["scaling-aspect"]):
1136 indata
["scaleVnfData"]["scaleByStepData"]["scaling-group-descriptor"]
1137 == scaling_aspect
["id"]
1141 raise EngineException(
1142 "Invalid scaleVnfData:scaleByStepData:scaling-group-descriptor '{}' is not "
1143 "present at vnfd:scaling-aspect".format(
1144 indata
["scaleVnfData"]["scaleByStepData"][
1145 "scaling-group-descriptor"
1150 def _check_instantiate_ns_operation(self
, indata
, nsr
, session
):
1151 vnf_member_index_to_vnfd
= {} # map between vnf_member_index to vnf descriptor.
1155 self
._check
_valid
_vim
_account
(indata
["vimAccountId"], vim_accounts
, session
)
1156 self
._check
_valid
_wim
_account
(indata
.get("wimAccountId"), wim_accounts
, session
)
1157 for in_vnf
in get_iterable(indata
.get("vnf")):
1158 member_vnf_index
= in_vnf
["member-vnf-index"]
1159 if vnf_member_index_to_vnfd
.get(member_vnf_index
):
1160 vnfd
= vnf_member_index_to_vnfd
[member_vnf_index
]
1162 vnfd
= self
._get
_vnfd
_from
_vnf
_member
_index
(
1163 member_vnf_index
, nsr
["_id"]
1165 vnf_member_index_to_vnfd
[
1167 ] = vnfd
# add to cache, avoiding a later look for
1168 self
._check
_vnf
_instantiation
_params
(in_vnf
, vnfd
)
1169 if in_vnf
.get("vimAccountId"):
1170 self
._check
_valid
_vim
_account
(
1171 in_vnf
["vimAccountId"], vim_accounts
, session
1174 for in_vld
in get_iterable(indata
.get("vld")):
1175 self
._check
_valid
_wim
_account
(
1176 in_vld
.get("wimAccountId"), wim_accounts
, session
1178 for vldd
in get_iterable(nsd
.get("virtual-link-desc")):
1179 if in_vld
["name"] == vldd
["id"]:
1182 raise EngineException(
1183 "Invalid parameter vld:name='{}' is not present at nsd:vld".format(
1188 def _get_vnfd_from_vnf_member_index(self
, member_vnf_index
, nsr_id
):
1189 # Obtain vnf descriptor. The vnfr is used to get the vnfd._id used for this member_vnf_index
1190 vnfr
= self
.db
.get_one(
1192 {"nsr-id-ref": nsr_id
, "member-vnf-index-ref": member_vnf_index
},
1193 fail_on_empty
=False,
1196 raise EngineException(
1197 "Invalid parameter member_vnf_index='{}' is not one of the "
1198 "nsd:constituent-vnfd".format(member_vnf_index
)
1200 vnfd
= self
.db
.get_one("vnfds", {"_id": vnfr
["vnfd-id"]}, fail_on_empty
=False)
1202 raise EngineException(
1203 "vnfd id={} has been deleted!. Operation cannot be performed".format(
1209 def _check_valid_vdu(self
, vnfd
, vdu_id
):
1210 for vdud
in get_iterable(vnfd
.get("vdu")):
1211 if vdud
["id"] == vdu_id
:
1214 raise EngineException(
1215 "Invalid parameter vdu_id='{}' not present at vnfd:vdu:id".format(
1220 def _check_valid_kdu(self
, vnfd
, kdu_name
):
1221 for kdud
in get_iterable(vnfd
.get("kdu")):
1222 if kdud
["name"] == kdu_name
:
1225 raise EngineException(
1226 "Invalid parameter kdu_name='{}' not present at vnfd:kdu:name".format(
1231 def _check_vnf_instantiation_params(self
, in_vnf
, vnfd
):
1232 for in_vdu
in get_iterable(in_vnf
.get("vdu")):
1233 for vdu
in get_iterable(vnfd
.get("vdu")):
1234 if in_vdu
["id"] == vdu
["id"]:
1235 for volume
in get_iterable(in_vdu
.get("volume")):
1236 for volumed
in get_iterable(vdu
.get("virtual-storage-desc")):
1237 if volumed
["id"] == volume
["name"]:
1240 raise EngineException(
1241 "Invalid parameter vnf[member-vnf-index='{}']:vdu[id='{}']:"
1242 "volume:name='{}' is not present at "
1243 "vnfd:vdu:virtual-storage-desc list".format(
1244 in_vnf
["member-vnf-index"],
1250 vdu_if_names
= set()
1251 for cpd
in get_iterable(vdu
.get("int-cpd")):
1252 for iface
in get_iterable(
1253 cpd
.get("virtual-network-interface-requirement")
1255 vdu_if_names
.add(iface
.get("name"))
1257 for in_iface
in get_iterable(in_vdu
["interface"]):
1258 if in_iface
["name"] in vdu_if_names
:
1261 raise EngineException(
1262 "Invalid parameter vnf[member-vnf-index='{}']:vdu[id='{}']:"
1263 "int-cpd[id='{}'] is not present at vnfd:vdu:int-cpd".format(
1264 in_vnf
["member-vnf-index"],
1272 raise EngineException(
1273 "Invalid parameter vnf[member-vnf-index='{}']:vdu[id='{}'] is not present "
1274 "at vnfd:vdu".format(in_vnf
["member-vnf-index"], in_vdu
["id"])
1278 ivld
.get("id"): set()
1279 for ivld
in get_iterable(vnfd
.get("int-virtual-link-desc"))
1281 for vdu
in get_iterable(vnfd
.get("vdu")):
1282 for cpd
in get_iterable(vnfd
.get("int-cpd")):
1283 if cpd
.get("int-virtual-link-desc"):
1284 vnfd_ivlds_cpds
[cpd
.get("int-virtual-link-desc")] = cpd
.get("id")
1286 for in_ivld
in get_iterable(in_vnf
.get("internal-vld")):
1287 if in_ivld
.get("name") in vnfd_ivlds_cpds
:
1288 for in_icp
in get_iterable(in_ivld
.get("internal-connection-point")):
1289 if in_icp
["id-ref"] in vnfd_ivlds_cpds
[in_ivld
.get("name")]:
1292 raise EngineException(
1293 "Invalid parameter vnf[member-vnf-index='{}']:internal-vld[name"
1294 "='{}']:internal-connection-point[id-ref:'{}'] is not present at "
1295 "vnfd:internal-vld:name/id:internal-connection-point".format(
1296 in_vnf
["member-vnf-index"],
1302 raise EngineException(
1303 "Invalid parameter vnf[member-vnf-index='{}']:internal-vld:name='{}'"
1304 " is not present at vnfd '{}'".format(
1305 in_vnf
["member-vnf-index"], in_ivld
["name"], vnfd
["id"]
1309 def _check_valid_vim_account(self
, vim_account
, vim_accounts
, session
):
1310 if vim_account
in vim_accounts
:
1313 db_filter
= self
._get
_project
_filter
(session
)
1314 db_filter
["_id"] = vim_account
1315 self
.db
.get_one("vim_accounts", db_filter
)
1317 raise EngineException(
1318 "Invalid vimAccountId='{}' not present for the project".format(
1322 vim_accounts
.append(vim_account
)
1324 def _check_valid_wim_account(self
, wim_account
, wim_accounts
, session
):
1325 if not isinstance(wim_account
, str):
1327 if wim_account
in wim_accounts
:
1330 db_filter
= self
._get
_project
_filter
(session
, write
=False, show_all
=True)
1331 db_filter
["_id"] = wim_account
1332 self
.db
.get_one("wim_accounts", db_filter
)
1334 raise EngineException(
1335 "Invalid wimAccountId='{}' not present for the project".format(
1339 wim_accounts
.append(wim_account
)
1342 self
, session
, rollback
, vnfr
, vim_account
, vnfr_update
, vnfr_update_rollback
1345 Look for a free PDU in the catalog matching vdur type and interfaces. Fills vnfr.vdur with the interface
1346 (ip_address, ...) information.
1347 Modifies PDU _admin.usageState to 'IN_USE'
1348 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1349 :param rollback: list with the database modifications to rollback if needed
1350 :param vnfr: vnfr to be updated. It is modified with pdu interface info if pdu is found
1351 :param vim_account: vim_account where this vnfr should be deployed
1352 :param vnfr_update: dictionary filled by this method with changes to be done at database vnfr
1353 :param vnfr_update_rollback: dictionary filled by this method with original content of vnfr in case a rollback
1354 of the changed vnfr is needed
1356 :return: List of PDU interfaces that are connected to an existing VIM network. Each item contains:
1357 "vim-network-name": used at VIM
1358 "name": interface name
1359 "vnf-vld-id": internal VNFD vld where this interface is connected, or
1360 "ns-vld-id": NSD vld where this interface is connected.
1361 NOTE: One, and only one between 'vnf-vld-id' and 'ns-vld-id' contains a value. The other will be None
1364 ifaces_forcing_vim_network
= []
1365 for vdur_index
, vdur
in enumerate(get_iterable(vnfr
.get("vdur"))):
1366 if not vdur
.get("pdu-type"):
1368 pdu_type
= vdur
.get("pdu-type")
1369 pdu_filter
= self
._get
_project
_filter
(session
)
1370 pdu_filter
["vim_accounts"] = vim_account
1371 pdu_filter
["type"] = pdu_type
1372 pdu_filter
["_admin.operationalState"] = "ENABLED"
1373 pdu_filter
["_admin.usageState"] = "NOT_IN_USE"
1374 # TODO feature 1417: "shared": True,
1376 available_pdus
= self
.db
.get_list("pdus", pdu_filter
)
1377 for pdu
in available_pdus
:
1378 # step 1 check if this pdu contains needed interfaces:
1379 match_interfaces
= True
1380 for vdur_interface
in vdur
["interfaces"]:
1381 for pdu_interface
in pdu
["interfaces"]:
1382 if pdu_interface
["name"] == vdur_interface
["name"]:
1383 # TODO feature 1417: match per mgmt type
1385 else: # no interface found for name
1386 match_interfaces
= False
1388 if match_interfaces
:
1391 raise EngineException(
1392 "No PDU of type={} at vim_account={} found for member_vnf_index={}, vdu={} matching interface "
1396 vnfr
["member-vnf-index-ref"],
1401 # step 2. Update pdu
1403 "_admin.usageState": pdu
["_admin"]["usageState"],
1404 "_admin.usage.vnfr_id": None,
1405 "_admin.usage.nsr_id": None,
1406 "_admin.usage.vdur": None,
1410 {"_id": pdu
["_id"]},
1412 "_admin.usageState": "IN_USE",
1414 "vnfr_id": vnfr
["_id"],
1415 "nsr_id": vnfr
["nsr-id-ref"],
1416 "vdur": vdur
["vdu-id-ref"],
1425 "content": rollback_pdu
,
1429 # step 3. Fill vnfr info by filling vdur
1430 vdu_text
= "vdur.{}".format(vdur_index
)
1431 vnfr_update_rollback
[vdu_text
+ ".pdu-id"] = None
1432 vnfr_update
[vdu_text
+ ".pdu-id"] = pdu
["_id"]
1433 for iface_index
, vdur_interface
in enumerate(vdur
["interfaces"]):
1434 for pdu_interface
in pdu
["interfaces"]:
1435 if pdu_interface
["name"] == vdur_interface
["name"]:
1436 iface_text
= vdu_text
+ ".interfaces.{}".format(iface_index
)
1437 for k
, v
in pdu_interface
.items():
1441 ): # TODO: switch-xxxxx must be inserted
1442 vnfr_update
[iface_text
+ ".{}".format(k
)] = v
1443 vnfr_update_rollback
[
1444 iface_text
+ ".{}".format(k
)
1445 ] = vdur_interface
.get(v
)
1446 if pdu_interface
.get("ip-address"):
1447 if vdur_interface
.get(
1449 ) or vdur_interface
.get("mgmt-vnf"):
1450 vnfr_update_rollback
[
1451 vdu_text
+ ".ip-address"
1452 ] = vdur
.get("ip-address")
1453 vnfr_update
[vdu_text
+ ".ip-address"] = pdu_interface
[
1456 if vdur_interface
.get("mgmt-vnf"):
1457 vnfr_update_rollback
["ip-address"] = vnfr
.get(
1460 vnfr_update
["ip-address"] = pdu_interface
["ip-address"]
1461 vnfr_update
[vdu_text
+ ".ip-address"] = pdu_interface
[
1464 if pdu_interface
.get("vim-network-name") or pdu_interface
.get(
1467 ifaces_forcing_vim_network
.append(
1469 "name": vdur_interface
.get("vnf-vld-id")
1470 or vdur_interface
.get("ns-vld-id"),
1471 "vnf-vld-id": vdur_interface
.get("vnf-vld-id"),
1472 "ns-vld-id": vdur_interface
.get("ns-vld-id"),
1475 if pdu_interface
.get("vim-network-id"):
1476 ifaces_forcing_vim_network
[-1][
1478 ] = pdu_interface
["vim-network-id"]
1479 if pdu_interface
.get("vim-network-name"):
1480 ifaces_forcing_vim_network
[-1][
1482 ] = pdu_interface
["vim-network-name"]
1485 return ifaces_forcing_vim_network
1487 def _look_for_k8scluster(
1488 self
, session
, rollback
, vnfr
, vim_account
, vnfr_update
, vnfr_update_rollback
1491 Look for an available k8scluster for all the kuds in the vnfd matching version and cni requirements.
1492 Fills vnfr.kdur with the selected k8scluster
1494 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1495 :param rollback: list with the database modifications to rollback if needed
1496 :param vnfr: vnfr to be updated. It is modified with pdu interface info if pdu is found
1497 :param vim_account: vim_account where this vnfr should be deployed
1498 :param vnfr_update: dictionary filled by this method with changes to be done at database vnfr
1499 :param vnfr_update_rollback: dictionary filled by this method with original content of vnfr in case a rollback
1500 of the changed vnfr is needed
1502 :return: List of KDU interfaces that are connected to an existing VIM network. Each item contains:
1503 "vim-network-name": used at VIM
1504 "name": interface name
1505 "vnf-vld-id": internal VNFD vld where this interface is connected, or
1506 "ns-vld-id": NSD vld where this interface is connected.
1507 NOTE: One, and only one between 'vnf-vld-id' and 'ns-vld-id' contains a value. The other will be None
1510 ifaces_forcing_vim_network
= []
1511 if not vnfr
.get("kdur"):
1512 return ifaces_forcing_vim_network
1514 kdu_filter
= self
._get
_project
_filter
(session
)
1515 kdu_filter
["vim_account"] = vim_account
1516 # TODO kdu_filter["_admin.operationalState"] = "ENABLED"
1517 available_k8sclusters
= self
.db
.get_list("k8sclusters", kdu_filter
)
1519 k8s_requirements
= {} # just for logging
1520 for k8scluster
in available_k8sclusters
:
1521 if not vnfr
.get("k8s-cluster"):
1524 if vnfr
["k8s-cluster"].get("cni"):
1525 k8s_requirements
["cni"] = vnfr
["k8s-cluster"]["cni"]
1526 if not set(vnfr
["k8s-cluster"]["cni"]).intersection(
1527 k8scluster
.get("cni", ())
1530 # restrict by version
1531 if vnfr
["k8s-cluster"].get("version"):
1532 k8s_requirements
["version"] = vnfr
["k8s-cluster"]["version"]
1533 if k8scluster
.get("k8s_version") not in vnfr
["k8s-cluster"]["version"]:
1535 # restrict by number of networks
1536 if vnfr
["k8s-cluster"].get("nets"):
1537 k8s_requirements
["networks"] = len(vnfr
["k8s-cluster"]["nets"])
1538 if not k8scluster
.get("nets") or len(k8scluster
["nets"]) < len(
1539 vnfr
["k8s-cluster"]["nets"]
1544 raise EngineException(
1545 "No k8scluster with requirements='{}' at vim_account={} found for member_vnf_index={}".format(
1546 k8s_requirements
, vim_account
, vnfr
["member-vnf-index-ref"]
1550 for kdur_index
, kdur
in enumerate(get_iterable(vnfr
.get("kdur"))):
1551 # step 3. Fill vnfr info by filling kdur
1552 kdu_text
= "kdur.{}.".format(kdur_index
)
1553 vnfr_update_rollback
[kdu_text
+ "k8s-cluster.id"] = None
1554 vnfr_update
[kdu_text
+ "k8s-cluster.id"] = k8scluster
["_id"]
1556 # step 4. Check VIM networks that forces the selected k8s_cluster
1557 if vnfr
.get("k8s-cluster") and vnfr
["k8s-cluster"].get("nets"):
1558 k8scluster_net_list
= list(k8scluster
.get("nets").keys())
1559 for net_index
, kdur_net
in enumerate(vnfr
["k8s-cluster"]["nets"]):
1560 # get a network from k8s_cluster nets. If name matches use this, if not use other
1561 if kdur_net
["id"] in k8scluster_net_list
: # name matches
1562 vim_net
= k8scluster
["nets"][kdur_net
["id"]]
1563 k8scluster_net_list
.remove(kdur_net
["id"])
1565 vim_net
= k8scluster
["nets"][k8scluster_net_list
[0]]
1566 k8scluster_net_list
.pop(0)
1567 vnfr_update_rollback
[
1568 "k8s-cluster.nets.{}.vim_net".format(net_index
)
1570 vnfr_update
["k8s-cluster.nets.{}.vim_net".format(net_index
)] = vim_net
1572 kdur_net
.get("vnf-vld-id") or kdur_net
.get("ns-vld-id")
1574 ifaces_forcing_vim_network
.append(
1576 "name": kdur_net
.get("vnf-vld-id")
1577 or kdur_net
.get("ns-vld-id"),
1578 "vnf-vld-id": kdur_net
.get("vnf-vld-id"),
1579 "ns-vld-id": kdur_net
.get("ns-vld-id"),
1580 "vim-network-name": vim_net
, # TODO can it be vim-network-id ???
1583 # TODO check that this forcing is not incompatible with other forcing
1584 return ifaces_forcing_vim_network
1586 def _update_vnfrs(self
, session
, rollback
, nsr
, indata
):
1589 vnfrs
= self
.db
.get_list("vnfrs", {"nsr-id-ref": nsr_id
})
1593 vnfr_update_rollback
= {}
1594 member_vnf_index
= vnfr
["member-vnf-index-ref"]
1595 # update vim-account-id
1597 vim_account
= indata
["vimAccountId"]
1598 vca_id
= indata
.get("vcaId")
1599 # check instantiate parameters
1600 for vnf_inst_params
in get_iterable(indata
.get("vnf")):
1601 if vnf_inst_params
["member-vnf-index"] != member_vnf_index
:
1603 if vnf_inst_params
.get("vimAccountId"):
1604 vim_account
= vnf_inst_params
.get("vimAccountId")
1605 if vnf_inst_params
.get("vcaId"):
1606 vca_id
= vnf_inst_params
.get("vcaId")
1608 # get vnf.vdu.interface instantiation params to update vnfr.vdur.interfaces ip, mac
1609 for vdu_inst_param
in get_iterable(vnf_inst_params
.get("vdu")):
1610 for vdur_index
, vdur
in enumerate(vnfr
["vdur"]):
1611 if vdu_inst_param
["id"] != vdur
["vdu-id-ref"]:
1613 for iface_inst_param
in get_iterable(
1614 vdu_inst_param
.get("interface")
1616 iface_index
, _
= next(
1618 for i
in enumerate(vdur
["interfaces"])
1619 if i
[1]["name"] == iface_inst_param
["name"]
1621 vnfr_update_text
= "vdur.{}.interfaces.{}".format(
1622 vdur_index
, iface_index
1624 if iface_inst_param
.get("ip-address"):
1626 vnfr_update_text
+ ".ip-address"
1627 ] = increment_ip_mac(
1628 iface_inst_param
.get("ip-address"),
1629 vdur
.get("count-index", 0),
1631 vnfr_update
[vnfr_update_text
+ ".fixed-ip"] = True
1632 if iface_inst_param
.get("mac-address"):
1634 vnfr_update_text
+ ".mac-address"
1635 ] = increment_ip_mac(
1636 iface_inst_param
.get("mac-address"),
1637 vdur
.get("count-index", 0),
1639 vnfr_update
[vnfr_update_text
+ ".fixed-mac"] = True
1640 if iface_inst_param
.get("floating-ip-required"):
1642 vnfr_update_text
+ ".floating-ip-required"
1644 # get vnf.internal-vld.internal-conection-point instantiation params to update vnfr.vdur.interfaces
1645 # TODO update vld with the ip-profile
1646 for ivld_inst_param
in get_iterable(
1647 vnf_inst_params
.get("internal-vld")
1649 for icp_inst_param
in get_iterable(
1650 ivld_inst_param
.get("internal-connection-point")
1653 for vdur_index
, vdur
in enumerate(vnfr
["vdur"]):
1654 for iface_index
, iface
in enumerate(vdur
["interfaces"]):
1656 iface
.get("internal-connection-point-ref")
1657 == icp_inst_param
["id-ref"]
1659 vnfr_update_text
= "vdur.{}.interfaces.{}".format(
1660 vdur_index
, iface_index
1662 if icp_inst_param
.get("ip-address"):
1664 vnfr_update_text
+ ".ip-address"
1665 ] = increment_ip_mac(
1666 icp_inst_param
.get("ip-address"),
1667 vdur
.get("count-index", 0),
1670 vnfr_update_text
+ ".fixed-ip"
1672 if icp_inst_param
.get("mac-address"):
1674 vnfr_update_text
+ ".mac-address"
1675 ] = increment_ip_mac(
1676 icp_inst_param
.get("mac-address"),
1677 vdur
.get("count-index", 0),
1680 vnfr_update_text
+ ".fixed-mac"
1683 # get ip address from instantiation parameters.vld.vnfd-connection-point-ref
1684 for vld_inst_param
in get_iterable(indata
.get("vld")):
1685 for vnfcp_inst_param
in get_iterable(
1686 vld_inst_param
.get("vnfd-connection-point-ref")
1688 if vnfcp_inst_param
["member-vnf-index-ref"] != member_vnf_index
:
1691 for vdur_index
, vdur
in enumerate(vnfr
["vdur"]):
1692 for iface_index
, iface
in enumerate(vdur
["interfaces"]):
1694 iface
.get("external-connection-point-ref")
1695 == vnfcp_inst_param
["vnfd-connection-point-ref"]
1697 vnfr_update_text
= "vdur.{}.interfaces.{}".format(
1698 vdur_index
, iface_index
1700 if vnfcp_inst_param
.get("ip-address"):
1702 vnfr_update_text
+ ".ip-address"
1703 ] = increment_ip_mac(
1704 vnfcp_inst_param
.get("ip-address"),
1705 vdur
.get("count-index", 0),
1707 vnfr_update
[vnfr_update_text
+ ".fixed-ip"] = True
1708 if vnfcp_inst_param
.get("mac-address"):
1710 vnfr_update_text
+ ".mac-address"
1711 ] = increment_ip_mac(
1712 vnfcp_inst_param
.get("mac-address"),
1713 vdur
.get("count-index", 0),
1715 vnfr_update
[vnfr_update_text
+ ".fixed-mac"] = True
1718 vnfr_update
["vim-account-id"] = vim_account
1719 vnfr_update_rollback
["vim-account-id"] = vnfr
.get("vim-account-id")
1722 vnfr_update
["vca-id"] = vca_id
1723 vnfr_update_rollback
["vca-id"] = vnfr
.get("vca-id")
1726 ifaces_forcing_vim_network
= self
._look
_for
_pdu
(
1727 session
, rollback
, vnfr
, vim_account
, vnfr_update
, vnfr_update_rollback
1731 ifaces_forcing_vim_network
+= self
._look
_for
_k
8scluster
(
1732 session
, rollback
, vnfr
, vim_account
, vnfr_update
, vnfr_update_rollback
1734 # update database vnfr
1735 self
.db
.set_one("vnfrs", {"_id": vnfr
["_id"]}, vnfr_update
)
1741 "content": vnfr_update_rollback
,
1745 # Update indada in case pdu forces to use a concrete vim-network-name
1746 # TODO check if user has already insert a vim-network-name and raises an error
1747 if not ifaces_forcing_vim_network
:
1749 for iface_info
in ifaces_forcing_vim_network
:
1750 if iface_info
.get("ns-vld-id"):
1751 if "vld" not in indata
:
1753 indata
["vld"].append(
1755 key
: iface_info
[key
]
1756 for key
in ("name", "vim-network-name", "vim-network-id")
1757 if iface_info
.get(key
)
1761 elif iface_info
.get("vnf-vld-id"):
1762 if "vnf" not in indata
:
1764 indata
["vnf"].append(
1766 "member-vnf-index": member_vnf_index
,
1769 key
: iface_info
[key
]
1775 if iface_info
.get(key
)
1782 def _create_nslcmop(nsr_id
, operation
, params
):
1784 Creates a ns-lcm-opp content to be stored at database.
1785 :param nsr_id: internal id of the instance
1786 :param operation: instantiate, terminate, scale, action, ...
1787 :param params: user parameters for the operation
1788 :return: dictionary following SOL005 format
1795 "operationState": "PROCESSING", # COMPLETED,PARTIALLY_COMPLETED,FAILED_TEMP,FAILED,ROLLING_BACK,ROLLED_BACK
1796 "queuePosition": None,
1798 "errorMessage": None,
1799 "detailedStatus": None,
1800 "statusEnteredTime": now
,
1801 "nsInstanceId": nsr_id
,
1802 "lcmOperationType": operation
,
1804 "isAutomaticInvocation": False,
1805 "operationParams": params
,
1806 "isCancelPending": False,
1808 "self": "/osm/nslcm/v1/ns_lcm_op_occs/" + _id
,
1809 "nsInstance": "/osm/nslcm/v1/ns_instances/" + nsr_id
,
1814 def _get_enabled_vims(self
, session
):
1816 Retrieve and return VIM accounts that are accessible by current user and has state ENABLE
1817 :param session: current session with user information
1819 db_filter
= self
._get
_project
_filter
(session
)
1820 db_filter
["_admin.operationalState"] = "ENABLED"
1821 vims
= self
.db
.get_list("vim_accounts", db_filter
)
1824 vimAccounts
.append(vim
["_id"])
1837 Performs a new operation over a ns
1838 :param rollback: list to append created items at database in case a rollback must to be done
1839 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1840 :param indata: descriptor with the parameters of the operation. It must contains among others
1841 nsInstanceId: _id of the nsr to perform the operation
1842 operation: it can be: instantiate, terminate, action, TODO: update, heal
1843 :param kwargs: used to override the indata descriptor
1844 :param headers: http request headers
1845 :return: id of the nslcmops
1848 def check_if_nsr_is_not_slice_member(session
, nsr_id
):
1850 db_filter
= self
._get
_project
_filter
(session
)
1851 db_filter
["_admin.nsrs-detailed-list.ANYINDEX.nsrId"] = nsr_id
1852 nsis
= self
.db
.get_one(
1853 "nsis", db_filter
, fail_on_empty
=False, fail_on_more
=False
1856 raise EngineException(
1857 "The NS instance {} cannot be terminated because is used by the slice {}".format(
1860 http_code
=HTTPStatus
.CONFLICT
,
1864 # Override descriptor with query string kwargs
1865 self
._update
_input
_with
_kwargs
(indata
, kwargs
, yaml_format
=True)
1866 operation
= indata
["lcmOperationType"]
1867 nsInstanceId
= indata
["nsInstanceId"]
1869 validate_input(indata
, self
.operation_schema
[operation
])
1870 # get ns from nsr_id
1871 _filter
= BaseTopic
._get
_project
_filter
(session
)
1872 _filter
["_id"] = nsInstanceId
1873 nsr
= self
.db
.get_one("nsrs", _filter
)
1876 if operation
== "terminate" and slice_object
is False:
1877 check_if_nsr_is_not_slice_member(session
, nsr
["_id"])
1879 not nsr
["_admin"].get("nsState")
1880 or nsr
["_admin"]["nsState"] == "NOT_INSTANTIATED"
1882 if operation
== "terminate" and indata
.get("autoremove"):
1883 # NSR must be deleted
1887 ) # a none in this case is used to indicate not instantiated. It can be removed
1888 if operation
!= "instantiate":
1889 raise EngineException(
1890 "ns_instance '{}' cannot be '{}' because it is not instantiated".format(
1891 nsInstanceId
, operation
1893 HTTPStatus
.CONFLICT
,
1896 if operation
== "instantiate" and not session
["force"]:
1897 raise EngineException(
1898 "ns_instance '{}' cannot be '{}' because it is already instantiated".format(
1899 nsInstanceId
, operation
1901 HTTPStatus
.CONFLICT
,
1903 self
._check
_ns
_operation
(session
, nsr
, operation
, indata
)
1905 if operation
== "instantiate":
1906 self
._update
_vnfrs
(session
, rollback
, nsr
, indata
)
1908 nslcmop_desc
= self
._create
_nslcmop
(nsInstanceId
, operation
, indata
)
1909 _id
= nslcmop_desc
["_id"]
1911 nslcmop_desc
, session
["project_id"], make_public
=session
["public"]
1913 if indata
.get("placement-engine"):
1914 # Save valid vim accounts in lcm operation descriptor
1915 nslcmop_desc
["operationParams"][
1917 ] = self
._get
_enabled
_vims
(session
)
1918 self
.db
.create("nslcmops", nslcmop_desc
)
1919 rollback
.append({"topic": "nslcmops", "_id": _id
})
1920 if not slice_object
:
1921 self
.msg
.write("ns", operation
, nslcmop_desc
)
1923 except ValidationError
as e
: # TODO remove try Except, it is captured at nbi.py
1924 raise EngineException(e
, HTTPStatus
.UNPROCESSABLE_ENTITY
)
1925 # except DbException as e:
1926 # raise EngineException("Cannot get ns_instance '{}': {}".format(e), HTTPStatus.NOT_FOUND)
1928 def delete(self
, session
, _id
, dry_run
=False, not_send_msg
=None):
1929 raise EngineException(
1930 "Method delete called directly", HTTPStatus
.INTERNAL_SERVER_ERROR
1933 def edit(self
, session
, _id
, indata
=None, kwargs
=None, content
=None):
1934 raise EngineException(
1935 "Method edit called directly", HTTPStatus
.INTERNAL_SERVER_ERROR
1939 class NsiTopic(BaseTopic
):
1942 quota_name
= "slice_instances"
1944 def __init__(self
, db
, fs
, msg
, auth
):
1945 BaseTopic
.__init
__(self
, db
, fs
, msg
, auth
)
1946 self
.nsrTopic
= NsrTopic(db
, fs
, msg
, auth
)
1949 def _format_ns_request(ns_request
):
1950 formated_request
= copy(ns_request
)
1951 # TODO: Add request params
1952 return formated_request
1955 def _format_addional_params(slice_request
):
1957 Get and format user additional params for NS or VNF
1958 :param slice_request: User instantiation additional parameters
1959 :return: a formatted copy of additional params or None if not supplied
1961 additional_params
= copy(slice_request
.get("additionalParamsForNsi"))
1962 if additional_params
:
1963 for k
, v
in additional_params
.items():
1964 if not isinstance(k
, str):
1965 raise EngineException(
1966 "Invalid param at additionalParamsForNsi:{}. Only string keys are allowed".format(
1970 if "." in k
or "$" in k
:
1971 raise EngineException(
1972 "Invalid param at additionalParamsForNsi:{}. Keys must not contain dots or $".format(
1976 if isinstance(v
, (dict, tuple, list)):
1977 additional_params
[k
] = "!!yaml " + safe_dump(v
)
1978 return additional_params
1980 def _check_descriptor_dependencies(self
, session
, descriptor
):
1982 Check that the dependent descriptors exist on a new descriptor or edition
1983 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1984 :param descriptor: descriptor to be inserted or edit
1985 :return: None or raises exception
1987 if not descriptor
.get("nst-ref"):
1989 nstd_id
= descriptor
["nst-ref"]
1990 if not self
.get_item_list(session
, "nsts", {"id": nstd_id
}):
1991 raise EngineException(
1992 "Descriptor error at nst-ref='{}' references a non exist nstd".format(
1995 http_code
=HTTPStatus
.CONFLICT
,
1998 def check_conflict_on_del(self
, session
, _id
, db_content
):
2000 Check that NSI is not instantiated
2001 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
2002 :param _id: nsi internal id
2003 :param db_content: The database content of the _id
2004 :return: None or raises EngineException with the conflict
2006 if session
["force"]:
2009 if nsi
["_admin"].get("nsiState") == "INSTANTIATED":
2010 raise EngineException(
2011 "nsi '{}' cannot be deleted because it is in 'INSTANTIATED' state. "
2012 "Launch 'terminate' operation first; or force deletion".format(_id
),
2013 http_code
=HTTPStatus
.CONFLICT
,
2016 def delete_extra(self
, session
, _id
, db_content
, not_send_msg
=None):
2018 Deletes associated nsilcmops from database. Deletes associated filesystem.
2019 Set usageState of nst
2020 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
2021 :param _id: server internal id
2022 :param db_content: The database content of the descriptor
2023 :param not_send_msg: To not send message (False) or store content (list) instead
2024 :return: None if ok or raises EngineException with the problem
2027 # Deleting the nsrs belonging to nsir
2029 for nsrs_detailed_item
in nsir
["_admin"]["nsrs-detailed-list"]:
2030 nsr_id
= nsrs_detailed_item
["nsrId"]
2031 if nsrs_detailed_item
.get("shared"):
2033 "_admin.nsrs-detailed-list.ANYINDEX.shared": True,
2034 "_admin.nsrs-detailed-list.ANYINDEX.nsrId": nsr_id
,
2035 "_id.ne": nsir
["_id"],
2037 nsi
= self
.db
.get_one(
2038 "nsis", _filter
, fail_on_empty
=False, fail_on_more
=False
2040 if nsi
: # last one using nsr
2043 self
.nsrTopic
.delete(
2044 session
, nsr_id
, dry_run
=False, not_send_msg
=not_send_msg
2046 except (DbException
, EngineException
) as e
:
2047 if e
.http_code
== HTTPStatus
.NOT_FOUND
:
2052 # delete related nsilcmops database entries
2053 self
.db
.del_list("nsilcmops", {"netsliceInstanceId": _id
})
2055 # Check and set used NST usage state
2056 nsir_admin
= nsir
.get("_admin")
2057 if nsir_admin
and nsir_admin
.get("nst-id"):
2058 # check if used by another NSI
2059 nsis_list
= self
.db
.get_one(
2061 {"nst-id": nsir_admin
["nst-id"]},
2062 fail_on_empty
=False,
2068 {"_id": nsir_admin
["nst-id"]},
2069 {"_admin.usageState": "NOT_IN_USE"},
2072 def new(self
, rollback
, session
, indata
=None, kwargs
=None, headers
=None):
2074 Creates a new netslice instance record into database. It also creates needed nsrs and vnfrs
2075 :param rollback: list to append the created items at database in case a rollback must be done
2076 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
2077 :param indata: params to be used for the nsir
2078 :param kwargs: used to override the indata descriptor
2079 :param headers: http request headers
2080 :return: the _id of nsi descriptor created at database
2084 step
= "checking quotas"
2085 self
.check_quota(session
)
2088 slice_request
= self
._remove
_envelop
(indata
)
2089 # Override descriptor with query string kwargs
2090 self
._update
_input
_with
_kwargs
(slice_request
, kwargs
)
2091 slice_request
= self
._validate
_input
_new
(slice_request
, session
["force"])
2094 step
= "getting nstd id='{}' from database".format(
2095 slice_request
.get("nstId")
2097 _filter
= self
._get
_project
_filter
(session
)
2098 _filter
["_id"] = slice_request
["nstId"]
2099 nstd
= self
.db
.get_one("nsts", _filter
)
2100 # check NST is not disabled
2101 step
= "checking NST operationalState"
2102 if nstd
["_admin"]["operationalState"] == "DISABLED":
2103 raise EngineException(
2104 "nst with id '{}' is DISABLED, and thus cannot be used to create a netslice "
2105 "instance".format(slice_request
["nstId"]),
2106 http_code
=HTTPStatus
.CONFLICT
,
2110 # check NSD is not disabled
2111 step
= "checking operationalState"
2112 if nstd
["_admin"]["operationalState"] == "DISABLED":
2113 raise EngineException(
2114 "nst with id '{}' is DISABLED, and thus cannot be used to create "
2115 "a network slice".format(slice_request
["nstId"]),
2116 http_code
=HTTPStatus
.CONFLICT
,
2119 nstd
.pop("_admin", None)
2120 nstd_id
= nstd
.pop("_id", None)
2121 nsi_id
= str(uuid4())
2122 step
= "filling nsi_descriptor with input data"
2127 "name": slice_request
["nsiName"],
2128 "description": slice_request
.get("nsiDescription", ""),
2129 "datacenter": slice_request
["vimAccountId"],
2130 "nst-ref": nstd
["id"],
2131 "instantiation_parameters": slice_request
,
2132 "network-slice-template": nstd
,
2136 "additionalParamsForNsi": self
._format
_addional
_params
(slice_request
),
2139 step
= "creating nsi at database"
2141 nsi_descriptor
, session
["project_id"], make_public
=session
["public"]
2143 nsi_descriptor
["_admin"]["nsiState"] = "NOT_INSTANTIATED"
2144 nsi_descriptor
["_admin"]["netslice-subnet"] = None
2145 nsi_descriptor
["_admin"]["deployed"] = {}
2146 nsi_descriptor
["_admin"]["deployed"]["RO"] = []
2147 nsi_descriptor
["_admin"]["nst-id"] = nstd_id
2149 # Creating netslice-vld for the RO.
2150 step
= "creating netslice-vld at database"
2152 # Building the vlds list to be deployed
2153 # From netslice descriptors, creating the initial list
2156 for netslice_vlds
in get_iterable(nstd
.get("netslice-vld")):
2157 # Getting template Instantiation parameters from NST
2158 nsi_vld
= deepcopy(netslice_vlds
)
2159 nsi_vld
["shared-nsrs-list"] = []
2160 nsi_vld
["vimAccountId"] = slice_request
["vimAccountId"]
2161 nsi_vlds
.append(nsi_vld
)
2163 nsi_descriptor
["_admin"]["netslice-vld"] = nsi_vlds
2164 # Creating netslice-subnet_record.
2168 # Updating the nstd with the nsd["_id"] associated to the nss -> services list
2169 for member_ns
in nstd
["netslice-subnet"]:
2170 nsd_id
= member_ns
["nsd-ref"]
2171 step
= "getting nstd id='{}' constituent-nsd='{}' from database".format(
2172 member_ns
["nsd-ref"], member_ns
["id"]
2174 if nsd_id
not in needed_nsds
:
2176 _filter
["id"] = nsd_id
2177 nsd
= self
.db
.get_one(
2178 "nsds", _filter
, fail_on_empty
=True, fail_on_more
=True
2182 needed_nsds
[nsd_id
] = nsd
2184 nsd
= needed_nsds
[nsd_id
]
2185 member_ns
["_id"] = needed_nsds
[nsd_id
].get("_id")
2186 services
.append(member_ns
)
2188 step
= "filling nsir nsd-id='{}' constituent-nsd='{}' from database".format(
2189 member_ns
["nsd-ref"], member_ns
["id"]
2192 # creates Network Services records (NSRs)
2193 step
= "creating nsrs at database using NsrTopic.new()"
2194 ns_params
= slice_request
.get("netslice-subnet")
2196 nsi_netslice_subnet
= []
2197 for service
in services
:
2198 # Check if the netslice-subnet is shared and if it is share if the nss exists
2201 # Is the nss shared and instantiated?
2202 _filter
["_admin.nsrs-detailed-list.ANYINDEX.shared"] = True
2203 _filter
["_admin.nsrs-detailed-list.ANYINDEX.nsd-id"] = service
[
2206 _filter
["_admin.nsrs-detailed-list.ANYINDEX.nss-id"] = service
["id"]
2207 nsi
= self
.db
.get_one(
2208 "nsis", _filter
, fail_on_empty
=False, fail_on_more
=False
2210 if nsi
and service
.get("is-shared-nss"):
2211 nsrs_detailed_list
= nsi
["_admin"]["nsrs-detailed-list"]
2212 for nsrs_detailed_item
in nsrs_detailed_list
:
2213 if nsrs_detailed_item
["nsd-id"] == service
["nsd-ref"]:
2214 if nsrs_detailed_item
["nss-id"] == service
["id"]:
2215 _id_nsr
= nsrs_detailed_item
["nsrId"]
2217 for netslice_subnet
in nsi
["_admin"]["netslice-subnet"]:
2218 if netslice_subnet
["nss-id"] == service
["id"]:
2219 indata_ns
= netslice_subnet
2223 if service
.get("instantiation-parameters"):
2224 indata_ns
= deepcopy(service
["instantiation-parameters"])
2225 # del service["instantiation-parameters"]
2227 indata_ns
["nsdId"] = service
["_id"]
2228 indata_ns
["nsName"] = (
2229 slice_request
.get("nsiName") + "." + service
["id"]
2231 indata_ns
["vimAccountId"] = slice_request
.get("vimAccountId")
2232 indata_ns
["nsDescription"] = service
["description"]
2233 if slice_request
.get("ssh_keys"):
2234 indata_ns
["ssh_keys"] = slice_request
.get("ssh_keys")
2237 for ns_param
in ns_params
:
2238 if ns_param
.get("id") == service
["id"]:
2239 copy_ns_param
= deepcopy(ns_param
)
2240 del copy_ns_param
["id"]
2241 indata_ns
.update(copy_ns_param
)
2244 # Creates Nsr objects
2245 _id_nsr
, _
= self
.nsrTopic
.new(
2246 rollback
, session
, indata_ns
, kwargs
, headers
2250 "shared": service
.get("is-shared-nss"),
2251 "nsd-id": service
["nsd-ref"],
2252 "nss-id": service
["id"],
2253 "nslcmop_instantiate": None,
2255 indata_ns
["nss-id"] = service
["id"]
2256 nsrs_list
.append(nsrs_item
)
2257 nsi_netslice_subnet
.append(indata_ns
)
2258 nsr_ref
= {"nsr-ref": _id_nsr
}
2259 nsi_descriptor
["nsr-ref-list"].append(nsr_ref
)
2261 # Adding the nsrs list to the nsi
2262 nsi_descriptor
["_admin"]["nsrs-detailed-list"] = nsrs_list
2263 nsi_descriptor
["_admin"]["netslice-subnet"] = nsi_netslice_subnet
2265 "nsts", {"_id": slice_request
["nstId"]}, {"_admin.usageState": "IN_USE"}
2268 # Creating the entry in the database
2269 self
.db
.create("nsis", nsi_descriptor
)
2270 rollback
.append({"topic": "nsis", "_id": nsi_id
})
2272 except Exception as e
: # TODO remove try Except, it is captured at nbi.py
2273 self
.logger
.exception(
2274 "Exception {} at NsiTopic.new()".format(e
), exc_info
=True
2276 raise EngineException("Error {}: {}".format(step
, e
))
2277 except ValidationError
as e
:
2278 raise EngineException(e
, HTTPStatus
.UNPROCESSABLE_ENTITY
)
2280 def edit(self
, session
, _id
, indata
=None, kwargs
=None, content
=None):
2281 raise EngineException(
2282 "Method edit called directly", HTTPStatus
.INTERNAL_SERVER_ERROR
2286 class NsiLcmOpTopic(BaseTopic
):
2289 operation_schema
= { # mapping between operation and jsonschema to validate
2290 "instantiate": nsi_instantiate
,
2294 def __init__(self
, db
, fs
, msg
, auth
):
2295 BaseTopic
.__init
__(self
, db
, fs
, msg
, auth
)
2296 self
.nsi_NsLcmOpTopic
= NsLcmOpTopic(self
.db
, self
.fs
, self
.msg
, self
.auth
)
2298 def _check_nsi_operation(self
, session
, nsir
, operation
, indata
):
2300 Check that user has enter right parameters for the operation
2301 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
2302 :param operation: it can be: instantiate, terminate, action, TODO: update, heal
2303 :param indata: descriptor with the parameters of the operation
2307 nstd
= nsir
["network-slice-template"]
2309 def check_valid_netslice_subnet_id(nstId
):
2310 # TODO change to vnfR (??)
2311 for netslice_subnet
in nstd
["netslice-subnet"]:
2312 if nstId
== netslice_subnet
["id"]:
2313 nsd_id
= netslice_subnet
["nsd-ref"]
2314 if nsd_id
not in nsds
:
2315 _filter
= self
._get
_project
_filter
(session
)
2316 _filter
["id"] = nsd_id
2317 nsds
[nsd_id
] = self
.db
.get_one("nsds", _filter
)
2320 raise EngineException(
2321 "Invalid parameter nstId='{}' is not one of the "
2322 "nst:netslice-subnet".format(nstId
)
2325 if operation
== "instantiate":
2326 # check the existance of netslice-subnet items
2327 for in_nst
in get_iterable(indata
.get("netslice-subnet")):
2328 check_valid_netslice_subnet_id(in_nst
["id"])
2330 def _create_nsilcmop(self
, session
, netsliceInstanceId
, operation
, params
):
2336 "operationState": "PROCESSING", # COMPLETED,PARTIALLY_COMPLETED,FAILED_TEMP,FAILED,ROLLING_BACK,ROLLED_BACK
2337 "statusEnteredTime": now
,
2338 "netsliceInstanceId": netsliceInstanceId
,
2339 "lcmOperationType": operation
,
2341 "isAutomaticInvocation": False,
2342 "operationParams": params
,
2343 "isCancelPending": False,
2345 "self": "/osm/nsilcm/v1/nsi_lcm_op_occs/" + _id
,
2346 "netsliceInstanceId": "/osm/nsilcm/v1/netslice_instances/"
2347 + netsliceInstanceId
,
2352 def add_shared_nsr_2vld(self
, nsir
, nsr_item
):
2353 for nst_sb_item
in nsir
["network-slice-template"].get("netslice-subnet"):
2354 if nst_sb_item
.get("is-shared-nss"):
2355 for admin_subnet_item
in nsir
["_admin"].get("netslice-subnet"):
2356 if admin_subnet_item
["nss-id"] == nst_sb_item
["id"]:
2357 for admin_vld_item
in nsir
["_admin"].get("netslice-vld"):
2358 for admin_vld_nss_cp_ref_item
in admin_vld_item
[
2359 "nss-connection-point-ref"
2362 admin_subnet_item
["nss-id"]
2363 == admin_vld_nss_cp_ref_item
["nss-ref"]
2366 not nsr_item
["nsrId"]
2367 in admin_vld_item
["shared-nsrs-list"]
2369 admin_vld_item
["shared-nsrs-list"].append(
2373 # self.db.set_one("nsis", {"_id": nsir["_id"]}, nsir)
2376 {"_id": nsir
["_id"]},
2377 {"_admin.netslice-vld": nsir
["_admin"].get("netslice-vld")},
2380 def new(self
, rollback
, session
, indata
=None, kwargs
=None, headers
=None):
2382 Performs a new operation over a ns
2383 :param rollback: list to append created items at database in case a rollback must to be done
2384 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
2385 :param indata: descriptor with the parameters of the operation. It must contains among others
2386 netsliceInstanceId: _id of the nsir to perform the operation
2387 operation: it can be: instantiate, terminate, action, TODO: update, heal
2388 :param kwargs: used to override the indata descriptor
2389 :param headers: http request headers
2390 :return: id of the nslcmops
2393 # Override descriptor with query string kwargs
2394 self
._update
_input
_with
_kwargs
(indata
, kwargs
)
2395 operation
= indata
["lcmOperationType"]
2396 netsliceInstanceId
= indata
["netsliceInstanceId"]
2397 validate_input(indata
, self
.operation_schema
[operation
])
2399 # get nsi from netsliceInstanceId
2400 _filter
= self
._get
_project
_filter
(session
)
2401 _filter
["_id"] = netsliceInstanceId
2402 nsir
= self
.db
.get_one("nsis", _filter
)
2403 logging_prefix
= "nsi={} {} ".format(netsliceInstanceId
, operation
)
2408 not nsir
["_admin"].get("nsiState")
2409 or nsir
["_admin"]["nsiState"] == "NOT_INSTANTIATED"
2411 if operation
== "terminate" and indata
.get("autoremove"):
2412 # NSIR must be deleted
2416 ) # a none in this case is used to indicate not instantiated. It can be removed
2417 if operation
!= "instantiate":
2418 raise EngineException(
2419 "netslice_instance '{}' cannot be '{}' because it is not instantiated".format(
2420 netsliceInstanceId
, operation
2422 HTTPStatus
.CONFLICT
,
2425 if operation
== "instantiate" and not session
["force"]:
2426 raise EngineException(
2427 "netslice_instance '{}' cannot be '{}' because it is already instantiated".format(
2428 netsliceInstanceId
, operation
2430 HTTPStatus
.CONFLICT
,
2433 # Creating all the NS_operation (nslcmop)
2434 # Get service list from db
2435 nsrs_list
= nsir
["_admin"]["nsrs-detailed-list"]
2437 # nslcmops_item = None
2438 for index
, nsr_item
in enumerate(nsrs_list
):
2439 nsr_id
= nsr_item
["nsrId"]
2440 if nsr_item
.get("shared"):
2441 _filter
["_admin.nsrs-detailed-list.ANYINDEX.shared"] = True
2442 _filter
["_admin.nsrs-detailed-list.ANYINDEX.nsrId"] = nsr_id
2444 "_admin.nsrs-detailed-list.ANYINDEX.nslcmop_instantiate.ne"
2446 _filter
["_id.ne"] = netsliceInstanceId
2447 nsi
= self
.db
.get_one(
2448 "nsis", _filter
, fail_on_empty
=False, fail_on_more
=False
2450 if operation
== "terminate":
2452 "_admin.nsrs-detailed-list.{}.nslcmop_instantiate".format(
2456 self
.db
.set_one("nsis", {"_id": nsir
["_id"]}, _update
)
2459 ): # other nsi is using this nsr and it needs this nsr instantiated
2460 continue # do not create nsilcmop
2462 # looks the first nsi fulfilling the conditions but not being the current NSIR
2464 nsi_nsr_item
= next(
2466 for n
in nsi
["_admin"]["nsrs-detailed-list"]
2467 if n
["nsrId"] == nsr_id
2469 and n
["nslcmop_instantiate"]
2471 self
.add_shared_nsr_2vld(nsir
, nsr_item
)
2472 nslcmops
.append(nsi_nsr_item
["nslcmop_instantiate"])
2474 "_admin.nsrs-detailed-list.{}".format(
2478 self
.db
.set_one("nsis", {"_id": nsir
["_id"]}, _update
)
2479 # continue to not create nslcmop since nsrs is shared and nsrs was created
2482 self
.add_shared_nsr_2vld(nsir
, nsr_item
)
2487 "lcmOperationType": operation
,
2488 "nsInstanceId": nsr_id
,
2489 # Including netslice_id in the ns instantiate Operation
2490 "netsliceInstanceId": netsliceInstanceId
,
2492 if operation
== "instantiate":
2493 service
= self
.db
.get_one("nsrs", {"_id": nsr_id
})
2494 indata_ns
.update(service
["instantiate_params"])
2496 # Creating NS_LCM_OP with the flag slice_object=True to not trigger the service instantiation
2497 # message via kafka bus
2498 nslcmop
, _
= self
.nsi_NsLcmOpTopic
.new(
2499 rollback
, session
, indata_ns
, None, headers
, slice_object
=True
2501 nslcmops
.append(nslcmop
)
2502 if operation
== "instantiate":
2504 "_admin.nsrs-detailed-list.{}.nslcmop_instantiate".format(
2508 self
.db
.set_one("nsis", {"_id": nsir
["_id"]}, _update
)
2509 except (DbException
, EngineException
) as e
:
2510 if e
.http_code
== HTTPStatus
.NOT_FOUND
:
2513 + "skipping NS={} because not found".format(nsr_id
)
2520 indata
["nslcmops_ids"] = nslcmops
2521 self
._check
_nsi
_operation
(session
, nsir
, operation
, indata
)
2523 nsilcmop_desc
= self
._create
_nsilcmop
(
2524 session
, netsliceInstanceId
, operation
, indata
2527 nsilcmop_desc
, session
["project_id"], make_public
=session
["public"]
2529 _id
= self
.db
.create("nsilcmops", nsilcmop_desc
)
2530 rollback
.append({"topic": "nsilcmops", "_id": _id
})
2531 self
.msg
.write("nsi", operation
, nsilcmop_desc
)
2533 except ValidationError
as e
:
2534 raise EngineException(e
, HTTPStatus
.UNPROCESSABLE_ENTITY
)
2536 def delete(self
, session
, _id
, dry_run
=False, not_send_msg
=None):
2537 raise EngineException(
2538 "Method delete called directly", HTTPStatus
.INTERNAL_SERVER_ERROR
2541 def edit(self
, session
, _id
, indata
=None, kwargs
=None, content
=None):
2542 raise EngineException(
2543 "Method edit called directly", HTTPStatus
.INTERNAL_SERVER_ERROR