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 validate_input
, ValidationError
, ns_instantiate
, ns_terminate
, ns_action
, ns_scale
,\
23 from osm_nbi
.base_topic
import BaseTopic
, EngineException
, get_iterable
, deep_get
, increment_ip_mac
24 from yaml
import safe_dump
25 from osm_common
.dbbase
import DbException
26 from osm_common
.msgbase
import MsgException
27 from osm_common
.fsbase
import FsException
28 from osm_nbi
import utils
29 from re
import match
# For checking that additional parameter names are valid Jinja2 identifiers
31 __author__
= "Alfonso Tierno <alfonso.tiernosepulveda@telefonica.com>"
34 class NsrTopic(BaseTopic
):
37 quota_name
= "ns_instances"
38 schema_new
= ns_instantiate
40 def __init__(self
, db
, fs
, msg
, auth
):
41 BaseTopic
.__init
__(self
, db
, fs
, msg
, auth
)
43 def _check_descriptor_dependencies(self
, session
, descriptor
):
45 Check that the dependent descriptors exist on a new descriptor or edition
46 :param session: client session information
47 :param descriptor: descriptor to be inserted or edit
48 :return: None or raises exception
50 if not descriptor
.get("nsdId"):
52 nsd_id
= descriptor
["nsdId"]
53 if not self
.get_item_list(session
, "nsds", {"id": nsd_id
}):
54 raise EngineException("Descriptor error at nsdId='{}' references a non exist nsd".format(nsd_id
),
55 http_code
=HTTPStatus
.CONFLICT
)
58 def format_on_new(content
, project_id
=None, make_public
=False):
59 BaseTopic
.format_on_new(content
, project_id
=project_id
, make_public
=make_public
)
60 content
["_admin"]["nsState"] = "NOT_INSTANTIATED"
63 def check_conflict_on_del(self
, session
, _id
, db_content
):
65 Check that NSR is not instantiated
66 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
67 :param _id: nsr internal id
68 :param db_content: The database content of the nsr
69 :return: None or raises EngineException with the conflict
74 if nsr
["_admin"].get("nsState") == "INSTANTIATED":
75 raise EngineException("nsr '{}' cannot be deleted because it is in 'INSTANTIATED' state. "
76 "Launch 'terminate' operation first; or force deletion".format(_id
),
77 http_code
=HTTPStatus
.CONFLICT
)
79 def delete_extra(self
, session
, _id
, db_content
, not_send_msg
=None):
81 Deletes associated nslcmops and vnfrs from database. Deletes associated filesystem.
82 Set usageState of pdu, vnfd, nsd
83 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
84 :param _id: server internal id
85 :param db_content: The database content of the descriptor
86 :param not_send_msg: To not send message (False) or store content (list) instead
87 :return: None if ok or raises EngineException with the problem
89 self
.fs
.file_delete(_id
, ignore_non_exist
=True)
90 self
.db
.del_list("nslcmops", {"nsInstanceId": _id
})
91 self
.db
.del_list("vnfrs", {"nsr-id-ref": _id
})
93 # set all used pdus as free
94 self
.db
.set_list("pdus", {"_admin.usage.nsr_id": _id
},
95 {"_admin.usageState": "NOT_IN_USE", "_admin.usage": None})
99 used_nsd_id
= nsr
.get("nsd-id")
101 # check if used by another NSR
102 nsrs_list
= self
.db
.get_one("nsrs", {"nsd-id": used_nsd_id
},
103 fail_on_empty
=False, fail_on_more
=False)
105 self
.db
.set_one("nsds", {"_id": used_nsd_id
}, {"_admin.usageState": "NOT_IN_USE"})
107 # Set VNFD usageState
108 used_vnfd_id_list
= nsr
.get("vnfd-id")
109 if used_vnfd_id_list
:
110 for used_vnfd_id
in used_vnfd_id_list
:
111 # check if used by another NSR
112 nsrs_list
= self
.db
.get_one("nsrs", {"vnfd-id": used_vnfd_id
},
113 fail_on_empty
=False, fail_on_more
=False)
115 self
.db
.set_one("vnfds", {"_id": used_vnfd_id
}, {"_admin.usageState": "NOT_IN_USE"})
117 # delete extra ro_nsrs used for internal RO module
118 self
.db
.del_one("ro_nsrs", q_filter
={"_id": _id
}, fail_on_empty
=False)
121 def _format_ns_request(ns_request
):
122 formated_request
= copy(ns_request
)
123 formated_request
.pop("additionalParamsForNs", None)
124 formated_request
.pop("additionalParamsForVnf", None)
125 return formated_request
128 def _format_additional_params(ns_request
, member_vnf_index
=None, vdu_id
=None, kdu_name
=None, descriptor
=None):
130 Get and format user additional params for NS or VNF
131 :param ns_request: User instantiation additional parameters
132 :param member_vnf_index: None for extract NS params, or member_vnf_index to extract VNF params
133 :param descriptor: If not None it check that needed parameters of descriptor are supplied
134 :return: tuple with a formatted copy of additional params or None if not supplied, plus other parameters
136 additional_params
= None
138 if not member_vnf_index
:
139 additional_params
= copy(ns_request
.get("additionalParamsForNs"))
140 where_
= "additionalParamsForNs"
141 elif ns_request
.get("additionalParamsForVnf"):
142 where_
= "additionalParamsForVnf[member-vnf-index={}]".format(member_vnf_index
)
143 item
= next((x
for x
in ns_request
["additionalParamsForVnf"] if x
["member-vnf-index"] == member_vnf_index
),
146 if not vdu_id
and not kdu_name
:
148 additional_params
= copy(item
.get("additionalParams")) or {}
149 if vdu_id
and item
.get("additionalParamsForVdu"):
150 item_vdu
= next((x
for x
in item
["additionalParamsForVdu"] if x
["vdu_id"] == vdu_id
), None)
151 other_params
= item_vdu
152 if item_vdu
and item_vdu
.get("additionalParams"):
153 where_
+= ".additionalParamsForVdu[vdu_id={}]".format(vdu_id
)
154 additional_params
= item_vdu
["additionalParams"]
156 additional_params
= {}
157 if item
.get("additionalParamsForKdu"):
158 item_kdu
= next((x
for x
in item
["additionalParamsForKdu"] if x
["kdu_name"] == kdu_name
), None)
159 other_params
= item_kdu
160 if item_kdu
and item_kdu
.get("additionalParams"):
161 where_
+= ".additionalParamsForKdu[kdu_name={}]".format(kdu_name
)
162 additional_params
= item_kdu
["additionalParams"]
164 if additional_params
:
165 for k
, v
in additional_params
.items():
166 # BEGIN Check that additional parameter names are valid Jinja2 identifiers if target is not Kdu
167 if not kdu_name
and not match('^[a-zA-Z_][a-zA-Z0-9_]*$', k
):
168 raise EngineException("Invalid param name at {}:{}. Must contain only alphanumeric characters "
169 "and underscores, and cannot start with a digit"
171 # END Check that additional parameter names are valid Jinja2 identifiers
172 if not isinstance(k
, str):
173 raise EngineException("Invalid param at {}:{}. Only string keys are allowed".format(where_
, k
))
174 if "." in k
or "$" in k
:
175 raise EngineException("Invalid param at {}:{}. Keys must not contain dots or $".format(where_
, k
))
176 if isinstance(v
, (dict, tuple, list)):
177 additional_params
[k
] = "!!yaml " + safe_dump(v
)
180 for df
in descriptor
.get("df", []):
181 # check that enough parameters are supplied for the initial-config-primitive
182 # TODO: check for cloud-init
184 initial_primitives
= []
185 if "lcm-operations-configuration" in df \
186 and "operate-vnf-op-config" in df
["lcm-operations-configuration"]:
187 for config
in df
["lcm-operations-configuration"]["operate-vnf-op-config"].get("day1-2", []):
188 for primitive
in get_iterable(config
.get("initial-config-primitive")):
189 initial_primitives
.append(primitive
)
191 initial_primitives
= deep_get(descriptor
, ("ns-configuration", "initial-config-primitive"))
193 for initial_primitive
in get_iterable(initial_primitives
):
194 for param
in get_iterable(initial_primitive
.get("parameter")):
195 if param
["value"].startswith("<") and param
["value"].endswith(">"):
196 if param
["value"] in ("<rw_mgmt_ip>", "<VDU_SCALE_INFO>", "<ns_config_info>"):
198 if not additional_params
or param
["value"][1:-1] not in additional_params
:
199 raise EngineException("Parameter '{}' needed for vnfd[id={}]:day1-2 configuration:"
200 "initial-config-primitive[name={}] not supplied".
201 format(param
["value"], descriptor
["id"],
202 initial_primitive
["name"]))
204 return additional_params
or None, other_params
or None
206 def new(self
, rollback
, session
, indata
=None, kwargs
=None, headers
=None):
208 Creates a new nsr into database. It also creates needed vnfrs
209 :param rollback: list to append the created items at database in case a rollback must be done
210 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
211 :param indata: params to be used for the nsr
212 :param kwargs: used to override the indata descriptor
213 :param headers: http request headers
214 :return: the _id of nsr descriptor created at database. Or an exception of type
215 EngineException, ValidationError, DbException, FsException, MsgException.
216 Note: Exceptions are not captured on purpose. They should be captured at called
219 step
= "checking quotas"
220 self
.check_quota(session
)
222 step
= "validating input parameters"
223 ns_request
= self
._remove
_envelop
(indata
)
224 self
._update
_input
_with
_kwargs
(ns_request
, kwargs
)
225 ns_request
= self
._validate
_input
_new
(ns_request
, session
["force"])
227 step
= "getting nsd id='{}' from database".format(ns_request
.get("nsdId"))
228 nsd
= self
._get
_nsd
_from
_db
(ns_request
["nsdId"], session
)
229 ns_k8s_namespace
= self
._get
_ns
_k
8s
_namespace
(nsd
, ns_request
, session
)
231 step
= "checking nsdOperationalState"
232 self
._check
_nsd
_operational
_state
(nsd
, ns_request
)
234 step
= "filling nsr from input data"
235 nsr_id
= str(uuid4())
236 nsr_descriptor
= self
._create
_nsr
_descriptor
_from
_nsd
(nsd
, ns_request
, nsr_id
, session
)
240 # TODO: Change for multiple df support
241 vnf_profiles
= nsd
.get("df", [[]])[0].get("vnf-profile", ())
242 for vnfp
in vnf_profiles
:
243 vnfd_id
= vnfp
.get("vnfd-id")
244 vnf_index
= vnfp
.get("id")
245 step
= "getting vnfd id='{}' constituent-vnfd='{}' from database".format(vnfd_id
, vnf_index
)
246 if vnfd_id
not in needed_vnfds
:
247 vnfd
= self
._get
_vnfd
_from
_db
(vnfd_id
, session
)
248 needed_vnfds
[vnfd_id
] = vnfd
249 nsr_descriptor
["vnfd-id"].append(vnfd
["_id"])
251 vnfd
= needed_vnfds
[vnfd_id
]
253 step
= "filling vnfr vnfd-id='{}' constituent-vnfd='{}'".format(vnfd_id
, vnf_index
)
254 vnfr_descriptor
= self
._create
_vnfr
_descriptor
_from
_vnfd
(nsd
, vnfd
, vnfd_id
, vnf_index
, nsr_descriptor
,
255 ns_request
, ns_k8s_namespace
)
257 step
= "creating vnfr vnfd-id='{}' constituent-vnfd='{}' at database".format(vnfd_id
, vnf_index
)
258 self
._add
_vnfr
_to
_db
(vnfr_descriptor
, rollback
, session
)
259 nsr_descriptor
["constituent-vnfr-ref"].append(vnfr_descriptor
["id"])
261 step
= "creating nsr at database"
262 self
._add
_nsr
_to
_db
(nsr_descriptor
, rollback
, session
)
264 step
= "creating nsr temporal folder"
265 self
.fs
.mkdir(nsr_id
)
268 except (ValidationError
, EngineException
, DbException
, MsgException
, FsException
) as e
:
269 raise type(e
)("{} while '{}'".format(e
, step
), http_code
=e
.http_code
)
271 def _get_nsd_from_db(self
, nsd_id
, session
):
272 _filter
= self
._get
_project
_filter
(session
)
273 _filter
["_id"] = nsd_id
274 return self
.db
.get_one("nsds", _filter
)
276 def _get_vnfd_from_db(self
, vnfd_id
, session
):
277 _filter
= self
._get
_project
_filter
(session
)
278 _filter
["id"] = vnfd_id
279 vnfd
= self
.db
.get_one("vnfds", _filter
, fail_on_empty
=True, fail_on_more
=True)
283 def _add_nsr_to_db(self
, nsr_descriptor
, rollback
, session
):
284 self
.format_on_new(nsr_descriptor
, session
["project_id"], make_public
=session
["public"])
285 self
.db
.create("nsrs", nsr_descriptor
)
286 rollback
.append({"topic": "nsrs", "_id": nsr_descriptor
["id"]})
288 def _add_vnfr_to_db(self
, vnfr_descriptor
, rollback
, session
):
289 self
.format_on_new(vnfr_descriptor
, session
["project_id"], make_public
=session
["public"])
290 self
.db
.create("vnfrs", vnfr_descriptor
)
291 rollback
.append({"topic": "vnfrs", "_id": vnfr_descriptor
["id"]})
293 def _check_nsd_operational_state(self
, nsd
, ns_request
):
294 if nsd
["_admin"]["operationalState"] == "DISABLED":
295 raise EngineException("nsd with id '{}' is DISABLED, and thus cannot be used to create "
296 "a network service".format(ns_request
["nsdId"]), http_code
=HTTPStatus
.CONFLICT
)
298 def _get_ns_k8s_namespace(self
, nsd
, ns_request
, session
):
299 additional_params
, _
= self
._format
_additional
_params
(ns_request
, descriptor
=nsd
)
300 # use for k8s-namespace from ns_request or additionalParamsForNs. By default, the project_id
301 ns_k8s_namespace
= session
["project_id"][0] if session
["project_id"] else None
302 if ns_request
and ns_request
.get("k8s-namespace"):
303 ns_k8s_namespace
= ns_request
["k8s-namespace"]
304 if additional_params
and additional_params
.get("k8s-namespace"):
305 ns_k8s_namespace
= additional_params
["k8s-namespace"]
307 return ns_k8s_namespace
309 def _create_nsr_descriptor_from_nsd(self
, nsd
, ns_request
, nsr_id
, session
):
311 additional_params
, _
= self
._format
_additional
_params
(ns_request
, descriptor
=nsd
)
314 "name": ns_request
["nsName"],
315 "name-ref": ns_request
["nsName"],
316 "short-name": ns_request
["nsName"],
317 "admin-status": "ENABLED",
318 "nsState": "NOT_INSTANTIATED",
319 "currentOperation": "IDLE",
320 "currentOperationID": None,
321 "errorDescription": None,
323 "deploymentStatus": None,
324 "configurationStatus": None,
326 "nsd": {k
: v
for k
, v
in nsd
.items()},
327 "datacenter": ns_request
["vimAccountId"],
328 "resource-orchestrator": "osmopenmano",
329 "description": ns_request
.get("nsDescription", ""),
330 "constituent-vnfr-ref": [],
331 "operational-status": "init", # typedef ns-operational-
332 "config-status": "init", # typedef config-states
333 "detailed-status": "scheduled",
334 "orchestration-progress": {},
336 "nsd-name-ref": nsd
["name"],
337 "operational-events": [], # "id", "timestamp", "description", "event",
338 "nsd-ref": nsd
["id"],
339 "nsd-id": nsd
["_id"],
341 "instantiate_params": self
._format
_ns
_request
(ns_request
),
342 "additionalParamsForNs": additional_params
,
343 "ns-instance-config-ref": nsr_id
,
346 "ssh-authorized-key": ns_request
.get("ssh_keys"), # TODO remove
350 ns_request
["nsr_id"] = nsr_id
351 if ns_request
and ns_request
.get("config-units"):
352 nsr_descriptor
["config-units"] = ns_request
["config-units"]
355 if nsd
.get("virtual-link-desc"):
356 nsr_vld
= deepcopy(nsd
.get("virtual-link-desc", []))
357 # Fill each vld with vnfd-connection-point-ref data
358 # TODO: Change for multiple df support
359 all_vld_connection_point_data
= {vld
.get("id"): [] for vld
in nsr_vld
}
360 vnf_profiles
= nsd
.get("df", [[]])[0].get("vnf-profile", ())
361 for vnf_profile
in vnf_profiles
:
362 for vlc
in vnf_profile
.get("virtual-link-connectivity", ()):
363 for cpd
in vlc
.get("constituent-cpd-id", ()):
364 all_vld_connection_point_data
[vlc
.get("virtual-link-profile-id")].append({
365 "member-vnf-index-ref": cpd
.get("constituent-base-element-id"),
366 "vnfd-connection-point-ref": cpd
.get("constituent-cpd-id"),
367 "vnfd-id-ref": vnf_profile
.get("vnfd-id")
370 vnfd
= self
._get
_vnfd
_from
_db
(vnf_profile
.get("vnfd-id"), session
)
372 for vdu
in vnfd
.get("vdu", ()):
375 # Find this vdu compute and storage descriptors
376 vdu_virtual_compute
= {}
377 vdu_virtual_storage
= {}
378 for vcd
in vnfd
.get("virtual-compute-desc", ()):
379 if vcd
.get("id") == vdu
.get("virtual-compute-desc"):
380 vdu_virtual_compute
= vcd
381 for vsd
in vnfd
.get("virtual-storage-desc", ()):
382 if vsd
.get("id") == vdu
.get("virtual-storage-desc", [[]])[0]:
383 vdu_virtual_storage
= vsd
384 # Get this vdu vcpus, memory and storage info for flavor_data
385 if vdu_virtual_compute
.get("virtual-cpu", {}).get("num-virtual-cpu"):
386 flavor_data
["vcpu-count"] = vdu_virtual_compute
["virtual-cpu"]["num-virtual-cpu"]
387 if vdu_virtual_compute
.get("virtual-memory", {}).get("size"):
388 flavor_data
["memory-mb"] = float(vdu_virtual_compute
["virtual-memory"]["size"]) * 1024.0
389 if vdu_virtual_storage
.get("size-of-storage"):
390 flavor_data
["storage-gb"] = vdu_virtual_storage
["size-of-storage"]
391 # Get this vdu EPA info for guest_epa
392 if vdu_virtual_compute
.get("virtual-cpu", {}).get("cpu-quota"):
393 guest_epa
["cpu-quota"] = vdu_virtual_compute
["virtual-cpu"]["cpu-quota"]
394 if vdu_virtual_compute
.get("virtual-cpu", {}).get("pinning"):
395 vcpu_pinning
= vdu_virtual_compute
["virtual-cpu"]["pinning"]
396 if vcpu_pinning
.get("thread-policy"):
397 guest_epa
["cpu-thread-pinning-policy"] = vcpu_pinning
["thread-policy"]
398 if vcpu_pinning
.get("policy"):
399 cpu_policy
= "SHARED" if vcpu_pinning
["policy"] == "dynamic" else "DEDICATED"
400 guest_epa
["cpu-pinning-policy"] = cpu_policy
401 if vdu_virtual_compute
.get("virtual-memory", {}).get("mem-quota"):
402 guest_epa
["mem-quota"] = vdu_virtual_compute
["virtual-memory"]["mem-quota"]
403 if vdu_virtual_compute
.get("virtual-memory", {}).get("mempage-size"):
404 guest_epa
["mempage-size"] = vdu_virtual_compute
["virtual-memory"]["mempage-size"]
405 if vdu_virtual_compute
.get("virtual-memory", {}).get("numa-node-policy"):
406 guest_epa
["numa-node-policy"] = vdu_virtual_compute
["virtual-memory"]["numa-node-policy"]
407 if vdu_virtual_storage
.get("disk-io-quota"):
408 guest_epa
["disk-io-quota"] = vdu_virtual_storage
["disk-io-quota"]
411 flavor_data
["guest-epa"] = guest_epa
413 flavor_data
["name"] = vdu
["id"][:56] + "-flv"
414 flavor_data
["id"] = str(len(nsr_descriptor
["flavor"]))
415 nsr_descriptor
["flavor"].append(flavor_data
)
417 sw_image_id
= vdu
.get("sw-image-desc")
419 image_data
= self
._get
_image
_data
_from
_vnfd
(vnfd
, sw_image_id
)
420 self
._add
_image
_to
_nsr
(nsr_descriptor
, image_data
)
422 # also add alternative images to the list of images
423 for alt_image
in vdu
.get("alternative-sw-image-desc", ()):
424 image_data
= self
._get
_image
_data
_from
_vnfd
(vnfd
, alt_image
)
425 self
._add
_image
_to
_nsr
(nsr_descriptor
, image_data
)
428 vld
["vnfd-connection-point-ref"] = all_vld_connection_point_data
.get(vld
.get("id"), [])
429 vld
["name"] = vld
["id"]
430 nsr_descriptor
["vld"] = nsr_vld
432 return nsr_descriptor
434 def _get_image_data_from_vnfd(self
, vnfd
, sw_image_id
):
435 sw_image_desc
= utils
.find_in_list(vnfd
.get("sw-image-desc", ()),
436 lambda sw
: sw
["id"] == sw_image_id
)
438 if sw_image_desc
.get("image"):
439 image_data
["image"] = sw_image_desc
["image"]
440 if sw_image_desc
.get("checksum"):
441 image_data
["image_checksum"] = sw_image_desc
["checksum"]["hash"]
442 if sw_image_desc
.get("vim-type"):
443 image_data
["vim-type"] = sw_image_desc
["vim-type"]
446 def _add_image_to_nsr(self
, nsr_descriptor
, image_data
):
448 Adds image to nsr checking first it is not already added
450 img
= next((f
for f
in nsr_descriptor
["image"] if
451 all(f
.get(k
) == image_data
[k
] for k
in image_data
)), None)
453 image_data
["id"] = str(len(nsr_descriptor
["image"]))
454 nsr_descriptor
["image"].append(image_data
)
456 def _create_vnfr_descriptor_from_vnfd(self
, nsd
, vnfd
, vnfd_id
, vnf_index
, nsr_descriptor
,
457 ns_request
, ns_k8s_namespace
):
458 vnfr_id
= str(uuid4())
459 nsr_id
= nsr_descriptor
["id"]
461 additional_params
, vnf_params
= self
._format
_additional
_params
(ns_request
, vnf_index
, descriptor
=vnfd
)
466 "nsr-id-ref": nsr_id
,
467 "member-vnf-index-ref": vnf_index
,
468 "additionalParamsForVnf": additional_params
,
470 # "vnfd": vnfd, # at OSM model.but removed to avoid data duplication TODO: revise
472 "vnfd-id": vnfd
["_id"], # not at OSM model, but useful
473 "vim-account-id": None,
475 "connection-point": [],
476 "ip-address": None, # mgmt-interface filled by LCM
478 vnf_k8s_namespace
= ns_k8s_namespace
480 if vnf_params
.get("k8s-namespace"):
481 vnf_k8s_namespace
= vnf_params
["k8s-namespace"]
482 if vnf_params
.get("config-units"):
483 vnfr_descriptor
["config-units"] = vnf_params
["config-units"]
486 if vnfd
.get("int-virtual-link-desc"):
487 vnfr_descriptor
["vld"] = []
488 for vnfd_vld
in vnfd
.get("int-virtual-link-desc"):
489 vnfr_descriptor
["vld"].append({key
: vnfd_vld
[key
] for key
in vnfd_vld
})
491 for cp
in vnfd
.get("ext-cpd", ()):
493 "name": cp
.get("id"),
494 "connection-point-id": cp
.get("int-cpd", {}).get("cpd"),
495 "connection-point-vdu-id": cp
.get("int-cpd", {}).get("vdu-id"),
497 # "ip-address", "mac-address" # filled by LCM
498 # vim-id # TODO it would be nice having a vim port id
500 vnfr_descriptor
["connection-point"].append(vnf_cp
)
502 # Create k8s-cluster information
503 # TODO: Validate if a k8s-cluster net can have more than one ext-cpd ?
504 if vnfd
.get("k8s-cluster"):
505 vnfr_descriptor
["k8s-cluster"] = vnfd
["k8s-cluster"]
506 all_k8s_cluster_nets_cpds
= {}
507 for cpd
in get_iterable(vnfd
.get("ext-cpd")):
508 if cpd
.get("k8s-cluster-net"):
509 all_k8s_cluster_nets_cpds
[cpd
.get("k8s-cluster-net")] = cpd
.get("id")
510 for net
in get_iterable(vnfr_descriptor
["k8s-cluster"].get("nets")):
511 if net
.get("id") in all_k8s_cluster_nets_cpds
:
512 net
["external-connection-point-ref"] = all_k8s_cluster_nets_cpds
[net
.get("id")]
515 for kdu
in get_iterable(vnfd
.get("kdu")):
516 additional_params
, kdu_params
= self
._format
_additional
_params
(ns_request
,
518 kdu_name
=kdu
["name"],
520 kdu_k8s_namespace
= vnf_k8s_namespace
521 kdu_model
= kdu_params
.get("kdu_model") if kdu_params
else None
522 if kdu_params
and kdu_params
.get("k8s-namespace"):
523 kdu_k8s_namespace
= kdu_params
["k8s-namespace"]
526 "additionalParams": additional_params
,
527 "k8s-namespace": kdu_k8s_namespace
,
528 "kdu-name": kdu
["name"],
529 # TODO "name": "" Name of the VDU in the VIM
530 "ip-address": None, # mgmt-interface filled by LCM
533 if kdu_params
and kdu_params
.get("config-units"):
534 kdur
["config-units"] = kdu_params
["config-units"]
535 if kdu
.get("helm-version"):
536 kdur
["helm-version"] = kdu
["helm-version"]
537 for k8s_type
in ("helm-chart", "juju-bundle"):
538 if kdu
.get(k8s_type
):
539 kdur
[k8s_type
] = kdu_model
or kdu
[k8s_type
]
540 if not vnfr_descriptor
.get("kdur"):
541 vnfr_descriptor
["kdur"] = []
542 vnfr_descriptor
["kdur"].append(kdur
)
544 vnfd_mgmt_cp
= vnfd
.get("mgmt-cp")
546 for vdu
in vnfd
.get("vdu", ()):
549 configs
= vnfd
.get("df")[0]["lcm-operations-configuration"]["operate-vnf-op-config"]["day1-2"]
550 vdu_config
= utils
.find_in_list(configs
, lambda config
: config
["id"] == vdu
["id"])
555 external_connection_ee
= utils
.filter_in_list(
556 vdu_config
.get("execution-environment-list", []),
557 lambda ee
: "external-connection-point-ref" in ee
559 for ee
in external_connection_ee
:
560 vdu_mgmt_cp
.append(ee
["external-connection-point-ref"])
562 additional_params
, vdu_params
= self
._format
_additional
_params
(
563 ns_request
, vnf_index
, vdu_id
=vdu
["id"], descriptor
=vnfd
)
565 "vdu-id-ref": vdu
["id"],
566 # TODO "name": "" Name of the VDU in the VIM
567 "ip-address": None, # mgmt-interface filled by LCM
568 # "vim-id", "flavor-id", "image-id", "management-ip" # filled by LCM
569 "internal-connection-point": [],
571 "additionalParams": additional_params
,
572 "vdu-name": vdu
["name"]
574 if vdu_params
and vdu_params
.get("config-units"):
575 vdur
["config-units"] = vdu_params
["config-units"]
576 if deep_get(vdu
, ("supplemental-boot-data", "boot-data-drive")):
577 vdur
["boot-data-drive"] = vdu
["supplemental-boot-data"]["boot-data-drive"]
578 if vdu
.get("pdu-type"):
579 vdur
["pdu-type"] = vdu
["pdu-type"]
580 vdur
["name"] = vdu
["pdu-type"]
581 # TODO volumes: name, volume-id
582 for icp
in vdu
.get("int-cpd", ()):
585 "connection-point-id": icp
["id"],
586 "name": icp
.get("id"),
589 if "port-security-enabled" in icp
:
590 vdu_icp
["port-security-enabled"] = icp
["port-security-enabled"]
592 if "port-security-disable-strategy" in icp
:
593 vdu_icp
["port-security-disable-strategy"] = icp
["port-security-disable-strategy"]
595 vdur
["internal-connection-point"].append(vdu_icp
)
597 for iface
in icp
.get("virtual-network-interface-requirement", ()):
598 iface_fields
= ("name", "mac-address")
599 vdu_iface
= {x
: iface
[x
] for x
in iface_fields
if iface
.get(x
) is not None}
601 vdu_iface
["internal-connection-point-ref"] = vdu_icp
["id"]
602 for ext_cp
in vnfd
.get("ext-cpd", ()):
603 if not ext_cp
.get("int-cpd"):
605 if ext_cp
["int-cpd"].get("vdu-id") != vdu
["id"]:
607 if icp
["id"] == ext_cp
["int-cpd"].get("cpd"):
608 vdu_iface
["external-connection-point-ref"] = ext_cp
.get("id")
611 if vnfd_mgmt_cp
and vdu_iface
.get("external-connection-point-ref") == vnfd_mgmt_cp
:
612 vdu_iface
["mgmt-vnf"] = True
613 vdu_iface
["mgmt-interface"] = True
615 for ecp
in vdu_mgmt_cp
:
616 if vdu_iface
.get("external-connection-point-ref") == ecp
:
617 vdu_iface
["mgmt-interface"] = True
619 if iface
.get("virtual-interface"):
620 vdu_iface
.update(deepcopy(iface
["virtual-interface"]))
622 # look for network where this interface is connected
623 iface_ext_cp
= vdu_iface
.get("external-connection-point-ref")
625 # TODO: Change for multiple df support
626 for df
in get_iterable(nsd
.get("df")):
627 for vnf_profile
in get_iterable(df
.get("vnf-profile")):
628 for vlc_index
, vlc
in \
629 enumerate(get_iterable(vnf_profile
.get("virtual-link-connectivity"))):
630 for cpd
in get_iterable(vlc
.get("constituent-cpd-id")):
631 if cpd
.get("constituent-cpd-id") == iface_ext_cp
:
632 vdu_iface
["ns-vld-id"] = vlc
.get("virtual-link-profile-id")
633 # if iface type is SRIOV or PASSTHROUGH, set pci-interfaces flag to True
634 if vdu_iface
.get("type") in ("SR-IOV", "PCI-PASSTHROUGH"):
635 nsr_descriptor
["vld"][vlc_index
]["pci-interfaces"] = True
637 elif vdu_iface
.get("internal-connection-point-ref"):
638 vdu_iface
["vnf-vld-id"] = icp
.get("int-virtual-link-desc")
639 # TODO: store fixed IP address in the record (if it exists in the ICP)
640 # if iface type is SRIOV or PASSTHROUGH, set pci-interfaces flag to True
641 if vdu_iface
.get("type") in ("SR-IOV", "PCI-PASSTHROUGH"):
642 ivld_index
= utils
.find_index_in_list(vnfd
.get("int-virtual-link-desc", ()),
644 ivld
["id"] == icp
.get("int-virtual-link-desc")
646 vnfr_descriptor
["vld"][ivld_index
]["pci-interfaces"] = True
648 vdur
["interfaces"].append(vdu_iface
)
650 if vdu
.get("sw-image-desc"):
651 sw_image
= utils
.find_in_list(
652 vnfd
.get("sw-image-desc", ()),
653 lambda image
: image
["id"] == vdu
.get("sw-image-desc"))
654 nsr_sw_image_data
= utils
.find_in_list(
655 nsr_descriptor
["image"],
656 lambda nsr_image
: (nsr_image
.get("image") == sw_image
.get("image"))
658 vdur
["ns-image-id"] = nsr_sw_image_data
["id"]
660 if vdu
.get("alternative-sw-image-desc"):
662 for alt_image_id
in vdu
.get("alternative-sw-image-desc", ()):
663 sw_image
= utils
.find_in_list(
664 vnfd
.get("sw-image-desc", ()),
665 lambda image
: image
["id"] == alt_image_id
)
666 nsr_sw_image_data
= utils
.find_in_list(
667 nsr_descriptor
["image"],
668 lambda nsr_image
: (nsr_image
.get("image") == sw_image
.get("image"))
670 alt_image_ids
.append(nsr_sw_image_data
["id"])
671 vdur
["alt-image-ids"] = alt_image_ids
673 flavor_data_name
= vdu
["id"][:56] + "-flv"
674 nsr_flavor_desc
= utils
.find_in_list(
675 nsr_descriptor
["flavor"],
676 lambda flavor
: flavor
["name"] == flavor_data_name
)
679 vdur
["ns-flavor-id"] = nsr_flavor_desc
["id"]
681 count
= int(vdu
.get("count", 1))
682 for index
in range(0, count
):
683 vdur
= deepcopy(vdur
)
684 for iface
in vdur
["interfaces"]:
685 if iface
.get("ip-address"):
686 iface
["ip-address"] = increment_ip_mac(iface
["ip-address"])
687 if iface
.get("mac-address"):
688 iface
["mac-address"] = increment_ip_mac(iface
["mac-address"])
690 vdur
["_id"] = str(uuid4())
691 vdur
["id"] = vdur
["_id"]
692 vdur
["count-index"] = index
693 vnfr_descriptor
["vdur"].append(vdur
)
695 return vnfr_descriptor
697 def edit(self
, session
, _id
, indata
=None, kwargs
=None, content
=None):
698 raise EngineException("Method edit called directly", HTTPStatus
.INTERNAL_SERVER_ERROR
)
701 class VnfrTopic(BaseTopic
):
705 def __init__(self
, db
, fs
, msg
, auth
):
706 BaseTopic
.__init
__(self
, db
, fs
, msg
, auth
)
708 def delete(self
, session
, _id
, dry_run
=False, not_send_msg
=None):
709 raise EngineException("Method delete called directly", HTTPStatus
.INTERNAL_SERVER_ERROR
)
711 def edit(self
, session
, _id
, indata
=None, kwargs
=None, content
=None):
712 raise EngineException("Method edit called directly", HTTPStatus
.INTERNAL_SERVER_ERROR
)
714 def new(self
, rollback
, session
, indata
=None, kwargs
=None, headers
=None):
715 # Not used because vnfrs are created and deleted by NsrTopic class directly
716 raise EngineException("Method new called directly", HTTPStatus
.INTERNAL_SERVER_ERROR
)
719 class NsLcmOpTopic(BaseTopic
):
722 operation_schema
= { # mapping between operation and jsonschema to validate
723 "instantiate": ns_instantiate
,
726 "terminate": ns_terminate
,
729 def __init__(self
, db
, fs
, msg
, auth
):
730 BaseTopic
.__init
__(self
, db
, fs
, msg
, auth
)
732 def _check_ns_operation(self
, session
, nsr
, operation
, indata
):
734 Check that user has enter right parameters for the operation
735 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
736 :param operation: it can be: instantiate, terminate, action, TODO: update, heal
737 :param indata: descriptor with the parameters of the operation
740 if operation
== "action":
741 self
._check
_action
_ns
_operation
(indata
, nsr
)
742 elif operation
== "scale":
743 self
._check
_scale
_ns
_operation
(indata
, nsr
)
744 elif operation
== "instantiate":
745 self
._check
_instantiate
_ns
_operation
(indata
, nsr
, session
)
747 def _check_action_ns_operation(self
, indata
, nsr
):
749 # check vnf_member_index
750 if indata
.get("vnf_member_index"):
751 indata
["member_vnf_index"] = indata
.pop("vnf_member_index") # for backward compatibility
752 if indata
.get("member_vnf_index"):
753 vnfd
= self
._get
_vnfd
_from
_vnf
_member
_index
(indata
["member_vnf_index"], nsr
["_id"])
755 configs
= vnfd
.get("df")[0]["lcm-operations-configuration"]["operate-vnf-op-config"]["day1-2"]
759 if indata
.get("vdu_id"):
760 self
._check
_valid
_vdu
(vnfd
, indata
["vdu_id"])
761 descriptor_configuration
= utils
.find_in_list(
763 lambda config
: config
["id"] == indata
["vdu_id"]
764 ).get("config-primitive")
765 elif indata
.get("kdu_name"):
766 self
._check
_valid
_kdu
(vnfd
, indata
["kdu_name"])
767 descriptor_configuration
= utils
.find_in_list(
769 lambda config
: config
["id"] == indata
.get("kdu_name")
770 ).get("config-primitive")
772 descriptor_configuration
= utils
.find_in_list(
774 lambda config
: config
["id"] == vnfd
["id"]
775 ).get("config-primitive")
777 descriptor_configuration
= nsd
.get("ns-configuration", {}).get("config-primitive")
779 # For k8s allows default primitives without validating the parameters
780 if indata
.get("kdu_name") and indata
["primitive"] in ("upgrade", "rollback", "status", "inspect", "readme"):
781 # TODO should be checked that rollback only can contains revsision_numbe????
782 if not indata
.get("member_vnf_index"):
783 raise EngineException("Missing action parameter 'member_vnf_index' for default KDU primitive '{}'"
784 .format(indata
["primitive"]))
786 # if not, check primitive
787 for config_primitive
in get_iterable(descriptor_configuration
):
788 if indata
["primitive"] == config_primitive
["name"]:
789 # check needed primitive_params are provided
790 if indata
.get("primitive_params"):
791 in_primitive_params_copy
= copy(indata
["primitive_params"])
793 in_primitive_params_copy
= {}
794 for paramd
in get_iterable(config_primitive
.get("parameter")):
795 if paramd
["name"] in in_primitive_params_copy
:
796 del in_primitive_params_copy
[paramd
["name"]]
797 elif not paramd
.get("default-value"):
798 raise EngineException("Needed parameter {} not provided for primitive '{}'".format(
799 paramd
["name"], indata
["primitive"]))
800 # check no extra primitive params are provided
801 if in_primitive_params_copy
:
802 raise EngineException("parameter/s '{}' not present at vnfd /nsd for primitive '{}'".format(
803 list(in_primitive_params_copy
.keys()), indata
["primitive"]))
806 raise EngineException("Invalid primitive '{}' is not present at vnfd/nsd".format(indata
["primitive"]))
808 def _check_scale_ns_operation(self
, indata
, nsr
):
809 vnfd
= self
._get
_vnfd
_from
_vnf
_member
_index
(indata
["scaleVnfData"]["scaleByStepData"]["member-vnf-index"],
811 for scaling_aspect
in get_iterable(vnfd
.get("df", ())[0]["scaling-aspect"]):
812 if indata
["scaleVnfData"]["scaleByStepData"]["scaling-group-descriptor"] == scaling_aspect
["id"]:
815 raise EngineException("Invalid scaleVnfData:scaleByStepData:scaling-group-descriptor '{}' is not "
816 "present at vnfd:scaling-aspect"
817 .format(indata
["scaleVnfData"]["scaleByStepData"]["scaling-group-descriptor"]))
819 def _check_instantiate_ns_operation(self
, indata
, nsr
, session
):
820 vnf_member_index_to_vnfd
= {} # map between vnf_member_index to vnf descriptor.
824 self
._check
_valid
_vim
_account
(indata
["vimAccountId"], vim_accounts
, session
)
825 self
._check
_valid
_wim
_account
(indata
.get("wimAccountId"), wim_accounts
, session
)
826 for in_vnf
in get_iterable(indata
.get("vnf")):
827 member_vnf_index
= in_vnf
["member-vnf-index"]
828 if vnf_member_index_to_vnfd
.get(member_vnf_index
):
829 vnfd
= vnf_member_index_to_vnfd
[member_vnf_index
]
831 vnfd
= self
._get
_vnfd
_from
_vnf
_member
_index
(member_vnf_index
, nsr
["_id"])
832 vnf_member_index_to_vnfd
[member_vnf_index
] = vnfd
# add to cache, avoiding a later look for
833 self
._check
_vnf
_instantiation
_params
(in_vnf
, vnfd
)
834 if in_vnf
.get("vimAccountId"):
835 self
._check
_valid
_vim
_account
(in_vnf
["vimAccountId"], vim_accounts
, session
)
837 for in_vld
in get_iterable(indata
.get("vld")):
838 self
._check
_valid
_wim
_account
(in_vld
.get("wimAccountId"), wim_accounts
, session
)
839 for vldd
in get_iterable(nsd
.get("virtual-link-desc")):
840 if in_vld
["name"] == vldd
["id"]:
843 raise EngineException("Invalid parameter vld:name='{}' is not present at nsd:vld".format(
846 def _get_vnfd_from_vnf_member_index(self
, member_vnf_index
, nsr_id
):
847 # Obtain vnf descriptor. The vnfr is used to get the vnfd._id used for this member_vnf_index
848 vnfr
= self
.db
.get_one("vnfrs",
849 {"nsr-id-ref": nsr_id
, "member-vnf-index-ref": member_vnf_index
},
852 raise EngineException("Invalid parameter member_vnf_index='{}' is not one of the "
853 "nsd:constituent-vnfd".format(member_vnf_index
))
854 vnfd
= self
.db
.get_one("vnfds", {"_id": vnfr
["vnfd-id"]}, fail_on_empty
=False)
856 raise EngineException("vnfd id={} has been deleted!. Operation cannot be performed".
857 format(vnfr
["vnfd-id"]))
860 def _check_valid_vdu(self
, vnfd
, vdu_id
):
861 for vdud
in get_iterable(vnfd
.get("vdu")):
862 if vdud
["id"] == vdu_id
:
865 raise EngineException("Invalid parameter vdu_id='{}' not present at vnfd:vdu:id".format(vdu_id
))
867 def _check_valid_kdu(self
, vnfd
, kdu_name
):
868 for kdud
in get_iterable(vnfd
.get("kdu")):
869 if kdud
["name"] == kdu_name
:
872 raise EngineException("Invalid parameter kdu_name='{}' not present at vnfd:kdu:name".format(kdu_name
))
874 def _check_vnf_instantiation_params(self
, in_vnf
, vnfd
):
875 for in_vdu
in get_iterable(in_vnf
.get("vdu")):
876 for vdu
in get_iterable(vnfd
.get("vdu")):
877 if in_vdu
["id"] == vdu
["id"]:
878 for volume
in get_iterable(in_vdu
.get("volume")):
879 for volumed
in get_iterable(vdu
.get("virtual-storage-desc")):
880 if volumed
["id"] == volume
["name"]:
883 raise EngineException("Invalid parameter vnf[member-vnf-index='{}']:vdu[id='{}']:"
884 "volume:name='{}' is not present at "
885 "vnfd:vdu:virtual-storage-desc list".
886 format(in_vnf
["member-vnf-index"], in_vdu
["id"],
890 for cpd
in get_iterable(vdu
.get("int-cpd")):
891 for iface
in get_iterable(cpd
.get("virtual-network-interface-requirement")):
892 vdu_if_names
.add(iface
.get("name"))
894 for in_iface
in get_iterable(in_vdu
["interface"]):
895 if in_iface
["name"] in vdu_if_names
:
898 raise EngineException("Invalid parameter vnf[member-vnf-index='{}']:vdu[id='{}']:"
899 "int-cpd[id='{}'] is not present at vnfd:vdu:int-cpd"
900 .format(in_vnf
["member-vnf-index"], in_vdu
["id"],
905 raise EngineException("Invalid parameter vnf[member-vnf-index='{}']:vdu[id='{}'] is not present "
906 "at vnfd:vdu".format(in_vnf
["member-vnf-index"], in_vdu
["id"]))
908 vnfd_ivlds_cpds
= {ivld
.get("id"): set() for ivld
in get_iterable(vnfd
.get("int-virtual-link-desc"))}
909 for vdu
in get_iterable(vnfd
.get("vdu")):
910 for cpd
in get_iterable(vnfd
.get("int-cpd")):
911 if cpd
.get("int-virtual-link-desc"):
912 vnfd_ivlds_cpds
[cpd
.get("int-virtual-link-desc")] = cpd
.get("id")
914 for in_ivld
in get_iterable(in_vnf
.get("internal-vld")):
915 if in_ivld
.get("name") in vnfd_ivlds_cpds
:
916 for in_icp
in get_iterable(in_ivld
.get("internal-connection-point")):
917 if in_icp
["id-ref"] in vnfd_ivlds_cpds
[in_ivld
.get("name")]:
920 raise EngineException("Invalid parameter vnf[member-vnf-index='{}']:internal-vld[name"
921 "='{}']:internal-connection-point[id-ref:'{}'] is not present at "
922 "vnfd:internal-vld:name/id:internal-connection-point"
923 .format(in_vnf
["member-vnf-index"], in_ivld
["name"],
926 raise EngineException("Invalid parameter vnf[member-vnf-index='{}']:internal-vld:name='{}'"
927 " is not present at vnfd '{}'".format(in_vnf
["member-vnf-index"],
928 in_ivld
["name"], vnfd
["id"]))
930 def _check_valid_vim_account(self
, vim_account
, vim_accounts
, session
):
931 if vim_account
in vim_accounts
:
934 db_filter
= self
._get
_project
_filter
(session
)
935 db_filter
["_id"] = vim_account
936 self
.db
.get_one("vim_accounts", db_filter
)
938 raise EngineException("Invalid vimAccountId='{}' not present for the project".format(vim_account
))
939 vim_accounts
.append(vim_account
)
941 def _check_valid_wim_account(self
, wim_account
, wim_accounts
, session
):
942 if not isinstance(wim_account
, str):
944 if wim_account
in wim_accounts
:
947 db_filter
= self
._get
_project
_filter
(session
, write
=False, show_all
=True)
948 db_filter
["_id"] = wim_account
949 self
.db
.get_one("wim_accounts", db_filter
)
951 raise EngineException("Invalid wimAccountId='{}' not present for the project".format(wim_account
))
952 wim_accounts
.append(wim_account
)
954 def _look_for_pdu(self
, session
, rollback
, vnfr
, vim_account
, vnfr_update
, vnfr_update_rollback
):
956 Look for a free PDU in the catalog matching vdur type and interfaces. Fills vnfr.vdur with the interface
957 (ip_address, ...) information.
958 Modifies PDU _admin.usageState to 'IN_USE'
959 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
960 :param rollback: list with the database modifications to rollback if needed
961 :param vnfr: vnfr to be updated. It is modified with pdu interface info if pdu is found
962 :param vim_account: vim_account where this vnfr should be deployed
963 :param vnfr_update: dictionary filled by this method with changes to be done at database vnfr
964 :param vnfr_update_rollback: dictionary filled by this method with original content of vnfr in case a rollback
965 of the changed vnfr is needed
967 :return: List of PDU interfaces that are connected to an existing VIM network. Each item contains:
968 "vim-network-name": used at VIM
969 "name": interface name
970 "vnf-vld-id": internal VNFD vld where this interface is connected, or
971 "ns-vld-id": NSD vld where this interface is connected.
972 NOTE: One, and only one between 'vnf-vld-id' and 'ns-vld-id' contains a value. The other will be None
975 ifaces_forcing_vim_network
= []
976 for vdur_index
, vdur
in enumerate(get_iterable(vnfr
.get("vdur"))):
977 if not vdur
.get("pdu-type"):
979 pdu_type
= vdur
.get("pdu-type")
980 pdu_filter
= self
._get
_project
_filter
(session
)
981 pdu_filter
["vim_accounts"] = vim_account
982 pdu_filter
["type"] = pdu_type
983 pdu_filter
["_admin.operationalState"] = "ENABLED"
984 pdu_filter
["_admin.usageState"] = "NOT_IN_USE"
985 # TODO feature 1417: "shared": True,
987 available_pdus
= self
.db
.get_list("pdus", pdu_filter
)
988 for pdu
in available_pdus
:
989 # step 1 check if this pdu contains needed interfaces:
990 match_interfaces
= True
991 for vdur_interface
in vdur
["interfaces"]:
992 for pdu_interface
in pdu
["interfaces"]:
993 if pdu_interface
["name"] == vdur_interface
["name"]:
994 # TODO feature 1417: match per mgmt type
996 else: # no interface found for name
997 match_interfaces
= False
1002 raise EngineException(
1003 "No PDU of type={} at vim_account={} found for member_vnf_index={}, vdu={} matching interface "
1004 "names".format(pdu_type
, vim_account
, vnfr
["member-vnf-index-ref"], vdur
["vdu-id-ref"]))
1006 # step 2. Update pdu
1008 "_admin.usageState": pdu
["_admin"]["usageState"],
1009 "_admin.usage.vnfr_id": None,
1010 "_admin.usage.nsr_id": None,
1011 "_admin.usage.vdur": None,
1013 self
.db
.set_one("pdus", {"_id": pdu
["_id"]},
1014 {"_admin.usageState": "IN_USE",
1015 "_admin.usage": {"vnfr_id": vnfr
["_id"],
1016 "nsr_id": vnfr
["nsr-id-ref"],
1017 "vdur": vdur
["vdu-id-ref"]}
1019 rollback
.append({"topic": "pdus", "_id": pdu
["_id"], "operation": "set", "content": rollback_pdu
})
1021 # step 3. Fill vnfr info by filling vdur
1022 vdu_text
= "vdur.{}".format(vdur_index
)
1023 vnfr_update_rollback
[vdu_text
+ ".pdu-id"] = None
1024 vnfr_update
[vdu_text
+ ".pdu-id"] = pdu
["_id"]
1025 for iface_index
, vdur_interface
in enumerate(vdur
["interfaces"]):
1026 for pdu_interface
in pdu
["interfaces"]:
1027 if pdu_interface
["name"] == vdur_interface
["name"]:
1028 iface_text
= vdu_text
+ ".interfaces.{}".format(iface_index
)
1029 for k
, v
in pdu_interface
.items():
1030 if k
in ("ip-address", "mac-address"): # TODO: switch-xxxxx must be inserted
1031 vnfr_update
[iface_text
+ ".{}".format(k
)] = v
1032 vnfr_update_rollback
[iface_text
+ ".{}".format(k
)] = vdur_interface
.get(v
)
1033 if pdu_interface
.get("ip-address"):
1034 if vdur_interface
.get("mgmt-interface") or vdur_interface
.get("mgmt-vnf"):
1035 vnfr_update_rollback
[vdu_text
+ ".ip-address"] = vdur
.get("ip-address")
1036 vnfr_update
[vdu_text
+ ".ip-address"] = pdu_interface
["ip-address"]
1037 if vdur_interface
.get("mgmt-vnf"):
1038 vnfr_update_rollback
["ip-address"] = vnfr
.get("ip-address")
1039 vnfr_update
["ip-address"] = pdu_interface
["ip-address"]
1040 vnfr_update
[vdu_text
+ ".ip-address"] = pdu_interface
["ip-address"]
1041 if pdu_interface
.get("vim-network-name") or pdu_interface
.get("vim-network-id"):
1042 ifaces_forcing_vim_network
.append({
1043 "name": vdur_interface
.get("vnf-vld-id") or vdur_interface
.get("ns-vld-id"),
1044 "vnf-vld-id": vdur_interface
.get("vnf-vld-id"),
1045 "ns-vld-id": vdur_interface
.get("ns-vld-id")})
1046 if pdu_interface
.get("vim-network-id"):
1047 ifaces_forcing_vim_network
[-1]["vim-network-id"] = pdu_interface
["vim-network-id"]
1048 if pdu_interface
.get("vim-network-name"):
1049 ifaces_forcing_vim_network
[-1]["vim-network-name"] = pdu_interface
["vim-network-name"]
1052 return ifaces_forcing_vim_network
1054 def _look_for_k8scluster(self
, session
, rollback
, vnfr
, vim_account
, vnfr_update
, vnfr_update_rollback
):
1056 Look for an available k8scluster for all the kuds in the vnfd matching version and cni requirements.
1057 Fills vnfr.kdur with the selected k8scluster
1059 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1060 :param rollback: list with the database modifications to rollback if needed
1061 :param vnfr: vnfr to be updated. It is modified with pdu interface info if pdu is found
1062 :param vim_account: vim_account where this vnfr should be deployed
1063 :param vnfr_update: dictionary filled by this method with changes to be done at database vnfr
1064 :param vnfr_update_rollback: dictionary filled by this method with original content of vnfr in case a rollback
1065 of the changed vnfr is needed
1067 :return: List of KDU interfaces that are connected to an existing VIM network. Each item contains:
1068 "vim-network-name": used at VIM
1069 "name": interface name
1070 "vnf-vld-id": internal VNFD vld where this interface is connected, or
1071 "ns-vld-id": NSD vld where this interface is connected.
1072 NOTE: One, and only one between 'vnf-vld-id' and 'ns-vld-id' contains a value. The other will be None
1075 ifaces_forcing_vim_network
= []
1076 if not vnfr
.get("kdur"):
1077 return ifaces_forcing_vim_network
1079 kdu_filter
= self
._get
_project
_filter
(session
)
1080 kdu_filter
["vim_account"] = vim_account
1081 # TODO kdu_filter["_admin.operationalState"] = "ENABLED"
1082 available_k8sclusters
= self
.db
.get_list("k8sclusters", kdu_filter
)
1084 k8s_requirements
= {} # just for logging
1085 for k8scluster
in available_k8sclusters
:
1086 if not vnfr
.get("k8s-cluster"):
1089 if vnfr
["k8s-cluster"].get("cni"):
1090 k8s_requirements
["cni"] = vnfr
["k8s-cluster"]["cni"]
1091 if not set(vnfr
["k8s-cluster"]["cni"]).intersection(k8scluster
.get("cni", ())):
1093 # restrict by version
1094 if vnfr
["k8s-cluster"].get("version"):
1095 k8s_requirements
["version"] = vnfr
["k8s-cluster"]["version"]
1096 if k8scluster
.get("k8s_version") not in vnfr
["k8s-cluster"]["version"]:
1098 # restrict by number of networks
1099 if vnfr
["k8s-cluster"].get("nets"):
1100 k8s_requirements
["networks"] = len(vnfr
["k8s-cluster"]["nets"])
1101 if not k8scluster
.get("nets") or len(k8scluster
["nets"]) < len(vnfr
["k8s-cluster"]["nets"]):
1105 raise EngineException("No k8scluster with requirements='{}' at vim_account={} found for member_vnf_index={}"
1106 .format(k8s_requirements
, vim_account
, vnfr
["member-vnf-index-ref"]))
1108 for kdur_index
, kdur
in enumerate(get_iterable(vnfr
.get("kdur"))):
1109 # step 3. Fill vnfr info by filling kdur
1110 kdu_text
= "kdur.{}.".format(kdur_index
)
1111 vnfr_update_rollback
[kdu_text
+ "k8s-cluster.id"] = None
1112 vnfr_update
[kdu_text
+ "k8s-cluster.id"] = k8scluster
["_id"]
1114 # step 4. Check VIM networks that forces the selected k8s_cluster
1115 if vnfr
.get("k8s-cluster") and vnfr
["k8s-cluster"].get("nets"):
1116 k8scluster_net_list
= list(k8scluster
.get("nets").keys())
1117 for net_index
, kdur_net
in enumerate(vnfr
["k8s-cluster"]["nets"]):
1118 # get a network from k8s_cluster nets. If name matches use this, if not use other
1119 if kdur_net
["id"] in k8scluster_net_list
: # name matches
1120 vim_net
= k8scluster
["nets"][kdur_net
["id"]]
1121 k8scluster_net_list
.remove(kdur_net
["id"])
1123 vim_net
= k8scluster
["nets"][k8scluster_net_list
[0]]
1124 k8scluster_net_list
.pop(0)
1125 vnfr_update_rollback
["k8s-cluster.nets.{}.vim_net".format(net_index
)] = None
1126 vnfr_update
["k8s-cluster.nets.{}.vim_net".format(net_index
)] = vim_net
1127 if vim_net
and (kdur_net
.get("vnf-vld-id") or kdur_net
.get("ns-vld-id")):
1128 ifaces_forcing_vim_network
.append({
1129 "name": kdur_net
.get("vnf-vld-id") or kdur_net
.get("ns-vld-id"),
1130 "vnf-vld-id": kdur_net
.get("vnf-vld-id"),
1131 "ns-vld-id": kdur_net
.get("ns-vld-id"),
1132 "vim-network-name": vim_net
, # TODO can it be vim-network-id ???
1134 # TODO check that this forcing is not incompatible with other forcing
1135 return ifaces_forcing_vim_network
1137 def _update_vnfrs(self
, session
, rollback
, nsr
, indata
):
1140 vnfrs
= self
.db
.get_list("vnfrs", {"nsr-id-ref": nsr_id
})
1144 vnfr_update_rollback
= {}
1145 member_vnf_index
= vnfr
["member-vnf-index-ref"]
1146 # update vim-account-id
1148 vim_account
= indata
["vimAccountId"]
1149 # check instantiate parameters
1150 for vnf_inst_params
in get_iterable(indata
.get("vnf")):
1151 if vnf_inst_params
["member-vnf-index"] != member_vnf_index
:
1153 if vnf_inst_params
.get("vimAccountId"):
1154 vim_account
= vnf_inst_params
.get("vimAccountId")
1156 # get vnf.vdu.interface instantiation params to update vnfr.vdur.interfaces ip, mac
1157 for vdu_inst_param
in get_iterable(vnf_inst_params
.get("vdu")):
1158 for vdur_index
, vdur
in enumerate(vnfr
["vdur"]):
1159 if vdu_inst_param
["id"] != vdur
["vdu-id-ref"]:
1161 for iface_inst_param
in get_iterable(vdu_inst_param
.get("interface")):
1162 iface_index
, _
= next(i
for i
in enumerate(vdur
["interfaces"])
1163 if i
[1]["name"] == iface_inst_param
["name"])
1164 vnfr_update_text
= "vdur.{}.interfaces.{}".format(vdur_index
, iface_index
)
1165 if iface_inst_param
.get("ip-address"):
1166 vnfr_update
[vnfr_update_text
+ ".ip-address"] = increment_ip_mac(
1167 iface_inst_param
.get("ip-address"), vdur
.get("count-index", 0))
1168 vnfr_update
[vnfr_update_text
+ ".fixed-ip"] = True
1169 if iface_inst_param
.get("mac-address"):
1170 vnfr_update
[vnfr_update_text
+ ".mac-address"] = increment_ip_mac(
1171 iface_inst_param
.get("mac-address"), vdur
.get("count-index", 0))
1172 vnfr_update
[vnfr_update_text
+ ".fixed-mac"] = True
1173 if iface_inst_param
.get("floating-ip-required"):
1174 vnfr_update
[vnfr_update_text
+ ".floating-ip-required"] = True
1175 # get vnf.internal-vld.internal-conection-point instantiation params to update vnfr.vdur.interfaces
1176 # TODO update vld with the ip-profile
1177 for ivld_inst_param
in get_iterable(vnf_inst_params
.get("internal-vld")):
1178 for icp_inst_param
in get_iterable(ivld_inst_param
.get("internal-connection-point")):
1180 for vdur_index
, vdur
in enumerate(vnfr
["vdur"]):
1181 for iface_index
, iface
in enumerate(vdur
["interfaces"]):
1182 if iface
.get("internal-connection-point-ref") == icp_inst_param
["id-ref"]:
1183 vnfr_update_text
= "vdur.{}.interfaces.{}".format(vdur_index
, iface_index
)
1184 if icp_inst_param
.get("ip-address"):
1185 vnfr_update
[vnfr_update_text
+ ".ip-address"] = increment_ip_mac(
1186 icp_inst_param
.get("ip-address"), vdur
.get("count-index", 0))
1187 vnfr_update
[vnfr_update_text
+ ".fixed-ip"] = True
1188 if icp_inst_param
.get("mac-address"):
1189 vnfr_update
[vnfr_update_text
+ ".mac-address"] = increment_ip_mac(
1190 icp_inst_param
.get("mac-address"), vdur
.get("count-index", 0))
1191 vnfr_update
[vnfr_update_text
+ ".fixed-mac"] = True
1193 # get ip address from instantiation parameters.vld.vnfd-connection-point-ref
1194 for vld_inst_param
in get_iterable(indata
.get("vld")):
1195 for vnfcp_inst_param
in get_iterable(vld_inst_param
.get("vnfd-connection-point-ref")):
1196 if vnfcp_inst_param
["member-vnf-index-ref"] != member_vnf_index
:
1199 for vdur_index
, vdur
in enumerate(vnfr
["vdur"]):
1200 for iface_index
, iface
in enumerate(vdur
["interfaces"]):
1201 if iface
.get("external-connection-point-ref") == \
1202 vnfcp_inst_param
["vnfd-connection-point-ref"]:
1203 vnfr_update_text
= "vdur.{}.interfaces.{}".format(vdur_index
, iface_index
)
1204 if vnfcp_inst_param
.get("ip-address"):
1205 vnfr_update
[vnfr_update_text
+ ".ip-address"] = increment_ip_mac(
1206 vnfcp_inst_param
.get("ip-address"), vdur
.get("count-index", 0))
1207 vnfr_update
[vnfr_update_text
+ ".fixed-ip"] = True
1208 if vnfcp_inst_param
.get("mac-address"):
1209 vnfr_update
[vnfr_update_text
+ ".mac-address"] = increment_ip_mac(
1210 vnfcp_inst_param
.get("mac-address"), vdur
.get("count-index", 0))
1211 vnfr_update
[vnfr_update_text
+ ".fixed-mac"] = True
1214 vnfr_update
["vim-account-id"] = vim_account
1215 vnfr_update_rollback
["vim-account-id"] = vnfr
.get("vim-account-id")
1218 ifaces_forcing_vim_network
= self
._look
_for
_pdu
(session
, rollback
, vnfr
, vim_account
, vnfr_update
,
1219 vnfr_update_rollback
)
1222 ifaces_forcing_vim_network
+= self
._look
_for
_k
8scluster
(session
, rollback
, vnfr
, vim_account
, vnfr_update
,
1223 vnfr_update_rollback
)
1224 # update database vnfr
1225 self
.db
.set_one("vnfrs", {"_id": vnfr
["_id"]}, vnfr_update
)
1226 rollback
.append({"topic": "vnfrs", "_id": vnfr
["_id"], "operation": "set", "content": vnfr_update_rollback
})
1228 # Update indada in case pdu forces to use a concrete vim-network-name
1229 # TODO check if user has already insert a vim-network-name and raises an error
1230 if not ifaces_forcing_vim_network
:
1232 for iface_info
in ifaces_forcing_vim_network
:
1233 if iface_info
.get("ns-vld-id"):
1234 if "vld" not in indata
:
1236 indata
["vld"].append({key
: iface_info
[key
] for key
in
1237 ("name", "vim-network-name", "vim-network-id") if iface_info
.get(key
)})
1239 elif iface_info
.get("vnf-vld-id"):
1240 if "vnf" not in indata
:
1242 indata
["vnf"].append({
1243 "member-vnf-index": member_vnf_index
,
1244 "internal-vld": [{key
: iface_info
[key
] for key
in
1245 ("name", "vim-network-name", "vim-network-id") if iface_info
.get(key
)}]
1249 def _create_nslcmop(nsr_id
, operation
, params
):
1251 Creates a ns-lcm-opp content to be stored at database.
1252 :param nsr_id: internal id of the instance
1253 :param operation: instantiate, terminate, scale, action, ...
1254 :param params: user parameters for the operation
1255 :return: dictionary following SOL005 format
1262 "operationState": "PROCESSING", # COMPLETED,PARTIALLY_COMPLETED,FAILED_TEMP,FAILED,ROLLING_BACK,ROLLED_BACK
1263 "queuePosition": None,
1265 "errorMessage": None,
1266 "detailedStatus": None,
1267 "statusEnteredTime": now
,
1268 "nsInstanceId": nsr_id
,
1269 "lcmOperationType": operation
,
1271 "isAutomaticInvocation": False,
1272 "operationParams": params
,
1273 "isCancelPending": False,
1275 "self": "/osm/nslcm/v1/ns_lcm_op_occs/" + _id
,
1276 "nsInstance": "/osm/nslcm/v1/ns_instances/" + nsr_id
,
1281 def _get_enabled_vims(self
, session
):
1283 Retrieve and return VIM accounts that are accessible by current user and has state ENABLE
1284 :param session: current session with user information
1286 db_filter
= self
._get
_project
_filter
(session
)
1287 db_filter
["_admin.operationalState"] = "ENABLED"
1288 vims
= self
.db
.get_list("vim_accounts", db_filter
)
1291 vimAccounts
.append(vim
['_id'])
1294 def new(self
, rollback
, session
, indata
=None, kwargs
=None, headers
=None, slice_object
=False):
1296 Performs a new operation over a ns
1297 :param rollback: list to append created items at database in case a rollback must to be done
1298 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1299 :param indata: descriptor with the parameters of the operation. It must contains among others
1300 nsInstanceId: _id of the nsr to perform the operation
1301 operation: it can be: instantiate, terminate, action, TODO: update, heal
1302 :param kwargs: used to override the indata descriptor
1303 :param headers: http request headers
1304 :return: id of the nslcmops
1306 def check_if_nsr_is_not_slice_member(session
, nsr_id
):
1308 db_filter
= self
._get
_project
_filter
(session
)
1309 db_filter
["_admin.nsrs-detailed-list.ANYINDEX.nsrId"] = nsr_id
1310 nsis
= self
.db
.get_one("nsis", db_filter
, fail_on_empty
=False, fail_on_more
=False)
1312 raise EngineException("The NS instance {} cannot be terminated because is used by the slice {}".format(
1313 nsr_id
, nsis
["_id"]), http_code
=HTTPStatus
.CONFLICT
)
1316 # Override descriptor with query string kwargs
1317 self
._update
_input
_with
_kwargs
(indata
, kwargs
, yaml_format
=True)
1318 operation
= indata
["lcmOperationType"]
1319 nsInstanceId
= indata
["nsInstanceId"]
1321 validate_input(indata
, self
.operation_schema
[operation
])
1322 # get ns from nsr_id
1323 _filter
= BaseTopic
._get
_project
_filter
(session
)
1324 _filter
["_id"] = nsInstanceId
1325 nsr
= self
.db
.get_one("nsrs", _filter
)
1328 if operation
== "terminate" and slice_object
is False:
1329 check_if_nsr_is_not_slice_member(session
, nsr
["_id"])
1330 if not nsr
["_admin"].get("nsState") or nsr
["_admin"]["nsState"] == "NOT_INSTANTIATED":
1331 if operation
== "terminate" and indata
.get("autoremove"):
1332 # NSR must be deleted
1333 return None, None # a none in this case is used to indicate not instantiated. It can be removed
1334 if operation
!= "instantiate":
1335 raise EngineException("ns_instance '{}' cannot be '{}' because it is not instantiated".format(
1336 nsInstanceId
, operation
), HTTPStatus
.CONFLICT
)
1338 if operation
== "instantiate" and not session
["force"]:
1339 raise EngineException("ns_instance '{}' cannot be '{}' because it is already instantiated".format(
1340 nsInstanceId
, operation
), HTTPStatus
.CONFLICT
)
1341 self
._check
_ns
_operation
(session
, nsr
, operation
, indata
)
1343 if operation
== "instantiate":
1344 self
._update
_vnfrs
(session
, rollback
, nsr
, indata
)
1346 nslcmop_desc
= self
._create
_nslcmop
(nsInstanceId
, operation
, indata
)
1347 _id
= nslcmop_desc
["_id"]
1348 self
.format_on_new(nslcmop_desc
, session
["project_id"], make_public
=session
["public"])
1349 if indata
.get("placement-engine"):
1350 # Save valid vim accounts in lcm operation descriptor
1351 nslcmop_desc
['operationParams']['validVimAccounts'] = self
._get
_enabled
_vims
(session
)
1352 self
.db
.create("nslcmops", nslcmop_desc
)
1353 rollback
.append({"topic": "nslcmops", "_id": _id
})
1354 if not slice_object
:
1355 self
.msg
.write("ns", operation
, nslcmop_desc
)
1357 except ValidationError
as e
: # TODO remove try Except, it is captured at nbi.py
1358 raise EngineException(e
, HTTPStatus
.UNPROCESSABLE_ENTITY
)
1359 # except DbException as e:
1360 # raise EngineException("Cannot get ns_instance '{}': {}".format(e), HTTPStatus.NOT_FOUND)
1362 def delete(self
, session
, _id
, dry_run
=False, not_send_msg
=None):
1363 raise EngineException("Method delete called directly", HTTPStatus
.INTERNAL_SERVER_ERROR
)
1365 def edit(self
, session
, _id
, indata
=None, kwargs
=None, content
=None):
1366 raise EngineException("Method edit called directly", HTTPStatus
.INTERNAL_SERVER_ERROR
)
1369 class NsiTopic(BaseTopic
):
1372 quota_name
= "slice_instances"
1374 def __init__(self
, db
, fs
, msg
, auth
):
1375 BaseTopic
.__init
__(self
, db
, fs
, msg
, auth
)
1376 self
.nsrTopic
= NsrTopic(db
, fs
, msg
, auth
)
1379 def _format_ns_request(ns_request
):
1380 formated_request
= copy(ns_request
)
1381 # TODO: Add request params
1382 return formated_request
1385 def _format_addional_params(slice_request
):
1387 Get and format user additional params for NS or VNF
1388 :param slice_request: User instantiation additional parameters
1389 :return: a formatted copy of additional params or None if not supplied
1391 additional_params
= copy(slice_request
.get("additionalParamsForNsi"))
1392 if additional_params
:
1393 for k
, v
in additional_params
.items():
1394 if not isinstance(k
, str):
1395 raise EngineException("Invalid param at additionalParamsForNsi:{}. Only string keys are allowed".
1397 if "." in k
or "$" in k
:
1398 raise EngineException("Invalid param at additionalParamsForNsi:{}. Keys must not contain dots or $".
1400 if isinstance(v
, (dict, tuple, list)):
1401 additional_params
[k
] = "!!yaml " + safe_dump(v
)
1402 return additional_params
1404 def _check_descriptor_dependencies(self
, session
, descriptor
):
1406 Check that the dependent descriptors exist on a new descriptor or edition
1407 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1408 :param descriptor: descriptor to be inserted or edit
1409 :return: None or raises exception
1411 if not descriptor
.get("nst-ref"):
1413 nstd_id
= descriptor
["nst-ref"]
1414 if not self
.get_item_list(session
, "nsts", {"id": nstd_id
}):
1415 raise EngineException("Descriptor error at nst-ref='{}' references a non exist nstd".format(nstd_id
),
1416 http_code
=HTTPStatus
.CONFLICT
)
1418 def check_conflict_on_del(self
, session
, _id
, db_content
):
1420 Check that NSI is not instantiated
1421 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1422 :param _id: nsi internal id
1423 :param db_content: The database content of the _id
1424 :return: None or raises EngineException with the conflict
1426 if session
["force"]:
1429 if nsi
["_admin"].get("nsiState") == "INSTANTIATED":
1430 raise EngineException("nsi '{}' cannot be deleted because it is in 'INSTANTIATED' state. "
1431 "Launch 'terminate' operation first; or force deletion".format(_id
),
1432 http_code
=HTTPStatus
.CONFLICT
)
1434 def delete_extra(self
, session
, _id
, db_content
, not_send_msg
=None):
1436 Deletes associated nsilcmops from database. Deletes associated filesystem.
1437 Set usageState of nst
1438 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1439 :param _id: server internal id
1440 :param db_content: The database content of the descriptor
1441 :param not_send_msg: To not send message (False) or store content (list) instead
1442 :return: None if ok or raises EngineException with the problem
1445 # Deleting the nsrs belonging to nsir
1447 for nsrs_detailed_item
in nsir
["_admin"]["nsrs-detailed-list"]:
1448 nsr_id
= nsrs_detailed_item
["nsrId"]
1449 if nsrs_detailed_item
.get("shared"):
1450 _filter
= {"_admin.nsrs-detailed-list.ANYINDEX.shared": True,
1451 "_admin.nsrs-detailed-list.ANYINDEX.nsrId": nsr_id
,
1452 "_id.ne": nsir
["_id"]}
1453 nsi
= self
.db
.get_one("nsis", _filter
, fail_on_empty
=False, fail_on_more
=False)
1454 if nsi
: # last one using nsr
1457 self
.nsrTopic
.delete(session
, nsr_id
, dry_run
=False, not_send_msg
=not_send_msg
)
1458 except (DbException
, EngineException
) as e
:
1459 if e
.http_code
== HTTPStatus
.NOT_FOUND
:
1464 # delete related nsilcmops database entries
1465 self
.db
.del_list("nsilcmops", {"netsliceInstanceId": _id
})
1467 # Check and set used NST usage state
1468 nsir_admin
= nsir
.get("_admin")
1469 if nsir_admin
and nsir_admin
.get("nst-id"):
1470 # check if used by another NSI
1471 nsis_list
= self
.db
.get_one("nsis", {"nst-id": nsir_admin
["nst-id"]},
1472 fail_on_empty
=False, fail_on_more
=False)
1474 self
.db
.set_one("nsts", {"_id": nsir_admin
["nst-id"]}, {"_admin.usageState": "NOT_IN_USE"})
1476 def new(self
, rollback
, session
, indata
=None, kwargs
=None, headers
=None):
1478 Creates a new netslice instance record into database. It also creates needed nsrs and vnfrs
1479 :param rollback: list to append the created items at database in case a rollback must be done
1480 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1481 :param indata: params to be used for the nsir
1482 :param kwargs: used to override the indata descriptor
1483 :param headers: http request headers
1484 :return: the _id of nsi descriptor created at database
1488 step
= "checking quotas"
1489 self
.check_quota(session
)
1492 slice_request
= self
._remove
_envelop
(indata
)
1493 # Override descriptor with query string kwargs
1494 self
._update
_input
_with
_kwargs
(slice_request
, kwargs
)
1495 slice_request
= self
._validate
_input
_new
(slice_request
, session
["force"])
1498 step
= "getting nstd id='{}' from database".format(slice_request
.get("nstId"))
1499 _filter
= self
._get
_project
_filter
(session
)
1500 _filter
["_id"] = slice_request
["nstId"]
1501 nstd
= self
.db
.get_one("nsts", _filter
)
1502 # check NST is not disabled
1503 step
= "checking NST operationalState"
1504 if nstd
["_admin"]["operationalState"] == "DISABLED":
1505 raise EngineException("nst with id '{}' is DISABLED, and thus cannot be used to create a netslice "
1506 "instance".format(slice_request
["nstId"]), http_code
=HTTPStatus
.CONFLICT
)
1509 # check NSD is not disabled
1510 step
= "checking operationalState"
1511 if nstd
["_admin"]["operationalState"] == "DISABLED":
1512 raise EngineException("nst with id '{}' is DISABLED, and thus cannot be used to create "
1513 "a network slice".format(slice_request
["nstId"]), http_code
=HTTPStatus
.CONFLICT
)
1515 nstd
.pop("_admin", None)
1516 nstd_id
= nstd
.pop("_id", None)
1517 nsi_id
= str(uuid4())
1518 step
= "filling nsi_descriptor with input data"
1523 "name": slice_request
["nsiName"],
1524 "description": slice_request
.get("nsiDescription", ""),
1525 "datacenter": slice_request
["vimAccountId"],
1526 "nst-ref": nstd
["id"],
1527 "instantiation_parameters": slice_request
,
1528 "network-slice-template": nstd
,
1532 "additionalParamsForNsi": self
._format
_addional
_params
(slice_request
)
1535 step
= "creating nsi at database"
1536 self
.format_on_new(nsi_descriptor
, session
["project_id"], make_public
=session
["public"])
1537 nsi_descriptor
["_admin"]["nsiState"] = "NOT_INSTANTIATED"
1538 nsi_descriptor
["_admin"]["netslice-subnet"] = None
1539 nsi_descriptor
["_admin"]["deployed"] = {}
1540 nsi_descriptor
["_admin"]["deployed"]["RO"] = []
1541 nsi_descriptor
["_admin"]["nst-id"] = nstd_id
1543 # Creating netslice-vld for the RO.
1544 step
= "creating netslice-vld at database"
1546 # Building the vlds list to be deployed
1547 # From netslice descriptors, creating the initial list
1550 for netslice_vlds
in get_iterable(nstd
.get("netslice-vld")):
1551 # Getting template Instantiation parameters from NST
1552 nsi_vld
= deepcopy(netslice_vlds
)
1553 nsi_vld
["shared-nsrs-list"] = []
1554 nsi_vld
["vimAccountId"] = slice_request
["vimAccountId"]
1555 nsi_vlds
.append(nsi_vld
)
1557 nsi_descriptor
["_admin"]["netslice-vld"] = nsi_vlds
1558 # Creating netslice-subnet_record.
1562 # Updating the nstd with the nsd["_id"] associated to the nss -> services list
1563 for member_ns
in nstd
["netslice-subnet"]:
1564 nsd_id
= member_ns
["nsd-ref"]
1565 step
= "getting nstd id='{}' constituent-nsd='{}' from database".format(
1566 member_ns
["nsd-ref"], member_ns
["id"])
1567 if nsd_id
not in needed_nsds
:
1569 _filter
["id"] = nsd_id
1570 nsd
= self
.db
.get_one("nsds", _filter
, fail_on_empty
=True, fail_on_more
=True)
1573 needed_nsds
[nsd_id
] = nsd
1575 nsd
= needed_nsds
[nsd_id
]
1576 member_ns
["_id"] = needed_nsds
[nsd_id
].get("_id")
1577 services
.append(member_ns
)
1579 step
= "filling nsir nsd-id='{}' constituent-nsd='{}' from database".format(
1580 member_ns
["nsd-ref"], member_ns
["id"])
1582 # creates Network Services records (NSRs)
1583 step
= "creating nsrs at database using NsrTopic.new()"
1584 ns_params
= slice_request
.get("netslice-subnet")
1586 nsi_netslice_subnet
= []
1587 for service
in services
:
1588 # Check if the netslice-subnet is shared and if it is share if the nss exists
1591 # Is the nss shared and instantiated?
1592 _filter
["_admin.nsrs-detailed-list.ANYINDEX.shared"] = True
1593 _filter
["_admin.nsrs-detailed-list.ANYINDEX.nsd-id"] = service
["nsd-ref"]
1594 _filter
["_admin.nsrs-detailed-list.ANYINDEX.nss-id"] = service
["id"]
1595 nsi
= self
.db
.get_one("nsis", _filter
, fail_on_empty
=False, fail_on_more
=False)
1596 if nsi
and service
.get("is-shared-nss"):
1597 nsrs_detailed_list
= nsi
["_admin"]["nsrs-detailed-list"]
1598 for nsrs_detailed_item
in nsrs_detailed_list
:
1599 if nsrs_detailed_item
["nsd-id"] == service
["nsd-ref"]:
1600 if nsrs_detailed_item
["nss-id"] == service
["id"]:
1601 _id_nsr
= nsrs_detailed_item
["nsrId"]
1603 for netslice_subnet
in nsi
["_admin"]["netslice-subnet"]:
1604 if netslice_subnet
["nss-id"] == service
["id"]:
1605 indata_ns
= netslice_subnet
1609 if service
.get("instantiation-parameters"):
1610 indata_ns
= deepcopy(service
["instantiation-parameters"])
1611 # del service["instantiation-parameters"]
1613 indata_ns
["nsdId"] = service
["_id"]
1614 indata_ns
["nsName"] = slice_request
.get("nsiName") + "." + service
["id"]
1615 indata_ns
["vimAccountId"] = slice_request
.get("vimAccountId")
1616 indata_ns
["nsDescription"] = service
["description"]
1617 if slice_request
.get("ssh_keys"):
1618 indata_ns
["ssh_keys"] = slice_request
.get("ssh_keys")
1621 for ns_param
in ns_params
:
1622 if ns_param
.get("id") == service
["id"]:
1623 copy_ns_param
= deepcopy(ns_param
)
1624 del copy_ns_param
["id"]
1625 indata_ns
.update(copy_ns_param
)
1628 # Creates Nsr objects
1629 _id_nsr
, _
= self
.nsrTopic
.new(rollback
, session
, indata_ns
, kwargs
, headers
)
1630 nsrs_item
= {"nsrId": _id_nsr
, "shared": service
.get("is-shared-nss"), "nsd-id": service
["nsd-ref"],
1631 "nss-id": service
["id"], "nslcmop_instantiate": None}
1632 indata_ns
["nss-id"] = service
["id"]
1633 nsrs_list
.append(nsrs_item
)
1634 nsi_netslice_subnet
.append(indata_ns
)
1635 nsr_ref
= {"nsr-ref": _id_nsr
}
1636 nsi_descriptor
["nsr-ref-list"].append(nsr_ref
)
1638 # Adding the nsrs list to the nsi
1639 nsi_descriptor
["_admin"]["nsrs-detailed-list"] = nsrs_list
1640 nsi_descriptor
["_admin"]["netslice-subnet"] = nsi_netslice_subnet
1641 self
.db
.set_one("nsts", {"_id": slice_request
["nstId"]}, {"_admin.usageState": "IN_USE"})
1643 # Creating the entry in the database
1644 self
.db
.create("nsis", nsi_descriptor
)
1645 rollback
.append({"topic": "nsis", "_id": nsi_id
})
1647 except Exception as e
: # TODO remove try Except, it is captured at nbi.py
1648 self
.logger
.exception("Exception {} at NsiTopic.new()".format(e
), exc_info
=True)
1649 raise EngineException("Error {}: {}".format(step
, e
))
1650 except ValidationError
as e
:
1651 raise EngineException(e
, HTTPStatus
.UNPROCESSABLE_ENTITY
)
1653 def edit(self
, session
, _id
, indata
=None, kwargs
=None, content
=None):
1654 raise EngineException("Method edit called directly", HTTPStatus
.INTERNAL_SERVER_ERROR
)
1657 class NsiLcmOpTopic(BaseTopic
):
1660 operation_schema
= { # mapping between operation and jsonschema to validate
1661 "instantiate": nsi_instantiate
,
1665 def __init__(self
, db
, fs
, msg
, auth
):
1666 BaseTopic
.__init
__(self
, db
, fs
, msg
, auth
)
1667 self
.nsi_NsLcmOpTopic
= NsLcmOpTopic(self
.db
, self
.fs
, self
.msg
, self
.auth
)
1669 def _check_nsi_operation(self
, session
, nsir
, operation
, indata
):
1671 Check that user has enter right parameters for the operation
1672 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1673 :param operation: it can be: instantiate, terminate, action, TODO: update, heal
1674 :param indata: descriptor with the parameters of the operation
1678 nstd
= nsir
["network-slice-template"]
1680 def check_valid_netslice_subnet_id(nstId
):
1681 # TODO change to vnfR (??)
1682 for netslice_subnet
in nstd
["netslice-subnet"]:
1683 if nstId
== netslice_subnet
["id"]:
1684 nsd_id
= netslice_subnet
["nsd-ref"]
1685 if nsd_id
not in nsds
:
1686 _filter
= self
._get
_project
_filter
(session
)
1687 _filter
["id"] = nsd_id
1688 nsds
[nsd_id
] = self
.db
.get_one("nsds", _filter
)
1691 raise EngineException("Invalid parameter nstId='{}' is not one of the "
1692 "nst:netslice-subnet".format(nstId
))
1693 if operation
== "instantiate":
1694 # check the existance of netslice-subnet items
1695 for in_nst
in get_iterable(indata
.get("netslice-subnet")):
1696 check_valid_netslice_subnet_id(in_nst
["id"])
1698 def _create_nsilcmop(self
, session
, netsliceInstanceId
, operation
, params
):
1704 "operationState": "PROCESSING", # COMPLETED,PARTIALLY_COMPLETED,FAILED_TEMP,FAILED,ROLLING_BACK,ROLLED_BACK
1705 "statusEnteredTime": now
,
1706 "netsliceInstanceId": netsliceInstanceId
,
1707 "lcmOperationType": operation
,
1709 "isAutomaticInvocation": False,
1710 "operationParams": params
,
1711 "isCancelPending": False,
1713 "self": "/osm/nsilcm/v1/nsi_lcm_op_occs/" + _id
,
1714 "netsliceInstanceId": "/osm/nsilcm/v1/netslice_instances/" + netsliceInstanceId
,
1719 def add_shared_nsr_2vld(self
, nsir
, nsr_item
):
1720 for nst_sb_item
in nsir
["network-slice-template"].get("netslice-subnet"):
1721 if nst_sb_item
.get("is-shared-nss"):
1722 for admin_subnet_item
in nsir
["_admin"].get("netslice-subnet"):
1723 if admin_subnet_item
["nss-id"] == nst_sb_item
["id"]:
1724 for admin_vld_item
in nsir
["_admin"].get("netslice-vld"):
1725 for admin_vld_nss_cp_ref_item
in admin_vld_item
["nss-connection-point-ref"]:
1726 if admin_subnet_item
["nss-id"] == admin_vld_nss_cp_ref_item
["nss-ref"]:
1727 if not nsr_item
["nsrId"] in admin_vld_item
["shared-nsrs-list"]:
1728 admin_vld_item
["shared-nsrs-list"].append(nsr_item
["nsrId"])
1730 # self.db.set_one("nsis", {"_id": nsir["_id"]}, nsir)
1731 self
.db
.set_one("nsis", {"_id": nsir
["_id"]}, {"_admin.netslice-vld": nsir
["_admin"].get("netslice-vld")})
1733 def new(self
, rollback
, session
, indata
=None, kwargs
=None, headers
=None):
1735 Performs a new operation over a ns
1736 :param rollback: list to append created items at database in case a rollback must to be done
1737 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1738 :param indata: descriptor with the parameters of the operation. It must contains among others
1739 netsliceInstanceId: _id of the nsir to perform the operation
1740 operation: it can be: instantiate, terminate, action, TODO: update, heal
1741 :param kwargs: used to override the indata descriptor
1742 :param headers: http request headers
1743 :return: id of the nslcmops
1746 # Override descriptor with query string kwargs
1747 self
._update
_input
_with
_kwargs
(indata
, kwargs
)
1748 operation
= indata
["lcmOperationType"]
1749 netsliceInstanceId
= indata
["netsliceInstanceId"]
1750 validate_input(indata
, self
.operation_schema
[operation
])
1752 # get nsi from netsliceInstanceId
1753 _filter
= self
._get
_project
_filter
(session
)
1754 _filter
["_id"] = netsliceInstanceId
1755 nsir
= self
.db
.get_one("nsis", _filter
)
1756 logging_prefix
= "nsi={} {} ".format(netsliceInstanceId
, operation
)
1760 if not nsir
["_admin"].get("nsiState") or nsir
["_admin"]["nsiState"] == "NOT_INSTANTIATED":
1761 if operation
== "terminate" and indata
.get("autoremove"):
1762 # NSIR must be deleted
1763 return None, None # a none in this case is used to indicate not instantiated. It can be removed
1764 if operation
!= "instantiate":
1765 raise EngineException("netslice_instance '{}' cannot be '{}' because it is not instantiated".format(
1766 netsliceInstanceId
, operation
), HTTPStatus
.CONFLICT
)
1768 if operation
== "instantiate" and not session
["force"]:
1769 raise EngineException("netslice_instance '{}' cannot be '{}' because it is already instantiated".
1770 format(netsliceInstanceId
, operation
), HTTPStatus
.CONFLICT
)
1772 # Creating all the NS_operation (nslcmop)
1773 # Get service list from db
1774 nsrs_list
= nsir
["_admin"]["nsrs-detailed-list"]
1776 # nslcmops_item = None
1777 for index
, nsr_item
in enumerate(nsrs_list
):
1778 nsr_id
= nsr_item
["nsrId"]
1779 if nsr_item
.get("shared"):
1780 _filter
["_admin.nsrs-detailed-list.ANYINDEX.shared"] = True
1781 _filter
["_admin.nsrs-detailed-list.ANYINDEX.nsrId"] = nsr_id
1782 _filter
["_admin.nsrs-detailed-list.ANYINDEX.nslcmop_instantiate.ne"] = None
1783 _filter
["_id.ne"] = netsliceInstanceId
1784 nsi
= self
.db
.get_one("nsis", _filter
, fail_on_empty
=False, fail_on_more
=False)
1785 if operation
== "terminate":
1786 _update
= {"_admin.nsrs-detailed-list.{}.nslcmop_instantiate".format(index
): None}
1787 self
.db
.set_one("nsis", {"_id": nsir
["_id"]}, _update
)
1788 if nsi
: # other nsi is using this nsr and it needs this nsr instantiated
1789 continue # do not create nsilcmop
1791 # looks the first nsi fulfilling the conditions but not being the current NSIR
1793 nsi_nsr_item
= next(n
for n
in nsi
["_admin"]["nsrs-detailed-list"] if
1794 n
["nsrId"] == nsr_id
and n
["shared"] and
1795 n
["nslcmop_instantiate"])
1796 self
.add_shared_nsr_2vld(nsir
, nsr_item
)
1797 nslcmops
.append(nsi_nsr_item
["nslcmop_instantiate"])
1798 _update
= {"_admin.nsrs-detailed-list.{}".format(index
): nsi_nsr_item
}
1799 self
.db
.set_one("nsis", {"_id": nsir
["_id"]}, _update
)
1800 # continue to not create nslcmop since nsrs is shared and nsrs was created
1803 self
.add_shared_nsr_2vld(nsir
, nsr_item
)
1808 "lcmOperationType": operation
,
1809 "nsInstanceId": nsr_id
,
1810 # Including netslice_id in the ns instantiate Operation
1811 "netsliceInstanceId": netsliceInstanceId
,
1813 if operation
== "instantiate":
1814 service
= self
.db
.get_one("nsrs", {"_id": nsr_id
})
1815 indata_ns
.update(service
["instantiate_params"])
1817 # Creating NS_LCM_OP with the flag slice_object=True to not trigger the service instantiation
1818 # message via kafka bus
1819 nslcmop
, _
= self
.nsi_NsLcmOpTopic
.new(rollback
, session
, indata_ns
, None, headers
,
1821 nslcmops
.append(nslcmop
)
1822 if operation
== "instantiate":
1823 _update
= {"_admin.nsrs-detailed-list.{}.nslcmop_instantiate".format(index
): nslcmop
}
1824 self
.db
.set_one("nsis", {"_id": nsir
["_id"]}, _update
)
1825 except (DbException
, EngineException
) as e
:
1826 if e
.http_code
== HTTPStatus
.NOT_FOUND
:
1827 self
.logger
.info(logging_prefix
+ "skipping NS={} because not found".format(nsr_id
))
1833 indata
["nslcmops_ids"] = nslcmops
1834 self
._check
_nsi
_operation
(session
, nsir
, operation
, indata
)
1836 nsilcmop_desc
= self
._create
_nsilcmop
(session
, netsliceInstanceId
, operation
, indata
)
1837 self
.format_on_new(nsilcmop_desc
, session
["project_id"], make_public
=session
["public"])
1838 _id
= self
.db
.create("nsilcmops", nsilcmop_desc
)
1839 rollback
.append({"topic": "nsilcmops", "_id": _id
})
1840 self
.msg
.write("nsi", operation
, nsilcmop_desc
)
1842 except ValidationError
as e
:
1843 raise EngineException(e
, HTTPStatus
.UNPROCESSABLE_ENTITY
)
1845 def delete(self
, session
, _id
, dry_run
=False, not_send_msg
=None):
1846 raise EngineException("Method delete called directly", HTTPStatus
.INTERNAL_SERVER_ERROR
)
1848 def edit(self
, session
, _id
, indata
=None, kwargs
=None, content
=None):
1849 raise EngineException("Method edit called directly", HTTPStatus
.INTERNAL_SERVER_ERROR
)