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"]
482 if nsd
.get("virtual-link-desc"):
483 nsr_vld
= deepcopy(nsd
.get("virtual-link-desc", []))
484 # Fill each vld with vnfd-connection-point-ref data
485 # TODO: Change for multiple df support
486 all_vld_connection_point_data
= {vld
.get("id"): [] for vld
in nsr_vld
}
487 vnf_profiles
= nsd
.get("df", [[]])[0].get("vnf-profile", ())
488 for vnf_profile
in vnf_profiles
:
489 for vlc
in vnf_profile
.get("virtual-link-connectivity", ()):
490 for cpd
in vlc
.get("constituent-cpd-id", ()):
491 all_vld_connection_point_data
[
492 vlc
.get("virtual-link-profile-id")
495 "member-vnf-index-ref": cpd
.get(
496 "constituent-base-element-id"
498 "vnfd-connection-point-ref": cpd
.get(
501 "vnfd-id-ref": vnf_profile
.get("vnfd-id"),
505 vnfd
= self
._get
_vnfd
_from
_db
(vnf_profile
.get("vnfd-id"), session
)
507 for vdu
in vnfd
.get("vdu", ()):
510 # Find this vdu compute and storage descriptors
511 vdu_virtual_compute
= {}
512 vdu_virtual_storage
= {}
513 for vcd
in vnfd
.get("virtual-compute-desc", ()):
514 if vcd
.get("id") == vdu
.get("virtual-compute-desc"):
515 vdu_virtual_compute
= vcd
516 for vsd
in vnfd
.get("virtual-storage-desc", ()):
517 if vsd
.get("id") == vdu
.get("virtual-storage-desc", [[]])[0]:
518 vdu_virtual_storage
= vsd
519 # Get this vdu vcpus, memory and storage info for flavor_data
520 if vdu_virtual_compute
.get("virtual-cpu", {}).get(
523 flavor_data
["vcpu-count"] = vdu_virtual_compute
["virtual-cpu"][
526 if vdu_virtual_compute
.get("virtual-memory", {}).get("size"):
527 flavor_data
["memory-mb"] = (
528 float(vdu_virtual_compute
["virtual-memory"]["size"])
531 if vdu_virtual_storage
.get("size-of-storage"):
532 flavor_data
["storage-gb"] = vdu_virtual_storage
[
535 # Get this vdu EPA info for guest_epa
536 if vdu_virtual_compute
.get("virtual-cpu", {}).get("cpu-quota"):
537 guest_epa
["cpu-quota"] = vdu_virtual_compute
["virtual-cpu"][
540 if vdu_virtual_compute
.get("virtual-cpu", {}).get("pinning"):
541 vcpu_pinning
= vdu_virtual_compute
["virtual-cpu"]["pinning"]
542 if vcpu_pinning
.get("thread-policy"):
543 guest_epa
["cpu-thread-pinning-policy"] = vcpu_pinning
[
546 if vcpu_pinning
.get("policy"):
549 if vcpu_pinning
["policy"] == "dynamic"
552 guest_epa
["cpu-pinning-policy"] = cpu_policy
553 if vdu_virtual_compute
.get("virtual-memory", {}).get("mem-quota"):
554 guest_epa
["mem-quota"] = vdu_virtual_compute
["virtual-memory"][
557 if vdu_virtual_compute
.get("virtual-memory", {}).get(
560 guest_epa
["mempage-size"] = vdu_virtual_compute
[
563 if vdu_virtual_compute
.get("virtual-memory", {}).get(
566 guest_epa
["numa-node-policy"] = vdu_virtual_compute
[
568 ]["numa-node-policy"]
569 if vdu_virtual_storage
.get("disk-io-quota"):
570 guest_epa
["disk-io-quota"] = vdu_virtual_storage
[
575 flavor_data
["guest-epa"] = guest_epa
577 flavor_data
["name"] = vdu
["id"][:56] + "-flv"
578 flavor_data
["id"] = str(len(nsr_descriptor
["flavor"]))
579 nsr_descriptor
["flavor"].append(flavor_data
)
581 sw_image_id
= vdu
.get("sw-image-desc")
583 image_data
= self
._get
_image
_data
_from
_vnfd
(vnfd
, sw_image_id
)
584 self
._add
_image
_to
_nsr
(nsr_descriptor
, image_data
)
586 # also add alternative images to the list of images
587 for alt_image
in vdu
.get("alternative-sw-image-desc", ()):
588 image_data
= self
._get
_image
_data
_from
_vnfd
(vnfd
, alt_image
)
589 self
._add
_image
_to
_nsr
(nsr_descriptor
, image_data
)
592 vld
["vnfd-connection-point-ref"] = all_vld_connection_point_data
.get(
595 vld
["name"] = vld
["id"]
596 nsr_descriptor
["vld"] = nsr_vld
598 return nsr_descriptor
600 def _get_image_data_from_vnfd(self
, vnfd
, sw_image_id
):
601 sw_image_desc
= utils
.find_in_list(
602 vnfd
.get("sw-image-desc", ()), lambda sw
: sw
["id"] == sw_image_id
605 if sw_image_desc
.get("image"):
606 image_data
["image"] = sw_image_desc
["image"]
607 if sw_image_desc
.get("checksum"):
608 image_data
["image_checksum"] = sw_image_desc
["checksum"]["hash"]
609 if sw_image_desc
.get("vim-type"):
610 image_data
["vim-type"] = sw_image_desc
["vim-type"]
613 def _add_image_to_nsr(self
, nsr_descriptor
, image_data
):
615 Adds image to nsr checking first it is not already added
620 for f
in nsr_descriptor
["image"]
621 if all(f
.get(k
) == image_data
[k
] for k
in image_data
)
626 image_data
["id"] = str(len(nsr_descriptor
["image"]))
627 nsr_descriptor
["image"].append(image_data
)
629 def _create_vnfr_descriptor_from_vnfd(
639 vnfr_id
= str(uuid4())
640 nsr_id
= nsr_descriptor
["id"]
642 additional_params
, vnf_params
= self
._format
_additional
_params
(
643 ns_request
, vnf_index
, descriptor
=vnfd
649 "nsr-id-ref": nsr_id
,
650 "member-vnf-index-ref": vnf_index
,
651 "additionalParamsForVnf": additional_params
,
653 # "vnfd": vnfd, # at OSM model.but removed to avoid data duplication TODO: revise
655 "vnfd-id": vnfd
["_id"], # not at OSM model, but useful
656 "vim-account-id": None,
659 "connection-point": [],
660 "ip-address": None, # mgmt-interface filled by LCM
662 vnf_k8s_namespace
= ns_k8s_namespace
664 if vnf_params
.get("k8s-namespace"):
665 vnf_k8s_namespace
= vnf_params
["k8s-namespace"]
666 if vnf_params
.get("config-units"):
667 vnfr_descriptor
["config-units"] = vnf_params
["config-units"]
670 if vnfd
.get("int-virtual-link-desc"):
671 vnfr_descriptor
["vld"] = []
672 for vnfd_vld
in vnfd
.get("int-virtual-link-desc"):
673 vnfr_descriptor
["vld"].append({key
: vnfd_vld
[key
] for key
in vnfd_vld
})
675 for cp
in vnfd
.get("ext-cpd", ()):
677 "name": cp
.get("id"),
678 "connection-point-id": cp
.get("int-cpd", {}).get("cpd"),
679 "connection-point-vdu-id": cp
.get("int-cpd", {}).get("vdu-id"),
681 # "ip-address", "mac-address" # filled by LCM
682 # vim-id # TODO it would be nice having a vim port id
684 vnfr_descriptor
["connection-point"].append(vnf_cp
)
686 # Create k8s-cluster information
687 # TODO: Validate if a k8s-cluster net can have more than one ext-cpd ?
688 if vnfd
.get("k8s-cluster"):
689 vnfr_descriptor
["k8s-cluster"] = vnfd
["k8s-cluster"]
690 all_k8s_cluster_nets_cpds
= {}
691 for cpd
in get_iterable(vnfd
.get("ext-cpd")):
692 if cpd
.get("k8s-cluster-net"):
693 all_k8s_cluster_nets_cpds
[cpd
.get("k8s-cluster-net")] = cpd
.get(
696 for net
in get_iterable(vnfr_descriptor
["k8s-cluster"].get("nets")):
697 if net
.get("id") in all_k8s_cluster_nets_cpds
:
698 net
["external-connection-point-ref"] = all_k8s_cluster_nets_cpds
[
703 for kdu
in get_iterable(vnfd
.get("kdu")):
704 additional_params
, kdu_params
= self
._format
_additional
_params
(
705 ns_request
, vnf_index
, kdu_name
=kdu
["name"], descriptor
=vnfd
707 kdu_k8s_namespace
= vnf_k8s_namespace
708 kdu_model
= kdu_params
.get("kdu_model") if kdu_params
else None
709 if kdu_params
and kdu_params
.get("k8s-namespace"):
710 kdu_k8s_namespace
= kdu_params
["k8s-namespace"]
711 kdu_deployment_name
= ""
712 if kdu_params
and kdu_params
.get("kdu-deployment-name"):
713 kdu_deployment_name
= kdu_params
.get("kdu-deployment-name")
716 "additionalParams": additional_params
,
717 "k8s-namespace": kdu_k8s_namespace
,
718 "kdu-deployment-name": kdu_deployment_name
,
719 "kdu-name": kdu
["name"],
720 # TODO "name": "" Name of the VDU in the VIM
721 "ip-address": None, # mgmt-interface filled by LCM
724 if kdu_params
and kdu_params
.get("config-units"):
725 kdur
["config-units"] = kdu_params
["config-units"]
726 if kdu
.get("helm-version"):
727 kdur
["helm-version"] = kdu
["helm-version"]
728 for k8s_type
in ("helm-chart", "juju-bundle"):
729 if kdu
.get(k8s_type
):
730 kdur
[k8s_type
] = kdu_model
or kdu
[k8s_type
]
731 if not vnfr_descriptor
.get("kdur"):
732 vnfr_descriptor
["kdur"] = []
733 vnfr_descriptor
["kdur"].append(kdur
)
735 vnfd_mgmt_cp
= vnfd
.get("mgmt-cp")
737 for vdu
in vnfd
.get("vdu", ()):
740 configs
= vnfd
.get("df")[0]["lcm-operations-configuration"][
741 "operate-vnf-op-config"
743 vdu_config
= utils
.find_in_list(
744 configs
, lambda config
: config
["id"] == vdu
["id"]
750 vdu_instantiation_level
= utils
.find_in_list(
751 vnfd
.get("df")[0]["instantiation-level"][0]["vdu-level"],
752 lambda a_vdu_profile
: a_vdu_profile
["vdu-id"] == vdu
["id"],
755 vdu_instantiation_level
= None
758 external_connection_ee
= utils
.filter_in_list(
759 vdu_config
.get("execution-environment-list", []),
760 lambda ee
: "external-connection-point-ref" in ee
,
762 for ee
in external_connection_ee
:
763 vdu_mgmt_cp
.append(ee
["external-connection-point-ref"])
765 additional_params
, vdu_params
= self
._format
_additional
_params
(
766 ns_request
, vnf_index
, vdu_id
=vdu
["id"], descriptor
=vnfd
770 vdu_virtual_storage_descriptors
= utils
.filter_in_list(
771 vnfd
.get("virtual-storage-desc", []),
772 lambda stg_desc
: stg_desc
["id"] in vdu
["virtual-storage-desc"]
775 vdu_virtual_storage_descriptors
= []
777 "vdu-id-ref": vdu
["id"],
778 # TODO "name": "" Name of the VDU in the VIM
779 "ip-address": None, # mgmt-interface filled by LCM
780 # "vim-id", "flavor-id", "image-id", "management-ip" # filled by LCM
781 "internal-connection-point": [],
783 "additionalParams": additional_params
,
784 "vdu-name": vdu
["name"],
785 "virtual-storages": vdu_virtual_storage_descriptors
787 if vdu_params
and vdu_params
.get("config-units"):
788 vdur
["config-units"] = vdu_params
["config-units"]
789 if deep_get(vdu
, ("supplemental-boot-data", "boot-data-drive")):
790 vdur
["boot-data-drive"] = vdu
["supplemental-boot-data"][
793 if vdu
.get("pdu-type"):
794 vdur
["pdu-type"] = vdu
["pdu-type"]
795 vdur
["name"] = vdu
["pdu-type"]
796 # TODO volumes: name, volume-id
797 for icp
in vdu
.get("int-cpd", ()):
800 "connection-point-id": icp
["id"],
801 "name": icp
.get("id"),
804 vdur
["internal-connection-point"].append(vdu_icp
)
806 for iface
in icp
.get("virtual-network-interface-requirement", ()):
807 iface_fields
= ("name", "mac-address")
809 x
: iface
[x
] for x
in iface_fields
if iface
.get(x
) is not None
812 vdu_iface
["internal-connection-point-ref"] = vdu_icp
["id"]
813 if "port-security-enabled" in icp
:
814 vdu_iface
["port-security-enabled"] = icp
[
815 "port-security-enabled"
818 if "port-security-disable-strategy" in icp
:
819 vdu_iface
["port-security-disable-strategy"] = icp
[
820 "port-security-disable-strategy"
823 for ext_cp
in vnfd
.get("ext-cpd", ()):
824 if not ext_cp
.get("int-cpd"):
826 if ext_cp
["int-cpd"].get("vdu-id") != vdu
["id"]:
828 if icp
["id"] == ext_cp
["int-cpd"].get("cpd"):
829 vdu_iface
["external-connection-point-ref"] = ext_cp
.get(
833 if "port-security-enabled" in ext_cp
:
834 vdu_iface
["port-security-enabled"] = ext_cp
[
835 "port-security-enabled"
838 if "port-security-disable-strategy" in ext_cp
:
839 vdu_iface
["port-security-disable-strategy"] = ext_cp
[
840 "port-security-disable-strategy"
847 and vdu_iface
.get("external-connection-point-ref")
850 vdu_iface
["mgmt-vnf"] = True
851 vdu_iface
["mgmt-interface"] = True
853 for ecp
in vdu_mgmt_cp
:
854 if vdu_iface
.get("external-connection-point-ref") == ecp
:
855 vdu_iface
["mgmt-interface"] = True
857 if iface
.get("virtual-interface"):
858 vdu_iface
.update(deepcopy(iface
["virtual-interface"]))
860 # look for network where this interface is connected
861 iface_ext_cp
= vdu_iface
.get("external-connection-point-ref")
863 # TODO: Change for multiple df support
864 for df
in get_iterable(nsd
.get("df")):
865 for vnf_profile
in get_iterable(df
.get("vnf-profile")):
866 for vlc_index
, vlc
in enumerate(
868 vnf_profile
.get("virtual-link-connectivity")
871 for cpd
in get_iterable(
872 vlc
.get("constituent-cpd-id")
875 cpd
.get("constituent-cpd-id")
878 vdu_iface
["ns-vld-id"] = vlc
.get(
879 "virtual-link-profile-id"
881 # if iface type is SRIOV or PASSTHROUGH, set pci-interfaces flag to True
882 if vdu_iface
.get("type") in (
886 nsr_descriptor
["vld"][vlc_index
][
890 elif vdu_iface
.get("internal-connection-point-ref"):
891 vdu_iface
["vnf-vld-id"] = icp
.get("int-virtual-link-desc")
892 # TODO: store fixed IP address in the record (if it exists in the ICP)
893 # if iface type is SRIOV or PASSTHROUGH, set pci-interfaces flag to True
894 if vdu_iface
.get("type") in ("SR-IOV", "PCI-PASSTHROUGH"):
895 ivld_index
= utils
.find_index_in_list(
896 vnfd
.get("int-virtual-link-desc", ()),
897 lambda ivld
: ivld
["id"]
898 == icp
.get("int-virtual-link-desc"),
900 vnfr_descriptor
["vld"][ivld_index
]["pci-interfaces"] = True
902 vdur
["interfaces"].append(vdu_iface
)
904 if vdu
.get("sw-image-desc"):
905 sw_image
= utils
.find_in_list(
906 vnfd
.get("sw-image-desc", ()),
907 lambda image
: image
["id"] == vdu
.get("sw-image-desc"),
909 nsr_sw_image_data
= utils
.find_in_list(
910 nsr_descriptor
["image"],
911 lambda nsr_image
: (nsr_image
.get("image") == sw_image
.get("image")),
913 vdur
["ns-image-id"] = nsr_sw_image_data
["id"]
915 if vdu
.get("alternative-sw-image-desc"):
917 for alt_image_id
in vdu
.get("alternative-sw-image-desc", ()):
918 sw_image
= utils
.find_in_list(
919 vnfd
.get("sw-image-desc", ()),
920 lambda image
: image
["id"] == alt_image_id
,
922 nsr_sw_image_data
= utils
.find_in_list(
923 nsr_descriptor
["image"],
925 nsr_image
.get("image") == sw_image
.get("image")
928 alt_image_ids
.append(nsr_sw_image_data
["id"])
929 vdur
["alt-image-ids"] = alt_image_ids
931 flavor_data_name
= vdu
["id"][:56] + "-flv"
932 nsr_flavor_desc
= utils
.find_in_list(
933 nsr_descriptor
["flavor"],
934 lambda flavor
: flavor
["name"] == flavor_data_name
,
938 vdur
["ns-flavor-id"] = nsr_flavor_desc
["id"]
940 if vdu_instantiation_level
:
941 count
= vdu_instantiation_level
.get("number-of-instances")
945 for index
in range(0, count
):
946 vdur
= deepcopy(vdur
)
947 for iface
in vdur
["interfaces"]:
948 if iface
.get("ip-address") and index
!= 0:
949 iface
["ip-address"] = increment_ip_mac(iface
["ip-address"])
950 if iface
.get("mac-address") and index
!= 0:
951 iface
["mac-address"] = increment_ip_mac(iface
["mac-address"])
953 vdur
["_id"] = str(uuid4())
954 vdur
["id"] = vdur
["_id"]
955 vdur
["count-index"] = index
956 vnfr_descriptor
["vdur"].append(vdur
)
958 return vnfr_descriptor
960 def vca_status_refresh(self
, session
, ns_instance_content
, filter_q
):
962 vcaStatus in ns_instance_content maybe stale, check if it is stale and create lcm op
963 to refresh vca status by sending message to LCM when it is stale. Ignore otherwise.
964 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
965 :param ns_instance_content: ns instance content
966 :param filter_q: dict: query parameter containing vcaStatus-refresh as true or false
969 time_now
, time_delta
= time(), time() - ns_instance_content
["_admin"]["modified"]
970 force_refresh
= isinstance(filter_q
, dict) and filter_q
.get('vcaStatusRefresh') == 'true'
971 threshold_reached
= time_delta
> 120
972 if force_refresh
or threshold_reached
:
973 operation
, _id
= "vca_status_refresh", ns_instance_content
["_id"]
974 ns_instance_content
["_admin"]["modified"] = time_now
975 self
.db
.set_one(self
.topic
, {"_id": _id
}, ns_instance_content
)
976 nslcmop_desc
= NsLcmOpTopic
._create
_nslcmop
(_id
, operation
, None)
977 self
.format_on_new(nslcmop_desc
, session
["project_id"], make_public
=session
["public"])
978 nslcmop_desc
["_admin"].pop("nsState")
979 self
.msg
.write("ns", operation
, nslcmop_desc
)
982 def show(self
, session
, _id
, filter_q
=None, api_req
=False):
984 Get complete information on an ns instance.
985 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
986 :param _id: string, ns instance id
987 :param filter_q: dict: query parameter containing vcaStatusRefresh as true or false
988 :param api_req: True if this call is serving an external API request. False if serving internal request.
989 :return: dictionary, raise exception if not found.
991 ns_instance_content
= super().show(session
, _id
, api_req
)
992 self
.vca_status_refresh(session
, ns_instance_content
, filter_q
)
993 return ns_instance_content
995 def edit(self
, session
, _id
, indata
=None, kwargs
=None, content
=None):
996 raise EngineException(
997 "Method edit called directly", HTTPStatus
.INTERNAL_SERVER_ERROR
1001 class VnfrTopic(BaseTopic
):
1005 def __init__(self
, db
, fs
, msg
, auth
):
1006 BaseTopic
.__init
__(self
, db
, fs
, msg
, auth
)
1008 def delete(self
, session
, _id
, dry_run
=False, not_send_msg
=None):
1009 raise EngineException(
1010 "Method delete called directly", HTTPStatus
.INTERNAL_SERVER_ERROR
1013 def edit(self
, session
, _id
, indata
=None, kwargs
=None, content
=None):
1014 raise EngineException(
1015 "Method edit called directly", HTTPStatus
.INTERNAL_SERVER_ERROR
1018 def new(self
, rollback
, session
, indata
=None, kwargs
=None, headers
=None):
1019 # Not used because vnfrs are created and deleted by NsrTopic class directly
1020 raise EngineException(
1021 "Method new called directly", HTTPStatus
.INTERNAL_SERVER_ERROR
1025 class NsLcmOpTopic(BaseTopic
):
1028 operation_schema
= { # mapping between operation and jsonschema to validate
1029 "instantiate": ns_instantiate
,
1030 "action": ns_action
,
1032 "terminate": ns_terminate
,
1035 def __init__(self
, db
, fs
, msg
, auth
):
1036 BaseTopic
.__init
__(self
, db
, fs
, msg
, auth
)
1038 def _check_ns_operation(self
, session
, nsr
, operation
, indata
):
1040 Check that user has enter right parameters for the operation
1041 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1042 :param operation: it can be: instantiate, terminate, action, TODO: update, heal
1043 :param indata: descriptor with the parameters of the operation
1046 if operation
== "action":
1047 self
._check
_action
_ns
_operation
(indata
, nsr
)
1048 elif operation
== "scale":
1049 self
._check
_scale
_ns
_operation
(indata
, nsr
)
1050 elif operation
== "instantiate":
1051 self
._check
_instantiate
_ns
_operation
(indata
, nsr
, session
)
1053 def _check_action_ns_operation(self
, indata
, nsr
):
1055 # check vnf_member_index
1056 if indata
.get("vnf_member_index"):
1057 indata
["member_vnf_index"] = indata
.pop(
1059 ) # for backward compatibility
1060 if indata
.get("member_vnf_index"):
1061 vnfd
= self
._get
_vnfd
_from
_vnf
_member
_index
(
1062 indata
["member_vnf_index"], nsr
["_id"]
1065 configs
= vnfd
.get("df")[0]["lcm-operations-configuration"][
1066 "operate-vnf-op-config"
1071 if indata
.get("vdu_id"):
1072 self
._check
_valid
_vdu
(vnfd
, indata
["vdu_id"])
1073 descriptor_configuration
= utils
.find_in_list(
1074 configs
, lambda config
: config
["id"] == indata
["vdu_id"]
1076 elif indata
.get("kdu_name"):
1077 self
._check
_valid
_kdu
(vnfd
, indata
["kdu_name"])
1078 descriptor_configuration
= utils
.find_in_list(
1079 configs
, lambda config
: config
["id"] == indata
.get("kdu_name")
1082 descriptor_configuration
= utils
.find_in_list(
1083 configs
, lambda config
: config
["id"] == vnfd
["id"]
1085 if descriptor_configuration
is not None:
1086 descriptor_configuration
= descriptor_configuration
.get(
1090 descriptor_configuration
= nsd
.get("ns-configuration", {}).get(
1094 # For k8s allows default primitives without validating the parameters
1095 if indata
.get("kdu_name") and indata
["primitive"] in (
1102 # TODO should be checked that rollback only can contains revsision_numbe????
1103 if not indata
.get("member_vnf_index"):
1104 raise EngineException(
1105 "Missing action parameter 'member_vnf_index' for default KDU primitive '{}'".format(
1110 # if not, check primitive
1111 for config_primitive
in get_iterable(descriptor_configuration
):
1112 if indata
["primitive"] == config_primitive
["name"]:
1113 # check needed primitive_params are provided
1114 if indata
.get("primitive_params"):
1115 in_primitive_params_copy
= copy(indata
["primitive_params"])
1117 in_primitive_params_copy
= {}
1118 for paramd
in get_iterable(config_primitive
.get("parameter")):
1119 if paramd
["name"] in in_primitive_params_copy
:
1120 del in_primitive_params_copy
[paramd
["name"]]
1121 elif not paramd
.get("default-value"):
1122 raise EngineException(
1123 "Needed parameter {} not provided for primitive '{}'".format(
1124 paramd
["name"], indata
["primitive"]
1127 # check no extra primitive params are provided
1128 if in_primitive_params_copy
:
1129 raise EngineException(
1130 "parameter/s '{}' not present at vnfd /nsd for primitive '{}'".format(
1131 list(in_primitive_params_copy
.keys()), indata
["primitive"]
1136 raise EngineException(
1137 "Invalid primitive '{}' is not present at vnfd/nsd".format(
1142 def _check_scale_ns_operation(self
, indata
, nsr
):
1143 vnfd
= self
._get
_vnfd
_from
_vnf
_member
_index
(
1144 indata
["scaleVnfData"]["scaleByStepData"]["member-vnf-index"], nsr
["_id"]
1146 for scaling_aspect
in get_iterable(vnfd
.get("df", ())[0]["scaling-aspect"]):
1148 indata
["scaleVnfData"]["scaleByStepData"]["scaling-group-descriptor"]
1149 == scaling_aspect
["id"]
1153 raise EngineException(
1154 "Invalid scaleVnfData:scaleByStepData:scaling-group-descriptor '{}' is not "
1155 "present at vnfd:scaling-aspect".format(
1156 indata
["scaleVnfData"]["scaleByStepData"][
1157 "scaling-group-descriptor"
1162 def _check_instantiate_ns_operation(self
, indata
, nsr
, session
):
1163 vnf_member_index_to_vnfd
= {} # map between vnf_member_index to vnf descriptor.
1167 self
._check
_valid
_vim
_account
(indata
["vimAccountId"], vim_accounts
, session
)
1168 self
._check
_valid
_wim
_account
(indata
.get("wimAccountId"), wim_accounts
, session
)
1169 for in_vnf
in get_iterable(indata
.get("vnf")):
1170 member_vnf_index
= in_vnf
["member-vnf-index"]
1171 if vnf_member_index_to_vnfd
.get(member_vnf_index
):
1172 vnfd
= vnf_member_index_to_vnfd
[member_vnf_index
]
1174 vnfd
= self
._get
_vnfd
_from
_vnf
_member
_index
(
1175 member_vnf_index
, nsr
["_id"]
1177 vnf_member_index_to_vnfd
[
1179 ] = vnfd
# add to cache, avoiding a later look for
1180 self
._check
_vnf
_instantiation
_params
(in_vnf
, vnfd
)
1181 if in_vnf
.get("vimAccountId"):
1182 self
._check
_valid
_vim
_account
(
1183 in_vnf
["vimAccountId"], vim_accounts
, session
1186 for in_vld
in get_iterable(indata
.get("vld")):
1187 self
._check
_valid
_wim
_account
(
1188 in_vld
.get("wimAccountId"), wim_accounts
, session
1190 for vldd
in get_iterable(nsd
.get("virtual-link-desc")):
1191 if in_vld
["name"] == vldd
["id"]:
1194 raise EngineException(
1195 "Invalid parameter vld:name='{}' is not present at nsd:vld".format(
1200 def _get_vnfd_from_vnf_member_index(self
, member_vnf_index
, nsr_id
):
1201 # Obtain vnf descriptor. The vnfr is used to get the vnfd._id used for this member_vnf_index
1202 vnfr
= self
.db
.get_one(
1204 {"nsr-id-ref": nsr_id
, "member-vnf-index-ref": member_vnf_index
},
1205 fail_on_empty
=False,
1208 raise EngineException(
1209 "Invalid parameter member_vnf_index='{}' is not one of the "
1210 "nsd:constituent-vnfd".format(member_vnf_index
)
1212 vnfd
= self
.db
.get_one("vnfds", {"_id": vnfr
["vnfd-id"]}, fail_on_empty
=False)
1214 raise EngineException(
1215 "vnfd id={} has been deleted!. Operation cannot be performed".format(
1221 def _check_valid_vdu(self
, vnfd
, vdu_id
):
1222 for vdud
in get_iterable(vnfd
.get("vdu")):
1223 if vdud
["id"] == vdu_id
:
1226 raise EngineException(
1227 "Invalid parameter vdu_id='{}' not present at vnfd:vdu:id".format(
1232 def _check_valid_kdu(self
, vnfd
, kdu_name
):
1233 for kdud
in get_iterable(vnfd
.get("kdu")):
1234 if kdud
["name"] == kdu_name
:
1237 raise EngineException(
1238 "Invalid parameter kdu_name='{}' not present at vnfd:kdu:name".format(
1243 def _check_vnf_instantiation_params(self
, in_vnf
, vnfd
):
1244 for in_vdu
in get_iterable(in_vnf
.get("vdu")):
1245 for vdu
in get_iterable(vnfd
.get("vdu")):
1246 if in_vdu
["id"] == vdu
["id"]:
1247 for volume
in get_iterable(in_vdu
.get("volume")):
1248 for volumed
in get_iterable(vdu
.get("virtual-storage-desc")):
1249 if volumed
["id"] == volume
["name"]:
1252 raise EngineException(
1253 "Invalid parameter vnf[member-vnf-index='{}']:vdu[id='{}']:"
1254 "volume:name='{}' is not present at "
1255 "vnfd:vdu:virtual-storage-desc list".format(
1256 in_vnf
["member-vnf-index"],
1262 vdu_if_names
= set()
1263 for cpd
in get_iterable(vdu
.get("int-cpd")):
1264 for iface
in get_iterable(
1265 cpd
.get("virtual-network-interface-requirement")
1267 vdu_if_names
.add(iface
.get("name"))
1269 for in_iface
in get_iterable(in_vdu
["interface"]):
1270 if in_iface
["name"] in vdu_if_names
:
1273 raise EngineException(
1274 "Invalid parameter vnf[member-vnf-index='{}']:vdu[id='{}']:"
1275 "int-cpd[id='{}'] is not present at vnfd:vdu:int-cpd".format(
1276 in_vnf
["member-vnf-index"],
1284 raise EngineException(
1285 "Invalid parameter vnf[member-vnf-index='{}']:vdu[id='{}'] is not present "
1286 "at vnfd:vdu".format(in_vnf
["member-vnf-index"], in_vdu
["id"])
1290 ivld
.get("id"): set()
1291 for ivld
in get_iterable(vnfd
.get("int-virtual-link-desc"))
1293 for vdu
in get_iterable(vnfd
.get("vdu")):
1294 for cpd
in get_iterable(vnfd
.get("int-cpd")):
1295 if cpd
.get("int-virtual-link-desc"):
1296 vnfd_ivlds_cpds
[cpd
.get("int-virtual-link-desc")] = cpd
.get("id")
1298 for in_ivld
in get_iterable(in_vnf
.get("internal-vld")):
1299 if in_ivld
.get("name") in vnfd_ivlds_cpds
:
1300 for in_icp
in get_iterable(in_ivld
.get("internal-connection-point")):
1301 if in_icp
["id-ref"] in vnfd_ivlds_cpds
[in_ivld
.get("name")]:
1304 raise EngineException(
1305 "Invalid parameter vnf[member-vnf-index='{}']:internal-vld[name"
1306 "='{}']:internal-connection-point[id-ref:'{}'] is not present at "
1307 "vnfd:internal-vld:name/id:internal-connection-point".format(
1308 in_vnf
["member-vnf-index"],
1314 raise EngineException(
1315 "Invalid parameter vnf[member-vnf-index='{}']:internal-vld:name='{}'"
1316 " is not present at vnfd '{}'".format(
1317 in_vnf
["member-vnf-index"], in_ivld
["name"], vnfd
["id"]
1321 def _check_valid_vim_account(self
, vim_account
, vim_accounts
, session
):
1322 if vim_account
in vim_accounts
:
1325 db_filter
= self
._get
_project
_filter
(session
)
1326 db_filter
["_id"] = vim_account
1327 self
.db
.get_one("vim_accounts", db_filter
)
1329 raise EngineException(
1330 "Invalid vimAccountId='{}' not present for the project".format(
1334 vim_accounts
.append(vim_account
)
1336 def _get_vim_account(self
, vim_id
: str, session
):
1338 db_filter
= self
._get
_project
_filter
(session
)
1339 db_filter
["_id"] = vim_id
1340 return self
.db
.get_one("vim_accounts", db_filter
)
1342 raise EngineException(
1343 "Invalid vimAccountId='{}' not present for the project".format(
1348 def _check_valid_wim_account(self
, wim_account
, wim_accounts
, session
):
1349 if not isinstance(wim_account
, str):
1351 if wim_account
in wim_accounts
:
1354 db_filter
= self
._get
_project
_filter
(session
, write
=False, show_all
=True)
1355 db_filter
["_id"] = wim_account
1356 self
.db
.get_one("wim_accounts", db_filter
)
1358 raise EngineException(
1359 "Invalid wimAccountId='{}' not present for the project".format(
1363 wim_accounts
.append(wim_account
)
1366 self
, session
, rollback
, vnfr
, vim_account
, vnfr_update
, vnfr_update_rollback
1369 Look for a free PDU in the catalog matching vdur type and interfaces. Fills vnfr.vdur with the interface
1370 (ip_address, ...) information.
1371 Modifies PDU _admin.usageState to 'IN_USE'
1372 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1373 :param rollback: list with the database modifications to rollback if needed
1374 :param vnfr: vnfr to be updated. It is modified with pdu interface info if pdu is found
1375 :param vim_account: vim_account where this vnfr should be deployed
1376 :param vnfr_update: dictionary filled by this method with changes to be done at database vnfr
1377 :param vnfr_update_rollback: dictionary filled by this method with original content of vnfr in case a rollback
1378 of the changed vnfr is needed
1380 :return: List of PDU interfaces that are connected to an existing VIM network. Each item contains:
1381 "vim-network-name": used at VIM
1382 "name": interface name
1383 "vnf-vld-id": internal VNFD vld where this interface is connected, or
1384 "ns-vld-id": NSD vld where this interface is connected.
1385 NOTE: One, and only one between 'vnf-vld-id' and 'ns-vld-id' contains a value. The other will be None
1388 ifaces_forcing_vim_network
= []
1389 for vdur_index
, vdur
in enumerate(get_iterable(vnfr
.get("vdur"))):
1390 if not vdur
.get("pdu-type"):
1392 pdu_type
= vdur
.get("pdu-type")
1393 pdu_filter
= self
._get
_project
_filter
(session
)
1394 pdu_filter
["vim_accounts"] = vim_account
1395 pdu_filter
["type"] = pdu_type
1396 pdu_filter
["_admin.operationalState"] = "ENABLED"
1397 pdu_filter
["_admin.usageState"] = "NOT_IN_USE"
1398 # TODO feature 1417: "shared": True,
1400 available_pdus
= self
.db
.get_list("pdus", pdu_filter
)
1401 for pdu
in available_pdus
:
1402 # step 1 check if this pdu contains needed interfaces:
1403 match_interfaces
= True
1404 for vdur_interface
in vdur
["interfaces"]:
1405 for pdu_interface
in pdu
["interfaces"]:
1406 if pdu_interface
["name"] == vdur_interface
["name"]:
1407 # TODO feature 1417: match per mgmt type
1409 else: # no interface found for name
1410 match_interfaces
= False
1412 if match_interfaces
:
1415 raise EngineException(
1416 "No PDU of type={} at vim_account={} found for member_vnf_index={}, vdu={} matching interface "
1420 vnfr
["member-vnf-index-ref"],
1425 # step 2. Update pdu
1427 "_admin.usageState": pdu
["_admin"]["usageState"],
1428 "_admin.usage.vnfr_id": None,
1429 "_admin.usage.nsr_id": None,
1430 "_admin.usage.vdur": None,
1434 {"_id": pdu
["_id"]},
1436 "_admin.usageState": "IN_USE",
1438 "vnfr_id": vnfr
["_id"],
1439 "nsr_id": vnfr
["nsr-id-ref"],
1440 "vdur": vdur
["vdu-id-ref"],
1449 "content": rollback_pdu
,
1453 # step 3. Fill vnfr info by filling vdur
1454 vdu_text
= "vdur.{}".format(vdur_index
)
1455 vnfr_update_rollback
[vdu_text
+ ".pdu-id"] = None
1456 vnfr_update
[vdu_text
+ ".pdu-id"] = pdu
["_id"]
1457 for iface_index
, vdur_interface
in enumerate(vdur
["interfaces"]):
1458 for pdu_interface
in pdu
["interfaces"]:
1459 if pdu_interface
["name"] == vdur_interface
["name"]:
1460 iface_text
= vdu_text
+ ".interfaces.{}".format(iface_index
)
1461 for k
, v
in pdu_interface
.items():
1465 ): # TODO: switch-xxxxx must be inserted
1466 vnfr_update
[iface_text
+ ".{}".format(k
)] = v
1467 vnfr_update_rollback
[
1468 iface_text
+ ".{}".format(k
)
1469 ] = vdur_interface
.get(v
)
1470 if pdu_interface
.get("ip-address"):
1471 if vdur_interface
.get(
1473 ) or vdur_interface
.get("mgmt-vnf"):
1474 vnfr_update_rollback
[
1475 vdu_text
+ ".ip-address"
1476 ] = vdur
.get("ip-address")
1477 vnfr_update
[vdu_text
+ ".ip-address"] = pdu_interface
[
1480 if vdur_interface
.get("mgmt-vnf"):
1481 vnfr_update_rollback
["ip-address"] = vnfr
.get(
1484 vnfr_update
["ip-address"] = pdu_interface
["ip-address"]
1485 vnfr_update
[vdu_text
+ ".ip-address"] = pdu_interface
[
1488 if pdu_interface
.get("vim-network-name") or pdu_interface
.get(
1491 ifaces_forcing_vim_network
.append(
1493 "name": vdur_interface
.get("vnf-vld-id")
1494 or vdur_interface
.get("ns-vld-id"),
1495 "vnf-vld-id": vdur_interface
.get("vnf-vld-id"),
1496 "ns-vld-id": vdur_interface
.get("ns-vld-id"),
1499 if pdu_interface
.get("vim-network-id"):
1500 ifaces_forcing_vim_network
[-1][
1502 ] = pdu_interface
["vim-network-id"]
1503 if pdu_interface
.get("vim-network-name"):
1504 ifaces_forcing_vim_network
[-1][
1506 ] = pdu_interface
["vim-network-name"]
1509 return ifaces_forcing_vim_network
1511 def _look_for_k8scluster(
1512 self
, session
, rollback
, vnfr
, vim_account
, vnfr_update
, vnfr_update_rollback
1515 Look for an available k8scluster for all the kuds in the vnfd matching version and cni requirements.
1516 Fills vnfr.kdur with the selected k8scluster
1518 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1519 :param rollback: list with the database modifications to rollback if needed
1520 :param vnfr: vnfr to be updated. It is modified with pdu interface info if pdu is found
1521 :param vim_account: vim_account where this vnfr should be deployed
1522 :param vnfr_update: dictionary filled by this method with changes to be done at database vnfr
1523 :param vnfr_update_rollback: dictionary filled by this method with original content of vnfr in case a rollback
1524 of the changed vnfr is needed
1526 :return: List of KDU interfaces that are connected to an existing VIM network. Each item contains:
1527 "vim-network-name": used at VIM
1528 "name": interface name
1529 "vnf-vld-id": internal VNFD vld where this interface is connected, or
1530 "ns-vld-id": NSD vld where this interface is connected.
1531 NOTE: One, and only one between 'vnf-vld-id' and 'ns-vld-id' contains a value. The other will be None
1534 ifaces_forcing_vim_network
= []
1535 if not vnfr
.get("kdur"):
1536 return ifaces_forcing_vim_network
1538 kdu_filter
= self
._get
_project
_filter
(session
)
1539 kdu_filter
["vim_account"] = vim_account
1540 # TODO kdu_filter["_admin.operationalState"] = "ENABLED"
1541 available_k8sclusters
= self
.db
.get_list("k8sclusters", kdu_filter
)
1543 k8s_requirements
= {} # just for logging
1544 for k8scluster
in available_k8sclusters
:
1545 if not vnfr
.get("k8s-cluster"):
1548 if vnfr
["k8s-cluster"].get("cni"):
1549 k8s_requirements
["cni"] = vnfr
["k8s-cluster"]["cni"]
1550 if not set(vnfr
["k8s-cluster"]["cni"]).intersection(
1551 k8scluster
.get("cni", ())
1554 # restrict by version
1555 if vnfr
["k8s-cluster"].get("version"):
1556 k8s_requirements
["version"] = vnfr
["k8s-cluster"]["version"]
1557 if k8scluster
.get("k8s_version") not in vnfr
["k8s-cluster"]["version"]:
1559 # restrict by number of networks
1560 if vnfr
["k8s-cluster"].get("nets"):
1561 k8s_requirements
["networks"] = len(vnfr
["k8s-cluster"]["nets"])
1562 if not k8scluster
.get("nets") or len(k8scluster
["nets"]) < len(
1563 vnfr
["k8s-cluster"]["nets"]
1568 raise EngineException(
1569 "No k8scluster with requirements='{}' at vim_account={} found for member_vnf_index={}".format(
1570 k8s_requirements
, vim_account
, vnfr
["member-vnf-index-ref"]
1574 for kdur_index
, kdur
in enumerate(get_iterable(vnfr
.get("kdur"))):
1575 # step 3. Fill vnfr info by filling kdur
1576 kdu_text
= "kdur.{}.".format(kdur_index
)
1577 vnfr_update_rollback
[kdu_text
+ "k8s-cluster.id"] = None
1578 vnfr_update
[kdu_text
+ "k8s-cluster.id"] = k8scluster
["_id"]
1580 # step 4. Check VIM networks that forces the selected k8s_cluster
1581 if vnfr
.get("k8s-cluster") and vnfr
["k8s-cluster"].get("nets"):
1582 k8scluster_net_list
= list(k8scluster
.get("nets").keys())
1583 for net_index
, kdur_net
in enumerate(vnfr
["k8s-cluster"]["nets"]):
1584 # get a network from k8s_cluster nets. If name matches use this, if not use other
1585 if kdur_net
["id"] in k8scluster_net_list
: # name matches
1586 vim_net
= k8scluster
["nets"][kdur_net
["id"]]
1587 k8scluster_net_list
.remove(kdur_net
["id"])
1589 vim_net
= k8scluster
["nets"][k8scluster_net_list
[0]]
1590 k8scluster_net_list
.pop(0)
1591 vnfr_update_rollback
[
1592 "k8s-cluster.nets.{}.vim_net".format(net_index
)
1594 vnfr_update
["k8s-cluster.nets.{}.vim_net".format(net_index
)] = vim_net
1596 kdur_net
.get("vnf-vld-id") or kdur_net
.get("ns-vld-id")
1598 ifaces_forcing_vim_network
.append(
1600 "name": kdur_net
.get("vnf-vld-id")
1601 or kdur_net
.get("ns-vld-id"),
1602 "vnf-vld-id": kdur_net
.get("vnf-vld-id"),
1603 "ns-vld-id": kdur_net
.get("ns-vld-id"),
1604 "vim-network-name": vim_net
, # TODO can it be vim-network-id ???
1607 # TODO check that this forcing is not incompatible with other forcing
1608 return ifaces_forcing_vim_network
1610 def _update_vnfrs_from_nsd(self
, nsr
):
1615 step
= "Getting vnf_profiles from nsd"
1616 vnf_profiles
= nsd
.get("df", [{}])[0].get("vnf-profile", ())
1617 vld_fixed_ip_connection_point_data
= {}
1619 step
= "Getting ip-address info from vnf_profile if it exists"
1620 for vnfp
in vnf_profiles
:
1621 # Checking ip-address info from nsd.vnf_profile and storing
1622 for vlc
in vnfp
.get("virtual-link-connectivity", ()):
1623 for cpd
in vlc
.get("constituent-cpd-id", ()):
1624 if cpd
.get("ip-address"):
1625 step
= "Storing ip-address info"
1626 vld_fixed_ip_connection_point_data
.update({vlc
.get("virtual-link-profile-id") + '.' + cpd
.get("constituent-base-element-id"): {
1627 "vnfd-connection-point-ref": cpd
.get(
1628 "constituent-cpd-id"),
1629 "ip-address": cpd
.get(
1632 # Inserting ip address to vnfr
1633 if len(vld_fixed_ip_connection_point_data
) > 0:
1634 step
= "Getting vnfrs"
1635 vnfrs
= self
.db
.get_list("vnfrs", {"nsr-id-ref": nsr_id
})
1636 for item
in vld_fixed_ip_connection_point_data
.keys():
1637 step
= "Filtering vnfrs"
1638 vnfr
= next(filter(lambda vnfr
: vnfr
["member-vnf-index-ref"] == item
.split('.')[1], vnfrs
), None)
1641 for vdur_index
, vdur
in enumerate(vnfr
["vdur"]):
1642 for iface_index
, iface
in enumerate(vdur
["interfaces"]):
1643 step
= "Looking for matched interface"
1645 iface
.get("external-connection-point-ref")
1646 == vld_fixed_ip_connection_point_data
[item
].get("vnfd-connection-point-ref") and
1647 iface
.get("ns-vld-id") == item
.split('.')[0]
1650 vnfr_update_text
= "vdur.{}.interfaces.{}".format(
1651 vdur_index
, iface_index
1653 step
= "Storing info in order to update vnfr"
1655 vnfr_update_text
+ ".ip-address"
1656 ] = increment_ip_mac(
1657 vld_fixed_ip_connection_point_data
[item
].get("ip-address"),
1658 vdur
.get("count-index", 0), )
1659 vnfr_update
[vnfr_update_text
+ ".fixed-ip"] = True
1661 step
= "updating vnfr at database"
1662 self
.db
.set_one("vnfrs", {"_id": vnfr
["_id"]}, vnfr_update
)
1670 raise type(e
)("{} while '{}'".format(e
, step
), http_code
=e
.http_code
)
1672 def _update_vnfrs(self
, session
, rollback
, nsr
, indata
):
1675 vnfrs
= self
.db
.get_list("vnfrs", {"nsr-id-ref": nsr_id
})
1679 vnfr_update_rollback
= {}
1680 member_vnf_index
= vnfr
["member-vnf-index-ref"]
1681 # update vim-account-id
1683 vim_account
= indata
["vimAccountId"]
1684 vca_id
= self
._get
_vim
_account
(vim_account
, session
).get("vca")
1685 # check instantiate parameters
1686 for vnf_inst_params
in get_iterable(indata
.get("vnf")):
1687 if vnf_inst_params
["member-vnf-index"] != member_vnf_index
:
1689 if vnf_inst_params
.get("vimAccountId"):
1690 vim_account
= vnf_inst_params
.get("vimAccountId")
1691 vca_id
= self
._get
_vim
_account
(vim_account
, session
).get("vca")
1693 # get vnf.vdu.interface instantiation params to update vnfr.vdur.interfaces ip, mac
1694 for vdu_inst_param
in get_iterable(vnf_inst_params
.get("vdu")):
1695 for vdur_index
, vdur
in enumerate(vnfr
["vdur"]):
1696 if vdu_inst_param
["id"] != vdur
["vdu-id-ref"]:
1698 for iface_inst_param
in get_iterable(
1699 vdu_inst_param
.get("interface")
1701 iface_index
, _
= next(
1703 for i
in enumerate(vdur
["interfaces"])
1704 if i
[1]["name"] == iface_inst_param
["name"]
1706 vnfr_update_text
= "vdur.{}.interfaces.{}".format(
1707 vdur_index
, iface_index
1709 if iface_inst_param
.get("ip-address"):
1711 vnfr_update_text
+ ".ip-address"
1712 ] = increment_ip_mac(
1713 iface_inst_param
.get("ip-address"),
1714 vdur
.get("count-index", 0),
1716 vnfr_update
[vnfr_update_text
+ ".fixed-ip"] = True
1717 if iface_inst_param
.get("mac-address"):
1719 vnfr_update_text
+ ".mac-address"
1720 ] = increment_ip_mac(
1721 iface_inst_param
.get("mac-address"),
1722 vdur
.get("count-index", 0),
1724 vnfr_update
[vnfr_update_text
+ ".fixed-mac"] = True
1725 if iface_inst_param
.get("floating-ip-required"):
1727 vnfr_update_text
+ ".floating-ip-required"
1729 # get vnf.internal-vld.internal-conection-point instantiation params to update vnfr.vdur.interfaces
1730 # TODO update vld with the ip-profile
1731 for ivld_inst_param
in get_iterable(
1732 vnf_inst_params
.get("internal-vld")
1734 for icp_inst_param
in get_iterable(
1735 ivld_inst_param
.get("internal-connection-point")
1738 for vdur_index
, vdur
in enumerate(vnfr
["vdur"]):
1739 for iface_index
, iface
in enumerate(vdur
["interfaces"]):
1741 iface
.get("internal-connection-point-ref")
1742 == icp_inst_param
["id-ref"]
1744 vnfr_update_text
= "vdur.{}.interfaces.{}".format(
1745 vdur_index
, iface_index
1747 if icp_inst_param
.get("ip-address"):
1749 vnfr_update_text
+ ".ip-address"
1750 ] = increment_ip_mac(
1751 icp_inst_param
.get("ip-address"),
1752 vdur
.get("count-index", 0),
1755 vnfr_update_text
+ ".fixed-ip"
1757 if icp_inst_param
.get("mac-address"):
1759 vnfr_update_text
+ ".mac-address"
1760 ] = increment_ip_mac(
1761 icp_inst_param
.get("mac-address"),
1762 vdur
.get("count-index", 0),
1765 vnfr_update_text
+ ".fixed-mac"
1768 # get ip address from instantiation parameters.vld.vnfd-connection-point-ref
1769 for vld_inst_param
in get_iterable(indata
.get("vld")):
1770 for vnfcp_inst_param
in get_iterable(
1771 vld_inst_param
.get("vnfd-connection-point-ref")
1773 if vnfcp_inst_param
["member-vnf-index-ref"] != member_vnf_index
:
1776 for vdur_index
, vdur
in enumerate(vnfr
["vdur"]):
1777 for iface_index
, iface
in enumerate(vdur
["interfaces"]):
1779 iface
.get("external-connection-point-ref")
1780 == vnfcp_inst_param
["vnfd-connection-point-ref"]
1782 vnfr_update_text
= "vdur.{}.interfaces.{}".format(
1783 vdur_index
, iface_index
1785 if vnfcp_inst_param
.get("ip-address"):
1787 vnfr_update_text
+ ".ip-address"
1788 ] = increment_ip_mac(
1789 vnfcp_inst_param
.get("ip-address"),
1790 vdur
.get("count-index", 0),
1792 vnfr_update
[vnfr_update_text
+ ".fixed-ip"] = True
1793 if vnfcp_inst_param
.get("mac-address"):
1795 vnfr_update_text
+ ".mac-address"
1796 ] = increment_ip_mac(
1797 vnfcp_inst_param
.get("mac-address"),
1798 vdur
.get("count-index", 0),
1800 vnfr_update
[vnfr_update_text
+ ".fixed-mac"] = True
1803 vnfr_update
["vim-account-id"] = vim_account
1804 vnfr_update_rollback
["vim-account-id"] = vnfr
.get("vim-account-id")
1807 vnfr_update
["vca-id"] = vca_id
1808 vnfr_update_rollback
["vca-id"] = vnfr
.get("vca-id")
1811 ifaces_forcing_vim_network
= self
._look
_for
_pdu
(
1812 session
, rollback
, vnfr
, vim_account
, vnfr_update
, vnfr_update_rollback
1816 ifaces_forcing_vim_network
+= self
._look
_for
_k
8scluster
(
1817 session
, rollback
, vnfr
, vim_account
, vnfr_update
, vnfr_update_rollback
1819 # update database vnfr
1820 self
.db
.set_one("vnfrs", {"_id": vnfr
["_id"]}, vnfr_update
)
1826 "content": vnfr_update_rollback
,
1830 # Update indada in case pdu forces to use a concrete vim-network-name
1831 # TODO check if user has already insert a vim-network-name and raises an error
1832 if not ifaces_forcing_vim_network
:
1834 for iface_info
in ifaces_forcing_vim_network
:
1835 if iface_info
.get("ns-vld-id"):
1836 if "vld" not in indata
:
1838 indata
["vld"].append(
1840 key
: iface_info
[key
]
1841 for key
in ("name", "vim-network-name", "vim-network-id")
1842 if iface_info
.get(key
)
1846 elif iface_info
.get("vnf-vld-id"):
1847 if "vnf" not in indata
:
1849 indata
["vnf"].append(
1851 "member-vnf-index": member_vnf_index
,
1854 key
: iface_info
[key
]
1860 if iface_info
.get(key
)
1867 def _create_nslcmop(nsr_id
, operation
, params
):
1869 Creates a ns-lcm-opp content to be stored at database.
1870 :param nsr_id: internal id of the instance
1871 :param operation: instantiate, terminate, scale, action, ...
1872 :param params: user parameters for the operation
1873 :return: dictionary following SOL005 format
1880 "operationState": "PROCESSING", # COMPLETED,PARTIALLY_COMPLETED,FAILED_TEMP,FAILED,ROLLING_BACK,ROLLED_BACK
1881 "queuePosition": None,
1883 "errorMessage": None,
1884 "detailedStatus": None,
1885 "statusEnteredTime": now
,
1886 "nsInstanceId": nsr_id
,
1887 "lcmOperationType": operation
,
1889 "isAutomaticInvocation": False,
1890 "operationParams": params
,
1891 "isCancelPending": False,
1893 "self": "/osm/nslcm/v1/ns_lcm_op_occs/" + _id
,
1894 "nsInstance": "/osm/nslcm/v1/ns_instances/" + nsr_id
,
1899 def _get_enabled_vims(self
, session
):
1901 Retrieve and return VIM accounts that are accessible by current user and has state ENABLE
1902 :param session: current session with user information
1904 db_filter
= self
._get
_project
_filter
(session
)
1905 db_filter
["_admin.operationalState"] = "ENABLED"
1906 vims
= self
.db
.get_list("vim_accounts", db_filter
)
1909 vimAccounts
.append(vim
["_id"])
1922 Performs a new operation over a ns
1923 :param rollback: list to append created items at database in case a rollback must to be done
1924 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1925 :param indata: descriptor with the parameters of the operation. It must contains among others
1926 nsInstanceId: _id of the nsr to perform the operation
1927 operation: it can be: instantiate, terminate, action, TODO: update, heal
1928 :param kwargs: used to override the indata descriptor
1929 :param headers: http request headers
1930 :return: id of the nslcmops
1933 def check_if_nsr_is_not_slice_member(session
, nsr_id
):
1935 db_filter
= self
._get
_project
_filter
(session
)
1936 db_filter
["_admin.nsrs-detailed-list.ANYINDEX.nsrId"] = nsr_id
1937 nsis
= self
.db
.get_one(
1938 "nsis", db_filter
, fail_on_empty
=False, fail_on_more
=False
1941 raise EngineException(
1942 "The NS instance {} cannot be terminated because is used by the slice {}".format(
1945 http_code
=HTTPStatus
.CONFLICT
,
1949 # Override descriptor with query string kwargs
1950 self
._update
_input
_with
_kwargs
(indata
, kwargs
, yaml_format
=True)
1951 operation
= indata
["lcmOperationType"]
1952 nsInstanceId
= indata
["nsInstanceId"]
1954 validate_input(indata
, self
.operation_schema
[operation
])
1955 # get ns from nsr_id
1956 _filter
= BaseTopic
._get
_project
_filter
(session
)
1957 _filter
["_id"] = nsInstanceId
1958 nsr
= self
.db
.get_one("nsrs", _filter
)
1961 if operation
== "terminate" and slice_object
is False:
1962 check_if_nsr_is_not_slice_member(session
, nsr
["_id"])
1964 not nsr
["_admin"].get("nsState")
1965 or nsr
["_admin"]["nsState"] == "NOT_INSTANTIATED"
1967 if operation
== "terminate" and indata
.get("autoremove"):
1968 # NSR must be deleted
1972 ) # a none in this case is used to indicate not instantiated. It can be removed
1973 if operation
!= "instantiate":
1974 raise EngineException(
1975 "ns_instance '{}' cannot be '{}' because it is not instantiated".format(
1976 nsInstanceId
, operation
1978 HTTPStatus
.CONFLICT
,
1981 if operation
== "instantiate" and not session
["force"]:
1982 raise EngineException(
1983 "ns_instance '{}' cannot be '{}' because it is already instantiated".format(
1984 nsInstanceId
, operation
1986 HTTPStatus
.CONFLICT
,
1988 self
._check
_ns
_operation
(session
, nsr
, operation
, indata
)
1990 if operation
== "instantiate":
1991 self
._update
_vnfrs
_from
_nsd
(nsr
)
1992 self
._update
_vnfrs
(session
, rollback
, nsr
, indata
)
1994 nslcmop_desc
= self
._create
_nslcmop
(nsInstanceId
, operation
, indata
)
1995 _id
= nslcmop_desc
["_id"]
1997 nslcmop_desc
, session
["project_id"], make_public
=session
["public"]
1999 if indata
.get("placement-engine"):
2000 # Save valid vim accounts in lcm operation descriptor
2001 nslcmop_desc
["operationParams"][
2003 ] = self
._get
_enabled
_vims
(session
)
2004 self
.db
.create("nslcmops", nslcmop_desc
)
2005 rollback
.append({"topic": "nslcmops", "_id": _id
})
2006 if not slice_object
:
2007 self
.msg
.write("ns", operation
, nslcmop_desc
)
2009 except ValidationError
as e
: # TODO remove try Except, it is captured at nbi.py
2010 raise EngineException(e
, HTTPStatus
.UNPROCESSABLE_ENTITY
)
2011 # except DbException as e:
2012 # raise EngineException("Cannot get ns_instance '{}': {}".format(e), HTTPStatus.NOT_FOUND)
2014 def delete(self
, session
, _id
, dry_run
=False, not_send_msg
=None):
2015 raise EngineException(
2016 "Method delete called directly", HTTPStatus
.INTERNAL_SERVER_ERROR
2019 def edit(self
, session
, _id
, indata
=None, kwargs
=None, content
=None):
2020 raise EngineException(
2021 "Method edit called directly", HTTPStatus
.INTERNAL_SERVER_ERROR
2025 class NsiTopic(BaseTopic
):
2028 quota_name
= "slice_instances"
2030 def __init__(self
, db
, fs
, msg
, auth
):
2031 BaseTopic
.__init
__(self
, db
, fs
, msg
, auth
)
2032 self
.nsrTopic
= NsrTopic(db
, fs
, msg
, auth
)
2035 def _format_ns_request(ns_request
):
2036 formated_request
= copy(ns_request
)
2037 # TODO: Add request params
2038 return formated_request
2041 def _format_addional_params(slice_request
):
2043 Get and format user additional params for NS or VNF
2044 :param slice_request: User instantiation additional parameters
2045 :return: a formatted copy of additional params or None if not supplied
2047 additional_params
= copy(slice_request
.get("additionalParamsForNsi"))
2048 if additional_params
:
2049 for k
, v
in additional_params
.items():
2050 if not isinstance(k
, str):
2051 raise EngineException(
2052 "Invalid param at additionalParamsForNsi:{}. Only string keys are allowed".format(
2056 if "." in k
or "$" in k
:
2057 raise EngineException(
2058 "Invalid param at additionalParamsForNsi:{}. Keys must not contain dots or $".format(
2062 if isinstance(v
, (dict, tuple, list)):
2063 additional_params
[k
] = "!!yaml " + safe_dump(v
)
2064 return additional_params
2066 def _check_descriptor_dependencies(self
, session
, descriptor
):
2068 Check that the dependent descriptors exist on a new descriptor or edition
2069 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
2070 :param descriptor: descriptor to be inserted or edit
2071 :return: None or raises exception
2073 if not descriptor
.get("nst-ref"):
2075 nstd_id
= descriptor
["nst-ref"]
2076 if not self
.get_item_list(session
, "nsts", {"id": nstd_id
}):
2077 raise EngineException(
2078 "Descriptor error at nst-ref='{}' references a non exist nstd".format(
2081 http_code
=HTTPStatus
.CONFLICT
,
2084 def check_conflict_on_del(self
, session
, _id
, db_content
):
2086 Check that NSI is not instantiated
2087 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
2088 :param _id: nsi internal id
2089 :param db_content: The database content of the _id
2090 :return: None or raises EngineException with the conflict
2092 if session
["force"]:
2095 if nsi
["_admin"].get("nsiState") == "INSTANTIATED":
2096 raise EngineException(
2097 "nsi '{}' cannot be deleted because it is in 'INSTANTIATED' state. "
2098 "Launch 'terminate' operation first; or force deletion".format(_id
),
2099 http_code
=HTTPStatus
.CONFLICT
,
2102 def delete_extra(self
, session
, _id
, db_content
, not_send_msg
=None):
2104 Deletes associated nsilcmops from database. Deletes associated filesystem.
2105 Set usageState of nst
2106 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
2107 :param _id: server internal id
2108 :param db_content: The database content of the descriptor
2109 :param not_send_msg: To not send message (False) or store content (list) instead
2110 :return: None if ok or raises EngineException with the problem
2113 # Deleting the nsrs belonging to nsir
2115 for nsrs_detailed_item
in nsir
["_admin"]["nsrs-detailed-list"]:
2116 nsr_id
= nsrs_detailed_item
["nsrId"]
2117 if nsrs_detailed_item
.get("shared"):
2119 "_admin.nsrs-detailed-list.ANYINDEX.shared": True,
2120 "_admin.nsrs-detailed-list.ANYINDEX.nsrId": nsr_id
,
2121 "_id.ne": nsir
["_id"],
2123 nsi
= self
.db
.get_one(
2124 "nsis", _filter
, fail_on_empty
=False, fail_on_more
=False
2126 if nsi
: # last one using nsr
2129 self
.nsrTopic
.delete(
2130 session
, nsr_id
, dry_run
=False, not_send_msg
=not_send_msg
2132 except (DbException
, EngineException
) as e
:
2133 if e
.http_code
== HTTPStatus
.NOT_FOUND
:
2138 # delete related nsilcmops database entries
2139 self
.db
.del_list("nsilcmops", {"netsliceInstanceId": _id
})
2141 # Check and set used NST usage state
2142 nsir_admin
= nsir
.get("_admin")
2143 if nsir_admin
and nsir_admin
.get("nst-id"):
2144 # check if used by another NSI
2145 nsis_list
= self
.db
.get_one(
2147 {"nst-id": nsir_admin
["nst-id"]},
2148 fail_on_empty
=False,
2154 {"_id": nsir_admin
["nst-id"]},
2155 {"_admin.usageState": "NOT_IN_USE"},
2158 def new(self
, rollback
, session
, indata
=None, kwargs
=None, headers
=None):
2160 Creates a new netslice instance record into database. It also creates needed nsrs and vnfrs
2161 :param rollback: list to append the created items at database in case a rollback must be done
2162 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
2163 :param indata: params to be used for the nsir
2164 :param kwargs: used to override the indata descriptor
2165 :param headers: http request headers
2166 :return: the _id of nsi descriptor created at database
2170 step
= "checking quotas"
2171 self
.check_quota(session
)
2174 slice_request
= self
._remove
_envelop
(indata
)
2175 # Override descriptor with query string kwargs
2176 self
._update
_input
_with
_kwargs
(slice_request
, kwargs
)
2177 slice_request
= self
._validate
_input
_new
(slice_request
, session
["force"])
2180 step
= "getting nstd id='{}' from database".format(
2181 slice_request
.get("nstId")
2183 _filter
= self
._get
_project
_filter
(session
)
2184 _filter
["_id"] = slice_request
["nstId"]
2185 nstd
= self
.db
.get_one("nsts", _filter
)
2186 # check NST is not disabled
2187 step
= "checking NST operationalState"
2188 if nstd
["_admin"]["operationalState"] == "DISABLED":
2189 raise EngineException(
2190 "nst with id '{}' is DISABLED, and thus cannot be used to create a netslice "
2191 "instance".format(slice_request
["nstId"]),
2192 http_code
=HTTPStatus
.CONFLICT
,
2196 # check NSD is not disabled
2197 step
= "checking operationalState"
2198 if nstd
["_admin"]["operationalState"] == "DISABLED":
2199 raise EngineException(
2200 "nst with id '{}' is DISABLED, and thus cannot be used to create "
2201 "a network slice".format(slice_request
["nstId"]),
2202 http_code
=HTTPStatus
.CONFLICT
,
2205 nstd
.pop("_admin", None)
2206 nstd_id
= nstd
.pop("_id", None)
2207 nsi_id
= str(uuid4())
2208 step
= "filling nsi_descriptor with input data"
2213 "name": slice_request
["nsiName"],
2214 "description": slice_request
.get("nsiDescription", ""),
2215 "datacenter": slice_request
["vimAccountId"],
2216 "nst-ref": nstd
["id"],
2217 "instantiation_parameters": slice_request
,
2218 "network-slice-template": nstd
,
2222 "additionalParamsForNsi": self
._format
_addional
_params
(slice_request
),
2225 step
= "creating nsi at database"
2227 nsi_descriptor
, session
["project_id"], make_public
=session
["public"]
2229 nsi_descriptor
["_admin"]["nsiState"] = "NOT_INSTANTIATED"
2230 nsi_descriptor
["_admin"]["netslice-subnet"] = None
2231 nsi_descriptor
["_admin"]["deployed"] = {}
2232 nsi_descriptor
["_admin"]["deployed"]["RO"] = []
2233 nsi_descriptor
["_admin"]["nst-id"] = nstd_id
2235 # Creating netslice-vld for the RO.
2236 step
= "creating netslice-vld at database"
2238 # Building the vlds list to be deployed
2239 # From netslice descriptors, creating the initial list
2242 for netslice_vlds
in get_iterable(nstd
.get("netslice-vld")):
2243 # Getting template Instantiation parameters from NST
2244 nsi_vld
= deepcopy(netslice_vlds
)
2245 nsi_vld
["shared-nsrs-list"] = []
2246 nsi_vld
["vimAccountId"] = slice_request
["vimAccountId"]
2247 nsi_vlds
.append(nsi_vld
)
2249 nsi_descriptor
["_admin"]["netslice-vld"] = nsi_vlds
2250 # Creating netslice-subnet_record.
2254 # Updating the nstd with the nsd["_id"] associated to the nss -> services list
2255 for member_ns
in nstd
["netslice-subnet"]:
2256 nsd_id
= member_ns
["nsd-ref"]
2257 step
= "getting nstd id='{}' constituent-nsd='{}' from database".format(
2258 member_ns
["nsd-ref"], member_ns
["id"]
2260 if nsd_id
not in needed_nsds
:
2262 _filter
["id"] = nsd_id
2263 nsd
= self
.db
.get_one(
2264 "nsds", _filter
, fail_on_empty
=True, fail_on_more
=True
2268 needed_nsds
[nsd_id
] = nsd
2270 nsd
= needed_nsds
[nsd_id
]
2271 member_ns
["_id"] = needed_nsds
[nsd_id
].get("_id")
2272 services
.append(member_ns
)
2274 step
= "filling nsir nsd-id='{}' constituent-nsd='{}' from database".format(
2275 member_ns
["nsd-ref"], member_ns
["id"]
2278 # creates Network Services records (NSRs)
2279 step
= "creating nsrs at database using NsrTopic.new()"
2280 ns_params
= slice_request
.get("netslice-subnet")
2282 nsi_netslice_subnet
= []
2283 for service
in services
:
2284 # Check if the netslice-subnet is shared and if it is share if the nss exists
2287 # Is the nss shared and instantiated?
2288 _filter
["_admin.nsrs-detailed-list.ANYINDEX.shared"] = True
2289 _filter
["_admin.nsrs-detailed-list.ANYINDEX.nsd-id"] = service
[
2292 _filter
["_admin.nsrs-detailed-list.ANYINDEX.nss-id"] = service
["id"]
2293 nsi
= self
.db
.get_one(
2294 "nsis", _filter
, fail_on_empty
=False, fail_on_more
=False
2296 if nsi
and service
.get("is-shared-nss"):
2297 nsrs_detailed_list
= nsi
["_admin"]["nsrs-detailed-list"]
2298 for nsrs_detailed_item
in nsrs_detailed_list
:
2299 if nsrs_detailed_item
["nsd-id"] == service
["nsd-ref"]:
2300 if nsrs_detailed_item
["nss-id"] == service
["id"]:
2301 _id_nsr
= nsrs_detailed_item
["nsrId"]
2303 for netslice_subnet
in nsi
["_admin"]["netslice-subnet"]:
2304 if netslice_subnet
["nss-id"] == service
["id"]:
2305 indata_ns
= netslice_subnet
2309 if service
.get("instantiation-parameters"):
2310 indata_ns
= deepcopy(service
["instantiation-parameters"])
2311 # del service["instantiation-parameters"]
2313 indata_ns
["nsdId"] = service
["_id"]
2314 indata_ns
["nsName"] = (
2315 slice_request
.get("nsiName") + "." + service
["id"]
2317 indata_ns
["vimAccountId"] = slice_request
.get("vimAccountId")
2318 indata_ns
["nsDescription"] = service
["description"]
2319 if slice_request
.get("ssh_keys"):
2320 indata_ns
["ssh_keys"] = slice_request
.get("ssh_keys")
2323 for ns_param
in ns_params
:
2324 if ns_param
.get("id") == service
["id"]:
2325 copy_ns_param
= deepcopy(ns_param
)
2326 del copy_ns_param
["id"]
2327 indata_ns
.update(copy_ns_param
)
2330 # Creates Nsr objects
2331 _id_nsr
, _
= self
.nsrTopic
.new(
2332 rollback
, session
, indata_ns
, kwargs
, headers
2336 "shared": service
.get("is-shared-nss"),
2337 "nsd-id": service
["nsd-ref"],
2338 "nss-id": service
["id"],
2339 "nslcmop_instantiate": None,
2341 indata_ns
["nss-id"] = service
["id"]
2342 nsrs_list
.append(nsrs_item
)
2343 nsi_netslice_subnet
.append(indata_ns
)
2344 nsr_ref
= {"nsr-ref": _id_nsr
}
2345 nsi_descriptor
["nsr-ref-list"].append(nsr_ref
)
2347 # Adding the nsrs list to the nsi
2348 nsi_descriptor
["_admin"]["nsrs-detailed-list"] = nsrs_list
2349 nsi_descriptor
["_admin"]["netslice-subnet"] = nsi_netslice_subnet
2351 "nsts", {"_id": slice_request
["nstId"]}, {"_admin.usageState": "IN_USE"}
2354 # Creating the entry in the database
2355 self
.db
.create("nsis", nsi_descriptor
)
2356 rollback
.append({"topic": "nsis", "_id": nsi_id
})
2358 except Exception as e
: # TODO remove try Except, it is captured at nbi.py
2359 self
.logger
.exception(
2360 "Exception {} at NsiTopic.new()".format(e
), exc_info
=True
2362 raise EngineException("Error {}: {}".format(step
, e
))
2363 except ValidationError
as e
:
2364 raise EngineException(e
, HTTPStatus
.UNPROCESSABLE_ENTITY
)
2366 def edit(self
, session
, _id
, indata
=None, kwargs
=None, content
=None):
2367 raise EngineException(
2368 "Method edit called directly", HTTPStatus
.INTERNAL_SERVER_ERROR
2372 class NsiLcmOpTopic(BaseTopic
):
2375 operation_schema
= { # mapping between operation and jsonschema to validate
2376 "instantiate": nsi_instantiate
,
2380 def __init__(self
, db
, fs
, msg
, auth
):
2381 BaseTopic
.__init
__(self
, db
, fs
, msg
, auth
)
2382 self
.nsi_NsLcmOpTopic
= NsLcmOpTopic(self
.db
, self
.fs
, self
.msg
, self
.auth
)
2384 def _check_nsi_operation(self
, session
, nsir
, operation
, indata
):
2386 Check that user has enter right parameters for the operation
2387 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
2388 :param operation: it can be: instantiate, terminate, action, TODO: update, heal
2389 :param indata: descriptor with the parameters of the operation
2393 nstd
= nsir
["network-slice-template"]
2395 def check_valid_netslice_subnet_id(nstId
):
2396 # TODO change to vnfR (??)
2397 for netslice_subnet
in nstd
["netslice-subnet"]:
2398 if nstId
== netslice_subnet
["id"]:
2399 nsd_id
= netslice_subnet
["nsd-ref"]
2400 if nsd_id
not in nsds
:
2401 _filter
= self
._get
_project
_filter
(session
)
2402 _filter
["id"] = nsd_id
2403 nsds
[nsd_id
] = self
.db
.get_one("nsds", _filter
)
2406 raise EngineException(
2407 "Invalid parameter nstId='{}' is not one of the "
2408 "nst:netslice-subnet".format(nstId
)
2411 if operation
== "instantiate":
2412 # check the existance of netslice-subnet items
2413 for in_nst
in get_iterable(indata
.get("netslice-subnet")):
2414 check_valid_netslice_subnet_id(in_nst
["id"])
2416 def _create_nsilcmop(self
, session
, netsliceInstanceId
, operation
, params
):
2422 "operationState": "PROCESSING", # COMPLETED,PARTIALLY_COMPLETED,FAILED_TEMP,FAILED,ROLLING_BACK,ROLLED_BACK
2423 "statusEnteredTime": now
,
2424 "netsliceInstanceId": netsliceInstanceId
,
2425 "lcmOperationType": operation
,
2427 "isAutomaticInvocation": False,
2428 "operationParams": params
,
2429 "isCancelPending": False,
2431 "self": "/osm/nsilcm/v1/nsi_lcm_op_occs/" + _id
,
2432 "netsliceInstanceId": "/osm/nsilcm/v1/netslice_instances/"
2433 + netsliceInstanceId
,
2438 def add_shared_nsr_2vld(self
, nsir
, nsr_item
):
2439 for nst_sb_item
in nsir
["network-slice-template"].get("netslice-subnet"):
2440 if nst_sb_item
.get("is-shared-nss"):
2441 for admin_subnet_item
in nsir
["_admin"].get("netslice-subnet"):
2442 if admin_subnet_item
["nss-id"] == nst_sb_item
["id"]:
2443 for admin_vld_item
in nsir
["_admin"].get("netslice-vld"):
2444 for admin_vld_nss_cp_ref_item
in admin_vld_item
[
2445 "nss-connection-point-ref"
2448 admin_subnet_item
["nss-id"]
2449 == admin_vld_nss_cp_ref_item
["nss-ref"]
2452 not nsr_item
["nsrId"]
2453 in admin_vld_item
["shared-nsrs-list"]
2455 admin_vld_item
["shared-nsrs-list"].append(
2459 # self.db.set_one("nsis", {"_id": nsir["_id"]}, nsir)
2462 {"_id": nsir
["_id"]},
2463 {"_admin.netslice-vld": nsir
["_admin"].get("netslice-vld")},
2466 def new(self
, rollback
, session
, indata
=None, kwargs
=None, headers
=None):
2468 Performs a new operation over a ns
2469 :param rollback: list to append created items at database in case a rollback must to be done
2470 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
2471 :param indata: descriptor with the parameters of the operation. It must contains among others
2472 netsliceInstanceId: _id of the nsir to perform the operation
2473 operation: it can be: instantiate, terminate, action, TODO: update, heal
2474 :param kwargs: used to override the indata descriptor
2475 :param headers: http request headers
2476 :return: id of the nslcmops
2479 # Override descriptor with query string kwargs
2480 self
._update
_input
_with
_kwargs
(indata
, kwargs
)
2481 operation
= indata
["lcmOperationType"]
2482 netsliceInstanceId
= indata
["netsliceInstanceId"]
2483 validate_input(indata
, self
.operation_schema
[operation
])
2485 # get nsi from netsliceInstanceId
2486 _filter
= self
._get
_project
_filter
(session
)
2487 _filter
["_id"] = netsliceInstanceId
2488 nsir
= self
.db
.get_one("nsis", _filter
)
2489 logging_prefix
= "nsi={} {} ".format(netsliceInstanceId
, operation
)
2494 not nsir
["_admin"].get("nsiState")
2495 or nsir
["_admin"]["nsiState"] == "NOT_INSTANTIATED"
2497 if operation
== "terminate" and indata
.get("autoremove"):
2498 # NSIR must be deleted
2502 ) # a none in this case is used to indicate not instantiated. It can be removed
2503 if operation
!= "instantiate":
2504 raise EngineException(
2505 "netslice_instance '{}' cannot be '{}' because it is not instantiated".format(
2506 netsliceInstanceId
, operation
2508 HTTPStatus
.CONFLICT
,
2511 if operation
== "instantiate" and not session
["force"]:
2512 raise EngineException(
2513 "netslice_instance '{}' cannot be '{}' because it is already instantiated".format(
2514 netsliceInstanceId
, operation
2516 HTTPStatus
.CONFLICT
,
2519 # Creating all the NS_operation (nslcmop)
2520 # Get service list from db
2521 nsrs_list
= nsir
["_admin"]["nsrs-detailed-list"]
2523 # nslcmops_item = None
2524 for index
, nsr_item
in enumerate(nsrs_list
):
2525 nsr_id
= nsr_item
["nsrId"]
2526 if nsr_item
.get("shared"):
2527 _filter
["_admin.nsrs-detailed-list.ANYINDEX.shared"] = True
2528 _filter
["_admin.nsrs-detailed-list.ANYINDEX.nsrId"] = nsr_id
2530 "_admin.nsrs-detailed-list.ANYINDEX.nslcmop_instantiate.ne"
2532 _filter
["_id.ne"] = netsliceInstanceId
2533 nsi
= self
.db
.get_one(
2534 "nsis", _filter
, fail_on_empty
=False, fail_on_more
=False
2536 if operation
== "terminate":
2538 "_admin.nsrs-detailed-list.{}.nslcmop_instantiate".format(
2542 self
.db
.set_one("nsis", {"_id": nsir
["_id"]}, _update
)
2545 ): # other nsi is using this nsr and it needs this nsr instantiated
2546 continue # do not create nsilcmop
2548 # looks the first nsi fulfilling the conditions but not being the current NSIR
2550 nsi_nsr_item
= next(
2552 for n
in nsi
["_admin"]["nsrs-detailed-list"]
2553 if n
["nsrId"] == nsr_id
2555 and n
["nslcmop_instantiate"]
2557 self
.add_shared_nsr_2vld(nsir
, nsr_item
)
2558 nslcmops
.append(nsi_nsr_item
["nslcmop_instantiate"])
2560 "_admin.nsrs-detailed-list.{}".format(
2564 self
.db
.set_one("nsis", {"_id": nsir
["_id"]}, _update
)
2565 # continue to not create nslcmop since nsrs is shared and nsrs was created
2568 self
.add_shared_nsr_2vld(nsir
, nsr_item
)
2573 "lcmOperationType": operation
,
2574 "nsInstanceId": nsr_id
,
2575 # Including netslice_id in the ns instantiate Operation
2576 "netsliceInstanceId": netsliceInstanceId
,
2578 if operation
== "instantiate":
2579 service
= self
.db
.get_one("nsrs", {"_id": nsr_id
})
2580 indata_ns
.update(service
["instantiate_params"])
2582 # Creating NS_LCM_OP with the flag slice_object=True to not trigger the service instantiation
2583 # message via kafka bus
2584 nslcmop
, _
= self
.nsi_NsLcmOpTopic
.new(
2585 rollback
, session
, indata_ns
, None, headers
, slice_object
=True
2587 nslcmops
.append(nslcmop
)
2588 if operation
== "instantiate":
2590 "_admin.nsrs-detailed-list.{}.nslcmop_instantiate".format(
2594 self
.db
.set_one("nsis", {"_id": nsir
["_id"]}, _update
)
2595 except (DbException
, EngineException
) as e
:
2596 if e
.http_code
== HTTPStatus
.NOT_FOUND
:
2599 + "skipping NS={} because not found".format(nsr_id
)
2606 indata
["nslcmops_ids"] = nslcmops
2607 self
._check
_nsi
_operation
(session
, nsir
, operation
, indata
)
2609 nsilcmop_desc
= self
._create
_nsilcmop
(
2610 session
, netsliceInstanceId
, operation
, indata
2613 nsilcmop_desc
, session
["project_id"], make_public
=session
["public"]
2615 _id
= self
.db
.create("nsilcmops", nsilcmop_desc
)
2616 rollback
.append({"topic": "nsilcmops", "_id": _id
})
2617 self
.msg
.write("nsi", operation
, nsilcmop_desc
)
2619 except ValidationError
as e
:
2620 raise EngineException(e
, HTTPStatus
.UNPROCESSABLE_ENTITY
)
2622 def delete(self
, session
, _id
, dry_run
=False, not_send_msg
=None):
2623 raise EngineException(
2624 "Method delete called directly", HTTPStatus
.INTERNAL_SERVER_ERROR
2627 def edit(self
, session
, _id
, indata
=None, kwargs
=None, content
=None):
2628 raise EngineException(
2629 "Method edit called directly", HTTPStatus
.INTERNAL_SERVER_ERROR