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.
18 from uuid
import uuid4
19 from http
import HTTPStatus
21 from copy
import copy
, deepcopy
22 from osm_nbi
.validation
import (
31 from osm_nbi
.base_topic
import (
38 from yaml
import safe_dump
39 from osm_common
.dbbase
import DbException
40 from osm_common
.msgbase
import MsgException
41 from osm_common
.fsbase
import FsException
42 from osm_nbi
import utils
45 ) # For checking that additional parameter names are valid Jinja2 identifiers
47 __author__
= "Alfonso Tierno <alfonso.tiernosepulveda@telefonica.com>"
50 class NsrTopic(BaseTopic
):
53 quota_name
= "ns_instances"
54 schema_new
= ns_instantiate
56 def __init__(self
, db
, fs
, msg
, auth
):
57 BaseTopic
.__init
__(self
, db
, fs
, msg
, auth
)
59 def _check_descriptor_dependencies(self
, session
, descriptor
):
61 Check that the dependent descriptors exist on a new descriptor or edition
62 :param session: client session information
63 :param descriptor: descriptor to be inserted or edit
64 :return: None or raises exception
66 if not descriptor
.get("nsdId"):
68 nsd_id
= descriptor
["nsdId"]
69 if not self
.get_item_list(session
, "nsds", {"id": nsd_id
}):
70 raise EngineException(
71 "Descriptor error at nsdId='{}' references a non exist nsd".format(
74 http_code
=HTTPStatus
.CONFLICT
,
78 def format_on_new(content
, project_id
=None, make_public
=False):
79 BaseTopic
.format_on_new(content
, project_id
=project_id
, make_public
=make_public
)
80 content
["_admin"]["nsState"] = "NOT_INSTANTIATED"
83 def check_conflict_on_del(self
, session
, _id
, db_content
):
85 Check that NSR is not instantiated
86 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
87 :param _id: nsr internal id
88 :param db_content: The database content of the nsr
89 :return: None or raises EngineException with the conflict
94 if nsr
["_admin"].get("nsState") == "INSTANTIATED":
95 raise EngineException(
96 "nsr '{}' cannot be deleted because it is in 'INSTANTIATED' state. "
97 "Launch 'terminate' operation first; or force deletion".format(_id
),
98 http_code
=HTTPStatus
.CONFLICT
,
101 def delete_extra(self
, session
, _id
, db_content
, not_send_msg
=None):
103 Deletes associated nslcmops and vnfrs from database. Deletes associated filesystem.
104 Set usageState of pdu, vnfd, nsd
105 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
106 :param _id: server internal id
107 :param db_content: The database content of the descriptor
108 :param not_send_msg: To not send message (False) or store content (list) instead
109 :return: None if ok or raises EngineException with the problem
111 self
.fs
.file_delete(_id
, ignore_non_exist
=True)
112 self
.db
.del_list("nslcmops", {"nsInstanceId": _id
})
113 self
.db
.del_list("vnfrs", {"nsr-id-ref": _id
})
115 # set all used pdus as free
118 {"_admin.usage.nsr_id": _id
},
119 {"_admin.usageState": "NOT_IN_USE", "_admin.usage": None},
124 used_nsd_id
= nsr
.get("nsd-id")
126 # check if used by another NSR
127 nsrs_list
= self
.db
.get_one(
128 "nsrs", {"nsd-id": used_nsd_id
}, fail_on_empty
=False, fail_on_more
=False
132 "nsds", {"_id": used_nsd_id
}, {"_admin.usageState": "NOT_IN_USE"}
135 # Set VNFD usageState
136 used_vnfd_id_list
= nsr
.get("vnfd-id")
137 if used_vnfd_id_list
:
138 for used_vnfd_id
in used_vnfd_id_list
:
139 # check if used by another NSR
140 nsrs_list
= self
.db
.get_one(
142 {"vnfd-id": used_vnfd_id
},
149 {"_id": used_vnfd_id
},
150 {"_admin.usageState": "NOT_IN_USE"},
153 # delete extra ro_nsrs used for internal RO module
154 self
.db
.del_one("ro_nsrs", q_filter
={"_id": _id
}, fail_on_empty
=False)
157 def _format_ns_request(ns_request
):
158 formated_request
= copy(ns_request
)
159 formated_request
.pop("additionalParamsForNs", None)
160 formated_request
.pop("additionalParamsForVnf", None)
161 return formated_request
164 def _format_additional_params(
165 ns_request
, member_vnf_index
=None, vdu_id
=None, kdu_name
=None, descriptor
=None
168 Get and format user additional params for NS or VNF
169 :param ns_request: User instantiation additional parameters
170 :param member_vnf_index: None for extract NS params, or member_vnf_index to extract VNF params
171 :param descriptor: If not None it check that needed parameters of descriptor are supplied
172 :return: tuple with a formatted copy of additional params or None if not supplied, plus other parameters
174 additional_params
= None
176 if not member_vnf_index
:
177 additional_params
= copy(ns_request
.get("additionalParamsForNs"))
178 where_
= "additionalParamsForNs"
179 elif ns_request
.get("additionalParamsForVnf"):
180 where_
= "additionalParamsForVnf[member-vnf-index={}]".format(
186 for x
in ns_request
["additionalParamsForVnf"]
187 if x
["member-vnf-index"] == member_vnf_index
192 if not vdu_id
and not kdu_name
:
194 additional_params
= copy(item
.get("additionalParams")) or {}
195 if vdu_id
and item
.get("additionalParamsForVdu"):
199 for x
in item
["additionalParamsForVdu"]
200 if x
["vdu_id"] == vdu_id
204 other_params
= item_vdu
205 if item_vdu
and item_vdu
.get("additionalParams"):
206 where_
+= ".additionalParamsForVdu[vdu_id={}]".format(vdu_id
)
207 additional_params
= item_vdu
["additionalParams"]
209 additional_params
= {}
210 if item
.get("additionalParamsForKdu"):
214 for x
in item
["additionalParamsForKdu"]
215 if x
["kdu_name"] == kdu_name
219 other_params
= item_kdu
220 if item_kdu
and item_kdu
.get("additionalParams"):
221 where_
+= ".additionalParamsForKdu[kdu_name={}]".format(
224 additional_params
= item_kdu
["additionalParams"]
226 if additional_params
:
227 for k
, v
in additional_params
.items():
228 # BEGIN Check that additional parameter names are valid Jinja2 identifiers if target is not Kdu
229 if not kdu_name
and not match("^[a-zA-Z_][a-zA-Z0-9_]*$", k
):
230 raise EngineException(
231 "Invalid param name at {}:{}. Must contain only alphanumeric characters "
232 "and underscores, and cannot start with a digit".format(
236 # END Check that additional parameter names are valid Jinja2 identifiers
237 if not isinstance(k
, str):
238 raise EngineException(
239 "Invalid param at {}:{}. Only string keys are allowed".format(
244 raise EngineException(
245 "Invalid param at {}:{}. Keys must not contain $ symbol".format(
249 if isinstance(v
, (dict, tuple, list)):
250 additional_params
[k
] = "!!yaml " + safe_dump(v
)
252 additional_params
= json
.dumps(additional_params
)
255 for df
in descriptor
.get("df", []):
256 # check that enough parameters are supplied for the initial-config-primitive
257 # TODO: check for cloud-init
259 initial_primitives
= []
261 "lcm-operations-configuration" in df
262 and "operate-vnf-op-config"
263 in df
["lcm-operations-configuration"]
265 for config
in df
["lcm-operations-configuration"][
266 "operate-vnf-op-config"
268 for primitive
in get_iterable(
269 config
.get("initial-config-primitive")
271 initial_primitives
.append(primitive
)
273 initial_primitives
= deep_get(
274 descriptor
, ("ns-configuration", "initial-config-primitive")
277 for initial_primitive
in get_iterable(initial_primitives
):
278 for param
in get_iterable(initial_primitive
.get("parameter")):
279 if param
["value"].startswith("<") and param
["value"].endswith(
282 if param
["value"] in (
289 not additional_params
290 or param
["value"][1:-1] not in additional_params
292 raise EngineException(
293 "Parameter '{}' needed for vnfd[id={}]:day1-2 configuration:"
294 "initial-config-primitive[name={}] not supplied".format(
297 initial_primitive
["name"],
301 return additional_params
or None, other_params
or None
303 def new(self
, rollback
, session
, indata
=None, kwargs
=None, headers
=None):
305 Creates a new nsr into database. It also creates needed vnfrs
306 :param rollback: list to append the created items at database in case a rollback must be done
307 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
308 :param indata: params to be used for the nsr
309 :param kwargs: used to override the indata descriptor
310 :param headers: http request headers
311 :return: the _id of nsr descriptor created at database. Or an exception of type
312 EngineException, ValidationError, DbException, FsException, MsgException.
313 Note: Exceptions are not captured on purpose. They should be captured at called
316 step
= "checking quotas"
317 self
.check_quota(session
)
319 step
= "validating input parameters"
320 ns_request
= self
._remove
_envelop
(indata
)
321 self
._update
_input
_with
_kwargs
(ns_request
, kwargs
)
322 ns_request
= self
._validate
_input
_new
(ns_request
, session
["force"])
324 step
= "getting nsd id='{}' from database".format(ns_request
.get("nsdId"))
325 nsd
= self
._get
_nsd
_from
_db
(ns_request
["nsdId"], session
)
326 ns_k8s_namespace
= self
._get
_ns
_k
8s
_namespace
(nsd
, ns_request
, session
)
328 step
= "checking nsdOperationalState"
329 self
._check
_nsd
_operational
_state
(nsd
, ns_request
)
331 step
= "filling nsr from input data"
332 nsr_id
= str(uuid4())
333 nsr_descriptor
= self
._create
_nsr
_descriptor
_from
_nsd
(
334 nsd
, ns_request
, nsr_id
, session
339 # TODO: Change for multiple df support
340 vnf_profiles
= nsd
.get("df", [[]])[0].get("vnf-profile", ())
341 for vnfp
in vnf_profiles
:
342 vnfd_id
= vnfp
.get("vnfd-id")
343 vnf_index
= vnfp
.get("id")
345 "getting vnfd id='{}' constituent-vnfd='{}' from database".format(
349 if vnfd_id
not in needed_vnfds
:
350 vnfd
= self
._get
_vnfd
_from
_db
(vnfd_id
, session
)
351 needed_vnfds
[vnfd_id
] = vnfd
352 nsr_descriptor
["vnfd-id"].append(vnfd
["_id"])
354 vnfd
= needed_vnfds
[vnfd_id
]
356 step
= "filling vnfr vnfd-id='{}' constituent-vnfd='{}'".format(
359 vnfr_descriptor
= self
._create
_vnfr
_descriptor
_from
_vnfd
(
369 step
= "creating vnfr vnfd-id='{}' constituent-vnfd='{}' at database".format(
372 self
._add
_vnfr
_to
_db
(vnfr_descriptor
, rollback
, session
)
373 nsr_descriptor
["constituent-vnfr-ref"].append(vnfr_descriptor
["id"])
375 step
= "creating nsr at database"
376 self
._add
_nsr
_to
_db
(nsr_descriptor
, rollback
, session
)
378 step
= "creating nsr temporal folder"
379 self
.fs
.mkdir(nsr_id
)
389 raise type(e
)("{} while '{}'".format(e
, step
), http_code
=e
.http_code
)
391 def _get_nsd_from_db(self
, nsd_id
, session
):
392 _filter
= self
._get
_project
_filter
(session
)
393 _filter
["_id"] = nsd_id
394 return self
.db
.get_one("nsds", _filter
)
396 def _get_vnfd_from_db(self
, vnfd_id
, session
):
397 _filter
= self
._get
_project
_filter
(session
)
398 _filter
["id"] = vnfd_id
399 vnfd
= self
.db
.get_one("vnfds", _filter
, fail_on_empty
=True, fail_on_more
=True)
403 def _add_nsr_to_db(self
, nsr_descriptor
, rollback
, session
):
405 nsr_descriptor
, session
["project_id"], make_public
=session
["public"]
407 self
.db
.create("nsrs", nsr_descriptor
)
408 rollback
.append({"topic": "nsrs", "_id": nsr_descriptor
["id"]})
410 def _add_vnfr_to_db(self
, vnfr_descriptor
, rollback
, session
):
412 vnfr_descriptor
, session
["project_id"], make_public
=session
["public"]
414 self
.db
.create("vnfrs", vnfr_descriptor
)
415 rollback
.append({"topic": "vnfrs", "_id": vnfr_descriptor
["id"]})
417 def _check_nsd_operational_state(self
, nsd
, ns_request
):
418 if nsd
["_admin"]["operationalState"] == "DISABLED":
419 raise EngineException(
420 "nsd with id '{}' is DISABLED, and thus cannot be used to create "
421 "a network service".format(ns_request
["nsdId"]),
422 http_code
=HTTPStatus
.CONFLICT
,
425 def _get_ns_k8s_namespace(self
, nsd
, ns_request
, session
):
426 additional_params
, _
= self
._format
_additional
_params
(
427 ns_request
, descriptor
=nsd
429 # use for k8s-namespace from ns_request or additionalParamsForNs. By default, the project_id
430 ns_k8s_namespace
= session
["project_id"][0] if session
["project_id"] else None
431 if ns_request
and ns_request
.get("k8s-namespace"):
432 ns_k8s_namespace
= ns_request
["k8s-namespace"]
433 if additional_params
and additional_params
.get("k8s-namespace"):
434 ns_k8s_namespace
= additional_params
["k8s-namespace"]
436 return ns_k8s_namespace
438 def _create_nsr_descriptor_from_nsd(self
, nsd
, ns_request
, nsr_id
, session
):
440 additional_params
, _
= self
._format
_additional
_params
(
441 ns_request
, descriptor
=nsd
445 "name": ns_request
["nsName"],
446 "name-ref": ns_request
["nsName"],
447 "short-name": ns_request
["nsName"],
448 "admin-status": "ENABLED",
449 "nsState": "NOT_INSTANTIATED",
450 "currentOperation": "IDLE",
451 "currentOperationID": None,
452 "errorDescription": None,
454 "deploymentStatus": None,
455 "configurationStatus": None,
457 "nsd": {k
: v
for k
, v
in nsd
.items()},
458 "datacenter": ns_request
["vimAccountId"],
459 "resource-orchestrator": "osmopenmano",
460 "description": ns_request
.get("nsDescription", ""),
461 "constituent-vnfr-ref": [],
462 "operational-status": "init", # typedef ns-operational-
463 "config-status": "init", # typedef config-states
464 "detailed-status": "scheduled",
465 "orchestration-progress": {},
467 "nsd-name-ref": nsd
["name"],
468 "operational-events": [], # "id", "timestamp", "description", "event",
469 "nsd-ref": nsd
["id"],
470 "nsd-id": nsd
["_id"],
472 "instantiate_params": self
._format
_ns
_request
(ns_request
),
473 "additionalParamsForNs": additional_params
,
474 "ns-instance-config-ref": nsr_id
,
477 "ssh-authorized-key": ns_request
.get("ssh_keys"), # TODO remove
481 ns_request
["nsr_id"] = nsr_id
482 if ns_request
and ns_request
.get("config-units"):
483 nsr_descriptor
["config-units"] = ns_request
["config-units"]
485 if nsd
.get("virtual-link-desc"):
486 nsr_vld
= deepcopy(nsd
.get("virtual-link-desc", []))
487 # Fill each vld with vnfd-connection-point-ref data
488 # TODO: Change for multiple df support
489 all_vld_connection_point_data
= {vld
.get("id"): [] for vld
in nsr_vld
}
490 vnf_profiles
= nsd
.get("df", [[]])[0].get("vnf-profile", ())
491 for vnf_profile
in vnf_profiles
:
492 for vlc
in vnf_profile
.get("virtual-link-connectivity", ()):
493 for cpd
in vlc
.get("constituent-cpd-id", ()):
494 all_vld_connection_point_data
[
495 vlc
.get("virtual-link-profile-id")
498 "member-vnf-index-ref": cpd
.get(
499 "constituent-base-element-id"
501 "vnfd-connection-point-ref": cpd
.get(
504 "vnfd-id-ref": vnf_profile
.get("vnfd-id"),
508 vnfd
= self
._get
_vnfd
_from
_db
(vnf_profile
.get("vnfd-id"), session
)
510 for vdu
in vnfd
.get("vdu", ()):
513 # Find this vdu compute and storage descriptors
514 vdu_virtual_compute
= {}
515 vdu_virtual_storage
= {}
516 for vcd
in vnfd
.get("virtual-compute-desc", ()):
517 if vcd
.get("id") == vdu
.get("virtual-compute-desc"):
518 vdu_virtual_compute
= vcd
519 for vsd
in vnfd
.get("virtual-storage-desc", ()):
520 if vsd
.get("id") == vdu
.get("virtual-storage-desc", [[]])[0]:
521 vdu_virtual_storage
= vsd
522 # Get this vdu vcpus, memory and storage info for flavor_data
523 if vdu_virtual_compute
.get("virtual-cpu", {}).get(
526 flavor_data
["vcpu-count"] = vdu_virtual_compute
["virtual-cpu"][
529 if vdu_virtual_compute
.get("virtual-memory", {}).get("size"):
530 flavor_data
["memory-mb"] = (
531 float(vdu_virtual_compute
["virtual-memory"]["size"])
534 if vdu_virtual_storage
.get("size-of-storage"):
535 flavor_data
["storage-gb"] = vdu_virtual_storage
[
538 # Get this vdu EPA info for guest_epa
539 if vdu_virtual_compute
.get("virtual-cpu", {}).get("cpu-quota"):
540 guest_epa
["cpu-quota"] = vdu_virtual_compute
["virtual-cpu"][
543 if vdu_virtual_compute
.get("virtual-cpu", {}).get("pinning"):
544 vcpu_pinning
= vdu_virtual_compute
["virtual-cpu"]["pinning"]
545 if vcpu_pinning
.get("thread-policy"):
546 guest_epa
["cpu-thread-pinning-policy"] = vcpu_pinning
[
549 if vcpu_pinning
.get("policy"):
552 if vcpu_pinning
["policy"] == "dynamic"
555 guest_epa
["cpu-pinning-policy"] = cpu_policy
556 if vdu_virtual_compute
.get("virtual-memory", {}).get("mem-quota"):
557 guest_epa
["mem-quota"] = vdu_virtual_compute
["virtual-memory"][
560 if vdu_virtual_compute
.get("virtual-memory", {}).get(
563 guest_epa
["mempage-size"] = vdu_virtual_compute
[
566 if vdu_virtual_compute
.get("virtual-memory", {}).get(
569 guest_epa
["numa-node-policy"] = vdu_virtual_compute
[
571 ]["numa-node-policy"]
572 if vdu_virtual_storage
.get("disk-io-quota"):
573 guest_epa
["disk-io-quota"] = vdu_virtual_storage
[
578 flavor_data
["guest-epa"] = guest_epa
580 flavor_data
["name"] = vdu
["id"][:56] + "-flv"
581 flavor_data
["id"] = str(len(nsr_descriptor
["flavor"]))
582 nsr_descriptor
["flavor"].append(flavor_data
)
584 sw_image_id
= vdu
.get("sw-image-desc")
586 image_data
= self
._get
_image
_data
_from
_vnfd
(vnfd
, sw_image_id
)
587 self
._add
_image
_to
_nsr
(nsr_descriptor
, image_data
)
589 # also add alternative images to the list of images
590 for alt_image
in vdu
.get("alternative-sw-image-desc", ()):
591 image_data
= self
._get
_image
_data
_from
_vnfd
(vnfd
, alt_image
)
592 self
._add
_image
_to
_nsr
(nsr_descriptor
, image_data
)
595 vld
["vnfd-connection-point-ref"] = all_vld_connection_point_data
.get(
598 vld
["name"] = vld
["id"]
599 nsr_descriptor
["vld"] = nsr_vld
601 return nsr_descriptor
603 def _get_image_data_from_vnfd(self
, vnfd
, sw_image_id
):
604 sw_image_desc
= utils
.find_in_list(
605 vnfd
.get("sw-image-desc", ()), lambda sw
: sw
["id"] == sw_image_id
608 if sw_image_desc
.get("image"):
609 image_data
["image"] = sw_image_desc
["image"]
610 if sw_image_desc
.get("checksum"):
611 image_data
["image_checksum"] = sw_image_desc
["checksum"]["hash"]
612 if sw_image_desc
.get("vim-type"):
613 image_data
["vim-type"] = sw_image_desc
["vim-type"]
616 def _add_image_to_nsr(self
, nsr_descriptor
, image_data
):
618 Adds image to nsr checking first it is not already added
623 for f
in nsr_descriptor
["image"]
624 if all(f
.get(k
) == image_data
[k
] for k
in image_data
)
629 image_data
["id"] = str(len(nsr_descriptor
["image"]))
630 nsr_descriptor
["image"].append(image_data
)
632 def _create_vnfr_descriptor_from_vnfd(
642 vnfr_id
= str(uuid4())
643 nsr_id
= nsr_descriptor
["id"]
645 additional_params
, vnf_params
= self
._format
_additional
_params
(
646 ns_request
, vnf_index
, descriptor
=vnfd
652 "nsr-id-ref": nsr_id
,
653 "member-vnf-index-ref": vnf_index
,
654 "additionalParamsForVnf": additional_params
,
656 # "vnfd": vnfd, # at OSM model.but removed to avoid data duplication TODO: revise
658 "vnfd-id": vnfd
["_id"], # not at OSM model, but useful
659 "vim-account-id": None,
662 "connection-point": [],
663 "ip-address": None, # mgmt-interface filled by LCM
665 vnf_k8s_namespace
= ns_k8s_namespace
667 if vnf_params
.get("k8s-namespace"):
668 vnf_k8s_namespace
= vnf_params
["k8s-namespace"]
669 if vnf_params
.get("config-units"):
670 vnfr_descriptor
["config-units"] = vnf_params
["config-units"]
673 if vnfd
.get("int-virtual-link-desc"):
674 vnfr_descriptor
["vld"] = []
675 for vnfd_vld
in vnfd
.get("int-virtual-link-desc"):
676 vnfr_descriptor
["vld"].append({key
: vnfd_vld
[key
] for key
in vnfd_vld
})
678 for cp
in vnfd
.get("ext-cpd", ()):
680 "name": cp
.get("id"),
681 "connection-point-id": cp
.get("int-cpd", {}).get("cpd"),
682 "connection-point-vdu-id": cp
.get("int-cpd", {}).get("vdu-id"),
684 # "ip-address", "mac-address" # filled by LCM
685 # vim-id # TODO it would be nice having a vim port id
687 vnfr_descriptor
["connection-point"].append(vnf_cp
)
689 # Create k8s-cluster information
690 # TODO: Validate if a k8s-cluster net can have more than one ext-cpd ?
691 if vnfd
.get("k8s-cluster"):
692 vnfr_descriptor
["k8s-cluster"] = vnfd
["k8s-cluster"]
693 all_k8s_cluster_nets_cpds
= {}
694 for cpd
in get_iterable(vnfd
.get("ext-cpd")):
695 if cpd
.get("k8s-cluster-net"):
696 all_k8s_cluster_nets_cpds
[cpd
.get("k8s-cluster-net")] = cpd
.get(
699 for net
in get_iterable(vnfr_descriptor
["k8s-cluster"].get("nets")):
700 if net
.get("id") in all_k8s_cluster_nets_cpds
:
701 net
["external-connection-point-ref"] = all_k8s_cluster_nets_cpds
[
706 for kdu
in get_iterable(vnfd
.get("kdu")):
707 additional_params
, kdu_params
= self
._format
_additional
_params
(
708 ns_request
, vnf_index
, kdu_name
=kdu
["name"], descriptor
=vnfd
710 kdu_k8s_namespace
= vnf_k8s_namespace
711 kdu_model
= kdu_params
.get("kdu_model") if kdu_params
else None
712 if kdu_params
and kdu_params
.get("k8s-namespace"):
713 kdu_k8s_namespace
= kdu_params
["k8s-namespace"]
714 kdu_deployment_name
= ""
715 if kdu_params
and kdu_params
.get("kdu-deployment-name"):
716 kdu_deployment_name
= kdu_params
.get("kdu-deployment-name")
719 "additionalParams": additional_params
,
720 "k8s-namespace": kdu_k8s_namespace
,
721 "kdu-deployment-name": kdu_deployment_name
,
722 "kdu-name": kdu
["name"],
723 # TODO "name": "" Name of the VDU in the VIM
724 "ip-address": None, # mgmt-interface filled by LCM
727 if kdu_params
and kdu_params
.get("config-units"):
728 kdur
["config-units"] = kdu_params
["config-units"]
729 if kdu
.get("helm-version"):
730 kdur
["helm-version"] = kdu
["helm-version"]
731 for k8s_type
in ("helm-chart", "juju-bundle"):
732 if kdu
.get(k8s_type
):
733 kdur
[k8s_type
] = kdu_model
or kdu
[k8s_type
]
734 if not vnfr_descriptor
.get("kdur"):
735 vnfr_descriptor
["kdur"] = []
736 vnfr_descriptor
["kdur"].append(kdur
)
738 vnfd_mgmt_cp
= vnfd
.get("mgmt-cp")
740 for vdu
in vnfd
.get("vdu", ()):
743 configs
= vnfd
.get("df")[0]["lcm-operations-configuration"][
744 "operate-vnf-op-config"
746 vdu_config
= utils
.find_in_list(
747 configs
, lambda config
: config
["id"] == vdu
["id"]
753 vdu_instantiation_level
= utils
.find_in_list(
754 vnfd
.get("df")[0]["instantiation-level"][0]["vdu-level"],
755 lambda a_vdu_profile
: a_vdu_profile
["vdu-id"] == vdu
["id"],
758 vdu_instantiation_level
= None
761 external_connection_ee
= utils
.filter_in_list(
762 vdu_config
.get("execution-environment-list", []),
763 lambda ee
: "external-connection-point-ref" in ee
,
765 for ee
in external_connection_ee
:
766 vdu_mgmt_cp
.append(ee
["external-connection-point-ref"])
768 additional_params
, vdu_params
= self
._format
_additional
_params
(
769 ns_request
, vnf_index
, vdu_id
=vdu
["id"], descriptor
=vnfd
773 vdu_virtual_storage_descriptors
= utils
.filter_in_list(
774 vnfd
.get("virtual-storage-desc", []),
775 lambda stg_desc
: stg_desc
["id"] in vdu
["virtual-storage-desc"]
778 vdu_virtual_storage_descriptors
= []
780 "vdu-id-ref": vdu
["id"],
781 # TODO "name": "" Name of the VDU in the VIM
782 "ip-address": None, # mgmt-interface filled by LCM
783 # "vim-id", "flavor-id", "image-id", "management-ip" # filled by LCM
784 "internal-connection-point": [],
786 "additionalParams": additional_params
,
787 "vdu-name": vdu
["name"],
788 "virtual-storages": vdu_virtual_storage_descriptors
790 if vdu_params
and vdu_params
.get("config-units"):
791 vdur
["config-units"] = vdu_params
["config-units"]
792 if deep_get(vdu
, ("supplemental-boot-data", "boot-data-drive")):
793 vdur
["boot-data-drive"] = vdu
["supplemental-boot-data"][
796 if vdu
.get("pdu-type"):
797 vdur
["pdu-type"] = vdu
["pdu-type"]
798 vdur
["name"] = vdu
["pdu-type"]
799 # TODO volumes: name, volume-id
800 for icp
in vdu
.get("int-cpd", ()):
803 "connection-point-id": icp
["id"],
804 "name": icp
.get("id"),
807 vdur
["internal-connection-point"].append(vdu_icp
)
809 for iface
in icp
.get("virtual-network-interface-requirement", ()):
810 iface_fields
= ("name", "mac-address")
812 x
: iface
[x
] for x
in iface_fields
if iface
.get(x
) is not None
815 vdu_iface
["internal-connection-point-ref"] = vdu_icp
["id"]
816 if "port-security-enabled" in icp
:
817 vdu_iface
["port-security-enabled"] = icp
[
818 "port-security-enabled"
821 if "port-security-disable-strategy" in icp
:
822 vdu_iface
["port-security-disable-strategy"] = icp
[
823 "port-security-disable-strategy"
826 for ext_cp
in vnfd
.get("ext-cpd", ()):
827 if not ext_cp
.get("int-cpd"):
829 if ext_cp
["int-cpd"].get("vdu-id") != vdu
["id"]:
831 if icp
["id"] == ext_cp
["int-cpd"].get("cpd"):
832 vdu_iface
["external-connection-point-ref"] = ext_cp
.get(
836 if "port-security-enabled" in ext_cp
:
837 vdu_iface
["port-security-enabled"] = ext_cp
[
838 "port-security-enabled"
841 if "port-security-disable-strategy" in ext_cp
:
842 vdu_iface
["port-security-disable-strategy"] = ext_cp
[
843 "port-security-disable-strategy"
850 and vdu_iface
.get("external-connection-point-ref")
853 vdu_iface
["mgmt-vnf"] = True
854 vdu_iface
["mgmt-interface"] = True
856 for ecp
in vdu_mgmt_cp
:
857 if vdu_iface
.get("external-connection-point-ref") == ecp
:
858 vdu_iface
["mgmt-interface"] = True
860 if iface
.get("virtual-interface"):
861 vdu_iface
.update(deepcopy(iface
["virtual-interface"]))
863 # look for network where this interface is connected
864 iface_ext_cp
= vdu_iface
.get("external-connection-point-ref")
866 # TODO: Change for multiple df support
867 for df
in get_iterable(nsd
.get("df")):
868 for vnf_profile
in get_iterable(df
.get("vnf-profile")):
869 for vlc_index
, vlc
in enumerate(
871 vnf_profile
.get("virtual-link-connectivity")
874 for cpd
in get_iterable(
875 vlc
.get("constituent-cpd-id")
878 cpd
.get("constituent-cpd-id")
881 vdu_iface
["ns-vld-id"] = vlc
.get(
882 "virtual-link-profile-id"
884 # if iface type is SRIOV or PASSTHROUGH, set pci-interfaces flag to True
885 if vdu_iface
.get("type") in (
889 nsr_descriptor
["vld"][vlc_index
][
893 elif vdu_iface
.get("internal-connection-point-ref"):
894 vdu_iface
["vnf-vld-id"] = icp
.get("int-virtual-link-desc")
895 # TODO: store fixed IP address in the record (if it exists in the ICP)
896 # if iface type is SRIOV or PASSTHROUGH, set pci-interfaces flag to True
897 if vdu_iface
.get("type") in ("SR-IOV", "PCI-PASSTHROUGH"):
898 ivld_index
= utils
.find_index_in_list(
899 vnfd
.get("int-virtual-link-desc", ()),
900 lambda ivld
: ivld
["id"]
901 == icp
.get("int-virtual-link-desc"),
903 vnfr_descriptor
["vld"][ivld_index
]["pci-interfaces"] = True
905 vdur
["interfaces"].append(vdu_iface
)
907 if vdu
.get("sw-image-desc"):
908 sw_image
= utils
.find_in_list(
909 vnfd
.get("sw-image-desc", ()),
910 lambda image
: image
["id"] == vdu
.get("sw-image-desc"),
912 nsr_sw_image_data
= utils
.find_in_list(
913 nsr_descriptor
["image"],
914 lambda nsr_image
: (nsr_image
.get("image") == sw_image
.get("image")),
916 vdur
["ns-image-id"] = nsr_sw_image_data
["id"]
918 if vdu
.get("alternative-sw-image-desc"):
920 for alt_image_id
in vdu
.get("alternative-sw-image-desc", ()):
921 sw_image
= utils
.find_in_list(
922 vnfd
.get("sw-image-desc", ()),
923 lambda image
: image
["id"] == alt_image_id
,
925 nsr_sw_image_data
= utils
.find_in_list(
926 nsr_descriptor
["image"],
928 nsr_image
.get("image") == sw_image
.get("image")
931 alt_image_ids
.append(nsr_sw_image_data
["id"])
932 vdur
["alt-image-ids"] = alt_image_ids
934 flavor_data_name
= vdu
["id"][:56] + "-flv"
935 nsr_flavor_desc
= utils
.find_in_list(
936 nsr_descriptor
["flavor"],
937 lambda flavor
: flavor
["name"] == flavor_data_name
,
941 vdur
["ns-flavor-id"] = nsr_flavor_desc
["id"]
943 if vdu_instantiation_level
:
944 count
= vdu_instantiation_level
.get("number-of-instances")
948 for index
in range(0, count
):
949 vdur
= deepcopy(vdur
)
950 for iface
in vdur
["interfaces"]:
951 if iface
.get("ip-address") and index
!= 0:
952 iface
["ip-address"] = increment_ip_mac(iface
["ip-address"])
953 if iface
.get("mac-address") and index
!= 0:
954 iface
["mac-address"] = increment_ip_mac(iface
["mac-address"])
956 vdur
["_id"] = str(uuid4())
957 vdur
["id"] = vdur
["_id"]
958 vdur
["count-index"] = index
959 vnfr_descriptor
["vdur"].append(vdur
)
961 return vnfr_descriptor
963 def vca_status_refresh(self
, session
, ns_instance_content
, filter_q
):
965 vcaStatus in ns_instance_content maybe stale, check if it is stale and create lcm op
966 to refresh vca status by sending message to LCM when it is stale. Ignore otherwise.
967 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
968 :param ns_instance_content: ns instance content
969 :param filter_q: dict: query parameter containing vcaStatus-refresh as true or false
972 time_now
, time_delta
= time(), time() - ns_instance_content
["_admin"]["modified"]
973 force_refresh
= isinstance(filter_q
, dict) and filter_q
.get('vcaStatusRefresh') == 'true'
974 threshold_reached
= time_delta
> 120
975 if force_refresh
or threshold_reached
:
976 operation
, _id
= "vca_status_refresh", ns_instance_content
["_id"]
977 ns_instance_content
["_admin"]["modified"] = time_now
978 self
.db
.set_one(self
.topic
, {"_id": _id
}, ns_instance_content
)
979 nslcmop_desc
= NsLcmOpTopic
._create
_nslcmop
(_id
, operation
, None)
980 self
.format_on_new(nslcmop_desc
, session
["project_id"], make_public
=session
["public"])
981 nslcmop_desc
["_admin"].pop("nsState")
982 self
.msg
.write("ns", operation
, nslcmop_desc
)
985 def show(self
, session
, _id
, filter_q
=None, api_req
=False):
987 Get complete information on an ns instance.
988 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
989 :param _id: string, ns instance id
990 :param filter_q: dict: query parameter containing vcaStatusRefresh as true or false
991 :param api_req: True if this call is serving an external API request. False if serving internal request.
992 :return: dictionary, raise exception if not found.
994 ns_instance_content
= super().show(session
, _id
, api_req
)
995 self
.vca_status_refresh(session
, ns_instance_content
, filter_q
)
996 return ns_instance_content
998 def edit(self
, session
, _id
, indata
=None, kwargs
=None, content
=None):
999 raise EngineException(
1000 "Method edit called directly", HTTPStatus
.INTERNAL_SERVER_ERROR
1004 class VnfrTopic(BaseTopic
):
1008 def __init__(self
, db
, fs
, msg
, auth
):
1009 BaseTopic
.__init
__(self
, db
, fs
, msg
, auth
)
1011 def delete(self
, session
, _id
, dry_run
=False, not_send_msg
=None):
1012 raise EngineException(
1013 "Method delete called directly", HTTPStatus
.INTERNAL_SERVER_ERROR
1016 def edit(self
, session
, _id
, indata
=None, kwargs
=None, content
=None):
1017 raise EngineException(
1018 "Method edit called directly", HTTPStatus
.INTERNAL_SERVER_ERROR
1021 def new(self
, rollback
, session
, indata
=None, kwargs
=None, headers
=None):
1022 # Not used because vnfrs are created and deleted by NsrTopic class directly
1023 raise EngineException(
1024 "Method new called directly", HTTPStatus
.INTERNAL_SERVER_ERROR
1028 class NsLcmOpTopic(BaseTopic
):
1031 operation_schema
= { # mapping between operation and jsonschema to validate
1032 "instantiate": ns_instantiate
,
1033 "action": ns_action
,
1035 "terminate": ns_terminate
,
1038 def __init__(self
, db
, fs
, msg
, auth
):
1039 BaseTopic
.__init
__(self
, db
, fs
, msg
, auth
)
1041 def _check_ns_operation(self
, session
, nsr
, operation
, indata
):
1043 Check that user has enter right parameters for the operation
1044 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1045 :param operation: it can be: instantiate, terminate, action, TODO: update, heal
1046 :param indata: descriptor with the parameters of the operation
1049 if operation
== "action":
1050 self
._check
_action
_ns
_operation
(indata
, nsr
)
1051 elif operation
== "scale":
1052 self
._check
_scale
_ns
_operation
(indata
, nsr
)
1053 elif operation
== "instantiate":
1054 self
._check
_instantiate
_ns
_operation
(indata
, nsr
, session
)
1056 def _check_action_ns_operation(self
, indata
, nsr
):
1058 # check vnf_member_index
1059 if indata
.get("vnf_member_index"):
1060 indata
["member_vnf_index"] = indata
.pop(
1062 ) # for backward compatibility
1063 if indata
.get("member_vnf_index"):
1064 vnfd
= self
._get
_vnfd
_from
_vnf
_member
_index
(
1065 indata
["member_vnf_index"], nsr
["_id"]
1068 configs
= vnfd
.get("df")[0]["lcm-operations-configuration"][
1069 "operate-vnf-op-config"
1074 if indata
.get("vdu_id"):
1075 self
._check
_valid
_vdu
(vnfd
, indata
["vdu_id"])
1076 descriptor_configuration
= utils
.find_in_list(
1077 configs
, lambda config
: config
["id"] == indata
["vdu_id"]
1079 elif indata
.get("kdu_name"):
1080 self
._check
_valid
_kdu
(vnfd
, indata
["kdu_name"])
1081 descriptor_configuration
= utils
.find_in_list(
1082 configs
, lambda config
: config
["id"] == indata
.get("kdu_name")
1085 descriptor_configuration
= utils
.find_in_list(
1086 configs
, lambda config
: config
["id"] == vnfd
["id"]
1088 if descriptor_configuration
is not None:
1089 descriptor_configuration
= descriptor_configuration
.get(
1093 descriptor_configuration
= nsd
.get("ns-configuration", {}).get(
1097 # For k8s allows default primitives without validating the parameters
1098 if indata
.get("kdu_name") and indata
["primitive"] in (
1105 # TODO should be checked that rollback only can contains revsision_numbe????
1106 if not indata
.get("member_vnf_index"):
1107 raise EngineException(
1108 "Missing action parameter 'member_vnf_index' for default KDU primitive '{}'".format(
1113 # if not, check primitive
1114 for config_primitive
in get_iterable(descriptor_configuration
):
1115 if indata
["primitive"] == config_primitive
["name"]:
1116 # check needed primitive_params are provided
1117 if indata
.get("primitive_params"):
1118 in_primitive_params_copy
= copy(indata
["primitive_params"])
1120 in_primitive_params_copy
= {}
1121 for paramd
in get_iterable(config_primitive
.get("parameter")):
1122 if paramd
["name"] in in_primitive_params_copy
:
1123 del in_primitive_params_copy
[paramd
["name"]]
1124 elif not paramd
.get("default-value"):
1125 raise EngineException(
1126 "Needed parameter {} not provided for primitive '{}'".format(
1127 paramd
["name"], indata
["primitive"]
1130 # check no extra primitive params are provided
1131 if in_primitive_params_copy
:
1132 raise EngineException(
1133 "parameter/s '{}' not present at vnfd /nsd for primitive '{}'".format(
1134 list(in_primitive_params_copy
.keys()), indata
["primitive"]
1139 raise EngineException(
1140 "Invalid primitive '{}' is not present at vnfd/nsd".format(
1145 def _check_scale_ns_operation(self
, indata
, nsr
):
1146 vnfd
= self
._get
_vnfd
_from
_vnf
_member
_index
(
1147 indata
["scaleVnfData"]["scaleByStepData"]["member-vnf-index"], nsr
["_id"]
1149 for scaling_aspect
in get_iterable(vnfd
.get("df", ())[0]["scaling-aspect"]):
1151 indata
["scaleVnfData"]["scaleByStepData"]["scaling-group-descriptor"]
1152 == scaling_aspect
["id"]
1156 raise EngineException(
1157 "Invalid scaleVnfData:scaleByStepData:scaling-group-descriptor '{}' is not "
1158 "present at vnfd:scaling-aspect".format(
1159 indata
["scaleVnfData"]["scaleByStepData"][
1160 "scaling-group-descriptor"
1165 def _check_instantiate_ns_operation(self
, indata
, nsr
, session
):
1166 vnf_member_index_to_vnfd
= {} # map between vnf_member_index to vnf descriptor.
1170 self
._check
_valid
_vim
_account
(indata
["vimAccountId"], vim_accounts
, session
)
1171 self
._check
_valid
_wim
_account
(indata
.get("wimAccountId"), wim_accounts
, session
)
1172 for in_vnf
in get_iterable(indata
.get("vnf")):
1173 member_vnf_index
= in_vnf
["member-vnf-index"]
1174 if vnf_member_index_to_vnfd
.get(member_vnf_index
):
1175 vnfd
= vnf_member_index_to_vnfd
[member_vnf_index
]
1177 vnfd
= self
._get
_vnfd
_from
_vnf
_member
_index
(
1178 member_vnf_index
, nsr
["_id"]
1180 vnf_member_index_to_vnfd
[
1182 ] = vnfd
# add to cache, avoiding a later look for
1183 self
._check
_vnf
_instantiation
_params
(in_vnf
, vnfd
)
1184 if in_vnf
.get("vimAccountId"):
1185 self
._check
_valid
_vim
_account
(
1186 in_vnf
["vimAccountId"], vim_accounts
, session
1189 for in_vld
in get_iterable(indata
.get("vld")):
1190 self
._check
_valid
_wim
_account
(
1191 in_vld
.get("wimAccountId"), wim_accounts
, session
1193 for vldd
in get_iterable(nsd
.get("virtual-link-desc")):
1194 if in_vld
["name"] == vldd
["id"]:
1197 raise EngineException(
1198 "Invalid parameter vld:name='{}' is not present at nsd:vld".format(
1203 def _get_vnfd_from_vnf_member_index(self
, member_vnf_index
, nsr_id
):
1204 # Obtain vnf descriptor. The vnfr is used to get the vnfd._id used for this member_vnf_index
1205 vnfr
= self
.db
.get_one(
1207 {"nsr-id-ref": nsr_id
, "member-vnf-index-ref": member_vnf_index
},
1208 fail_on_empty
=False,
1211 raise EngineException(
1212 "Invalid parameter member_vnf_index='{}' is not one of the "
1213 "nsd:constituent-vnfd".format(member_vnf_index
)
1215 vnfd
= self
.db
.get_one("vnfds", {"_id": vnfr
["vnfd-id"]}, fail_on_empty
=False)
1217 raise EngineException(
1218 "vnfd id={} has been deleted!. Operation cannot be performed".format(
1224 def _check_valid_vdu(self
, vnfd
, vdu_id
):
1225 for vdud
in get_iterable(vnfd
.get("vdu")):
1226 if vdud
["id"] == vdu_id
:
1229 raise EngineException(
1230 "Invalid parameter vdu_id='{}' not present at vnfd:vdu:id".format(
1235 def _check_valid_kdu(self
, vnfd
, kdu_name
):
1236 for kdud
in get_iterable(vnfd
.get("kdu")):
1237 if kdud
["name"] == kdu_name
:
1240 raise EngineException(
1241 "Invalid parameter kdu_name='{}' not present at vnfd:kdu:name".format(
1246 def _check_vnf_instantiation_params(self
, in_vnf
, vnfd
):
1247 for in_vdu
in get_iterable(in_vnf
.get("vdu")):
1248 for vdu
in get_iterable(vnfd
.get("vdu")):
1249 if in_vdu
["id"] == vdu
["id"]:
1250 for volume
in get_iterable(in_vdu
.get("volume")):
1251 for volumed
in get_iterable(vdu
.get("virtual-storage-desc")):
1252 if volumed
["id"] == volume
["name"]:
1255 raise EngineException(
1256 "Invalid parameter vnf[member-vnf-index='{}']:vdu[id='{}']:"
1257 "volume:name='{}' is not present at "
1258 "vnfd:vdu:virtual-storage-desc list".format(
1259 in_vnf
["member-vnf-index"],
1265 vdu_if_names
= set()
1266 for cpd
in get_iterable(vdu
.get("int-cpd")):
1267 for iface
in get_iterable(
1268 cpd
.get("virtual-network-interface-requirement")
1270 vdu_if_names
.add(iface
.get("name"))
1272 for in_iface
in get_iterable(in_vdu
["interface"]):
1273 if in_iface
["name"] in vdu_if_names
:
1276 raise EngineException(
1277 "Invalid parameter vnf[member-vnf-index='{}']:vdu[id='{}']:"
1278 "int-cpd[id='{}'] is not present at vnfd:vdu:int-cpd".format(
1279 in_vnf
["member-vnf-index"],
1287 raise EngineException(
1288 "Invalid parameter vnf[member-vnf-index='{}']:vdu[id='{}'] is not present "
1289 "at vnfd:vdu".format(in_vnf
["member-vnf-index"], in_vdu
["id"])
1293 ivld
.get("id"): set()
1294 for ivld
in get_iterable(vnfd
.get("int-virtual-link-desc"))
1296 for vdu
in get_iterable(vnfd
.get("vdu")):
1297 for cpd
in get_iterable(vnfd
.get("int-cpd")):
1298 if cpd
.get("int-virtual-link-desc"):
1299 vnfd_ivlds_cpds
[cpd
.get("int-virtual-link-desc")] = cpd
.get("id")
1301 for in_ivld
in get_iterable(in_vnf
.get("internal-vld")):
1302 if in_ivld
.get("name") in vnfd_ivlds_cpds
:
1303 for in_icp
in get_iterable(in_ivld
.get("internal-connection-point")):
1304 if in_icp
["id-ref"] in vnfd_ivlds_cpds
[in_ivld
.get("name")]:
1307 raise EngineException(
1308 "Invalid parameter vnf[member-vnf-index='{}']:internal-vld[name"
1309 "='{}']:internal-connection-point[id-ref:'{}'] is not present at "
1310 "vnfd:internal-vld:name/id:internal-connection-point".format(
1311 in_vnf
["member-vnf-index"],
1317 raise EngineException(
1318 "Invalid parameter vnf[member-vnf-index='{}']:internal-vld:name='{}'"
1319 " is not present at vnfd '{}'".format(
1320 in_vnf
["member-vnf-index"], in_ivld
["name"], vnfd
["id"]
1324 def _check_valid_vim_account(self
, vim_account
, vim_accounts
, session
):
1325 if vim_account
in vim_accounts
:
1328 db_filter
= self
._get
_project
_filter
(session
)
1329 db_filter
["_id"] = vim_account
1330 self
.db
.get_one("vim_accounts", db_filter
)
1332 raise EngineException(
1333 "Invalid vimAccountId='{}' not present for the project".format(
1337 vim_accounts
.append(vim_account
)
1339 def _get_vim_account(self
, vim_id
: str, session
):
1341 db_filter
= self
._get
_project
_filter
(session
)
1342 db_filter
["_id"] = vim_id
1343 return self
.db
.get_one("vim_accounts", db_filter
)
1345 raise EngineException(
1346 "Invalid vimAccountId='{}' not present for the project".format(
1351 def _check_valid_wim_account(self
, wim_account
, wim_accounts
, session
):
1352 if not isinstance(wim_account
, str):
1354 if wim_account
in wim_accounts
:
1357 db_filter
= self
._get
_project
_filter
(session
)
1358 db_filter
["_id"] = wim_account
1359 self
.db
.get_one("wim_accounts", db_filter
)
1361 raise EngineException(
1362 "Invalid wimAccountId='{}' not present for the project".format(
1366 wim_accounts
.append(wim_account
)
1369 self
, session
, rollback
, vnfr
, vim_account
, vnfr_update
, vnfr_update_rollback
1372 Look for a free PDU in the catalog matching vdur type and interfaces. Fills vnfr.vdur with the interface
1373 (ip_address, ...) information.
1374 Modifies PDU _admin.usageState to 'IN_USE'
1375 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1376 :param rollback: list with the database modifications to rollback if needed
1377 :param vnfr: vnfr to be updated. It is modified with pdu interface info if pdu is found
1378 :param vim_account: vim_account where this vnfr should be deployed
1379 :param vnfr_update: dictionary filled by this method with changes to be done at database vnfr
1380 :param vnfr_update_rollback: dictionary filled by this method with original content of vnfr in case a rollback
1381 of the changed vnfr is needed
1383 :return: List of PDU interfaces that are connected to an existing VIM network. Each item contains:
1384 "vim-network-name": used at VIM
1385 "name": interface name
1386 "vnf-vld-id": internal VNFD vld where this interface is connected, or
1387 "ns-vld-id": NSD vld where this interface is connected.
1388 NOTE: One, and only one between 'vnf-vld-id' and 'ns-vld-id' contains a value. The other will be None
1391 ifaces_forcing_vim_network
= []
1392 for vdur_index
, vdur
in enumerate(get_iterable(vnfr
.get("vdur"))):
1393 if not vdur
.get("pdu-type"):
1395 pdu_type
= vdur
.get("pdu-type")
1396 pdu_filter
= self
._get
_project
_filter
(session
)
1397 pdu_filter
["vim_accounts"] = vim_account
1398 pdu_filter
["type"] = pdu_type
1399 pdu_filter
["_admin.operationalState"] = "ENABLED"
1400 pdu_filter
["_admin.usageState"] = "NOT_IN_USE"
1401 # TODO feature 1417: "shared": True,
1403 available_pdus
= self
.db
.get_list("pdus", pdu_filter
)
1404 for pdu
in available_pdus
:
1405 # step 1 check if this pdu contains needed interfaces:
1406 match_interfaces
= True
1407 for vdur_interface
in vdur
["interfaces"]:
1408 for pdu_interface
in pdu
["interfaces"]:
1409 if pdu_interface
["name"] == vdur_interface
["name"]:
1410 # TODO feature 1417: match per mgmt type
1412 else: # no interface found for name
1413 match_interfaces
= False
1415 if match_interfaces
:
1418 raise EngineException(
1419 "No PDU of type={} at vim_account={} found for member_vnf_index={}, vdu={} matching interface "
1423 vnfr
["member-vnf-index-ref"],
1428 # step 2. Update pdu
1430 "_admin.usageState": pdu
["_admin"]["usageState"],
1431 "_admin.usage.vnfr_id": None,
1432 "_admin.usage.nsr_id": None,
1433 "_admin.usage.vdur": None,
1437 {"_id": pdu
["_id"]},
1439 "_admin.usageState": "IN_USE",
1441 "vnfr_id": vnfr
["_id"],
1442 "nsr_id": vnfr
["nsr-id-ref"],
1443 "vdur": vdur
["vdu-id-ref"],
1452 "content": rollback_pdu
,
1456 # step 3. Fill vnfr info by filling vdur
1457 vdu_text
= "vdur.{}".format(vdur_index
)
1458 vnfr_update_rollback
[vdu_text
+ ".pdu-id"] = None
1459 vnfr_update
[vdu_text
+ ".pdu-id"] = pdu
["_id"]
1460 for iface_index
, vdur_interface
in enumerate(vdur
["interfaces"]):
1461 for pdu_interface
in pdu
["interfaces"]:
1462 if pdu_interface
["name"] == vdur_interface
["name"]:
1463 iface_text
= vdu_text
+ ".interfaces.{}".format(iface_index
)
1464 for k
, v
in pdu_interface
.items():
1468 ): # TODO: switch-xxxxx must be inserted
1469 vnfr_update
[iface_text
+ ".{}".format(k
)] = v
1470 vnfr_update_rollback
[
1471 iface_text
+ ".{}".format(k
)
1472 ] = vdur_interface
.get(v
)
1473 if pdu_interface
.get("ip-address"):
1474 if vdur_interface
.get(
1476 ) or vdur_interface
.get("mgmt-vnf"):
1477 vnfr_update_rollback
[
1478 vdu_text
+ ".ip-address"
1479 ] = vdur
.get("ip-address")
1480 vnfr_update
[vdu_text
+ ".ip-address"] = pdu_interface
[
1483 if vdur_interface
.get("mgmt-vnf"):
1484 vnfr_update_rollback
["ip-address"] = vnfr
.get(
1487 vnfr_update
["ip-address"] = pdu_interface
["ip-address"]
1488 vnfr_update
[vdu_text
+ ".ip-address"] = pdu_interface
[
1491 if pdu_interface
.get("vim-network-name") or pdu_interface
.get(
1494 ifaces_forcing_vim_network
.append(
1496 "name": vdur_interface
.get("vnf-vld-id")
1497 or vdur_interface
.get("ns-vld-id"),
1498 "vnf-vld-id": vdur_interface
.get("vnf-vld-id"),
1499 "ns-vld-id": vdur_interface
.get("ns-vld-id"),
1502 if pdu_interface
.get("vim-network-id"):
1503 ifaces_forcing_vim_network
[-1][
1505 ] = pdu_interface
["vim-network-id"]
1506 if pdu_interface
.get("vim-network-name"):
1507 ifaces_forcing_vim_network
[-1][
1509 ] = pdu_interface
["vim-network-name"]
1512 return ifaces_forcing_vim_network
1514 def _look_for_k8scluster(
1515 self
, session
, rollback
, vnfr
, vim_account
, vnfr_update
, vnfr_update_rollback
1518 Look for an available k8scluster for all the kuds in the vnfd matching version and cni requirements.
1519 Fills vnfr.kdur with the selected k8scluster
1521 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1522 :param rollback: list with the database modifications to rollback if needed
1523 :param vnfr: vnfr to be updated. It is modified with pdu interface info if pdu is found
1524 :param vim_account: vim_account where this vnfr should be deployed
1525 :param vnfr_update: dictionary filled by this method with changes to be done at database vnfr
1526 :param vnfr_update_rollback: dictionary filled by this method with original content of vnfr in case a rollback
1527 of the changed vnfr is needed
1529 :return: List of KDU interfaces that are connected to an existing VIM network. Each item contains:
1530 "vim-network-name": used at VIM
1531 "name": interface name
1532 "vnf-vld-id": internal VNFD vld where this interface is connected, or
1533 "ns-vld-id": NSD vld where this interface is connected.
1534 NOTE: One, and only one between 'vnf-vld-id' and 'ns-vld-id' contains a value. The other will be None
1537 ifaces_forcing_vim_network
= []
1538 if not vnfr
.get("kdur"):
1539 return ifaces_forcing_vim_network
1541 kdu_filter
= self
._get
_project
_filter
(session
)
1542 kdu_filter
["vim_account"] = vim_account
1543 # TODO kdu_filter["_admin.operationalState"] = "ENABLED"
1544 available_k8sclusters
= self
.db
.get_list("k8sclusters", kdu_filter
)
1546 k8s_requirements
= {} # just for logging
1547 for k8scluster
in available_k8sclusters
:
1548 if not vnfr
.get("k8s-cluster"):
1551 if vnfr
["k8s-cluster"].get("cni"):
1552 k8s_requirements
["cni"] = vnfr
["k8s-cluster"]["cni"]
1553 if not set(vnfr
["k8s-cluster"]["cni"]).intersection(
1554 k8scluster
.get("cni", ())
1557 # restrict by version
1558 if vnfr
["k8s-cluster"].get("version"):
1559 k8s_requirements
["version"] = vnfr
["k8s-cluster"]["version"]
1560 if k8scluster
.get("k8s_version") not in vnfr
["k8s-cluster"]["version"]:
1562 # restrict by number of networks
1563 if vnfr
["k8s-cluster"].get("nets"):
1564 k8s_requirements
["networks"] = len(vnfr
["k8s-cluster"]["nets"])
1565 if not k8scluster
.get("nets") or len(k8scluster
["nets"]) < len(
1566 vnfr
["k8s-cluster"]["nets"]
1571 raise EngineException(
1572 "No k8scluster with requirements='{}' at vim_account={} found for member_vnf_index={}".format(
1573 k8s_requirements
, vim_account
, vnfr
["member-vnf-index-ref"]
1577 for kdur_index
, kdur
in enumerate(get_iterable(vnfr
.get("kdur"))):
1578 # step 3. Fill vnfr info by filling kdur
1579 kdu_text
= "kdur.{}.".format(kdur_index
)
1580 vnfr_update_rollback
[kdu_text
+ "k8s-cluster.id"] = None
1581 vnfr_update
[kdu_text
+ "k8s-cluster.id"] = k8scluster
["_id"]
1583 # step 4. Check VIM networks that forces the selected k8s_cluster
1584 if vnfr
.get("k8s-cluster") and vnfr
["k8s-cluster"].get("nets"):
1585 k8scluster_net_list
= list(k8scluster
.get("nets").keys())
1586 for net_index
, kdur_net
in enumerate(vnfr
["k8s-cluster"]["nets"]):
1587 # get a network from k8s_cluster nets. If name matches use this, if not use other
1588 if kdur_net
["id"] in k8scluster_net_list
: # name matches
1589 vim_net
= k8scluster
["nets"][kdur_net
["id"]]
1590 k8scluster_net_list
.remove(kdur_net
["id"])
1592 vim_net
= k8scluster
["nets"][k8scluster_net_list
[0]]
1593 k8scluster_net_list
.pop(0)
1594 vnfr_update_rollback
[
1595 "k8s-cluster.nets.{}.vim_net".format(net_index
)
1597 vnfr_update
["k8s-cluster.nets.{}.vim_net".format(net_index
)] = vim_net
1599 kdur_net
.get("vnf-vld-id") or kdur_net
.get("ns-vld-id")
1601 ifaces_forcing_vim_network
.append(
1603 "name": kdur_net
.get("vnf-vld-id")
1604 or kdur_net
.get("ns-vld-id"),
1605 "vnf-vld-id": kdur_net
.get("vnf-vld-id"),
1606 "ns-vld-id": kdur_net
.get("ns-vld-id"),
1607 "vim-network-name": vim_net
, # TODO can it be vim-network-id ???
1610 # TODO check that this forcing is not incompatible with other forcing
1611 return ifaces_forcing_vim_network
1613 def _update_vnfrs_from_nsd(self
, nsr
):
1618 step
= "Getting vnf_profiles from nsd"
1619 vnf_profiles
= nsd
.get("df", [{}])[0].get("vnf-profile", ())
1620 vld_fixed_ip_connection_point_data
= {}
1622 step
= "Getting ip-address info from vnf_profile if it exists"
1623 for vnfp
in vnf_profiles
:
1624 # Checking ip-address info from nsd.vnf_profile and storing
1625 for vlc
in vnfp
.get("virtual-link-connectivity", ()):
1626 for cpd
in vlc
.get("constituent-cpd-id", ()):
1627 if cpd
.get("ip-address"):
1628 step
= "Storing ip-address info"
1629 vld_fixed_ip_connection_point_data
.update({vlc
.get("virtual-link-profile-id") + '.' + cpd
.get("constituent-base-element-id"): {
1630 "vnfd-connection-point-ref": cpd
.get(
1631 "constituent-cpd-id"),
1632 "ip-address": cpd
.get(
1635 # Inserting ip address to vnfr
1636 if len(vld_fixed_ip_connection_point_data
) > 0:
1637 step
= "Getting vnfrs"
1638 vnfrs
= self
.db
.get_list("vnfrs", {"nsr-id-ref": nsr_id
})
1639 for item
in vld_fixed_ip_connection_point_data
.keys():
1640 step
= "Filtering vnfrs"
1641 vnfr
= next(filter(lambda vnfr
: vnfr
["member-vnf-index-ref"] == item
.split('.')[1], vnfrs
), None)
1644 for vdur_index
, vdur
in enumerate(vnfr
["vdur"]):
1645 for iface_index
, iface
in enumerate(vdur
["interfaces"]):
1646 step
= "Looking for matched interface"
1648 iface
.get("external-connection-point-ref")
1649 == vld_fixed_ip_connection_point_data
[item
].get("vnfd-connection-point-ref") and
1650 iface
.get("ns-vld-id") == item
.split('.')[0]
1653 vnfr_update_text
= "vdur.{}.interfaces.{}".format(
1654 vdur_index
, iface_index
1656 step
= "Storing info in order to update vnfr"
1658 vnfr_update_text
+ ".ip-address"
1659 ] = increment_ip_mac(
1660 vld_fixed_ip_connection_point_data
[item
].get("ip-address"),
1661 vdur
.get("count-index", 0), )
1662 vnfr_update
[vnfr_update_text
+ ".fixed-ip"] = True
1664 step
= "updating vnfr at database"
1665 self
.db
.set_one("vnfrs", {"_id": vnfr
["_id"]}, vnfr_update
)
1673 raise type(e
)("{} while '{}'".format(e
, step
), http_code
=e
.http_code
)
1675 def _update_vnfrs(self
, session
, rollback
, nsr
, indata
):
1678 vnfrs
= self
.db
.get_list("vnfrs", {"nsr-id-ref": nsr_id
})
1682 vnfr_update_rollback
= {}
1683 member_vnf_index
= vnfr
["member-vnf-index-ref"]
1684 # update vim-account-id
1686 vim_account
= indata
["vimAccountId"]
1687 vca_id
= self
._get
_vim
_account
(vim_account
, session
).get("vca")
1688 # check instantiate parameters
1689 for vnf_inst_params
in get_iterable(indata
.get("vnf")):
1690 if vnf_inst_params
["member-vnf-index"] != member_vnf_index
:
1692 if vnf_inst_params
.get("vimAccountId"):
1693 vim_account
= vnf_inst_params
.get("vimAccountId")
1694 vca_id
= self
._get
_vim
_account
(vim_account
, session
).get("vca")
1696 # get vnf.vdu.interface instantiation params to update vnfr.vdur.interfaces ip, mac
1697 for vdu_inst_param
in get_iterable(vnf_inst_params
.get("vdu")):
1698 for vdur_index
, vdur
in enumerate(vnfr
["vdur"]):
1699 if vdu_inst_param
["id"] != vdur
["vdu-id-ref"]:
1701 for iface_inst_param
in get_iterable(
1702 vdu_inst_param
.get("interface")
1704 iface_index
, _
= next(
1706 for i
in enumerate(vdur
["interfaces"])
1707 if i
[1]["name"] == iface_inst_param
["name"]
1709 vnfr_update_text
= "vdur.{}.interfaces.{}".format(
1710 vdur_index
, iface_index
1712 if iface_inst_param
.get("ip-address"):
1714 vnfr_update_text
+ ".ip-address"
1715 ] = increment_ip_mac(
1716 iface_inst_param
.get("ip-address"),
1717 vdur
.get("count-index", 0),
1719 vnfr_update
[vnfr_update_text
+ ".fixed-ip"] = True
1720 if iface_inst_param
.get("mac-address"):
1722 vnfr_update_text
+ ".mac-address"
1723 ] = increment_ip_mac(
1724 iface_inst_param
.get("mac-address"),
1725 vdur
.get("count-index", 0),
1727 vnfr_update
[vnfr_update_text
+ ".fixed-mac"] = True
1728 if iface_inst_param
.get("floating-ip-required"):
1730 vnfr_update_text
+ ".floating-ip-required"
1732 # get vnf.internal-vld.internal-conection-point instantiation params to update vnfr.vdur.interfaces
1733 # TODO update vld with the ip-profile
1734 for ivld_inst_param
in get_iterable(
1735 vnf_inst_params
.get("internal-vld")
1737 for icp_inst_param
in get_iterable(
1738 ivld_inst_param
.get("internal-connection-point")
1741 for vdur_index
, vdur
in enumerate(vnfr
["vdur"]):
1742 for iface_index
, iface
in enumerate(vdur
["interfaces"]):
1744 iface
.get("internal-connection-point-ref")
1745 == icp_inst_param
["id-ref"]
1747 vnfr_update_text
= "vdur.{}.interfaces.{}".format(
1748 vdur_index
, iface_index
1750 if icp_inst_param
.get("ip-address"):
1752 vnfr_update_text
+ ".ip-address"
1753 ] = increment_ip_mac(
1754 icp_inst_param
.get("ip-address"),
1755 vdur
.get("count-index", 0),
1758 vnfr_update_text
+ ".fixed-ip"
1760 if icp_inst_param
.get("mac-address"):
1762 vnfr_update_text
+ ".mac-address"
1763 ] = increment_ip_mac(
1764 icp_inst_param
.get("mac-address"),
1765 vdur
.get("count-index", 0),
1768 vnfr_update_text
+ ".fixed-mac"
1771 # get ip address from instantiation parameters.vld.vnfd-connection-point-ref
1772 for vld_inst_param
in get_iterable(indata
.get("vld")):
1773 for vnfcp_inst_param
in get_iterable(
1774 vld_inst_param
.get("vnfd-connection-point-ref")
1776 if vnfcp_inst_param
["member-vnf-index-ref"] != member_vnf_index
:
1779 for vdur_index
, vdur
in enumerate(vnfr
["vdur"]):
1780 for iface_index
, iface
in enumerate(vdur
["interfaces"]):
1782 iface
.get("external-connection-point-ref")
1783 == vnfcp_inst_param
["vnfd-connection-point-ref"]
1785 vnfr_update_text
= "vdur.{}.interfaces.{}".format(
1786 vdur_index
, iface_index
1788 if vnfcp_inst_param
.get("ip-address"):
1790 vnfr_update_text
+ ".ip-address"
1791 ] = increment_ip_mac(
1792 vnfcp_inst_param
.get("ip-address"),
1793 vdur
.get("count-index", 0),
1795 vnfr_update
[vnfr_update_text
+ ".fixed-ip"] = True
1796 if vnfcp_inst_param
.get("mac-address"):
1798 vnfr_update_text
+ ".mac-address"
1799 ] = increment_ip_mac(
1800 vnfcp_inst_param
.get("mac-address"),
1801 vdur
.get("count-index", 0),
1803 vnfr_update
[vnfr_update_text
+ ".fixed-mac"] = True
1806 vnfr_update
["vim-account-id"] = vim_account
1807 vnfr_update_rollback
["vim-account-id"] = vnfr
.get("vim-account-id")
1810 vnfr_update
["vca-id"] = vca_id
1811 vnfr_update_rollback
["vca-id"] = vnfr
.get("vca-id")
1814 ifaces_forcing_vim_network
= self
._look
_for
_pdu
(
1815 session
, rollback
, vnfr
, vim_account
, vnfr_update
, vnfr_update_rollback
1819 ifaces_forcing_vim_network
+= self
._look
_for
_k
8scluster
(
1820 session
, rollback
, vnfr
, vim_account
, vnfr_update
, vnfr_update_rollback
1822 # update database vnfr
1823 self
.db
.set_one("vnfrs", {"_id": vnfr
["_id"]}, vnfr_update
)
1829 "content": vnfr_update_rollback
,
1833 # Update indada in case pdu forces to use a concrete vim-network-name
1834 # TODO check if user has already insert a vim-network-name and raises an error
1835 if not ifaces_forcing_vim_network
:
1837 for iface_info
in ifaces_forcing_vim_network
:
1838 if iface_info
.get("ns-vld-id"):
1839 if "vld" not in indata
:
1841 indata
["vld"].append(
1843 key
: iface_info
[key
]
1844 for key
in ("name", "vim-network-name", "vim-network-id")
1845 if iface_info
.get(key
)
1849 elif iface_info
.get("vnf-vld-id"):
1850 if "vnf" not in indata
:
1852 indata
["vnf"].append(
1854 "member-vnf-index": member_vnf_index
,
1857 key
: iface_info
[key
]
1863 if iface_info
.get(key
)
1870 def _create_nslcmop(nsr_id
, operation
, params
):
1872 Creates a ns-lcm-opp content to be stored at database.
1873 :param nsr_id: internal id of the instance
1874 :param operation: instantiate, terminate, scale, action, ...
1875 :param params: user parameters for the operation
1876 :return: dictionary following SOL005 format
1883 "operationState": "PROCESSING", # COMPLETED,PARTIALLY_COMPLETED,FAILED_TEMP,FAILED,ROLLING_BACK,ROLLED_BACK
1884 "queuePosition": None,
1886 "errorMessage": None,
1887 "detailedStatus": None,
1888 "statusEnteredTime": now
,
1889 "nsInstanceId": nsr_id
,
1890 "lcmOperationType": operation
,
1892 "isAutomaticInvocation": False,
1893 "operationParams": params
,
1894 "isCancelPending": False,
1896 "self": "/osm/nslcm/v1/ns_lcm_op_occs/" + _id
,
1897 "nsInstance": "/osm/nslcm/v1/ns_instances/" + nsr_id
,
1902 def _get_enabled_vims(self
, session
):
1904 Retrieve and return VIM accounts that are accessible by current user and has state ENABLE
1905 :param session: current session with user information
1907 db_filter
= self
._get
_project
_filter
(session
)
1908 db_filter
["_admin.operationalState"] = "ENABLED"
1909 vims
= self
.db
.get_list("vim_accounts", db_filter
)
1912 vimAccounts
.append(vim
["_id"])
1925 Performs a new operation over a ns
1926 :param rollback: list to append created items at database in case a rollback must to be done
1927 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1928 :param indata: descriptor with the parameters of the operation. It must contains among others
1929 nsInstanceId: _id of the nsr to perform the operation
1930 operation: it can be: instantiate, terminate, action, TODO: update, heal
1931 :param kwargs: used to override the indata descriptor
1932 :param headers: http request headers
1933 :return: id of the nslcmops
1936 def check_if_nsr_is_not_slice_member(session
, nsr_id
):
1938 db_filter
= self
._get
_project
_filter
(session
)
1939 db_filter
["_admin.nsrs-detailed-list.ANYINDEX.nsrId"] = nsr_id
1940 nsis
= self
.db
.get_one(
1941 "nsis", db_filter
, fail_on_empty
=False, fail_on_more
=False
1944 raise EngineException(
1945 "The NS instance {} cannot be terminated because is used by the slice {}".format(
1948 http_code
=HTTPStatus
.CONFLICT
,
1952 # Override descriptor with query string kwargs
1953 self
._update
_input
_with
_kwargs
(indata
, kwargs
, yaml_format
=True)
1954 operation
= indata
["lcmOperationType"]
1955 nsInstanceId
= indata
["nsInstanceId"]
1957 validate_input(indata
, self
.operation_schema
[operation
])
1958 # get ns from nsr_id
1959 _filter
= BaseTopic
._get
_project
_filter
(session
)
1960 _filter
["_id"] = nsInstanceId
1961 nsr
= self
.db
.get_one("nsrs", _filter
)
1964 if operation
== "terminate" and slice_object
is False:
1965 check_if_nsr_is_not_slice_member(session
, nsr
["_id"])
1967 not nsr
["_admin"].get("nsState")
1968 or nsr
["_admin"]["nsState"] == "NOT_INSTANTIATED"
1970 if operation
== "terminate" and indata
.get("autoremove"):
1971 # NSR must be deleted
1975 ) # a none in this case is used to indicate not instantiated. It can be removed
1976 if operation
!= "instantiate":
1977 raise EngineException(
1978 "ns_instance '{}' cannot be '{}' because it is not instantiated".format(
1979 nsInstanceId
, operation
1981 HTTPStatus
.CONFLICT
,
1984 if operation
== "instantiate" and not session
["force"]:
1985 raise EngineException(
1986 "ns_instance '{}' cannot be '{}' because it is already instantiated".format(
1987 nsInstanceId
, operation
1989 HTTPStatus
.CONFLICT
,
1991 self
._check
_ns
_operation
(session
, nsr
, operation
, indata
)
1992 if (indata
.get("primitive_params")):
1993 indata
["primitive_params"] = json
.dumps(indata
["primitive_params"])
1994 elif (indata
.get("additionalParamsForVnf")):
1995 indata
["additionalParamsForVnf"] = json
.dumps(indata
["additionalParamsForVnf"])
1997 if operation
== "instantiate":
1998 self
._update
_vnfrs
_from
_nsd
(nsr
)
1999 self
._update
_vnfrs
(session
, rollback
, nsr
, indata
)
2001 nslcmop_desc
= self
._create
_nslcmop
(nsInstanceId
, operation
, indata
)
2002 _id
= nslcmop_desc
["_id"]
2004 nslcmop_desc
, session
["project_id"], make_public
=session
["public"]
2006 if indata
.get("placement-engine"):
2007 # Save valid vim accounts in lcm operation descriptor
2008 nslcmop_desc
["operationParams"][
2010 ] = self
._get
_enabled
_vims
(session
)
2011 self
.db
.create("nslcmops", nslcmop_desc
)
2012 rollback
.append({"topic": "nslcmops", "_id": _id
})
2013 if not slice_object
:
2014 self
.msg
.write("ns", operation
, nslcmop_desc
)
2016 except ValidationError
as e
: # TODO remove try Except, it is captured at nbi.py
2017 raise EngineException(e
, HTTPStatus
.UNPROCESSABLE_ENTITY
)
2018 # except DbException as e:
2019 # raise EngineException("Cannot get ns_instance '{}': {}".format(e), HTTPStatus.NOT_FOUND)
2021 def delete(self
, session
, _id
, dry_run
=False, not_send_msg
=None):
2022 raise EngineException(
2023 "Method delete called directly", HTTPStatus
.INTERNAL_SERVER_ERROR
2026 def edit(self
, session
, _id
, indata
=None, kwargs
=None, content
=None):
2027 raise EngineException(
2028 "Method edit called directly", HTTPStatus
.INTERNAL_SERVER_ERROR
2032 class NsiTopic(BaseTopic
):
2035 quota_name
= "slice_instances"
2037 def __init__(self
, db
, fs
, msg
, auth
):
2038 BaseTopic
.__init
__(self
, db
, fs
, msg
, auth
)
2039 self
.nsrTopic
= NsrTopic(db
, fs
, msg
, auth
)
2042 def _format_ns_request(ns_request
):
2043 formated_request
= copy(ns_request
)
2044 # TODO: Add request params
2045 return formated_request
2048 def _format_addional_params(slice_request
):
2050 Get and format user additional params for NS or VNF
2051 :param slice_request: User instantiation additional parameters
2052 :return: a formatted copy of additional params or None if not supplied
2054 additional_params
= copy(slice_request
.get("additionalParamsForNsi"))
2055 if additional_params
:
2056 for k
, v
in additional_params
.items():
2057 if not isinstance(k
, str):
2058 raise EngineException(
2059 "Invalid param at additionalParamsForNsi:{}. Only string keys are allowed".format(
2063 if "." in k
or "$" in k
:
2064 raise EngineException(
2065 "Invalid param at additionalParamsForNsi:{}. Keys must not contain dots or $".format(
2069 if isinstance(v
, (dict, tuple, list)):
2070 additional_params
[k
] = "!!yaml " + safe_dump(v
)
2071 return additional_params
2073 def _check_descriptor_dependencies(self
, session
, descriptor
):
2075 Check that the dependent descriptors exist on a new descriptor or edition
2076 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
2077 :param descriptor: descriptor to be inserted or edit
2078 :return: None or raises exception
2080 if not descriptor
.get("nst-ref"):
2082 nstd_id
= descriptor
["nst-ref"]
2083 if not self
.get_item_list(session
, "nsts", {"id": nstd_id
}):
2084 raise EngineException(
2085 "Descriptor error at nst-ref='{}' references a non exist nstd".format(
2088 http_code
=HTTPStatus
.CONFLICT
,
2091 def check_conflict_on_del(self
, session
, _id
, db_content
):
2093 Check that NSI is not instantiated
2094 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
2095 :param _id: nsi internal id
2096 :param db_content: The database content of the _id
2097 :return: None or raises EngineException with the conflict
2099 if session
["force"]:
2102 if nsi
["_admin"].get("nsiState") == "INSTANTIATED":
2103 raise EngineException(
2104 "nsi '{}' cannot be deleted because it is in 'INSTANTIATED' state. "
2105 "Launch 'terminate' operation first; or force deletion".format(_id
),
2106 http_code
=HTTPStatus
.CONFLICT
,
2109 def delete_extra(self
, session
, _id
, db_content
, not_send_msg
=None):
2111 Deletes associated nsilcmops from database. Deletes associated filesystem.
2112 Set usageState of nst
2113 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
2114 :param _id: server internal id
2115 :param db_content: The database content of the descriptor
2116 :param not_send_msg: To not send message (False) or store content (list) instead
2117 :return: None if ok or raises EngineException with the problem
2120 # Deleting the nsrs belonging to nsir
2122 for nsrs_detailed_item
in nsir
["_admin"]["nsrs-detailed-list"]:
2123 nsr_id
= nsrs_detailed_item
["nsrId"]
2124 if nsrs_detailed_item
.get("shared"):
2126 "_admin.nsrs-detailed-list.ANYINDEX.shared": True,
2127 "_admin.nsrs-detailed-list.ANYINDEX.nsrId": nsr_id
,
2128 "_id.ne": nsir
["_id"],
2130 nsi
= self
.db
.get_one(
2131 "nsis", _filter
, fail_on_empty
=False, fail_on_more
=False
2133 if nsi
: # last one using nsr
2136 self
.nsrTopic
.delete(
2137 session
, nsr_id
, dry_run
=False, not_send_msg
=not_send_msg
2139 except (DbException
, EngineException
) as e
:
2140 if e
.http_code
== HTTPStatus
.NOT_FOUND
:
2145 # delete related nsilcmops database entries
2146 self
.db
.del_list("nsilcmops", {"netsliceInstanceId": _id
})
2148 # Check and set used NST usage state
2149 nsir_admin
= nsir
.get("_admin")
2150 if nsir_admin
and nsir_admin
.get("nst-id"):
2151 # check if used by another NSI
2152 nsis_list
= self
.db
.get_one(
2154 {"nst-id": nsir_admin
["nst-id"]},
2155 fail_on_empty
=False,
2161 {"_id": nsir_admin
["nst-id"]},
2162 {"_admin.usageState": "NOT_IN_USE"},
2165 def new(self
, rollback
, session
, indata
=None, kwargs
=None, headers
=None):
2167 Creates a new netslice instance record into database. It also creates needed nsrs and vnfrs
2168 :param rollback: list to append the created items at database in case a rollback must be done
2169 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
2170 :param indata: params to be used for the nsir
2171 :param kwargs: used to override the indata descriptor
2172 :param headers: http request headers
2173 :return: the _id of nsi descriptor created at database
2177 step
= "checking quotas"
2178 self
.check_quota(session
)
2181 slice_request
= self
._remove
_envelop
(indata
)
2182 # Override descriptor with query string kwargs
2183 self
._update
_input
_with
_kwargs
(slice_request
, kwargs
)
2184 slice_request
= self
._validate
_input
_new
(slice_request
, session
["force"])
2187 step
= "getting nstd id='{}' from database".format(
2188 slice_request
.get("nstId")
2190 _filter
= self
._get
_project
_filter
(session
)
2191 _filter
["_id"] = slice_request
["nstId"]
2192 nstd
= self
.db
.get_one("nsts", _filter
)
2193 # check NST is not disabled
2194 step
= "checking NST operationalState"
2195 if nstd
["_admin"]["operationalState"] == "DISABLED":
2196 raise EngineException(
2197 "nst with id '{}' is DISABLED, and thus cannot be used to create a netslice "
2198 "instance".format(slice_request
["nstId"]),
2199 http_code
=HTTPStatus
.CONFLICT
,
2203 # check NSD is not disabled
2204 step
= "checking operationalState"
2205 if nstd
["_admin"]["operationalState"] == "DISABLED":
2206 raise EngineException(
2207 "nst with id '{}' is DISABLED, and thus cannot be used to create "
2208 "a network slice".format(slice_request
["nstId"]),
2209 http_code
=HTTPStatus
.CONFLICT
,
2212 nstd
.pop("_admin", None)
2213 nstd_id
= nstd
.pop("_id", None)
2214 nsi_id
= str(uuid4())
2215 step
= "filling nsi_descriptor with input data"
2220 "name": slice_request
["nsiName"],
2221 "description": slice_request
.get("nsiDescription", ""),
2222 "datacenter": slice_request
["vimAccountId"],
2223 "nst-ref": nstd
["id"],
2224 "instantiation_parameters": slice_request
,
2225 "network-slice-template": nstd
,
2229 "additionalParamsForNsi": self
._format
_addional
_params
(slice_request
),
2232 step
= "creating nsi at database"
2234 nsi_descriptor
, session
["project_id"], make_public
=session
["public"]
2236 nsi_descriptor
["_admin"]["nsiState"] = "NOT_INSTANTIATED"
2237 nsi_descriptor
["_admin"]["netslice-subnet"] = None
2238 nsi_descriptor
["_admin"]["deployed"] = {}
2239 nsi_descriptor
["_admin"]["deployed"]["RO"] = []
2240 nsi_descriptor
["_admin"]["nst-id"] = nstd_id
2242 # Creating netslice-vld for the RO.
2243 step
= "creating netslice-vld at database"
2245 # Building the vlds list to be deployed
2246 # From netslice descriptors, creating the initial list
2249 for netslice_vlds
in get_iterable(nstd
.get("netslice-vld")):
2250 # Getting template Instantiation parameters from NST
2251 nsi_vld
= deepcopy(netslice_vlds
)
2252 nsi_vld
["shared-nsrs-list"] = []
2253 nsi_vld
["vimAccountId"] = slice_request
["vimAccountId"]
2254 nsi_vlds
.append(nsi_vld
)
2256 nsi_descriptor
["_admin"]["netslice-vld"] = nsi_vlds
2257 # Creating netslice-subnet_record.
2261 # Updating the nstd with the nsd["_id"] associated to the nss -> services list
2262 for member_ns
in nstd
["netslice-subnet"]:
2263 nsd_id
= member_ns
["nsd-ref"]
2264 step
= "getting nstd id='{}' constituent-nsd='{}' from database".format(
2265 member_ns
["nsd-ref"], member_ns
["id"]
2267 if nsd_id
not in needed_nsds
:
2269 _filter
["id"] = nsd_id
2270 nsd
= self
.db
.get_one(
2271 "nsds", _filter
, fail_on_empty
=True, fail_on_more
=True
2275 needed_nsds
[nsd_id
] = nsd
2277 nsd
= needed_nsds
[nsd_id
]
2278 member_ns
["_id"] = needed_nsds
[nsd_id
].get("_id")
2279 services
.append(member_ns
)
2281 step
= "filling nsir nsd-id='{}' constituent-nsd='{}' from database".format(
2282 member_ns
["nsd-ref"], member_ns
["id"]
2285 # creates Network Services records (NSRs)
2286 step
= "creating nsrs at database using NsrTopic.new()"
2287 ns_params
= slice_request
.get("netslice-subnet")
2289 nsi_netslice_subnet
= []
2290 for service
in services
:
2291 # Check if the netslice-subnet is shared and if it is share if the nss exists
2294 # Is the nss shared and instantiated?
2295 _filter
["_admin.nsrs-detailed-list.ANYINDEX.shared"] = True
2296 _filter
["_admin.nsrs-detailed-list.ANYINDEX.nsd-id"] = service
[
2299 _filter
["_admin.nsrs-detailed-list.ANYINDEX.nss-id"] = service
["id"]
2300 nsi
= self
.db
.get_one(
2301 "nsis", _filter
, fail_on_empty
=False, fail_on_more
=False
2303 if nsi
and service
.get("is-shared-nss"):
2304 nsrs_detailed_list
= nsi
["_admin"]["nsrs-detailed-list"]
2305 for nsrs_detailed_item
in nsrs_detailed_list
:
2306 if nsrs_detailed_item
["nsd-id"] == service
["nsd-ref"]:
2307 if nsrs_detailed_item
["nss-id"] == service
["id"]:
2308 _id_nsr
= nsrs_detailed_item
["nsrId"]
2310 for netslice_subnet
in nsi
["_admin"]["netslice-subnet"]:
2311 if netslice_subnet
["nss-id"] == service
["id"]:
2312 indata_ns
= netslice_subnet
2316 if service
.get("instantiation-parameters"):
2317 indata_ns
= deepcopy(service
["instantiation-parameters"])
2318 # del service["instantiation-parameters"]
2320 indata_ns
["nsdId"] = service
["_id"]
2321 indata_ns
["nsName"] = (
2322 slice_request
.get("nsiName") + "." + service
["id"]
2324 indata_ns
["vimAccountId"] = slice_request
.get("vimAccountId")
2325 indata_ns
["nsDescription"] = service
["description"]
2326 if slice_request
.get("ssh_keys"):
2327 indata_ns
["ssh_keys"] = slice_request
.get("ssh_keys")
2330 for ns_param
in ns_params
:
2331 if ns_param
.get("id") == service
["id"]:
2332 copy_ns_param
= deepcopy(ns_param
)
2333 del copy_ns_param
["id"]
2334 indata_ns
.update(copy_ns_param
)
2337 # Creates Nsr objects
2338 _id_nsr
, _
= self
.nsrTopic
.new(
2339 rollback
, session
, indata_ns
, kwargs
, headers
2343 "shared": service
.get("is-shared-nss"),
2344 "nsd-id": service
["nsd-ref"],
2345 "nss-id": service
["id"],
2346 "nslcmop_instantiate": None,
2348 indata_ns
["nss-id"] = service
["id"]
2349 nsrs_list
.append(nsrs_item
)
2350 nsi_netslice_subnet
.append(indata_ns
)
2351 nsr_ref
= {"nsr-ref": _id_nsr
}
2352 nsi_descriptor
["nsr-ref-list"].append(nsr_ref
)
2354 # Adding the nsrs list to the nsi
2355 nsi_descriptor
["_admin"]["nsrs-detailed-list"] = nsrs_list
2356 nsi_descriptor
["_admin"]["netslice-subnet"] = nsi_netslice_subnet
2358 "nsts", {"_id": slice_request
["nstId"]}, {"_admin.usageState": "IN_USE"}
2361 # Creating the entry in the database
2362 self
.db
.create("nsis", nsi_descriptor
)
2363 rollback
.append({"topic": "nsis", "_id": nsi_id
})
2365 except Exception as e
: # TODO remove try Except, it is captured at nbi.py
2366 self
.logger
.exception(
2367 "Exception {} at NsiTopic.new()".format(e
), exc_info
=True
2369 raise EngineException("Error {}: {}".format(step
, e
))
2370 except ValidationError
as e
:
2371 raise EngineException(e
, HTTPStatus
.UNPROCESSABLE_ENTITY
)
2373 def edit(self
, session
, _id
, indata
=None, kwargs
=None, content
=None):
2374 raise EngineException(
2375 "Method edit called directly", HTTPStatus
.INTERNAL_SERVER_ERROR
2379 class NsiLcmOpTopic(BaseTopic
):
2382 operation_schema
= { # mapping between operation and jsonschema to validate
2383 "instantiate": nsi_instantiate
,
2387 def __init__(self
, db
, fs
, msg
, auth
):
2388 BaseTopic
.__init
__(self
, db
, fs
, msg
, auth
)
2389 self
.nsi_NsLcmOpTopic
= NsLcmOpTopic(self
.db
, self
.fs
, self
.msg
, self
.auth
)
2391 def _check_nsi_operation(self
, session
, nsir
, operation
, indata
):
2393 Check that user has enter right parameters for the operation
2394 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
2395 :param operation: it can be: instantiate, terminate, action, TODO: update, heal
2396 :param indata: descriptor with the parameters of the operation
2400 nstd
= nsir
["network-slice-template"]
2402 def check_valid_netslice_subnet_id(nstId
):
2403 # TODO change to vnfR (??)
2404 for netslice_subnet
in nstd
["netslice-subnet"]:
2405 if nstId
== netslice_subnet
["id"]:
2406 nsd_id
= netslice_subnet
["nsd-ref"]
2407 if nsd_id
not in nsds
:
2408 _filter
= self
._get
_project
_filter
(session
)
2409 _filter
["id"] = nsd_id
2410 nsds
[nsd_id
] = self
.db
.get_one("nsds", _filter
)
2413 raise EngineException(
2414 "Invalid parameter nstId='{}' is not one of the "
2415 "nst:netslice-subnet".format(nstId
)
2418 if operation
== "instantiate":
2419 # check the existance of netslice-subnet items
2420 for in_nst
in get_iterable(indata
.get("netslice-subnet")):
2421 check_valid_netslice_subnet_id(in_nst
["id"])
2423 def _create_nsilcmop(self
, session
, netsliceInstanceId
, operation
, params
):
2429 "operationState": "PROCESSING", # COMPLETED,PARTIALLY_COMPLETED,FAILED_TEMP,FAILED,ROLLING_BACK,ROLLED_BACK
2430 "statusEnteredTime": now
,
2431 "netsliceInstanceId": netsliceInstanceId
,
2432 "lcmOperationType": operation
,
2434 "isAutomaticInvocation": False,
2435 "operationParams": params
,
2436 "isCancelPending": False,
2438 "self": "/osm/nsilcm/v1/nsi_lcm_op_occs/" + _id
,
2439 "netsliceInstanceId": "/osm/nsilcm/v1/netslice_instances/"
2440 + netsliceInstanceId
,
2445 def add_shared_nsr_2vld(self
, nsir
, nsr_item
):
2446 for nst_sb_item
in nsir
["network-slice-template"].get("netslice-subnet"):
2447 if nst_sb_item
.get("is-shared-nss"):
2448 for admin_subnet_item
in nsir
["_admin"].get("netslice-subnet"):
2449 if admin_subnet_item
["nss-id"] == nst_sb_item
["id"]:
2450 for admin_vld_item
in nsir
["_admin"].get("netslice-vld"):
2451 for admin_vld_nss_cp_ref_item
in admin_vld_item
[
2452 "nss-connection-point-ref"
2455 admin_subnet_item
["nss-id"]
2456 == admin_vld_nss_cp_ref_item
["nss-ref"]
2459 not nsr_item
["nsrId"]
2460 in admin_vld_item
["shared-nsrs-list"]
2462 admin_vld_item
["shared-nsrs-list"].append(
2466 # self.db.set_one("nsis", {"_id": nsir["_id"]}, nsir)
2469 {"_id": nsir
["_id"]},
2470 {"_admin.netslice-vld": nsir
["_admin"].get("netslice-vld")},
2473 def new(self
, rollback
, session
, indata
=None, kwargs
=None, headers
=None):
2475 Performs a new operation over a ns
2476 :param rollback: list to append created items at database in case a rollback must to be done
2477 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
2478 :param indata: descriptor with the parameters of the operation. It must contains among others
2479 netsliceInstanceId: _id of the nsir to perform the operation
2480 operation: it can be: instantiate, terminate, action, TODO: update, heal
2481 :param kwargs: used to override the indata descriptor
2482 :param headers: http request headers
2483 :return: id of the nslcmops
2486 # Override descriptor with query string kwargs
2487 self
._update
_input
_with
_kwargs
(indata
, kwargs
)
2488 operation
= indata
["lcmOperationType"]
2489 netsliceInstanceId
= indata
["netsliceInstanceId"]
2490 validate_input(indata
, self
.operation_schema
[operation
])
2492 # get nsi from netsliceInstanceId
2493 _filter
= self
._get
_project
_filter
(session
)
2494 _filter
["_id"] = netsliceInstanceId
2495 nsir
= self
.db
.get_one("nsis", _filter
)
2496 logging_prefix
= "nsi={} {} ".format(netsliceInstanceId
, operation
)
2501 not nsir
["_admin"].get("nsiState")
2502 or nsir
["_admin"]["nsiState"] == "NOT_INSTANTIATED"
2504 if operation
== "terminate" and indata
.get("autoremove"):
2505 # NSIR must be deleted
2509 ) # a none in this case is used to indicate not instantiated. It can be removed
2510 if operation
!= "instantiate":
2511 raise EngineException(
2512 "netslice_instance '{}' cannot be '{}' because it is not instantiated".format(
2513 netsliceInstanceId
, operation
2515 HTTPStatus
.CONFLICT
,
2518 if operation
== "instantiate" and not session
["force"]:
2519 raise EngineException(
2520 "netslice_instance '{}' cannot be '{}' because it is already instantiated".format(
2521 netsliceInstanceId
, operation
2523 HTTPStatus
.CONFLICT
,
2526 # Creating all the NS_operation (nslcmop)
2527 # Get service list from db
2528 nsrs_list
= nsir
["_admin"]["nsrs-detailed-list"]
2530 # nslcmops_item = None
2531 for index
, nsr_item
in enumerate(nsrs_list
):
2532 nsr_id
= nsr_item
["nsrId"]
2533 if nsr_item
.get("shared"):
2534 _filter
["_admin.nsrs-detailed-list.ANYINDEX.shared"] = True
2535 _filter
["_admin.nsrs-detailed-list.ANYINDEX.nsrId"] = nsr_id
2537 "_admin.nsrs-detailed-list.ANYINDEX.nslcmop_instantiate.ne"
2539 _filter
["_id.ne"] = netsliceInstanceId
2540 nsi
= self
.db
.get_one(
2541 "nsis", _filter
, fail_on_empty
=False, fail_on_more
=False
2543 if operation
== "terminate":
2545 "_admin.nsrs-detailed-list.{}.nslcmop_instantiate".format(
2549 self
.db
.set_one("nsis", {"_id": nsir
["_id"]}, _update
)
2552 ): # other nsi is using this nsr and it needs this nsr instantiated
2553 continue # do not create nsilcmop
2555 # looks the first nsi fulfilling the conditions but not being the current NSIR
2557 nsi_nsr_item
= next(
2559 for n
in nsi
["_admin"]["nsrs-detailed-list"]
2560 if n
["nsrId"] == nsr_id
2562 and n
["nslcmop_instantiate"]
2564 self
.add_shared_nsr_2vld(nsir
, nsr_item
)
2565 nslcmops
.append(nsi_nsr_item
["nslcmop_instantiate"])
2567 "_admin.nsrs-detailed-list.{}".format(
2571 self
.db
.set_one("nsis", {"_id": nsir
["_id"]}, _update
)
2572 # continue to not create nslcmop since nsrs is shared and nsrs was created
2575 self
.add_shared_nsr_2vld(nsir
, nsr_item
)
2580 "lcmOperationType": operation
,
2581 "nsInstanceId": nsr_id
,
2582 # Including netslice_id in the ns instantiate Operation
2583 "netsliceInstanceId": netsliceInstanceId
,
2585 if operation
== "instantiate":
2586 service
= self
.db
.get_one("nsrs", {"_id": nsr_id
})
2587 indata_ns
.update(service
["instantiate_params"])
2589 # Creating NS_LCM_OP with the flag slice_object=True to not trigger the service instantiation
2590 # message via kafka bus
2591 nslcmop
, _
= self
.nsi_NsLcmOpTopic
.new(
2592 rollback
, session
, indata_ns
, None, headers
, slice_object
=True
2594 nslcmops
.append(nslcmop
)
2595 if operation
== "instantiate":
2597 "_admin.nsrs-detailed-list.{}.nslcmop_instantiate".format(
2601 self
.db
.set_one("nsis", {"_id": nsir
["_id"]}, _update
)
2602 except (DbException
, EngineException
) as e
:
2603 if e
.http_code
== HTTPStatus
.NOT_FOUND
:
2606 + "skipping NS={} because not found".format(nsr_id
)
2613 indata
["nslcmops_ids"] = nslcmops
2614 self
._check
_nsi
_operation
(session
, nsir
, operation
, indata
)
2616 nsilcmop_desc
= self
._create
_nsilcmop
(
2617 session
, netsliceInstanceId
, operation
, indata
2620 nsilcmop_desc
, session
["project_id"], make_public
=session
["public"]
2622 _id
= self
.db
.create("nsilcmops", nsilcmop_desc
)
2623 rollback
.append({"topic": "nsilcmops", "_id": _id
})
2624 self
.msg
.write("nsi", operation
, nsilcmop_desc
)
2626 except ValidationError
as e
:
2627 raise EngineException(e
, HTTPStatus
.UNPROCESSABLE_ENTITY
)
2629 def delete(self
, session
, _id
, dry_run
=False, not_send_msg
=None):
2630 raise EngineException(
2631 "Method delete called directly", HTTPStatus
.INTERNAL_SERVER_ERROR
2634 def edit(self
, session
, _id
, indata
=None, kwargs
=None, content
=None):
2635 raise EngineException(
2636 "Method edit called directly", HTTPStatus
.INTERNAL_SERVER_ERROR