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_action
, ns_scale
, nsi_instantiate
22 from osm_nbi
.base_topic
import BaseTopic
, EngineException
, get_iterable
23 # from descriptor_topics import DescriptorTopic
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 re
import match
# For checking that additional parameter names are valid Jinja2 identifiers
30 __author__
= "Alfonso Tierno <alfonso.tiernosepulveda@telefonica.com>"
33 class NsrTopic(BaseTopic
):
36 schema_new
= ns_instantiate
38 def __init__(self
, db
, fs
, msg
, auth
):
39 BaseTopic
.__init
__(self
, db
, fs
, msg
, auth
)
41 def _check_descriptor_dependencies(self
, session
, descriptor
):
43 Check that the dependent descriptors exist on a new descriptor or edition
44 :param session: client session information
45 :param descriptor: descriptor to be inserted or edit
46 :return: None or raises exception
48 if not descriptor
.get("nsdId"):
50 nsd_id
= descriptor
["nsdId"]
51 if not self
.get_item_list(session
, "nsds", {"id": nsd_id
}):
52 raise EngineException("Descriptor error at nsdId='{}' references a non exist nsd".format(nsd_id
),
53 http_code
=HTTPStatus
.CONFLICT
)
56 def format_on_new(content
, project_id
=None, make_public
=False):
57 BaseTopic
.format_on_new(content
, project_id
=project_id
, make_public
=make_public
)
58 content
["_admin"]["nsState"] = "NOT_INSTANTIATED"
61 def check_conflict_on_del(self
, session
, _id
, db_content
):
63 Check that NSR is not instantiated
64 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
65 :param _id: nsr internal id
66 :param db_content: The database content of the nsr
67 :return: None or raises EngineException with the conflict
72 if nsr
["_admin"].get("nsState") == "INSTANTIATED":
73 raise EngineException("nsr '{}' cannot be deleted because it is in 'INSTANTIATED' state. "
74 "Launch 'terminate' operation first; or force deletion".format(_id
),
75 http_code
=HTTPStatus
.CONFLICT
)
77 def delete_extra(self
, session
, _id
, db_content
):
79 Deletes associated nslcmops and vnfrs from database. Deletes associated filesystem.
80 Set usageState of pdu, vnfd, nsd
81 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
82 :param _id: server internal id
83 :param db_content: The database content of the descriptor
84 :return: None if ok or raises EngineException with the problem
86 self
.fs
.file_delete(_id
, ignore_non_exist
=True)
87 self
.db
.del_list("nslcmops", {"nsInstanceId": _id
})
88 self
.db
.del_list("vnfrs", {"nsr-id-ref": _id
})
90 # set all used pdus as free
91 self
.db
.set_list("pdus", {"_admin.usage.nsr_id": _id
},
92 {"_admin.usageState": "NOT_IN_USE", "_admin.usage": None})
96 used_nsd_id
= nsr
.get("nsd-id")
98 # check if used by another NSR
99 nsrs_list
= self
.db
.get_one("nsrs", {"nsd-id": used_nsd_id
},
100 fail_on_empty
=False, fail_on_more
=False)
102 self
.db
.set_one("nsds", {"_id": used_nsd_id
}, {"_admin.usageState": "NOT_IN_USE"})
104 # Set VNFD usageState
105 used_vnfd_id_list
= nsr
.get("vnfd-id")
106 if used_vnfd_id_list
:
107 for used_vnfd_id
in used_vnfd_id_list
:
108 # check if used by another NSR
109 nsrs_list
= self
.db
.get_one("nsrs", {"vnfd-id": used_vnfd_id
},
110 fail_on_empty
=False, fail_on_more
=False)
112 self
.db
.set_one("vnfds", {"_id": used_vnfd_id
}, {"_admin.usageState": "NOT_IN_USE"})
115 def _format_ns_request(ns_request
):
116 formated_request
= copy(ns_request
)
117 formated_request
.pop("additionalParamsForNs", None)
118 formated_request
.pop("additionalParamsForVnf", None)
119 return formated_request
122 def _format_addional_params(ns_request
, member_vnf_index
=None, descriptor
=None):
124 Get and format user additional params for NS or VNF
125 :param ns_request: User instantiation additional parameters
126 :param member_vnf_index: None for extract NS params, or member_vnf_index to extract VNF params
127 :param descriptor: If not None it check that needed parameters of descriptor are supplied
128 :return: a formated copy of additional params or None if not supplied
130 additional_params
= None
131 if not member_vnf_index
:
132 additional_params
= copy(ns_request
.get("additionalParamsForNs"))
133 where_
= "additionalParamsForNs"
134 elif ns_request
.get("additionalParamsForVnf"):
135 for additionalParamsForVnf
in get_iterable(ns_request
.get("additionalParamsForVnf")):
136 if additionalParamsForVnf
["member-vnf-index"] == member_vnf_index
:
137 additional_params
= copy(additionalParamsForVnf
.get("additionalParams"))
138 where_
= "additionalParamsForVnf[member-vnf-index={}]".format(
139 additionalParamsForVnf
["member-vnf-index"])
141 if additional_params
:
142 for k
, v
in additional_params
.items():
143 # BEGIN Check that additional parameter names are valid Jinja2 identifiers
144 if not match('^[a-zA-Z_][a-zA-Z0-9_]*$', k
):
145 raise EngineException("Invalid param name at {}:{}. Must contain only alphanumeric characters "
146 "and underscores, and cannot start with a digit"
148 # END Check that additional parameter names are valid Jinja2 identifiers
149 if not isinstance(k
, str):
150 raise EngineException("Invalid param at {}:{}. Only string keys are allowed".format(where_
, k
))
151 if "." in k
or "$" in k
:
152 raise EngineException("Invalid param at {}:{}. Keys must not contain dots or $".format(where_
, k
))
153 if isinstance(v
, (dict, tuple, list)):
154 additional_params
[k
] = "!!yaml " + safe_dump(v
)
157 # check that enough parameters are supplied for the initial-config-primitive
158 # TODO: check for cloud-init
160 if descriptor
.get("vnf-configuration"):
161 for initial_primitive
in get_iterable(
162 descriptor
["vnf-configuration"].get("initial-config-primitive")):
163 for param
in get_iterable(initial_primitive
.get("parameter")):
164 if param
["value"].startswith("<") and param
["value"].endswith(">"):
165 if param
["value"] in ("<rw_mgmt_ip>", "<VDU_SCALE_INFO>"):
167 if not additional_params
or param
["value"][1:-1] not in additional_params
:
168 raise EngineException("Parameter '{}' needed for vnfd[id={}]:vnf-configuration:"
169 "initial-config-primitive[name={}] not supplied".
170 format(param
["value"], descriptor
["id"],
171 initial_primitive
["name"]))
173 return additional_params
175 def new(self
, rollback
, session
, indata
=None, kwargs
=None, headers
=None):
177 Creates a new nsr into database. It also creates needed vnfrs
178 :param rollback: list to append the created items at database in case a rollback must be done
179 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
180 :param indata: params to be used for the nsr
181 :param kwargs: used to override the indata descriptor
182 :param headers: http request headers
183 :return: the _id of nsr descriptor created at database. Or an exception of type
184 EngineException, ValidationError, DbException, FsException, MsgException.
185 Note: Exceptions are not captured on purpose. They should be captured at called
189 step
= "checking quotas"
190 self
.check_quota(session
)
192 step
= "validating input parameters"
193 ns_request
= self
._remove
_envelop
(indata
)
194 # Override descriptor with query string kwargs
195 self
._update
_input
_with
_kwargs
(ns_request
, kwargs
)
196 self
._validate
_input
_new
(ns_request
, session
["force"])
199 step
= "getting nsd id='{}' from database".format(ns_request
.get("nsdId"))
200 _filter
= self
._get
_project
_filter
(session
)
201 _filter
["_id"] = ns_request
["nsdId"]
202 nsd
= self
.db
.get_one("nsds", _filter
)
205 nsr_id
= str(uuid4())
208 step
= "filling nsr from input data"
210 "name": ns_request
["nsName"],
211 "name-ref": ns_request
["nsName"],
212 "short-name": ns_request
["nsName"],
213 "admin-status": "ENABLED",
215 "datacenter": ns_request
["vimAccountId"],
216 "resource-orchestrator": "osmopenmano",
217 "description": ns_request
.get("nsDescription", ""),
218 "constituent-vnfr-ref": [],
220 "operational-status": "init", # typedef ns-operational-
221 "config-status": "init", # typedef config-states
222 "detailed-status": "scheduled",
224 "orchestration-progress": {},
225 # {"networks": {"active": 0, "total": 0}, "vms": {"active": 0, "total": 0}},
228 "nsd-name-ref": nsd
["name"],
229 "operational-events": [], # "id", "timestamp", "description", "event",
230 "nsd-ref": nsd
["id"],
231 "nsd-id": nsd
["_id"],
233 "instantiate_params": self
._format
_ns
_request
(ns_request
),
234 "additionalParamsForNs": self
._format
_addional
_params
(ns_request
),
235 "ns-instance-config-ref": nsr_id
,
238 # "input-parameter": xpath, value,
239 "ssh-authorized-key": ns_request
.get("ssh_keys"), # TODO remove
241 ns_request
["nsr_id"] = nsr_id
244 nsr_descriptor
["vld"] = []
245 for nsd_vld
in nsd
.get("vld"):
246 nsr_descriptor
["vld"].append(
247 {key
: nsd_vld
[key
] for key
in ("id", "vim-network-name", "vim-network-id") if key
in nsd_vld
})
251 for member_vnf
in nsd
.get("constituent-vnfd", ()):
252 vnfd_id
= member_vnf
["vnfd-id-ref"]
253 step
= "getting vnfd id='{}' constituent-vnfd='{}' from database".format(
254 member_vnf
["vnfd-id-ref"], member_vnf
["member-vnf-index"])
255 if vnfd_id
not in needed_vnfds
:
257 _filter
["id"] = vnfd_id
258 vnfd
= self
.db
.get_one("vnfds", _filter
, fail_on_empty
=True, fail_on_more
=True)
261 needed_vnfds
[vnfd_id
] = vnfd
262 nsr_descriptor
["vnfd-id"].append(vnfd
["_id"])
264 vnfd
= needed_vnfds
[vnfd_id
]
265 step
= "filling vnfr vnfd-id='{}' constituent-vnfd='{}'".format(
266 member_vnf
["vnfd-id-ref"], member_vnf
["member-vnf-index"])
267 vnfr_id
= str(uuid4())
271 "nsr-id-ref": nsr_id
,
272 "member-vnf-index-ref": member_vnf
["member-vnf-index"],
273 "additionalParamsForVnf": self
._format
_addional
_params
(ns_request
, member_vnf
["member-vnf-index"],
276 # "vnfd": vnfd, # at OSM model.but removed to avoid data duplication TODO: revise
278 "vnfd-id": vnfd
["_id"], # not at OSM model, but useful
279 "vim-account-id": None,
281 "connection-point": [],
282 "ip-address": None, # mgmt-interface filled by LCM
286 if vnfd
.get("internal-vld"):
287 vnfr_descriptor
["vld"] = []
288 for vnfd_vld
in vnfd
.get("internal-vld"):
289 vnfr_descriptor
["vld"].append(
290 {key
: vnfd_vld
[key
] for key
in ("id", "vim-network-name", "vim-network-id") if key
in
293 vnfd_mgmt_cp
= vnfd
["mgmt-interface"].get("cp")
294 for cp
in vnfd
.get("connection-point", ()):
297 "connection-point-id": cp
.get("id"),
299 # "ip-address", "mac-address" # filled by LCM
300 # vim-id # TODO it would be nice having a vim port id
302 vnfr_descriptor
["connection-point"].append(vnf_cp
)
304 # Create k8s-cluster information
305 if vnfd
.get("k8s-cluster"):
306 vnfr_descriptor
["k8s-cluster"] = vnfd
["k8s-cluster"]
307 for net
in get_iterable(vnfr_descriptor
["k8s-cluster"].get("nets")):
308 if net
.get("external-connection-point-ref"):
309 for nsd_vld
in get_iterable(nsd
.get("vld")):
310 for nsd_vld_cp
in get_iterable(nsd_vld
.get("vnfd-connection-point-ref")):
311 if nsd_vld_cp
.get("vnfd-connection-point-ref") == \
312 net
["external-connection-point-ref"] and \
313 nsd_vld_cp
.get("member-vnf-index-ref") == member_vnf
["member-vnf-index"]:
314 net
["ns-vld-id"] = nsd_vld
["id"]
319 elif net
.get("internal-connection-point-ref"):
320 for vnfd_ivld
in get_iterable(vnfd
.get("internal-vld")):
321 for vnfd_ivld_icp
in get_iterable(vnfd_ivld
.get("internal-connection-point")):
322 if vnfd_ivld_icp
.get("id-ref") == net
["internal-connection-point-ref"]:
323 net
["vnf-vld-id"] = vnfd_ivld
["id"]
329 for kdu
in get_iterable(vnfd
.get("kdu")):
331 "kdu-name": kdu
["name"],
332 # TODO "name": "" Name of the VDU in the VIM
333 "ip-address": None, # mgmt-interface filled by LCM
336 if not vnfr_descriptor
.get("kdur"):
337 vnfr_descriptor
["kdur"] = []
338 vnfr_descriptor
["kdur"].append(kdur
)
340 for vdu
in vnfd
.get("vdu", ()):
342 "vdu-id-ref": vdu
["id"],
343 # TODO "name": "" Name of the VDU in the VIM
344 "ip-address": None, # mgmt-interface filled by LCM
345 # "vim-id", "flavor-id", "image-id", "management-ip" # filled by LCM
346 "internal-connection-point": [],
349 if vdu
.get("pdu-type"):
350 vdur
["pdu-type"] = vdu
["pdu-type"]
351 # TODO volumes: name, volume-id
352 for icp
in vdu
.get("internal-connection-point", ()):
355 "connection-point-id": icp
["id"],
356 "name": icp
.get("name"),
357 # "ip-address", "mac-address" # filled by LCM
358 # vim-id # TODO it would be nice having a vim port id
360 vdur
["internal-connection-point"].append(vdu_icp
)
361 for iface
in vdu
.get("interface", ()):
363 "name": iface
.get("name"),
364 # "ip-address", "mac-address" # filled by LCM
365 # vim-id # TODO it would be nice having a vim port id
367 if vnfd_mgmt_cp
and iface
.get("external-connection-point-ref") == vnfd_mgmt_cp
:
368 vdu_iface
["mgmt-vnf"] = True
369 if iface
.get("mgmt-interface"):
370 vdu_iface
["mgmt-interface"] = True # TODO change to mgmt-vdu
372 # look for network where this interface is connected
373 if iface
.get("external-connection-point-ref"):
374 for nsd_vld
in get_iterable(nsd
.get("vld")):
375 for nsd_vld_cp
in get_iterable(nsd_vld
.get("vnfd-connection-point-ref")):
376 if nsd_vld_cp
.get("vnfd-connection-point-ref") == \
377 iface
["external-connection-point-ref"] and \
378 nsd_vld_cp
.get("member-vnf-index-ref") == member_vnf
["member-vnf-index"]:
379 vdu_iface
["ns-vld-id"] = nsd_vld
["id"]
384 elif iface
.get("internal-connection-point-ref"):
385 for vnfd_ivld
in get_iterable(vnfd
.get("internal-vld")):
386 for vnfd_ivld_icp
in get_iterable(vnfd_ivld
.get("internal-connection-point")):
387 if vnfd_ivld_icp
.get("id-ref") == iface
["internal-connection-point-ref"]:
388 vdu_iface
["vnf-vld-id"] = vnfd_ivld
["id"]
394 vdur
["interfaces"].append(vdu_iface
)
395 count
= vdu
.get("count", 1)
398 count
= int(count
) # TODO remove when descriptor serialized with payngbind
399 for index
in range(0, count
):
401 vdur
= deepcopy(vdur
)
402 vdur
["_id"] = str(uuid4())
403 vdur
["count-index"] = index
404 vnfr_descriptor
["vdur"].append(vdur
)
406 step
= "creating vnfr vnfd-id='{}' constituent-vnfd='{}' at database".format(
407 member_vnf
["vnfd-id-ref"], member_vnf
["member-vnf-index"])
410 self
.format_on_new(vnfr_descriptor
, session
["project_id"], make_public
=session
["public"])
411 self
.db
.create("vnfrs", vnfr_descriptor
)
412 rollback
.append({"topic": "vnfrs", "_id": vnfr_id
})
413 nsr_descriptor
["constituent-vnfr-ref"].append(vnfr_id
)
415 step
= "creating nsr at database"
416 self
.format_on_new(nsr_descriptor
, session
["project_id"], make_public
=session
["public"])
417 self
.db
.create("nsrs", nsr_descriptor
)
418 rollback
.append({"topic": "nsrs", "_id": nsr_id
})
420 step
= "creating nsr temporal folder"
421 self
.fs
.mkdir(nsr_id
)
424 except (ValidationError
, EngineException
, DbException
, MsgException
, FsException
) as e
:
425 raise type(e
)("{} while '{}".format(e
, step
), http_code
=e
.http_code
)
427 def edit(self
, session
, _id
, indata
=None, kwargs
=None, content
=None):
428 raise EngineException("Method edit called directly", HTTPStatus
.INTERNAL_SERVER_ERROR
)
431 class VnfrTopic(BaseTopic
):
435 def __init__(self
, db
, fs
, msg
, auth
):
436 BaseTopic
.__init
__(self
, db
, fs
, msg
, auth
)
438 def delete(self
, session
, _id
, dry_run
=False):
439 raise EngineException("Method delete called directly", HTTPStatus
.INTERNAL_SERVER_ERROR
)
441 def edit(self
, session
, _id
, indata
=None, kwargs
=None, content
=None):
442 raise EngineException("Method edit called directly", HTTPStatus
.INTERNAL_SERVER_ERROR
)
444 def new(self
, rollback
, session
, indata
=None, kwargs
=None, headers
=None):
445 # Not used because vnfrs are created and deleted by NsrTopic class directly
446 raise EngineException("Method new called directly", HTTPStatus
.INTERNAL_SERVER_ERROR
)
449 class NsLcmOpTopic(BaseTopic
):
452 operation_schema
= { # mapping between operation and jsonschema to validate
453 "instantiate": ns_instantiate
,
459 def __init__(self
, db
, fs
, msg
, auth
):
460 BaseTopic
.__init
__(self
, db
, fs
, msg
, auth
)
462 def _check_ns_operation(self
, session
, nsr
, operation
, indata
):
464 Check that user has enter right parameters for the operation
465 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
466 :param operation: it can be: instantiate, terminate, action, TODO: update, heal
467 :param indata: descriptor with the parameters of the operation
470 vnf_member_index_to_vnfd
= {} # map between vnf_member_index to vnf descriptor.
475 def check_valid_vnf_member_index(member_vnf_index
):
476 # Obtain vnf descriptor. The vnfr is used to get the vnfd._id used for this member_vnf_index
477 if vnf_member_index_to_vnfd
.get(member_vnf_index
):
478 return vnf_member_index_to_vnfd
[member_vnf_index
]
479 vnfr
= self
.db
.get_one("vnfrs",
480 {"nsr-id-ref": nsr
["_id"], "member-vnf-index-ref": member_vnf_index
},
483 raise EngineException("Invalid parameter member_vnf_index='{}' is not one of the "
484 "nsd:constituent-vnfd".format(member_vnf_index
))
485 vnfd
= self
.db
.get_one("vnfds", {"_id": vnfr
["vnfd-id"]}, fail_on_empty
=False)
487 raise EngineException("vnfd id={} has been deleted!. Operation cannot be performed".
488 format(vnfr
["vnfd-id"]))
489 vnf_member_index_to_vnfd
[member_vnf_index
] = vnfd
# add to cache, avoiding a later look for
492 def check_valid_vdu(vnfd
, vdu_id
):
493 for vdud
in get_iterable(vnfd
.get("vdu")):
494 if vdud
["id"] == vdu_id
:
497 raise EngineException("Invalid parameter vdu_id='{}' not present at vnfd:vdu:id".format(vdu_id
))
499 def check_valid_kdu(vnfd
, kdu_name
):
500 for kdud
in get_iterable(vnfd
.get("kdu")):
501 if kdud
["name"] == kdu_name
:
504 raise EngineException("Invalid parameter kdu_name='{}' not present at vnfd:kdu:name".format(kdu_name
))
506 def _check_vnf_instantiation_params(in_vnfd
, vnfd
):
508 for in_vdu
in get_iterable(in_vnfd
.get("vdu")):
509 for vdu
in get_iterable(vnfd
.get("vdu")):
510 if in_vdu
["id"] == vdu
["id"]:
511 for volume
in get_iterable(in_vdu
.get("volume")):
512 for volumed
in get_iterable(vdu
.get("volumes")):
513 if volumed
["name"] == volume
["name"]:
516 raise EngineException("Invalid parameter vnf[member-vnf-index='{}']:vdu[id='{}']:"
517 "volume:name='{}' is not present at vnfd:vdu:volumes list".
518 format(in_vnf
["member-vnf-index"], in_vdu
["id"],
520 for in_iface
in get_iterable(in_vdu
["interface"]):
521 for iface
in get_iterable(vdu
.get("interface")):
522 if in_iface
["name"] == iface
["name"]:
525 raise EngineException("Invalid parameter vnf[member-vnf-index='{}']:vdu[id='{}']:"
526 "interface[name='{}'] is not present at vnfd:vdu:interface"
527 .format(in_vnf
["member-vnf-index"], in_vdu
["id"],
531 raise EngineException("Invalid parameter vnf[member-vnf-index='{}']:vdu[id='{}'] is is not present "
532 "at vnfd:vdu".format(in_vnf
["member-vnf-index"], in_vdu
["id"]))
534 for in_ivld
in get_iterable(in_vnfd
.get("internal-vld")):
535 for ivld
in get_iterable(vnfd
.get("internal-vld")):
536 if in_ivld
["name"] == ivld
["name"] or in_ivld
["name"] == ivld
["id"]:
537 for in_icp
in get_iterable(in_ivld
.get("internal-connection-point")):
538 for icp
in ivld
["internal-connection-point"]:
539 if in_icp
["id-ref"] == icp
["id-ref"]:
542 raise EngineException("Invalid parameter vnf[member-vnf-index='{}']:internal-vld[name"
543 "='{}']:internal-connection-point[id-ref:'{}'] is not present at "
544 "vnfd:internal-vld:name/id:internal-connection-point"
545 .format(in_vnf
["member-vnf-index"], in_ivld
["name"],
546 in_icp
["id-ref"], vnfd
["id"]))
549 raise EngineException("Invalid parameter vnf[member-vnf-index='{}']:internal-vld:name='{}'"
550 " is not present at vnfd '{}'".format(in_vnf
["member-vnf-index"],
551 in_ivld
["name"], vnfd
["id"]))
553 def check_valid_vim_account(vim_account
):
554 if vim_account
in vim_accounts
:
557 db_filter
= self
._get
_project
_filter
(session
)
558 db_filter
["_id"] = vim_account
559 self
.db
.get_one("vim_accounts", db_filter
)
561 raise EngineException("Invalid vimAccountId='{}' not present for the project".format(vim_account
))
562 vim_accounts
.append(vim_account
)
564 def check_valid_wim_account(wim_account
):
565 if not isinstance(wim_account
, str):
567 elif wim_account
in wim_accounts
:
570 db_filter
= self
._get
_project
_filter
(session
, write
=False, show_all
=True)
571 db_filter
["_id"] = wim_account
572 self
.db
.get_one("wim_accounts", db_filter
)
574 raise EngineException("Invalid wimAccountId='{}' not present for the project".format(wim_account
))
575 wim_accounts
.append(wim_account
)
577 if operation
== "action":
578 # check vnf_member_index
579 if indata
.get("vnf_member_index"):
580 indata
["member_vnf_index"] = indata
.pop("vnf_member_index") # for backward compatibility
581 if indata
.get("member_vnf_index"):
582 vnfd
= check_valid_vnf_member_index(indata
["member_vnf_index"])
583 if indata
.get("vdu_id"):
584 vdud
= check_valid_vdu(vnfd
, indata
["vdu_id"])
585 descriptor_configuration
= vdud
.get("vdu-configuration", {}).get("config-primitive")
586 elif indata
.get("kdu_name"):
587 kdud
= check_valid_kdu(vnfd
, indata
["kdu_name"])
588 descriptor_configuration
= kdud
.get("kdu-configuration", {}).get("config-primitive")
590 descriptor_configuration
= vnfd
.get("vnf-configuration", {}).get("config-primitive")
592 descriptor_configuration
= nsd
.get("ns-configuration", {}).get("config-primitive")
594 # For k8s allows default primitives without validating the parameters
595 if indata
.get("kdu_name") and indata
["primitive"] in ("upgrade", "rollback", "status"):
596 # TODO should be checked that rollback only can contains revsision_numbe????
598 # if not, check primitive
599 for config_primitive
in get_iterable(descriptor_configuration
):
600 if indata
["primitive"] == config_primitive
["name"]:
601 # check needed primitive_params are provided
602 if indata
.get("primitive_params"):
603 in_primitive_params_copy
= copy(indata
["primitive_params"])
605 in_primitive_params_copy
= {}
606 for paramd
in get_iterable(config_primitive
.get("parameter")):
607 if paramd
["name"] in in_primitive_params_copy
:
608 del in_primitive_params_copy
[paramd
["name"]]
609 elif not paramd
.get("default-value"):
610 raise EngineException("Needed parameter {} not provided for primitive '{}'".format(
611 paramd
["name"], indata
["primitive"]))
612 # check no extra primitive params are provided
613 if in_primitive_params_copy
:
614 raise EngineException("parameter/s '{}' not present at vnfd /nsd for primitive '{}'".format(
615 list(in_primitive_params_copy
.keys()), indata
["primitive"]))
618 raise EngineException("Invalid primitive '{}' is not present at vnfd/nsd".format(indata
["primitive"]))
619 if operation
== "scale":
620 vnfd
= check_valid_vnf_member_index(indata
["scaleVnfData"]["scaleByStepData"]["member-vnf-index"])
621 for scaling_group
in get_iterable(vnfd
.get("scaling-group-descriptor")):
622 if indata
["scaleVnfData"]["scaleByStepData"]["scaling-group-descriptor"] == scaling_group
["name"]:
625 raise EngineException("Invalid scaleVnfData:scaleByStepData:scaling-group-descriptor '{}' is not "
626 "present at vnfd:scaling-group-descriptor".format(
627 indata
["scaleVnfData"]["scaleByStepData"]["scaling-group-descriptor"]))
628 if operation
== "instantiate":
630 check_valid_vim_account(indata
["vimAccountId"])
631 check_valid_wim_account(indata
.get("wimAccountId"))
632 for in_vnf
in get_iterable(indata
.get("vnf")):
633 vnfd
= check_valid_vnf_member_index(in_vnf
["member-vnf-index"])
634 _check_vnf_instantiation_params(in_vnf
, vnfd
)
635 if in_vnf
.get("vimAccountId"):
636 check_valid_vim_account(in_vnf
["vimAccountId"])
638 for in_vld
in get_iterable(indata
.get("vld")):
639 check_valid_wim_account(in_vld
.get("wimAccountId"))
640 for vldd
in get_iterable(nsd
.get("vld")):
641 if in_vld
["name"] == vldd
["name"] or in_vld
["name"] == vldd
["id"]:
644 raise EngineException("Invalid parameter vld:name='{}' is not present at nsd:vld".format(
647 def _look_for_pdu(self
, session
, rollback
, vnfr
, vim_account
, vnfr_update
, vnfr_update_rollback
):
649 Look for a free PDU in the catalog matching vdur type and interfaces. Fills vnfr.vdur with the interface
650 (ip_address, ...) information.
651 Modifies PDU _admin.usageState to 'IN_USE'
653 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
654 :param rollback: list with the database modifications to rollback if needed
655 :param vnfr: vnfr to be updated. It is modified with pdu interface info if pdu is found
656 :param vim_account: vim_account where this vnfr should be deployed
657 :param vnfr_update: dictionary filled by this method with changes to be done at database vnfr
658 :param vnfr_update_rollback: dictionary filled by this method with original content of vnfr in case a rollback
659 of the changed vnfr is needed
661 :return: List of PDU interfaces that are connected to an existing VIM network. Each item contains:
662 "vim-network-name": used at VIM
663 "name": interface name
664 "vnf-vld-id": internal VNFD vld where this interface is connected, or
665 "ns-vld-id": NSD vld where this interface is connected.
666 NOTE: One, and only one between 'vnf-vld-id' and 'ns-vld-id' contains a value. The other will be None
669 ifaces_forcing_vim_network
= []
670 for vdur_index
, vdur
in enumerate(get_iterable(vnfr
.get("vdur"))):
671 if not vdur
.get("pdu-type"):
673 pdu_type
= vdur
.get("pdu-type")
674 pdu_filter
= self
._get
_project
_filter
(session
)
675 pdu_filter
["vim_accounts"] = vim_account
676 pdu_filter
["type"] = pdu_type
677 pdu_filter
["_admin.operationalState"] = "ENABLED"
678 pdu_filter
["_admin.usageState"] = "NOT_IN_USE"
679 # TODO feature 1417: "shared": True,
681 available_pdus
= self
.db
.get_list("pdus", pdu_filter
)
682 for pdu
in available_pdus
:
683 # step 1 check if this pdu contains needed interfaces:
684 match_interfaces
= True
685 for vdur_interface
in vdur
["interfaces"]:
686 for pdu_interface
in pdu
["interfaces"]:
687 if pdu_interface
["name"] == vdur_interface
["name"]:
688 # TODO feature 1417: match per mgmt type
690 else: # no interface found for name
691 match_interfaces
= False
696 raise EngineException(
697 "No PDU of type={} at vim_account={} found for member_vnf_index={}, vdu={} matching interface "
698 "names".format(pdu_type
, vim_account
, vnfr
["member-vnf-index-ref"], vdur
["vdu-id-ref"]))
702 "_admin.usageState": pdu
["_admin"]["usageState"],
703 "_admin.usage.vnfr_id": None,
704 "_admin.usage.nsr_id": None,
705 "_admin.usage.vdur": None,
707 self
.db
.set_one("pdus", {"_id": pdu
["_id"]},
708 {"_admin.usageState": "IN_USE",
709 "_admin.usage": {"vnfr_id": vnfr
["_id"],
710 "nsr_id": vnfr
["nsr-id-ref"],
711 "vdur": vdur
["vdu-id-ref"]}
713 rollback
.append({"topic": "pdus", "_id": pdu
["_id"], "operation": "set", "content": rollback_pdu
})
715 # step 3. Fill vnfr info by filling vdur
716 vdu_text
= "vdur.{}".format(vdur_index
)
717 vnfr_update_rollback
[vdu_text
+ ".pdu-id"] = None
718 vnfr_update
[vdu_text
+ ".pdu-id"] = pdu
["_id"]
719 for iface_index
, vdur_interface
in enumerate(vdur
["interfaces"]):
720 for pdu_interface
in pdu
["interfaces"]:
721 if pdu_interface
["name"] == vdur_interface
["name"]:
722 iface_text
= vdu_text
+ ".interfaces.{}".format(iface_index
)
723 for k
, v
in pdu_interface
.items():
724 if k
in ("ip-address", "mac-address"): # TODO: switch-xxxxx must be inserted
725 vnfr_update
[iface_text
+ ".{}".format(k
)] = v
726 vnfr_update_rollback
[iface_text
+ ".{}".format(k
)] = vdur_interface
.get(v
)
727 if pdu_interface
.get("ip-address"):
728 if vdur_interface
.get("mgmt-interface"):
729 vnfr_update_rollback
[vdu_text
+ ".ip-address"] = vdur
.get("ip-address")
730 vnfr_update
[vdu_text
+ ".ip-address"] = pdu_interface
["ip-address"]
731 if vdur_interface
.get("mgmt-vnf"):
732 vnfr_update_rollback
["ip-address"] = vnfr
.get("ip-address")
733 vnfr_update
["ip-address"] = pdu_interface
["ip-address"]
734 if pdu_interface
.get("vim-network-name") or pdu_interface
.get("vim-network-id"):
735 ifaces_forcing_vim_network
.append({
736 "name": vdur_interface
.get("vnf-vld-id") or vdur_interface
.get("ns-vld-id"),
737 "vnf-vld-id": vdur_interface
.get("vnf-vld-id"),
738 "ns-vld-id": vdur_interface
.get("ns-vld-id")})
739 if pdu_interface
.get("vim-network-id"):
740 ifaces_forcing_vim_network
[-1]["vim-network-id"] = pdu_interface
["vim-network-id"]
741 if pdu_interface
.get("vim-network-name"):
742 ifaces_forcing_vim_network
[-1]["vim-network-name"] = pdu_interface
["vim-network-name"]
745 return ifaces_forcing_vim_network
747 def _look_for_k8scluster(self
, session
, rollback
, vnfr
, vim_account
, vnfr_update
, vnfr_update_rollback
):
749 Look for an available k8scluster for all the kuds in the vnfd matching version and cni requirements.
750 Fills vnfr.kdur with the selected k8scluster
752 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
753 :param rollback: list with the database modifications to rollback if needed
754 :param vnfr: vnfr to be updated. It is modified with pdu interface info if pdu is found
755 :param vim_account: vim_account where this vnfr should be deployed
756 :param vnfr_update: dictionary filled by this method with changes to be done at database vnfr
757 :param vnfr_update_rollback: dictionary filled by this method with original content of vnfr in case a rollback
758 of the changed vnfr is needed
760 :return: List of KDU interfaces that are connected to an existing VIM network. Each item contains:
761 "vim-network-name": used at VIM
762 "name": interface name
763 "vnf-vld-id": internal VNFD vld where this interface is connected, or
764 "ns-vld-id": NSD vld where this interface is connected.
765 NOTE: One, and only one between 'vnf-vld-id' and 'ns-vld-id' contains a value. The other will be None
768 ifaces_forcing_vim_network
= []
769 if not vnfr
.get("kdur"):
770 return ifaces_forcing_vim_network
772 kdu_filter
= self
._get
_project
_filter
(session
)
773 kdu_filter
["vim_account"] = vim_account
774 # TODO kdu_filter["_admin.operationalState"] = "ENABLED"
775 available_k8sclusters
= self
.db
.get_list("k8sclusters", kdu_filter
)
777 k8s_requirements
= {} # just for logging
778 for k8scluster
in available_k8sclusters
:
779 if not vnfr
.get("k8s-cluster"):
782 if vnfr
["k8s-cluster"].get("cni"):
783 k8s_requirements
["cni"] = vnfr
["k8s-cluster"]["cni"]
784 if not set(vnfr
["k8s-cluster"]["cni"]).intersection(k8scluster
.get("cni", ())):
786 # restrict by version
787 if vnfr
["k8s-cluster"].get("version"):
788 k8s_requirements
["version"] = vnfr
["k8s-cluster"]["version"]
789 if k8scluster
.get("k8s_version") not in vnfr
["k8s-cluster"]["version"]:
791 # restrict by number of networks
792 if vnfr
["k8s-cluster"].get("nets"):
793 k8s_requirements
["networks"] = len(vnfr
["k8s-cluster"]["nets"])
794 if not k8scluster
.get("nets") or len(k8scluster
["nets"]) < len(vnfr
["k8s-cluster"]["nets"]):
798 raise EngineException("No k8scluster with requirements='{}' at vim_account={} found for member_vnf_index={}"
799 .format(k8s_requirements
, vim_account
, vnfr
["member-vnf-index-ref"]))
801 for kdur_index
, kdur
in enumerate(get_iterable(vnfr
.get("kdur"))):
802 # step 3. Fill vnfr info by filling kdur
803 kdu_text
= "kdur.{}.".format(kdur_index
)
804 vnfr_update_rollback
[kdu_text
+ "k8s-cluster.id"] = None
805 vnfr_update
[kdu_text
+ "k8s-cluster.id"] = k8scluster
["_id"]
807 # step 4. Check VIM networks that forces the selected k8s_cluster
808 if vnfr
.get("k8s-cluster") and vnfr
["k8s-cluster"].get("nets"):
809 k8scluster_net_list
= list(k8scluster
.get("nets").keys())
810 for net_index
, kdur_net
in enumerate(vnfr
["k8s-cluster"]["nets"]):
811 # get a network from k8s_cluster nets. If name matches use this, if not use other
812 if kdur_net
["id"] in k8scluster_net_list
: # name matches
813 vim_net
= k8scluster
["nets"][kdur_net
["id"]]
814 k8scluster_net_list
.remove(kdur_net
["id"])
816 vim_net
= k8scluster
["nets"][k8scluster_net_list
[0]]
817 k8scluster_net_list
.pop(0)
818 vnfr_update_rollback
["k8s-cluster.nets.{}.vim_net".format(net_index
)] = None
819 vnfr_update
["k8s-cluster.nets.{}.vim_net".format(net_index
)] = vim_net
820 if vim_net
and (kdur_net
.get("vnf-vld-id") or kdur_net
.get("ns-vld-id")):
821 ifaces_forcing_vim_network
.append({
822 "name": kdur_net
.get("vnf-vld-id") or kdur_net
.get("ns-vld-id"),
823 "vnf-vld-id": kdur_net
.get("vnf-vld-id"),
824 "ns-vld-id": kdur_net
.get("ns-vld-id"),
825 "vim-network-name": vim_net
, # TODO can it be vim-network-id ???
827 # TODO check that this forcing is not incompatible with other forcing
828 return ifaces_forcing_vim_network
830 def _update_vnfrs(self
, session
, rollback
, nsr
, indata
):
833 vnfrs
= self
.db
.get_list("vnfrs", {"nsr-id-ref": nsr_id
})
837 vnfr_update_rollback
= {}
838 member_vnf_index
= vnfr
["member-vnf-index-ref"]
839 # update vim-account-id
841 vim_account
= indata
["vimAccountId"]
842 # check instantiate parameters
843 for vnf_inst_params
in get_iterable(indata
.get("vnf")):
844 if vnf_inst_params
["member-vnf-index"] != member_vnf_index
:
846 if vnf_inst_params
.get("vimAccountId"):
847 vim_account
= vnf_inst_params
.get("vimAccountId")
849 vnfr_update
["vim-account-id"] = vim_account
850 vnfr_update_rollback
["vim-account-id"] = vnfr
.get("vim-account-id")
853 ifaces_forcing_vim_network
= self
._look
_for
_pdu
(session
, rollback
, vnfr
, vim_account
, vnfr_update
,
854 vnfr_update_rollback
)
857 ifaces_forcing_vim_network
+= self
._look
_for
_k
8scluster
(session
, rollback
, vnfr
, vim_account
, vnfr_update
,
858 vnfr_update_rollback
)
859 # update database vnfr
860 self
.db
.set_one("vnfrs", {"_id": vnfr
["_id"]}, vnfr_update
)
861 rollback
.append({"topic": "vnfrs", "_id": vnfr
["_id"], "operation": "set", "content": vnfr_update_rollback
})
863 # Update indada in case pdu forces to use a concrete vim-network-name
864 # TODO check if user has already insert a vim-network-name and raises an error
865 if not ifaces_forcing_vim_network
:
867 for iface_info
in ifaces_forcing_vim_network
:
868 if iface_info
.get("ns-vld-id"):
869 if "vld" not in indata
:
871 indata
["vld"].append({key
: iface_info
[key
] for key
in
872 ("name", "vim-network-name", "vim-network-id") if iface_info
.get(key
)})
874 elif iface_info
.get("vnf-vld-id"):
875 if "vnf" not in indata
:
877 indata
["vnf"].append({
878 "member-vnf-index": member_vnf_index
,
879 "internal-vld": [{key
: iface_info
[key
] for key
in
880 ("name", "vim-network-name", "vim-network-id") if iface_info
.get(key
)}]
884 def _create_nslcmop(nsr_id
, operation
, params
):
886 Creates a ns-lcm-opp content to be stored at database.
887 :param nsr_id: internal id of the instance
888 :param operation: instantiate, terminate, scale, action, ...
889 :param params: user parameters for the operation
890 :return: dictionary following SOL005 format
897 "operationState": "PROCESSING", # COMPLETED,PARTIALLY_COMPLETED,FAILED_TEMP,FAILED,ROLLING_BACK,ROLLED_BACK
898 "statusEnteredTime": now
,
899 "nsInstanceId": nsr_id
,
900 "lcmOperationType": operation
,
902 "isAutomaticInvocation": False,
903 "operationParams": params
,
904 "isCancelPending": False,
906 "self": "/osm/nslcm/v1/ns_lcm_op_occs/" + _id
,
907 "nsInstance": "/osm/nslcm/v1/ns_instances/" + nsr_id
,
912 def new(self
, rollback
, session
, indata
=None, kwargs
=None, headers
=None, slice_object
=False):
914 Performs a new operation over a ns
915 :param rollback: list to append created items at database in case a rollback must to be done
916 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
917 :param indata: descriptor with the parameters of the operation. It must contains among others
918 nsInstanceId: _id of the nsr to perform the operation
919 operation: it can be: instantiate, terminate, action, TODO: update, heal
920 :param kwargs: used to override the indata descriptor
921 :param headers: http request headers
922 :return: id of the nslcmops
924 def check_if_nsr_is_not_slice_member(session
, nsr_id
):
926 db_filter
= self
._get
_project
_filter
(session
)
927 db_filter
["_admin.nsrs-detailed-list.ANYINDEX.nsrId"] = nsr_id
928 nsis
= self
.db
.get_one("nsis", db_filter
, fail_on_empty
=False, fail_on_more
=False)
930 raise EngineException("The NS instance {} cannot be terminate because is used by the slice {}".format(
931 nsr_id
, nsis
["_id"]), http_code
=HTTPStatus
.CONFLICT
)
934 # Override descriptor with query string kwargs
935 self
._update
_input
_with
_kwargs
(indata
, kwargs
)
936 operation
= indata
["lcmOperationType"]
937 nsInstanceId
= indata
["nsInstanceId"]
939 validate_input(indata
, self
.operation_schema
[operation
])
941 _filter
= BaseTopic
._get
_project
_filter
(session
)
942 _filter
["_id"] = nsInstanceId
943 nsr
= self
.db
.get_one("nsrs", _filter
)
946 if operation
== "terminate" and slice_object
is False:
947 check_if_nsr_is_not_slice_member(session
, nsr
["_id"])
948 if not nsr
["_admin"].get("nsState") or nsr
["_admin"]["nsState"] == "NOT_INSTANTIATED":
949 if operation
== "terminate" and indata
.get("autoremove"):
950 # NSR must be deleted
951 return None, None # a none in this case is used to indicate not instantiated. It can be removed
952 if operation
!= "instantiate":
953 raise EngineException("ns_instance '{}' cannot be '{}' because it is not instantiated".format(
954 nsInstanceId
, operation
), HTTPStatus
.CONFLICT
)
956 if operation
== "instantiate" and not session
["force"]:
957 raise EngineException("ns_instance '{}' cannot be '{}' because it is already instantiated".format(
958 nsInstanceId
, operation
), HTTPStatus
.CONFLICT
)
959 self
._check
_ns
_operation
(session
, nsr
, operation
, indata
)
961 if operation
== "instantiate":
962 self
._update
_vnfrs
(session
, rollback
, nsr
, indata
)
964 nslcmop_desc
= self
._create
_nslcmop
(nsInstanceId
, operation
, indata
)
965 _id
= nslcmop_desc
["_id"]
966 self
.format_on_new(nslcmop_desc
, session
["project_id"], make_public
=session
["public"])
967 self
.db
.create("nslcmops", nslcmop_desc
)
968 rollback
.append({"topic": "nslcmops", "_id": _id
})
970 self
.msg
.write("ns", operation
, nslcmop_desc
)
972 except ValidationError
as e
: # TODO remove try Except, it is captured at nbi.py
973 raise EngineException(e
, HTTPStatus
.UNPROCESSABLE_ENTITY
)
974 # except DbException as e:
975 # raise EngineException("Cannot get ns_instance '{}': {}".format(e), HTTPStatus.NOT_FOUND)
977 def delete(self
, session
, _id
, dry_run
=False):
978 raise EngineException("Method delete called directly", HTTPStatus
.INTERNAL_SERVER_ERROR
)
980 def edit(self
, session
, _id
, indata
=None, kwargs
=None, content
=None):
981 raise EngineException("Method edit called directly", HTTPStatus
.INTERNAL_SERVER_ERROR
)
984 class NsiTopic(BaseTopic
):
988 def __init__(self
, db
, fs
, msg
, auth
):
989 BaseTopic
.__init
__(self
, db
, fs
, msg
, auth
)
990 self
.nsrTopic
= NsrTopic(db
, fs
, msg
, auth
)
993 def _format_ns_request(ns_request
):
994 formated_request
= copy(ns_request
)
995 # TODO: Add request params
996 return formated_request
999 def _format_addional_params(slice_request
):
1001 Get and format user additional params for NS or VNF
1002 :param slice_request: User instantiation additional parameters
1003 :return: a formatted copy of additional params or None if not supplied
1005 additional_params
= copy(slice_request
.get("additionalParamsForNsi"))
1006 if additional_params
:
1007 for k
, v
in additional_params
.items():
1008 if not isinstance(k
, str):
1009 raise EngineException("Invalid param at additionalParamsForNsi:{}. Only string keys are allowed".
1011 if "." in k
or "$" in k
:
1012 raise EngineException("Invalid param at additionalParamsForNsi:{}. Keys must not contain dots or $".
1014 if isinstance(v
, (dict, tuple, list)):
1015 additional_params
[k
] = "!!yaml " + safe_dump(v
)
1016 return additional_params
1018 def _check_descriptor_dependencies(self
, session
, descriptor
):
1020 Check that the dependent descriptors exist on a new descriptor or edition
1021 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1022 :param descriptor: descriptor to be inserted or edit
1023 :return: None or raises exception
1025 if not descriptor
.get("nst-ref"):
1027 nstd_id
= descriptor
["nst-ref"]
1028 if not self
.get_item_list(session
, "nsts", {"id": nstd_id
}):
1029 raise EngineException("Descriptor error at nst-ref='{}' references a non exist nstd".format(nstd_id
),
1030 http_code
=HTTPStatus
.CONFLICT
)
1032 def check_conflict_on_del(self
, session
, _id
, db_content
):
1034 Check that NSI is not instantiated
1035 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1036 :param _id: nsi internal id
1037 :param db_content: The database content of the _id
1038 :return: None or raises EngineException with the conflict
1040 if session
["force"]:
1043 if nsi
["_admin"].get("nsiState") == "INSTANTIATED":
1044 raise EngineException("nsi '{}' cannot be deleted because it is in 'INSTANTIATED' state. "
1045 "Launch 'terminate' operation first; or force deletion".format(_id
),
1046 http_code
=HTTPStatus
.CONFLICT
)
1048 def delete_extra(self
, session
, _id
, db_content
):
1050 Deletes associated nsilcmops from database. Deletes associated filesystem.
1051 Set usageState of nst
1052 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1053 :param _id: server internal id
1054 :param db_content: The database content of the descriptor
1055 :return: None if ok or raises EngineException with the problem
1058 # Deleting the nsrs belonging to nsir
1060 for nsrs_detailed_item
in nsir
["_admin"]["nsrs-detailed-list"]:
1061 nsr_id
= nsrs_detailed_item
["nsrId"]
1062 if nsrs_detailed_item
.get("shared"):
1063 _filter
= {"_admin.nsrs-detailed-list.ANYINDEX.shared": True,
1064 "_admin.nsrs-detailed-list.ANYINDEX.nsrId": nsr_id
,
1065 "_id.ne": nsir
["_id"]}
1066 nsi
= self
.db
.get_one("nsis", _filter
, fail_on_empty
=False, fail_on_more
=False)
1067 if nsi
: # last one using nsr
1070 self
.nsrTopic
.delete(session
, nsr_id
, dry_run
=False)
1071 except (DbException
, EngineException
) as e
:
1072 if e
.http_code
== HTTPStatus
.NOT_FOUND
:
1077 # delete related nsilcmops database entries
1078 self
.db
.del_list("nsilcmops", {"netsliceInstanceId": _id
})
1080 # Check and set used NST usage state
1081 nsir_admin
= nsir
.get("_admin")
1082 if nsir_admin
and nsir_admin
.get("nst-id"):
1083 # check if used by another NSI
1084 nsis_list
= self
.db
.get_one("nsis", {"nst-id": nsir_admin
["nst-id"]},
1085 fail_on_empty
=False, fail_on_more
=False)
1087 self
.db
.set_one("nsts", {"_id": nsir_admin
["nst-id"]}, {"_admin.usageState": "NOT_IN_USE"})
1089 # def delete(self, session, _id, dry_run=False):
1091 # Delete item by its internal _id
1092 # :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1093 # :param _id: server internal id
1094 # :param dry_run: make checking but do not delete
1095 # :return: dictionary with deleted item _id. It raises EngineException on error: not found, conflict, ...
1097 # # TODO add admin to filter, validate rights
1098 # BaseTopic.delete(self, session, _id, dry_run=True)
1102 # # Deleting the nsrs belonging to nsir
1103 # nsir = self.db.get_one("nsis", {"_id": _id})
1104 # for nsrs_detailed_item in nsir["_admin"]["nsrs-detailed-list"]:
1105 # nsr_id = nsrs_detailed_item["nsrId"]
1106 # if nsrs_detailed_item.get("shared"):
1107 # _filter = {"_admin.nsrs-detailed-list.ANYINDEX.shared": True,
1108 # "_admin.nsrs-detailed-list.ANYINDEX.nsrId": nsr_id,
1109 # "_id.ne": nsir["_id"]}
1110 # nsi = self.db.get_one("nsis", _filter, fail_on_empty=False, fail_on_more=False)
1111 # if nsi: # last one using nsr
1114 # self.nsrTopic.delete(session, nsr_id, dry_run=False)
1115 # except (DbException, EngineException) as e:
1116 # if e.http_code == HTTPStatus.NOT_FOUND:
1120 # # deletes NetSlice instance object
1121 # v = self.db.del_one("nsis", {"_id": _id})
1123 # # makes a temporal list of nsilcmops objects related to the _id given and deletes them from db
1124 # _filter = {"netsliceInstanceId": _id}
1125 # self.db.del_list("nsilcmops", _filter)
1127 # # Search if nst is being used by other nsi
1128 # nsir_admin = nsir.get("_admin")
1130 # if nsir_admin.get("nst-id"):
1131 # nsis_list = self.db.get_one("nsis", {"nst-id": nsir_admin["nst-id"]},
1132 # fail_on_empty=False, fail_on_more=False)
1134 # self.db.set_one("nsts", {"_id": nsir_admin["nst-id"]}, {"_admin.usageState": "NOT_IN_USE"})
1137 def new(self
, rollback
, session
, indata
=None, kwargs
=None, headers
=None):
1139 Creates a new netslice instance record into database. It also creates needed nsrs and vnfrs
1140 :param rollback: list to append the created items at database in case a rollback must be done
1141 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1142 :param indata: params to be used for the nsir
1143 :param kwargs: used to override the indata descriptor
1144 :param headers: http request headers
1145 :return: the _id of nsi descriptor created at database
1149 step
= "checking quotas"
1150 self
.check_quota(session
)
1153 slice_request
= self
._remove
_envelop
(indata
)
1154 # Override descriptor with query string kwargs
1155 self
._update
_input
_with
_kwargs
(slice_request
, kwargs
)
1156 self
._validate
_input
_new
(slice_request
, session
["force"])
1159 step
= "getting nstd id='{}' from database".format(slice_request
.get("nstId"))
1160 _filter
= self
._get
_project
_filter
(session
)
1161 _filter
["_id"] = slice_request
["nstId"]
1162 nstd
= self
.db
.get_one("nsts", _filter
)
1165 nstd
.pop("_admin", None)
1166 nstd_id
= nstd
.pop("_id", None)
1167 nsi_id
= str(uuid4())
1168 step
= "filling nsi_descriptor with input data"
1173 "name": slice_request
["nsiName"],
1174 "description": slice_request
.get("nsiDescription", ""),
1175 "datacenter": slice_request
["vimAccountId"],
1176 "nst-ref": nstd
["id"],
1177 "instantiation_parameters": slice_request
,
1178 "network-slice-template": nstd
,
1182 "additionalParamsForNsi": self
._format
_addional
_params
(slice_request
)
1185 step
= "creating nsi at database"
1186 self
.format_on_new(nsi_descriptor
, session
["project_id"], make_public
=session
["public"])
1187 nsi_descriptor
["_admin"]["nsiState"] = "NOT_INSTANTIATED"
1188 nsi_descriptor
["_admin"]["netslice-subnet"] = None
1189 nsi_descriptor
["_admin"]["deployed"] = {}
1190 nsi_descriptor
["_admin"]["deployed"]["RO"] = []
1191 nsi_descriptor
["_admin"]["nst-id"] = nstd_id
1193 # Creating netslice-vld for the RO.
1194 step
= "creating netslice-vld at database"
1196 # Building the vlds list to be deployed
1197 # From netslice descriptors, creating the initial list
1200 for netslice_vlds
in get_iterable(nstd
.get("netslice-vld")):
1201 # Getting template Instantiation parameters from NST
1202 nsi_vld
= deepcopy(netslice_vlds
)
1203 nsi_vld
["shared-nsrs-list"] = []
1204 nsi_vld
["vimAccountId"] = slice_request
["vimAccountId"]
1205 nsi_vlds
.append(nsi_vld
)
1207 nsi_descriptor
["_admin"]["netslice-vld"] = nsi_vlds
1208 # Creating netslice-subnet_record.
1212 # Updating the nstd with the nsd["_id"] associated to the nss -> services list
1213 for member_ns
in nstd
["netslice-subnet"]:
1214 nsd_id
= member_ns
["nsd-ref"]
1215 step
= "getting nstd id='{}' constituent-nsd='{}' from database".format(
1216 member_ns
["nsd-ref"], member_ns
["id"])
1217 if nsd_id
not in needed_nsds
:
1219 _filter
["id"] = nsd_id
1220 nsd
= self
.db
.get_one("nsds", _filter
, fail_on_empty
=True, fail_on_more
=True)
1223 needed_nsds
[nsd_id
] = nsd
1225 nsd
= needed_nsds
[nsd_id
]
1226 member_ns
["_id"] = needed_nsds
[nsd_id
].get("_id")
1227 services
.append(member_ns
)
1229 step
= "filling nsir nsd-id='{}' constituent-nsd='{}' from database".format(
1230 member_ns
["nsd-ref"], member_ns
["id"])
1232 # creates Network Services records (NSRs)
1233 step
= "creating nsrs at database using NsrTopic.new()"
1234 ns_params
= slice_request
.get("netslice-subnet")
1236 nsi_netslice_subnet
= []
1237 for service
in services
:
1238 # Check if the netslice-subnet is shared and if it is share if the nss exists
1241 # Is the nss shared and instantiated?
1242 _filter
["_admin.nsrs-detailed-list.ANYINDEX.shared"] = True
1243 _filter
["_admin.nsrs-detailed-list.ANYINDEX.nsd-id"] = service
["nsd-ref"]
1244 _filter
["_admin.nsrs-detailed-list.ANYINDEX.nss-id"] = service
["id"]
1245 nsi
= self
.db
.get_one("nsis", _filter
, fail_on_empty
=False, fail_on_more
=False)
1246 if nsi
and service
.get("is-shared-nss"):
1247 nsrs_detailed_list
= nsi
["_admin"]["nsrs-detailed-list"]
1248 for nsrs_detailed_item
in nsrs_detailed_list
:
1249 if nsrs_detailed_item
["nsd-id"] == service
["nsd-ref"]:
1250 if nsrs_detailed_item
["nss-id"] == service
["id"]:
1251 _id_nsr
= nsrs_detailed_item
["nsrId"]
1253 for netslice_subnet
in nsi
["_admin"]["netslice-subnet"]:
1254 if netslice_subnet
["nss-id"] == service
["id"]:
1255 indata_ns
= netslice_subnet
1259 if service
.get("instantiation-parameters"):
1260 indata_ns
= deepcopy(service
["instantiation-parameters"])
1261 # del service["instantiation-parameters"]
1263 indata_ns
["nsdId"] = service
["_id"]
1264 indata_ns
["nsName"] = slice_request
.get("nsiName") + "." + service
["id"]
1265 indata_ns
["vimAccountId"] = slice_request
.get("vimAccountId")
1266 indata_ns
["nsDescription"] = service
["description"]
1267 if slice_request
.get("ssh_keys"):
1268 indata_ns
["ssh_keys"] = slice_request
.get("ssh_keys")
1271 for ns_param
in ns_params
:
1272 if ns_param
.get("id") == service
["id"]:
1273 copy_ns_param
= deepcopy(ns_param
)
1274 del copy_ns_param
["id"]
1275 indata_ns
.update(copy_ns_param
)
1278 # Creates Nsr objects
1279 _id_nsr
, _
= self
.nsrTopic
.new(rollback
, session
, indata_ns
, kwargs
, headers
)
1280 nsrs_item
= {"nsrId": _id_nsr
, "shared": service
.get("is-shared-nss"), "nsd-id": service
["nsd-ref"],
1281 "nss-id": service
["id"], "nslcmop_instantiate": None}
1282 indata_ns
["nss-id"] = service
["id"]
1283 nsrs_list
.append(nsrs_item
)
1284 nsi_netslice_subnet
.append(indata_ns
)
1285 nsr_ref
= {"nsr-ref": _id_nsr
}
1286 nsi_descriptor
["nsr-ref-list"].append(nsr_ref
)
1288 # Adding the nsrs list to the nsi
1289 nsi_descriptor
["_admin"]["nsrs-detailed-list"] = nsrs_list
1290 nsi_descriptor
["_admin"]["netslice-subnet"] = nsi_netslice_subnet
1291 self
.db
.set_one("nsts", {"_id": slice_request
["nstId"]}, {"_admin.usageState": "IN_USE"})
1293 # Creating the entry in the database
1294 self
.db
.create("nsis", nsi_descriptor
)
1295 rollback
.append({"topic": "nsis", "_id": nsi_id
})
1297 except Exception as e
: # TODO remove try Except, it is captured at nbi.py
1298 self
.logger
.exception("Exception {} at NsiTopic.new()".format(e
), exc_info
=True)
1299 raise EngineException("Error {}: {}".format(step
, e
))
1300 except ValidationError
as e
:
1301 raise EngineException(e
, HTTPStatus
.UNPROCESSABLE_ENTITY
)
1303 def edit(self
, session
, _id
, indata
=None, kwargs
=None, content
=None):
1304 raise EngineException("Method edit called directly", HTTPStatus
.INTERNAL_SERVER_ERROR
)
1307 class NsiLcmOpTopic(BaseTopic
):
1310 operation_schema
= { # mapping between operation and jsonschema to validate
1311 "instantiate": nsi_instantiate
,
1315 def __init__(self
, db
, fs
, msg
, auth
):
1316 BaseTopic
.__init
__(self
, db
, fs
, msg
, auth
)
1317 self
.nsi_NsLcmOpTopic
= NsLcmOpTopic(self
.db
, self
.fs
, self
.msg
, self
.auth
)
1319 def _check_nsi_operation(self
, session
, nsir
, operation
, indata
):
1321 Check that user has enter right parameters for the operation
1322 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1323 :param operation: it can be: instantiate, terminate, action, TODO: update, heal
1324 :param indata: descriptor with the parameters of the operation
1328 nstd
= nsir
["network-slice-template"]
1330 def check_valid_netslice_subnet_id(nstId
):
1331 # TODO change to vnfR (??)
1332 for netslice_subnet
in nstd
["netslice-subnet"]:
1333 if nstId
== netslice_subnet
["id"]:
1334 nsd_id
= netslice_subnet
["nsd-ref"]
1335 if nsd_id
not in nsds
:
1336 nsds
[nsd_id
] = self
.db
.get_one("nsds", {"id": nsd_id
})
1339 raise EngineException("Invalid parameter nstId='{}' is not one of the "
1340 "nst:netslice-subnet".format(nstId
))
1341 if operation
== "instantiate":
1342 # check the existance of netslice-subnet items
1343 for in_nst
in get_iterable(indata
.get("netslice-subnet")):
1344 check_valid_netslice_subnet_id(in_nst
["id"])
1346 def _create_nsilcmop(self
, session
, netsliceInstanceId
, operation
, params
):
1352 "operationState": "PROCESSING", # COMPLETED,PARTIALLY_COMPLETED,FAILED_TEMP,FAILED,ROLLING_BACK,ROLLED_BACK
1353 "statusEnteredTime": now
,
1354 "netsliceInstanceId": netsliceInstanceId
,
1355 "lcmOperationType": operation
,
1357 "isAutomaticInvocation": False,
1358 "operationParams": params
,
1359 "isCancelPending": False,
1361 "self": "/osm/nsilcm/v1/nsi_lcm_op_occs/" + _id
,
1362 "netsliceInstanceId": "/osm/nsilcm/v1/netslice_instances/" + netsliceInstanceId
,
1367 def add_shared_nsr_2vld(self
, nsir
, nsr_item
):
1368 for nst_sb_item
in nsir
["network-slice-template"].get("netslice-subnet"):
1369 if nst_sb_item
.get("is-shared-nss"):
1370 for admin_subnet_item
in nsir
["_admin"].get("netslice-subnet"):
1371 if admin_subnet_item
["nss-id"] == nst_sb_item
["id"]:
1372 for admin_vld_item
in nsir
["_admin"].get("netslice-vld"):
1373 for admin_vld_nss_cp_ref_item
in admin_vld_item
["nss-connection-point-ref"]:
1374 if admin_subnet_item
["nss-id"] == admin_vld_nss_cp_ref_item
["nss-ref"]:
1375 if not nsr_item
["nsrId"] in admin_vld_item
["shared-nsrs-list"]:
1376 admin_vld_item
["shared-nsrs-list"].append(nsr_item
["nsrId"])
1378 # self.db.set_one("nsis", {"_id": nsir["_id"]}, nsir)
1379 self
.db
.set_one("nsis", {"_id": nsir
["_id"]}, {"_admin.netslice-vld": nsir
["_admin"].get("netslice-vld")})
1381 def new(self
, rollback
, session
, indata
=None, kwargs
=None, headers
=None):
1383 Performs a new operation over a ns
1384 :param rollback: list to append created items at database in case a rollback must to be done
1385 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1386 :param indata: descriptor with the parameters of the operation. It must contains among others
1387 netsliceInstanceId: _id of the nsir to perform the operation
1388 operation: it can be: instantiate, terminate, action, TODO: update, heal
1389 :param kwargs: used to override the indata descriptor
1390 :param headers: http request headers
1391 :return: id of the nslcmops
1394 # Override descriptor with query string kwargs
1395 self
._update
_input
_with
_kwargs
(indata
, kwargs
)
1396 operation
= indata
["lcmOperationType"]
1397 netsliceInstanceId
= indata
["netsliceInstanceId"]
1398 validate_input(indata
, self
.operation_schema
[operation
])
1400 # get nsi from netsliceInstanceId
1401 _filter
= self
._get
_project
_filter
(session
)
1402 _filter
["_id"] = netsliceInstanceId
1403 nsir
= self
.db
.get_one("nsis", _filter
)
1407 if not nsir
["_admin"].get("nsiState") or nsir
["_admin"]["nsiState"] == "NOT_INSTANTIATED":
1408 if operation
== "terminate" and indata
.get("autoremove"):
1409 # NSIR must be deleted
1410 return None, None # a none in this case is used to indicate not instantiated. It can be removed
1411 if operation
!= "instantiate":
1412 raise EngineException("netslice_instance '{}' cannot be '{}' because it is not instantiated".format(
1413 netsliceInstanceId
, operation
), HTTPStatus
.CONFLICT
)
1415 if operation
== "instantiate" and not session
["force"]:
1416 raise EngineException("netslice_instance '{}' cannot be '{}' because it is already instantiated".
1417 format(netsliceInstanceId
, operation
), HTTPStatus
.CONFLICT
)
1419 # Creating all the NS_operation (nslcmop)
1420 # Get service list from db
1421 nsrs_list
= nsir
["_admin"]["nsrs-detailed-list"]
1423 # nslcmops_item = None
1424 for index
, nsr_item
in enumerate(nsrs_list
):
1426 if nsr_item
.get("shared"):
1427 _filter
["_admin.nsrs-detailed-list.ANYINDEX.shared"] = True
1428 _filter
["_admin.nsrs-detailed-list.ANYINDEX.nsrId"] = nsr_item
["nsrId"]
1429 _filter
["_admin.nsrs-detailed-list.ANYINDEX.nslcmop_instantiate.ne"] = None
1430 _filter
["_id.ne"] = netsliceInstanceId
1431 nsi
= self
.db
.get_one("nsis", _filter
, fail_on_empty
=False, fail_on_more
=False)
1432 if operation
== "terminate":
1433 _update
= {"_admin.nsrs-detailed-list.{}.nslcmop_instantiate".format(index
): None}
1434 self
.db
.set_one("nsis", {"_id": nsir
["_id"]}, _update
)
1436 # looks the first nsi fulfilling the conditions but not being the current NSIR
1438 nsi_admin_shared
= nsi
["_admin"]["nsrs-detailed-list"]
1439 for nsi_nsr_item
in nsi_admin_shared
:
1440 if nsi_nsr_item
["nsd-id"] == nsr_item
["nsd-id"] and nsi_nsr_item
["shared"]:
1441 self
.add_shared_nsr_2vld(nsir
, nsr_item
)
1442 nslcmops
.append(nsi_nsr_item
["nslcmop_instantiate"])
1443 _update
= {"_admin.nsrs-detailed-list.{}".format(index
): nsi_nsr_item
}
1444 self
.db
.set_one("nsis", {"_id": nsir
["_id"]}, _update
)
1446 # continue to not create nslcmop since nsrs is shared and nsrs was created
1449 self
.add_shared_nsr_2vld(nsir
, nsr_item
)
1452 service
= self
.db
.get_one("nsrs", {"_id": nsr_item
["nsrId"]})
1454 indata_ns
= service
["instantiate_params"]
1455 indata_ns
["lcmOperationType"] = operation
1456 indata_ns
["nsInstanceId"] = service
["_id"]
1457 # Including netslice_id in the ns instantiate Operation
1458 indata_ns
["netsliceInstanceId"] = netsliceInstanceId
1459 # Creating NS_LCM_OP with the flag slice_object=True to not trigger the service instantiation
1460 # message via kafka bus
1461 nslcmop
, _
= self
.nsi_NsLcmOpTopic
.new(rollback
, session
, indata_ns
, kwargs
, headers
,
1463 nslcmops
.append(nslcmop
)
1464 if operation
== "terminate":
1466 _update
= {"_admin.nsrs-detailed-list.{}.nslcmop_instantiate".format(index
): nslcmop
}
1467 self
.db
.set_one("nsis", {"_id": nsir
["_id"]}, _update
)
1468 except (DbException
, EngineException
) as e
:
1469 if e
.http_code
== HTTPStatus
.NOT_FOUND
:
1470 self
.logger
.info("HTTPStatus.NOT_FOUND")
1476 indata
["nslcmops_ids"] = nslcmops
1477 self
._check
_nsi
_operation
(session
, nsir
, operation
, indata
)
1479 nsilcmop_desc
= self
._create
_nsilcmop
(session
, netsliceInstanceId
, operation
, indata
)
1480 self
.format_on_new(nsilcmop_desc
, session
["project_id"], make_public
=session
["public"])
1481 _id
= self
.db
.create("nsilcmops", nsilcmop_desc
)
1482 rollback
.append({"topic": "nsilcmops", "_id": _id
})
1483 self
.msg
.write("nsi", operation
, nsilcmop_desc
)
1485 except ValidationError
as e
:
1486 raise EngineException(e
, HTTPStatus
.UNPROCESSABLE_ENTITY
)
1488 def delete(self
, session
, _id
, dry_run
=False):
1489 raise EngineException("Method delete called directly", HTTPStatus
.INTERNAL_SERVER_ERROR
)
1491 def edit(self
, session
, _id
, indata
=None, kwargs
=None, content
=None):
1492 raise EngineException("Method edit called directly", HTTPStatus
.INTERNAL_SERVER_ERROR
)