blob: 60a569a4bf2afef2c89fde62fac0dee9c8a0d8b3 [file] [log] [blame]
tiernob24258a2018-10-04 18:39:49 +02001# -*- coding: utf-8 -*-
2
tiernod125caf2018-11-22 16:05:54 +00003# 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
6#
7# http://www.apache.org/licenses/LICENSE-2.0
8#
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
12# implied.
13# See the License for the specific language governing permissions and
14# limitations under the License.
15
tiernob24258a2018-10-04 18:39:49 +020016# import logging
17from uuid import uuid4
18from http import HTTPStatus
19from time import time
tiernocc103432018-10-19 14:10:35 +020020from copy import copy, deepcopy
tierno1c38f2f2020-03-24 11:51:39 +000021from osm_nbi.validation import validate_input, ValidationError, ns_instantiate, ns_terminate, ns_action, ns_scale,\
22 nsi_instantiate
tierno55cbc982020-10-06 08:28:00 +000023from osm_nbi.base_topic import BaseTopic, EngineException, get_iterable, deep_get, increment_ip_mac
tiernob4844ab2019-05-23 08:42:12 +000024# from descriptor_topics import DescriptorTopic
tiernobee085c2018-12-12 17:03:04 +000025from yaml import safe_dump
Felipe Vicens09e65422019-01-22 15:06:46 +010026from osm_common.dbbase import DbException
tierno1bfe4e22019-09-02 16:03:25 +000027from osm_common.msgbase import MsgException
28from osm_common.fsbase import FsException
delacruzramo36ffe552019-05-03 14:52:37 +020029from re import match # For checking that additional parameter names are valid Jinja2 identifiers
tiernob24258a2018-10-04 18:39:49 +020030
31__author__ = "Alfonso Tierno <alfonso.tiernosepulveda@telefonica.com>"
32
33
34class NsrTopic(BaseTopic):
35 topic = "nsrs"
36 topic_msg = "ns"
tierno6b02b052020-06-02 10:07:41 +000037 quota_name = "ns_instances"
tiernod77ba6f2019-06-27 14:31:10 +000038 schema_new = ns_instantiate
tiernob24258a2018-10-04 18:39:49 +020039
delacruzramo32bab472019-09-13 12:24:22 +020040 def __init__(self, db, fs, msg, auth):
41 BaseTopic.__init__(self, db, fs, msg, auth)
tiernob24258a2018-10-04 18:39:49 +020042
43 def _check_descriptor_dependencies(self, session, descriptor):
44 """
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
49 """
50 if not descriptor.get("nsdId"):
51 return
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)
56
57 @staticmethod
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"
tiernobdebce92019-07-01 15:36:49 +000061 return None
tiernob24258a2018-10-04 18:39:49 +020062
tiernob4844ab2019-05-23 08:42:12 +000063 def check_conflict_on_del(self, session, _id, db_content):
64 """
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
70 """
tierno65ca36d2019-02-12 19:27:52 +010071 if session["force"]:
tiernob24258a2018-10-04 18:39:49 +020072 return
tiernob4844ab2019-05-23 08:42:12 +000073 nsr = db_content
tiernob24258a2018-10-04 18:39:49 +020074 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)
78
tiernobee3bad2019-12-05 12:26:01 +000079 def delete_extra(self, session, _id, db_content, not_send_msg=None):
tiernob4844ab2019-05-23 08:42:12 +000080 """
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
tiernobee3bad2019-12-05 12:26:01 +000086 :param not_send_msg: To not send message (False) or store content (list) instead
tiernob4844ab2019-05-23 08:42:12 +000087 :return: None if ok or raises EngineException with the problem
88 """
tiernobee085c2018-12-12 17:03:04 +000089 self.fs.file_delete(_id, ignore_non_exist=True)
tiernob24258a2018-10-04 18:39:49 +020090 self.db.del_list("nslcmops", {"nsInstanceId": _id})
91 self.db.del_list("vnfrs", {"nsr-id-ref": _id})
tiernob4844ab2019-05-23 08:42:12 +000092
tiernob24258a2018-10-04 18:39:49 +020093 # set all used pdus as free
94 self.db.set_list("pdus", {"_admin.usage.nsr_id": _id},
tierno36ec8602018-11-02 17:27:11 +010095 {"_admin.usageState": "NOT_IN_USE", "_admin.usage": None})
tiernob24258a2018-10-04 18:39:49 +020096
tiernob4844ab2019-05-23 08:42:12 +000097 # Set NSD usageState
98 nsr = db_content
99 used_nsd_id = nsr.get("nsd-id")
100 if used_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)
104 if not nsrs_list:
105 self.db.set_one("nsds", {"_id": used_nsd_id}, {"_admin.usageState": "NOT_IN_USE"})
106
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)
114 if not nsrs_list:
115 self.db.set_one("vnfds", {"_id": used_vnfd_id}, {"_admin.usageState": "NOT_IN_USE"})
116
tiernobee085c2018-12-12 17:03:04 +0000117 @staticmethod
118 def _format_ns_request(ns_request):
119 formated_request = copy(ns_request)
120 formated_request.pop("additionalParamsForNs", None)
121 formated_request.pop("additionalParamsForVnf", None)
122 return formated_request
123
124 @staticmethod
tiernoe19707b2020-04-21 13:08:04 +0000125 def _format_additional_params(ns_request, member_vnf_index=None, vdu_id=None, kdu_name=None, descriptor=None):
tiernobee085c2018-12-12 17:03:04 +0000126 """
127 Get and format user additional params for NS or VNF
128 :param ns_request: User instantiation additional parameters
129 :param member_vnf_index: None for extract NS params, or member_vnf_index to extract VNF params
130 :param descriptor: If not None it check that needed parameters of descriptor are supplied
tierno54db2e42020-04-06 15:29:42 +0000131 :return: tuple with a formatted copy of additional params or None if not supplied, plus other parameters
tiernobee085c2018-12-12 17:03:04 +0000132 """
133 additional_params = None
tierno54db2e42020-04-06 15:29:42 +0000134 other_params = None
tiernobee085c2018-12-12 17:03:04 +0000135 if not member_vnf_index:
136 additional_params = copy(ns_request.get("additionalParamsForNs"))
137 where_ = "additionalParamsForNs"
138 elif ns_request.get("additionalParamsForVnf"):
tierno714954e2019-11-29 13:43:26 +0000139 where_ = "additionalParamsForVnf[member-vnf-index={}]".format(member_vnf_index)
140 item = next((x for x in ns_request["additionalParamsForVnf"] if x["member-vnf-index"] == member_vnf_index),
141 None)
142 if item:
tierno54db2e42020-04-06 15:29:42 +0000143 if not vdu_id and not kdu_name:
144 other_params = item
tierno714954e2019-11-29 13:43:26 +0000145 additional_params = copy(item.get("additionalParams")) or {}
146 if vdu_id and item.get("additionalParamsForVdu"):
147 item_vdu = next((x for x in item["additionalParamsForVdu"] if x["vdu_id"] == vdu_id), None)
tiernobce98f02020-04-17 11:27:47 +0000148 other_params = item_vdu
tierno714954e2019-11-29 13:43:26 +0000149 if item_vdu and item_vdu.get("additionalParams"):
150 where_ += ".additionalParamsForVdu[vdu_id={}]".format(vdu_id)
tiernob091dc12019-12-02 15:53:25 +0000151 additional_params = item_vdu["additionalParams"]
152 if kdu_name:
153 additional_params = {}
154 if item.get("additionalParamsForKdu"):
155 item_kdu = next((x for x in item["additionalParamsForKdu"] if x["kdu_name"] == kdu_name), None)
tiernobce98f02020-04-17 11:27:47 +0000156 other_params = item_kdu
tiernob091dc12019-12-02 15:53:25 +0000157 if item_kdu and item_kdu.get("additionalParams"):
158 where_ += ".additionalParamsForKdu[kdu_name={}]".format(kdu_name)
159 additional_params = item_kdu["additionalParams"]
tierno714954e2019-11-29 13:43:26 +0000160
tiernobee085c2018-12-12 17:03:04 +0000161 if additional_params:
162 for k, v in additional_params.items():
tierno714954e2019-11-29 13:43:26 +0000163 # BEGIN Check that additional parameter names are valid Jinja2 identifiers if target is not Kdu
164 if not kdu_name and not match('^[a-zA-Z_][a-zA-Z0-9_]*$', k):
delacruzramo36ffe552019-05-03 14:52:37 +0200165 raise EngineException("Invalid param name at {}:{}. Must contain only alphanumeric characters "
166 "and underscores, and cannot start with a digit"
167 .format(where_, k))
168 # END Check that additional parameter names are valid Jinja2 identifiers
tiernobee085c2018-12-12 17:03:04 +0000169 if not isinstance(k, str):
170 raise EngineException("Invalid param at {}:{}. Only string keys are allowed".format(where_, k))
171 if "." in k or "$" in k:
172 raise EngineException("Invalid param at {}:{}. Keys must not contain dots or $".format(where_, k))
173 if isinstance(v, (dict, tuple, list)):
174 additional_params[k] = "!!yaml " + safe_dump(v)
175
176 if descriptor:
177 # check that enough parameters are supplied for the initial-config-primitive
178 # TODO: check for cloud-init
179 if member_vnf_index:
tierno714954e2019-11-29 13:43:26 +0000180 if kdu_name:
181 initial_primitives = None
182 elif vdu_id:
183 vdud = next(x for x in descriptor["vdu"] if x["id"] == vdu_id)
184 initial_primitives = deep_get(vdud, ("vdu-configuration", "initial-config-primitive"))
185 else:
186 initial_primitives = deep_get(descriptor, ("vnf-configuration", "initial-config-primitive"))
187 else:
188 initial_primitives = deep_get(descriptor, ("ns-configuration", "initial-config-primitive"))
tiernobee085c2018-12-12 17:03:04 +0000189
tierno714954e2019-11-29 13:43:26 +0000190 for initial_primitive in get_iterable(initial_primitives):
191 for param in get_iterable(initial_primitive.get("parameter")):
192 if param["value"].startswith("<") and param["value"].endswith(">"):
193 if param["value"] in ("<rw_mgmt_ip>", "<VDU_SCALE_INFO>", "<ns_config_info>"):
194 continue
195 if not additional_params or param["value"][1:-1] not in additional_params:
196 raise EngineException("Parameter '{}' needed for vnfd[id={}]:vnf-configuration:"
197 "initial-config-primitive[name={}] not supplied".
198 format(param["value"], descriptor["id"],
199 initial_primitive["name"]))
200
tierno54db2e42020-04-06 15:29:42 +0000201 return additional_params or None, other_params or None
tiernobee085c2018-12-12 17:03:04 +0000202
tierno65ca36d2019-02-12 19:27:52 +0100203 def new(self, rollback, session, indata=None, kwargs=None, headers=None):
tiernob24258a2018-10-04 18:39:49 +0200204 """
205 Creates a new nsr into database. It also creates needed vnfrs
206 :param rollback: list to append the created items at database in case a rollback must be done
tierno65ca36d2019-02-12 19:27:52 +0100207 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
tiernob24258a2018-10-04 18:39:49 +0200208 :param indata: params to be used for the nsr
209 :param kwargs: used to override the indata descriptor
210 :param headers: http request headers
tierno1bfe4e22019-09-02 16:03:25 +0000211 :return: the _id of nsr descriptor created at database. Or an exception of type
212 EngineException, ValidationError, DbException, FsException, MsgException.
213 Note: Exceptions are not captured on purpose. They should be captured at called
tiernob24258a2018-10-04 18:39:49 +0200214 """
215
216 try:
delacruzramo32bab472019-09-13 12:24:22 +0200217 step = "checking quotas"
218 self.check_quota(session)
219
tierno99d4b172019-07-02 09:28:40 +0000220 step = "validating input parameters"
tiernob24258a2018-10-04 18:39:49 +0200221 ns_request = self._remove_envelop(indata)
222 # Override descriptor with query string kwargs
223 self._update_input_with_kwargs(ns_request, kwargs)
tierno65ca36d2019-02-12 19:27:52 +0100224 self._validate_input_new(ns_request, session["force"])
tiernob24258a2018-10-04 18:39:49 +0200225
tierno54db2e42020-04-06 15:29:42 +0000226 # look for nsd
tiernob24258a2018-10-04 18:39:49 +0200227 step = "getting nsd id='{}' from database".format(ns_request.get("nsdId"))
tiernob4844ab2019-05-23 08:42:12 +0000228 _filter = self._get_project_filter(session)
229 _filter["_id"] = ns_request["nsdId"]
tiernob24258a2018-10-04 18:39:49 +0200230 nsd = self.db.get_one("nsds", _filter)
tiernob4844ab2019-05-23 08:42:12 +0000231 del _filter["_id"]
tiernob24258a2018-10-04 18:39:49 +0200232
Frank Bryden98246e42020-07-21 14:25:32 +0000233 # check NSD is not disabled
234 step = "checking nsdOperationalState"
235 if nsd["_admin"]["operationalState"] == "DISABLED":
236 raise EngineException("nsd with id '{}' is DISABLED, and thus cannot be used to create "
237 "a network service".format(ns_request["nsdId"]), http_code=HTTPStatus.CONFLICT)
238
tiernob24258a2018-10-04 18:39:49 +0200239 nsr_id = str(uuid4())
tiernobee085c2018-12-12 17:03:04 +0000240
tiernob24258a2018-10-04 18:39:49 +0200241 now = time()
242 step = "filling nsr from input data"
tiernoe19707b2020-04-21 13:08:04 +0000243 additional_params, _ = self._format_additional_params(ns_request, descriptor=nsd)
tierno54db2e42020-04-06 15:29:42 +0000244
245 # use for k8s-namespace from ns_request or additionalParamsForNs. By default, the project_id
246 ns_k8s_namespace = session["project_id"][0] if session["project_id"] else None
247 if ns_request and ns_request.get("k8s-namespace"):
248 ns_k8s_namespace = ns_request["k8s-namespace"]
249 if additional_params and additional_params.get("k8s-namespace"):
250 ns_k8s_namespace = additional_params["k8s-namespace"]
251
tiernob24258a2018-10-04 18:39:49 +0200252 nsr_descriptor = {
253 "name": ns_request["nsName"],
254 "name-ref": ns_request["nsName"],
255 "short-name": ns_request["nsName"],
256 "admin-status": "ENABLED",
tiernoecf94bd2020-01-09 12:40:45 +0000257 "nsState": "NOT_INSTANTIATED",
258 "currentOperation": "IDLE",
259 "currentOperationID": None,
260 "errorDescription": None,
261 "errorDetail": None,
262 "deploymentStatus": None,
263 "configurationStatus": None,
264 "vcaStatus": None,
preethika.p89b7a122020-07-10 13:14:22 +0000265 "nsd": {k: v for k, v in nsd.items() if k in ("vld", "_id", "id", "constituent-vnfd", "name",
266 "ns-configuration")},
tiernob24258a2018-10-04 18:39:49 +0200267 "datacenter": ns_request["vimAccountId"],
268 "resource-orchestrator": "osmopenmano",
269 "description": ns_request.get("nsDescription", ""),
270 "constituent-vnfr-ref": [],
271
272 "operational-status": "init", # typedef ns-operational-
273 "config-status": "init", # typedef config-states
274 "detailed-status": "scheduled",
275
276 "orchestration-progress": {},
277 # {"networks": {"active": 0, "total": 0}, "vms": {"active": 0, "total": 0}},
278
tierno65ca36d2019-02-12 19:27:52 +0100279 "create-time": now,
tiernob24258a2018-10-04 18:39:49 +0200280 "nsd-name-ref": nsd["name"],
281 "operational-events": [], # "id", "timestamp", "description", "event",
282 "nsd-ref": nsd["id"],
tiernof0637052019-03-07 16:26:47 +0000283 "nsd-id": nsd["_id"],
tiernob4844ab2019-05-23 08:42:12 +0000284 "vnfd-id": [],
tiernobee085c2018-12-12 17:03:04 +0000285 "instantiate_params": self._format_ns_request(ns_request),
tierno54db2e42020-04-06 15:29:42 +0000286 "additionalParamsForNs": additional_params,
tiernob24258a2018-10-04 18:39:49 +0200287 "ns-instance-config-ref": nsr_id,
288 "id": nsr_id,
289 "_id": nsr_id,
290 # "input-parameter": xpath, value,
tierno99d4b172019-07-02 09:28:40 +0000291 "ssh-authorized-key": ns_request.get("ssh_keys"), # TODO remove
tiernob24258a2018-10-04 18:39:49 +0200292 }
293 ns_request["nsr_id"] = nsr_id
tierno59338b12020-06-25 13:26:28 +0000294 if ns_request and ns_request.get("config-units"):
295 nsr_descriptor["config-units"] = ns_request["config-units"]
296
tierno36ec8602018-11-02 17:27:11 +0100297 # Create vld
298 if nsd.get("vld"):
tierno340df482020-04-03 10:09:06 +0000299 nsr_descriptor["vld"] = nsd["vld"]
tiernob24258a2018-10-04 18:39:49 +0200300
301 # Create VNFR
302 needed_vnfds = {}
gcalvino4f269dd2018-11-06 13:18:31 +0100303 for member_vnf in nsd.get("constituent-vnfd", ()):
tiernob24258a2018-10-04 18:39:49 +0200304 vnfd_id = member_vnf["vnfd-id-ref"]
305 step = "getting vnfd id='{}' constituent-vnfd='{}' from database".format(
306 member_vnf["vnfd-id-ref"], member_vnf["member-vnf-index"])
307 if vnfd_id not in needed_vnfds:
308 # Obtain vnfd
tiernob4844ab2019-05-23 08:42:12 +0000309 _filter["id"] = vnfd_id
310 vnfd = self.db.get_one("vnfds", _filter, fail_on_empty=True, fail_on_more=True)
311 del _filter["id"]
tiernob24258a2018-10-04 18:39:49 +0200312 vnfd.pop("_admin")
313 needed_vnfds[vnfd_id] = vnfd
tiernob4844ab2019-05-23 08:42:12 +0000314 nsr_descriptor["vnfd-id"].append(vnfd["_id"])
tiernob24258a2018-10-04 18:39:49 +0200315 else:
316 vnfd = needed_vnfds[vnfd_id]
317 step = "filling vnfr vnfd-id='{}' constituent-vnfd='{}'".format(
318 member_vnf["vnfd-id-ref"], member_vnf["member-vnf-index"])
319 vnfr_id = str(uuid4())
tiernoe19707b2020-04-21 13:08:04 +0000320 additional_params, vnf_params = self._format_additional_params(ns_request,
321 member_vnf["member-vnf-index"],
322 descriptor=vnfd)
tiernob24258a2018-10-04 18:39:49 +0200323 vnfr_descriptor = {
324 "id": vnfr_id,
325 "_id": vnfr_id,
326 "nsr-id-ref": nsr_id,
327 "member-vnf-index-ref": member_vnf["member-vnf-index"],
tierno54db2e42020-04-06 15:29:42 +0000328 "additionalParamsForVnf": additional_params,
tiernob24258a2018-10-04 18:39:49 +0200329 "created-time": now,
330 # "vnfd": vnfd, # at OSM model.but removed to avoid data duplication TODO: revise
331 "vnfd-ref": vnfd_id,
332 "vnfd-id": vnfd["_id"], # not at OSM model, but useful
333 "vim-account-id": None,
334 "vdur": [],
335 "connection-point": [],
336 "ip-address": None, # mgmt-interface filled by LCM
337 }
tierno59338b12020-06-25 13:26:28 +0000338 vnf_k8s_namespace = ns_k8s_namespace
339 if vnf_params:
340 if vnf_params.get("k8s-namespace"):
341 vnf_k8s_namespace = vnf_params["k8s-namespace"]
342 if vnf_params.get("config-units"):
343 vnfr_descriptor["config-units"] = vnf_params["config-units"]
tierno36ec8602018-11-02 17:27:11 +0100344
345 # Create vld
346 if vnfd.get("internal-vld"):
347 vnfr_descriptor["vld"] = []
348 for vnfd_vld in vnfd.get("internal-vld"):
349 vnfr_descriptor["vld"].append(
gcalvino17d5b732018-12-17 16:26:21 +0100350 {key: vnfd_vld[key] for key in ("id", "vim-network-name", "vim-network-id") if key in
351 vnfd_vld})
tierno36ec8602018-11-02 17:27:11 +0100352
353 vnfd_mgmt_cp = vnfd["mgmt-interface"].get("cp")
tiernob24258a2018-10-04 18:39:49 +0200354 for cp in vnfd.get("connection-point", ()):
355 vnf_cp = {
356 "name": cp["name"],
357 "connection-point-id": cp.get("id"),
358 "id": cp.get("id"),
359 # "ip-address", "mac-address" # filled by LCM
360 # vim-id # TODO it would be nice having a vim port id
361 }
362 vnfr_descriptor["connection-point"].append(vnf_cp)
tierno9cb7d672019-10-30 12:13:48 +0000363
tiernoc67b0e92019-11-05 12:45:29 +0000364 # Create k8s-cluster information
365 if vnfd.get("k8s-cluster"):
366 vnfr_descriptor["k8s-cluster"] = vnfd["k8s-cluster"]
367 for net in get_iterable(vnfr_descriptor["k8s-cluster"].get("nets")):
368 if net.get("external-connection-point-ref"):
369 for nsd_vld in get_iterable(nsd.get("vld")):
370 for nsd_vld_cp in get_iterable(nsd_vld.get("vnfd-connection-point-ref")):
371 if nsd_vld_cp.get("vnfd-connection-point-ref") == \
372 net["external-connection-point-ref"] and \
373 nsd_vld_cp.get("member-vnf-index-ref") == member_vnf["member-vnf-index"]:
374 net["ns-vld-id"] = nsd_vld["id"]
375 break
376 else:
377 continue
378 break
379 elif net.get("internal-connection-point-ref"):
380 for vnfd_ivld in get_iterable(vnfd.get("internal-vld")):
381 for vnfd_ivld_icp in get_iterable(vnfd_ivld.get("internal-connection-point")):
382 if vnfd_ivld_icp.get("id-ref") == net["internal-connection-point-ref"]:
383 net["vnf-vld-id"] = vnfd_ivld["id"]
384 break
385 else:
386 continue
387 break
tierno9cb7d672019-10-30 12:13:48 +0000388 # update kdus
389 for kdu in get_iterable(vnfd.get("kdu")):
tiernoe19707b2020-04-21 13:08:04 +0000390 additional_params, kdu_params = self._format_additional_params(ns_request,
391 member_vnf["member-vnf-index"],
392 kdu_name=kdu["name"],
393 descriptor=vnfd)
tierno54db2e42020-04-06 15:29:42 +0000394 kdu_k8s_namespace = vnf_k8s_namespace
tiernobce98f02020-04-17 11:27:47 +0000395 kdu_model = kdu_params.get("kdu_model") if kdu_params else None
tierno54db2e42020-04-06 15:29:42 +0000396 if kdu_params and kdu_params.get("k8s-namespace"):
397 kdu_k8s_namespace = kdu_params["k8s-namespace"]
398
399 kdur = {
400 "additionalParams": additional_params,
401 "k8s-namespace": kdu_k8s_namespace,
402 "kdu-name": kdu["name"],
403 # TODO "name": "" Name of the VDU in the VIM
404 "ip-address": None, # mgmt-interface filled by LCM
405 "k8s-cluster": {},
406 }
tierno59338b12020-06-25 13:26:28 +0000407 if kdu_params and kdu_params.get("config-units"):
408 kdur["config-units"] = kdu_params["config-units"]
tierno54db2e42020-04-06 15:29:42 +0000409 for k8s_type in ("helm-chart", "juju-bundle"):
410 if kdu.get(k8s_type):
411 kdur[k8s_type] = kdu_model or kdu[k8s_type]
tierno9cb7d672019-10-30 12:13:48 +0000412 if not vnfr_descriptor.get("kdur"):
413 vnfr_descriptor["kdur"] = []
414 vnfr_descriptor["kdur"].append(kdur)
415
gcalvinoe45aded2018-11-13 17:17:28 +0100416 for vdu in vnfd.get("vdu", ()):
tierno59338b12020-06-25 13:26:28 +0000417 additional_params, vdu_params = self._format_additional_params(
418 ns_request, member_vnf["member-vnf-index"], vdu_id=vdu["id"], descriptor=vnfd)
tiernob24258a2018-10-04 18:39:49 +0200419 vdur = {
tiernob24258a2018-10-04 18:39:49 +0200420 "vdu-id-ref": vdu["id"],
421 # TODO "name": "" Name of the VDU in the VIM
422 "ip-address": None, # mgmt-interface filled by LCM
423 # "vim-id", "flavor-id", "image-id", "management-ip" # filled by LCM
424 "internal-connection-point": [],
425 "interfaces": [],
tierno54db2e42020-04-06 15:29:42 +0000426 "additionalParams": additional_params
tiernob24258a2018-10-04 18:39:49 +0200427 }
tierno59338b12020-06-25 13:26:28 +0000428 if vdu_params and vdu_params.get("config-units"):
429 vdur["config-units"] = vdu_params["config-units"]
430 if deep_get(vdu, ("supplemental-boot-data", "boot-data-drive")):
431 vdur["boot-data-drive"] = vdu["supplemental-boot-data"]["boot-data-drive"]
tiernocc103432018-10-19 14:10:35 +0200432 if vdu.get("pdu-type"):
433 vdur["pdu-type"] = vdu["pdu-type"]
tierno43e82fb2020-07-14 15:39:07 +0000434 vdur["name"] = vdu["pdu-type"]
tiernob24258a2018-10-04 18:39:49 +0200435 # TODO volumes: name, volume-id
436 for icp in vdu.get("internal-connection-point", ()):
437 vdu_icp = {
438 "id": icp["id"],
439 "connection-point-id": icp["id"],
440 "name": icp.get("name"),
tiernob24258a2018-10-04 18:39:49 +0200441 }
442 vdur["internal-connection-point"].append(vdu_icp)
443 for iface in vdu.get("interface", ()):
444 vdu_iface = {
tierno55cbc982020-10-06 08:28:00 +0000445 x: iface[x] for x in ("name", "ip-address", "mac-address", "internal-connection-point-ref",
446 "external-connection-point-ref") if iface.get(x) is not None}
tierno36ec8602018-11-02 17:27:11 +0100447 if vnfd_mgmt_cp and iface.get("external-connection-point-ref") == vnfd_mgmt_cp:
448 vdu_iface["mgmt-vnf"] = True
tiernocc103432018-10-19 14:10:35 +0200449 if iface.get("mgmt-interface"):
tierno36ec8602018-11-02 17:27:11 +0100450 vdu_iface["mgmt-interface"] = True # TODO change to mgmt-vdu
451
452 # look for network where this interface is connected
453 if iface.get("external-connection-point-ref"):
454 for nsd_vld in get_iterable(nsd.get("vld")):
455 for nsd_vld_cp in get_iterable(nsd_vld.get("vnfd-connection-point-ref")):
456 if nsd_vld_cp.get("vnfd-connection-point-ref") == \
457 iface["external-connection-point-ref"] and \
458 nsd_vld_cp.get("member-vnf-index-ref") == member_vnf["member-vnf-index"]:
459 vdu_iface["ns-vld-id"] = nsd_vld["id"]
460 break
461 else:
462 continue
463 break
464 elif iface.get("internal-connection-point-ref"):
465 for vnfd_ivld in get_iterable(vnfd.get("internal-vld")):
466 for vnfd_ivld_icp in get_iterable(vnfd_ivld.get("internal-connection-point")):
467 if vnfd_ivld_icp.get("id-ref") == iface["internal-connection-point-ref"]:
468 vdu_iface["vnf-vld-id"] = vnfd_ivld["id"]
tierno55cbc982020-10-06 08:28:00 +0000469 if vnfd_ivld_icp.get("ip-address"):
470 vdu_iface["ip-address"] = vnfd_ivld_icp["ip-address"]
tierno36ec8602018-11-02 17:27:11 +0100471 break
472 else:
473 continue
474 break
tiernocc103432018-10-19 14:10:35 +0200475
tiernob24258a2018-10-04 18:39:49 +0200476 vdur["interfaces"].append(vdu_iface)
tiernocc103432018-10-19 14:10:35 +0200477 count = vdu.get("count", 1)
478 if count is None:
479 count = 1
480 count = int(count) # TODO remove when descriptor serialized with payngbind
481 for index in range(0, count):
482 if index:
483 vdur = deepcopy(vdur)
tierno55cbc982020-10-06 08:28:00 +0000484 for iface in vdur["interfaces"]:
485 if iface.get("ip-address"):
486 iface["ip-address"] = increment_ip_mac(iface["ip-address"])
487 if iface.get("mac-address"):
488 iface["mac-address"] = increment_ip_mac(iface["mac-address"])
489
tiernocc103432018-10-19 14:10:35 +0200490 vdur["_id"] = str(uuid4())
491 vdur["count-index"] = index
492 vnfr_descriptor["vdur"].append(vdur)
tiernob24258a2018-10-04 18:39:49 +0200493
494 step = "creating vnfr vnfd-id='{}' constituent-vnfd='{}' at database".format(
495 member_vnf["vnfd-id-ref"], member_vnf["member-vnf-index"])
496
497 # add at database
tiernobdebce92019-07-01 15:36:49 +0000498 self.format_on_new(vnfr_descriptor, session["project_id"], make_public=session["public"])
tiernob24258a2018-10-04 18:39:49 +0200499 self.db.create("vnfrs", vnfr_descriptor)
500 rollback.append({"topic": "vnfrs", "_id": vnfr_id})
501 nsr_descriptor["constituent-vnfr-ref"].append(vnfr_id)
502
503 step = "creating nsr at database"
tierno65ca36d2019-02-12 19:27:52 +0100504 self.format_on_new(nsr_descriptor, session["project_id"], make_public=session["public"])
tiernob24258a2018-10-04 18:39:49 +0200505 self.db.create("nsrs", nsr_descriptor)
506 rollback.append({"topic": "nsrs", "_id": nsr_id})
tiernobee085c2018-12-12 17:03:04 +0000507
508 step = "creating nsr temporal folder"
509 self.fs.mkdir(nsr_id)
510
tiernobdebce92019-07-01 15:36:49 +0000511 return nsr_id, None
tierno1bfe4e22019-09-02 16:03:25 +0000512 except (ValidationError, EngineException, DbException, MsgException, FsException) as e:
Frank Bryden98246e42020-07-21 14:25:32 +0000513 raise type(e)("{} while '{}'".format(e, step), http_code=e.http_code)
tiernob24258a2018-10-04 18:39:49 +0200514
tierno65ca36d2019-02-12 19:27:52 +0100515 def edit(self, session, _id, indata=None, kwargs=None, content=None):
tiernob24258a2018-10-04 18:39:49 +0200516 raise EngineException("Method edit called directly", HTTPStatus.INTERNAL_SERVER_ERROR)
517
518
519class VnfrTopic(BaseTopic):
520 topic = "vnfrs"
521 topic_msg = None
522
delacruzramo32bab472019-09-13 12:24:22 +0200523 def __init__(self, db, fs, msg, auth):
524 BaseTopic.__init__(self, db, fs, msg, auth)
tiernob24258a2018-10-04 18:39:49 +0200525
tiernobee3bad2019-12-05 12:26:01 +0000526 def delete(self, session, _id, dry_run=False, not_send_msg=None):
tiernob24258a2018-10-04 18:39:49 +0200527 raise EngineException("Method delete called directly", HTTPStatus.INTERNAL_SERVER_ERROR)
528
tierno65ca36d2019-02-12 19:27:52 +0100529 def edit(self, session, _id, indata=None, kwargs=None, content=None):
tiernob24258a2018-10-04 18:39:49 +0200530 raise EngineException("Method edit called directly", HTTPStatus.INTERNAL_SERVER_ERROR)
531
tierno65ca36d2019-02-12 19:27:52 +0100532 def new(self, rollback, session, indata=None, kwargs=None, headers=None):
tiernob24258a2018-10-04 18:39:49 +0200533 # Not used because vnfrs are created and deleted by NsrTopic class directly
534 raise EngineException("Method new called directly", HTTPStatus.INTERNAL_SERVER_ERROR)
535
536
537class NsLcmOpTopic(BaseTopic):
538 topic = "nslcmops"
539 topic_msg = "ns"
540 operation_schema = { # mapping between operation and jsonschema to validate
541 "instantiate": ns_instantiate,
542 "action": ns_action,
543 "scale": ns_scale,
tierno1c38f2f2020-03-24 11:51:39 +0000544 "terminate": ns_terminate,
tiernob24258a2018-10-04 18:39:49 +0200545 }
546
delacruzramo32bab472019-09-13 12:24:22 +0200547 def __init__(self, db, fs, msg, auth):
548 BaseTopic.__init__(self, db, fs, msg, auth)
tiernob24258a2018-10-04 18:39:49 +0200549
tiernob24258a2018-10-04 18:39:49 +0200550 def _check_ns_operation(self, session, nsr, operation, indata):
551 """
552 Check that user has enter right parameters for the operation
tierno65ca36d2019-02-12 19:27:52 +0100553 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
tiernob24258a2018-10-04 18:39:49 +0200554 :param operation: it can be: instantiate, terminate, action, TODO: update, heal
555 :param indata: descriptor with the parameters of the operation
556 :return: None
557 """
tierno982da4e2019-09-03 11:51:55 +0000558 vnf_member_index_to_vnfd = {} # map between vnf_member_index to vnf descriptor.
tiernob24258a2018-10-04 18:39:49 +0200559 vim_accounts = []
tierno4f9d4ae2019-03-20 17:24:11 +0000560 wim_accounts = []
tiernob24258a2018-10-04 18:39:49 +0200561 nsd = nsr["nsd"]
562
563 def check_valid_vnf_member_index(member_vnf_index):
tierno982da4e2019-09-03 11:51:55 +0000564 # Obtain vnf descriptor. The vnfr is used to get the vnfd._id used for this member_vnf_index
565 if vnf_member_index_to_vnfd.get(member_vnf_index):
566 return vnf_member_index_to_vnfd[member_vnf_index]
567 vnfr = self.db.get_one("vnfrs",
568 {"nsr-id-ref": nsr["_id"], "member-vnf-index-ref": member_vnf_index},
569 fail_on_empty=False)
570 if not vnfr:
tiernob24258a2018-10-04 18:39:49 +0200571 raise EngineException("Invalid parameter member_vnf_index='{}' is not one of the "
572 "nsd:constituent-vnfd".format(member_vnf_index))
tierno982da4e2019-09-03 11:51:55 +0000573 vnfd = self.db.get_one("vnfds", {"_id": vnfr["vnfd-id"]}, fail_on_empty=False)
574 if not vnfd:
575 raise EngineException("vnfd id={} has been deleted!. Operation cannot be performed".
576 format(vnfr["vnfd-id"]))
577 vnf_member_index_to_vnfd[member_vnf_index] = vnfd # add to cache, avoiding a later look for
578 return vnfd
tiernob24258a2018-10-04 18:39:49 +0200579
tierno260dd6f2019-09-02 10:48:56 +0000580 def check_valid_vdu(vnfd, vdu_id):
581 for vdud in get_iterable(vnfd.get("vdu")):
582 if vdud["id"] == vdu_id:
583 return vdud
584 else:
585 raise EngineException("Invalid parameter vdu_id='{}' not present at vnfd:vdu:id".format(vdu_id))
586
tierno9cb7d672019-10-30 12:13:48 +0000587 def check_valid_kdu(vnfd, kdu_name):
588 for kdud in get_iterable(vnfd.get("kdu")):
589 if kdud["name"] == kdu_name:
590 return kdud
591 else:
592 raise EngineException("Invalid parameter kdu_name='{}' not present at vnfd:kdu:name".format(kdu_name))
593
gcalvino5e72d152018-10-23 11:46:57 +0200594 def _check_vnf_instantiation_params(in_vnfd, vnfd):
595
tierno40fbcad2018-10-26 10:58:15 +0200596 for in_vdu in get_iterable(in_vnfd.get("vdu")):
597 for vdu in get_iterable(vnfd.get("vdu")):
598 if in_vdu["id"] == vdu["id"]:
599 for volume in get_iterable(in_vdu.get("volume")):
600 for volumed in get_iterable(vdu.get("volumes")):
601 if volumed["name"] == volume["name"]:
602 break
603 else:
604 raise EngineException("Invalid parameter vnf[member-vnf-index='{}']:vdu[id='{}']:"
605 "volume:name='{}' is not present at vnfd:vdu:volumes list".
606 format(in_vnf["member-vnf-index"], in_vdu["id"],
607 volume["name"]))
608 for in_iface in get_iterable(in_vdu["interface"]):
609 for iface in get_iterable(vdu.get("interface")):
610 if in_iface["name"] == iface["name"]:
611 break
612 else:
613 raise EngineException("Invalid parameter vnf[member-vnf-index='{}']:vdu[id='{}']:"
614 "interface[name='{}'] is not present at vnfd:vdu:interface"
615 .format(in_vnf["member-vnf-index"], in_vdu["id"],
616 in_iface["name"]))
617 break
gcalvino5e72d152018-10-23 11:46:57 +0200618 else:
tierno40fbcad2018-10-26 10:58:15 +0200619 raise EngineException("Invalid parameter vnf[member-vnf-index='{}']:vdu[id='{}'] is is not present "
620 "at vnfd:vdu".format(in_vnf["member-vnf-index"], in_vdu["id"]))
gcalvino5e72d152018-10-23 11:46:57 +0200621
622 for in_ivld in get_iterable(in_vnfd.get("internal-vld")):
623 for ivld in get_iterable(vnfd.get("internal-vld")):
tierno75d5a4e2020-05-21 15:09:22 +0000624 if in_ivld["name"] in (ivld["id"], ivld.get("name")):
tierno1bfe4e22019-09-02 16:03:25 +0000625 for in_icp in get_iterable(in_ivld.get("internal-connection-point")):
gcalvino5e72d152018-10-23 11:46:57 +0200626 for icp in ivld["internal-connection-point"]:
627 if in_icp["id-ref"] == icp["id-ref"]:
628 break
629 else:
tierno40fbcad2018-10-26 10:58:15 +0200630 raise EngineException("Invalid parameter vnf[member-vnf-index='{}']:internal-vld[name"
631 "='{}']:internal-connection-point[id-ref:'{}'] is not present at "
632 "vnfd:internal-vld:name/id:internal-connection-point"
633 .format(in_vnf["member-vnf-index"], in_ivld["name"],
tierno670b0c62020-05-12 13:01:19 +0000634 in_icp["id-ref"]))
gcalvino5e72d152018-10-23 11:46:57 +0200635 break
636 else:
637 raise EngineException("Invalid parameter vnf[member-vnf-index='{}']:internal-vld:name='{}'"
638 " is not present at vnfd '{}'".format(in_vnf["member-vnf-index"],
639 in_ivld["name"], vnfd["id"]))
640
tiernob24258a2018-10-04 18:39:49 +0200641 def check_valid_vim_account(vim_account):
642 if vim_account in vim_accounts:
643 return
644 try:
tierno65ca36d2019-02-12 19:27:52 +0100645 db_filter = self._get_project_filter(session)
tiernocc103432018-10-19 14:10:35 +0200646 db_filter["_id"] = vim_account
647 self.db.get_one("vim_accounts", db_filter)
tiernob24258a2018-10-04 18:39:49 +0200648 except Exception:
tiernocc103432018-10-19 14:10:35 +0200649 raise EngineException("Invalid vimAccountId='{}' not present for the project".format(vim_account))
tiernob24258a2018-10-04 18:39:49 +0200650 vim_accounts.append(vim_account)
651
tierno4f9d4ae2019-03-20 17:24:11 +0000652 def check_valid_wim_account(wim_account):
653 if not isinstance(wim_account, str):
654 return
655 elif wim_account in wim_accounts:
656 return
657 try:
658 db_filter = self._get_project_filter(session, write=False, show_all=True)
659 db_filter["_id"] = wim_account
660 self.db.get_one("wim_accounts", db_filter)
661 except Exception:
662 raise EngineException("Invalid wimAccountId='{}' not present for the project".format(wim_account))
663 wim_accounts.append(wim_account)
664
tiernob24258a2018-10-04 18:39:49 +0200665 if operation == "action":
666 # check vnf_member_index
667 if indata.get("vnf_member_index"):
668 indata["member_vnf_index"] = indata.pop("vnf_member_index") # for backward compatibility
tierno1ac7f462019-06-03 17:22:12 +0000669 if indata.get("member_vnf_index"):
670 vnfd = check_valid_vnf_member_index(indata["member_vnf_index"])
tierno260dd6f2019-09-02 10:48:56 +0000671 if indata.get("vdu_id"):
672 vdud = check_valid_vdu(vnfd, indata["vdu_id"])
673 descriptor_configuration = vdud.get("vdu-configuration", {}).get("config-primitive")
tierno9cb7d672019-10-30 12:13:48 +0000674 elif indata.get("kdu_name"):
tiernoc67b0e92019-11-05 12:45:29 +0000675 kdud = check_valid_kdu(vnfd, indata["kdu_name"])
tierno9cb7d672019-10-30 12:13:48 +0000676 descriptor_configuration = kdud.get("kdu-configuration", {}).get("config-primitive")
tierno260dd6f2019-09-02 10:48:56 +0000677 else:
678 descriptor_configuration = vnfd.get("vnf-configuration", {}).get("config-primitive")
tierno1ac7f462019-06-03 17:22:12 +0000679 else: # use a NSD
680 descriptor_configuration = nsd.get("ns-configuration", {}).get("config-primitive")
tierno9cb7d672019-10-30 12:13:48 +0000681
682 # For k8s allows default primitives without validating the parameters
delacruzramo6ddff2e2019-11-28 11:24:09 +0100683 if indata.get("kdu_name") and indata["primitive"] in ("upgrade", "rollback", "status", "inspect", "readme"):
tierno9cb7d672019-10-30 12:13:48 +0000684 # TODO should be checked that rollback only can contains revsision_numbe????
delacruzramo6ddff2e2019-11-28 11:24:09 +0100685 if not indata.get("member_vnf_index"):
686 raise EngineException("Missing action parameter 'member_vnf_index' for default KDU primitive '{}'"
687 .format(indata["primitive"]))
tierno9cb7d672019-10-30 12:13:48 +0000688 return
689 # if not, check primitive
tierno1ac7f462019-06-03 17:22:12 +0000690 for config_primitive in get_iterable(descriptor_configuration):
tiernob24258a2018-10-04 18:39:49 +0200691 if indata["primitive"] == config_primitive["name"]:
692 # check needed primitive_params are provided
693 if indata.get("primitive_params"):
694 in_primitive_params_copy = copy(indata["primitive_params"])
695 else:
696 in_primitive_params_copy = {}
697 for paramd in get_iterable(config_primitive.get("parameter")):
698 if paramd["name"] in in_primitive_params_copy:
699 del in_primitive_params_copy[paramd["name"]]
700 elif not paramd.get("default-value"):
701 raise EngineException("Needed parameter {} not provided for primitive '{}'".format(
702 paramd["name"], indata["primitive"]))
703 # check no extra primitive params are provided
704 if in_primitive_params_copy:
tierno1ac7f462019-06-03 17:22:12 +0000705 raise EngineException("parameter/s '{}' not present at vnfd /nsd for primitive '{}'".format(
tiernob24258a2018-10-04 18:39:49 +0200706 list(in_primitive_params_copy.keys()), indata["primitive"]))
707 break
708 else:
tierno1ac7f462019-06-03 17:22:12 +0000709 raise EngineException("Invalid primitive '{}' is not present at vnfd/nsd".format(indata["primitive"]))
tiernob24258a2018-10-04 18:39:49 +0200710 if operation == "scale":
711 vnfd = check_valid_vnf_member_index(indata["scaleVnfData"]["scaleByStepData"]["member-vnf-index"])
712 for scaling_group in get_iterable(vnfd.get("scaling-group-descriptor")):
713 if indata["scaleVnfData"]["scaleByStepData"]["scaling-group-descriptor"] == scaling_group["name"]:
714 break
715 else:
716 raise EngineException("Invalid scaleVnfData:scaleByStepData:scaling-group-descriptor '{}' is not "
717 "present at vnfd:scaling-group-descriptor".format(
718 indata["scaleVnfData"]["scaleByStepData"]["scaling-group-descriptor"]))
719 if operation == "instantiate":
720 # check vim_account
721 check_valid_vim_account(indata["vimAccountId"])
tierno4f9d4ae2019-03-20 17:24:11 +0000722 check_valid_wim_account(indata.get("wimAccountId"))
tiernob24258a2018-10-04 18:39:49 +0200723 for in_vnf in get_iterable(indata.get("vnf")):
724 vnfd = check_valid_vnf_member_index(in_vnf["member-vnf-index"])
gcalvino5e72d152018-10-23 11:46:57 +0200725 _check_vnf_instantiation_params(in_vnf, vnfd)
tiernob24258a2018-10-04 18:39:49 +0200726 if in_vnf.get("vimAccountId"):
727 check_valid_vim_account(in_vnf["vimAccountId"])
tiernob24258a2018-10-04 18:39:49 +0200728
tiernob24258a2018-10-04 18:39:49 +0200729 for in_vld in get_iterable(indata.get("vld")):
tierno4f9d4ae2019-03-20 17:24:11 +0000730 check_valid_wim_account(in_vld.get("wimAccountId"))
tiernob24258a2018-10-04 18:39:49 +0200731 for vldd in get_iterable(nsd.get("vld")):
732 if in_vld["name"] == vldd["name"] or in_vld["name"] == vldd["id"]:
733 break
734 else:
735 raise EngineException("Invalid parameter vld:name='{}' is not present at nsd:vld".format(
736 in_vld["name"]))
737
tierno36ec8602018-11-02 17:27:11 +0100738 def _look_for_pdu(self, session, rollback, vnfr, vim_account, vnfr_update, vnfr_update_rollback):
tiernocc103432018-10-19 14:10:35 +0200739 """
tierno36ec8602018-11-02 17:27:11 +0100740 Look for a free PDU in the catalog matching vdur type and interfaces. Fills vnfr.vdur with the interface
741 (ip_address, ...) information.
742 Modifies PDU _admin.usageState to 'IN_USE'
tierno65ca36d2019-02-12 19:27:52 +0100743 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
tierno36ec8602018-11-02 17:27:11 +0100744 :param rollback: list with the database modifications to rollback if needed
745 :param vnfr: vnfr to be updated. It is modified with pdu interface info if pdu is found
746 :param vim_account: vim_account where this vnfr should be deployed
747 :param vnfr_update: dictionary filled by this method with changes to be done at database vnfr
748 :param vnfr_update_rollback: dictionary filled by this method with original content of vnfr in case a rollback
749 of the changed vnfr is needed
750
751 :return: List of PDU interfaces that are connected to an existing VIM network. Each item contains:
752 "vim-network-name": used at VIM
753 "name": interface name
754 "vnf-vld-id": internal VNFD vld where this interface is connected, or
755 "ns-vld-id": NSD vld where this interface is connected.
756 NOTE: One, and only one between 'vnf-vld-id' and 'ns-vld-id' contains a value. The other will be None
tiernocc103432018-10-19 14:10:35 +0200757 """
tierno36ec8602018-11-02 17:27:11 +0100758
759 ifaces_forcing_vim_network = []
tiernocc103432018-10-19 14:10:35 +0200760 for vdur_index, vdur in enumerate(get_iterable(vnfr.get("vdur"))):
761 if not vdur.get("pdu-type"):
762 continue
763 pdu_type = vdur.get("pdu-type")
tierno65ca36d2019-02-12 19:27:52 +0100764 pdu_filter = self._get_project_filter(session)
tierno36ec8602018-11-02 17:27:11 +0100765 pdu_filter["vim_accounts"] = vim_account
tiernocc103432018-10-19 14:10:35 +0200766 pdu_filter["type"] = pdu_type
767 pdu_filter["_admin.operationalState"] = "ENABLED"
tierno36ec8602018-11-02 17:27:11 +0100768 pdu_filter["_admin.usageState"] = "NOT_IN_USE"
tiernocc103432018-10-19 14:10:35 +0200769 # TODO feature 1417: "shared": True,
770
771 available_pdus = self.db.get_list("pdus", pdu_filter)
772 for pdu in available_pdus:
773 # step 1 check if this pdu contains needed interfaces:
774 match_interfaces = True
775 for vdur_interface in vdur["interfaces"]:
776 for pdu_interface in pdu["interfaces"]:
777 if pdu_interface["name"] == vdur_interface["name"]:
778 # TODO feature 1417: match per mgmt type
779 break
780 else: # no interface found for name
781 match_interfaces = False
782 break
783 if match_interfaces:
784 break
785 else:
786 raise EngineException(
tierno36ec8602018-11-02 17:27:11 +0100787 "No PDU of type={} at vim_account={} found for member_vnf_index={}, vdu={} matching interface "
788 "names".format(pdu_type, vim_account, vnfr["member-vnf-index-ref"], vdur["vdu-id-ref"]))
tiernocc103432018-10-19 14:10:35 +0200789
790 # step 2. Update pdu
791 rollback_pdu = {
792 "_admin.usageState": pdu["_admin"]["usageState"],
793 "_admin.usage.vnfr_id": None,
794 "_admin.usage.nsr_id": None,
795 "_admin.usage.vdur": None,
796 }
797 self.db.set_one("pdus", {"_id": pdu["_id"]},
tierno36ec8602018-11-02 17:27:11 +0100798 {"_admin.usageState": "IN_USE",
tiernoe8631782018-12-21 13:31:52 +0000799 "_admin.usage": {"vnfr_id": vnfr["_id"],
800 "nsr_id": vnfr["nsr-id-ref"],
801 "vdur": vdur["vdu-id-ref"]}
802 })
tiernocc103432018-10-19 14:10:35 +0200803 rollback.append({"topic": "pdus", "_id": pdu["_id"], "operation": "set", "content": rollback_pdu})
804
805 # step 3. Fill vnfr info by filling vdur
806 vdu_text = "vdur.{}".format(vdur_index)
tierno36ec8602018-11-02 17:27:11 +0100807 vnfr_update_rollback[vdu_text + ".pdu-id"] = None
tiernocc103432018-10-19 14:10:35 +0200808 vnfr_update[vdu_text + ".pdu-id"] = pdu["_id"]
809 for iface_index, vdur_interface in enumerate(vdur["interfaces"]):
810 for pdu_interface in pdu["interfaces"]:
811 if pdu_interface["name"] == vdur_interface["name"]:
812 iface_text = vdu_text + ".interfaces.{}".format(iface_index)
813 for k, v in pdu_interface.items():
tierno36ec8602018-11-02 17:27:11 +0100814 if k in ("ip-address", "mac-address"): # TODO: switch-xxxxx must be inserted
815 vnfr_update[iface_text + ".{}".format(k)] = v
816 vnfr_update_rollback[iface_text + ".{}".format(k)] = vdur_interface.get(v)
817 if pdu_interface.get("ip-address"):
tiernoc88003e2020-03-12 17:31:42 +0000818 if vdur_interface.get("mgmt-interface") or vdur_interface.get("mgmt-vnf"):
tierno36ec8602018-11-02 17:27:11 +0100819 vnfr_update_rollback[vdu_text + ".ip-address"] = vdur.get("ip-address")
820 vnfr_update[vdu_text + ".ip-address"] = pdu_interface["ip-address"]
821 if vdur_interface.get("mgmt-vnf"):
822 vnfr_update_rollback["ip-address"] = vnfr.get("ip-address")
823 vnfr_update["ip-address"] = pdu_interface["ip-address"]
tierno72b16e12020-03-18 09:49:43 +0000824 vnfr_update[vdu_text + ".ip-address"] = pdu_interface["ip-address"]
gcalvino17d5b732018-12-17 16:26:21 +0100825 if pdu_interface.get("vim-network-name") or pdu_interface.get("vim-network-id"):
tierno36ec8602018-11-02 17:27:11 +0100826 ifaces_forcing_vim_network.append({
tierno36ec8602018-11-02 17:27:11 +0100827 "name": vdur_interface.get("vnf-vld-id") or vdur_interface.get("ns-vld-id"),
828 "vnf-vld-id": vdur_interface.get("vnf-vld-id"),
829 "ns-vld-id": vdur_interface.get("ns-vld-id")})
gcalvino17d5b732018-12-17 16:26:21 +0100830 if pdu_interface.get("vim-network-id"):
tiernoc67b0e92019-11-05 12:45:29 +0000831 ifaces_forcing_vim_network[-1]["vim-network-id"] = pdu_interface["vim-network-id"]
gcalvino17d5b732018-12-17 16:26:21 +0100832 if pdu_interface.get("vim-network-name"):
tiernoc67b0e92019-11-05 12:45:29 +0000833 ifaces_forcing_vim_network[-1]["vim-network-name"] = pdu_interface["vim-network-name"]
tiernocc103432018-10-19 14:10:35 +0200834 break
835
tierno36ec8602018-11-02 17:27:11 +0100836 return ifaces_forcing_vim_network
tiernocc103432018-10-19 14:10:35 +0200837
tierno9cb7d672019-10-30 12:13:48 +0000838 def _look_for_k8scluster(self, session, rollback, vnfr, vim_account, vnfr_update, vnfr_update_rollback):
839 """
840 Look for an available k8scluster for all the kuds in the vnfd matching version and cni requirements.
841 Fills vnfr.kdur with the selected k8scluster
842
843 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
844 :param rollback: list with the database modifications to rollback if needed
845 :param vnfr: vnfr to be updated. It is modified with pdu interface info if pdu is found
846 :param vim_account: vim_account where this vnfr should be deployed
847 :param vnfr_update: dictionary filled by this method with changes to be done at database vnfr
848 :param vnfr_update_rollback: dictionary filled by this method with original content of vnfr in case a rollback
849 of the changed vnfr is needed
850
851 :return: List of KDU interfaces that are connected to an existing VIM network. Each item contains:
852 "vim-network-name": used at VIM
853 "name": interface name
854 "vnf-vld-id": internal VNFD vld where this interface is connected, or
855 "ns-vld-id": NSD vld where this interface is connected.
856 NOTE: One, and only one between 'vnf-vld-id' and 'ns-vld-id' contains a value. The other will be None
857 """
858
859 ifaces_forcing_vim_network = []
tiernoc67b0e92019-11-05 12:45:29 +0000860 if not vnfr.get("kdur"):
861 return ifaces_forcing_vim_network
tierno9cb7d672019-10-30 12:13:48 +0000862
tiernoc67b0e92019-11-05 12:45:29 +0000863 kdu_filter = self._get_project_filter(session)
864 kdu_filter["vim_account"] = vim_account
865 # TODO kdu_filter["_admin.operationalState"] = "ENABLED"
866 available_k8sclusters = self.db.get_list("k8sclusters", kdu_filter)
867
868 k8s_requirements = {} # just for logging
869 for k8scluster in available_k8sclusters:
870 if not vnfr.get("k8s-cluster"):
tierno9cb7d672019-10-30 12:13:48 +0000871 break
tiernoc67b0e92019-11-05 12:45:29 +0000872 # restrict by cni
873 if vnfr["k8s-cluster"].get("cni"):
874 k8s_requirements["cni"] = vnfr["k8s-cluster"]["cni"]
875 if not set(vnfr["k8s-cluster"]["cni"]).intersection(k8scluster.get("cni", ())):
876 continue
877 # restrict by version
878 if vnfr["k8s-cluster"].get("version"):
879 k8s_requirements["version"] = vnfr["k8s-cluster"]["version"]
880 if k8scluster.get("k8s_version") not in vnfr["k8s-cluster"]["version"]:
881 continue
882 # restrict by number of networks
883 if vnfr["k8s-cluster"].get("nets"):
884 k8s_requirements["networks"] = len(vnfr["k8s-cluster"]["nets"])
885 if not k8scluster.get("nets") or len(k8scluster["nets"]) < len(vnfr["k8s-cluster"]["nets"]):
886 continue
887 break
888 else:
889 raise EngineException("No k8scluster with requirements='{}' at vim_account={} found for member_vnf_index={}"
890 .format(k8s_requirements, vim_account, vnfr["member-vnf-index-ref"]))
tierno9cb7d672019-10-30 12:13:48 +0000891
tiernoc67b0e92019-11-05 12:45:29 +0000892 for kdur_index, kdur in enumerate(get_iterable(vnfr.get("kdur"))):
tierno9cb7d672019-10-30 12:13:48 +0000893 # step 3. Fill vnfr info by filling kdur
894 kdu_text = "kdur.{}.".format(kdur_index)
895 vnfr_update_rollback[kdu_text + "k8s-cluster.id"] = None
896 vnfr_update[kdu_text + "k8s-cluster.id"] = k8scluster["_id"]
897
tiernoc67b0e92019-11-05 12:45:29 +0000898 # step 4. Check VIM networks that forces the selected k8s_cluster
899 if vnfr.get("k8s-cluster") and vnfr["k8s-cluster"].get("nets"):
900 k8scluster_net_list = list(k8scluster.get("nets").keys())
901 for net_index, kdur_net in enumerate(vnfr["k8s-cluster"]["nets"]):
902 # get a network from k8s_cluster nets. If name matches use this, if not use other
903 if kdur_net["id"] in k8scluster_net_list: # name matches
904 vim_net = k8scluster["nets"][kdur_net["id"]]
905 k8scluster_net_list.remove(kdur_net["id"])
906 else:
907 vim_net = k8scluster["nets"][k8scluster_net_list[0]]
908 k8scluster_net_list.pop(0)
909 vnfr_update_rollback["k8s-cluster.nets.{}.vim_net".format(net_index)] = None
910 vnfr_update["k8s-cluster.nets.{}.vim_net".format(net_index)] = vim_net
911 if vim_net and (kdur_net.get("vnf-vld-id") or kdur_net.get("ns-vld-id")):
912 ifaces_forcing_vim_network.append({
913 "name": kdur_net.get("vnf-vld-id") or kdur_net.get("ns-vld-id"),
914 "vnf-vld-id": kdur_net.get("vnf-vld-id"),
915 "ns-vld-id": kdur_net.get("ns-vld-id"),
916 "vim-network-name": vim_net, # TODO can it be vim-network-id ???
917 })
918 # TODO check that this forcing is not incompatible with other forcing
tierno9cb7d672019-10-30 12:13:48 +0000919 return ifaces_forcing_vim_network
920
tiernocc103432018-10-19 14:10:35 +0200921 def _update_vnfrs(self, session, rollback, nsr, indata):
tiernocc103432018-10-19 14:10:35 +0200922 # get vnfr
923 nsr_id = nsr["_id"]
924 vnfrs = self.db.get_list("vnfrs", {"nsr-id-ref": nsr_id})
925
926 for vnfr in vnfrs:
927 vnfr_update = {}
928 vnfr_update_rollback = {}
929 member_vnf_index = vnfr["member-vnf-index-ref"]
930 # update vim-account-id
931
932 vim_account = indata["vimAccountId"]
933 # check instantiate parameters
934 for vnf_inst_params in get_iterable(indata.get("vnf")):
935 if vnf_inst_params["member-vnf-index"] != member_vnf_index:
936 continue
937 if vnf_inst_params.get("vimAccountId"):
938 vim_account = vnf_inst_params.get("vimAccountId")
939
tierno55cbc982020-10-06 08:28:00 +0000940 # get vnf.vdu.interface instantiation params to update vnfr.vdur.interfaces ip, mac
941 for vdu_inst_param in get_iterable(vnf_inst_params.get("vdu")):
942 for vdur_index, vdur in enumerate(vnfr["vdur"]):
943 if vdu_inst_param["id"] != vdur["vdu-id-ref"]:
944 continue
945 for iface_inst_param in get_iterable(vdu_inst_param.get("interface")):
946 iface_index, _ = next(i for i in enumerate(vdur["interfaces"])
947 if i[1]["name"] == iface_inst_param["name"])
948 vnfr_update_text = "vdur.{}.interfaces.{}".format(vdur_index, iface_index)
949 if iface_inst_param.get("ip-address"):
950 vnfr_update[vnfr_update_text + ".ip-address"] = increment_ip_mac(
951 iface_inst_param.get("ip-address"), vdur.get("count-index", 0))
952 if iface_inst_param.get("mac-address"):
953 vnfr_update[vnfr_update_text + ".mac-address"] = increment_ip_mac(
954 iface_inst_param.get("mac-address"), vdur.get("count-index", 0))
955 # get vnf.internal-vld.internal-conection-point instantiation params to update vnfr.vdur.interfaces
956 # TODO update vld with the ip-profile
957 for ivld_inst_param in get_iterable(vnf_inst_params.get("internal-vld")):
958 for icp_inst_param in get_iterable(ivld_inst_param.get("internal-connection-point")):
959 # look for iface
960 for vdur_index, vdur in enumerate(vnfr["vdur"]):
961 for iface_index, iface in enumerate(vdur["interfaces"]):
962 if iface.get("internal-connection-point-ref") == icp_inst_param["id-ref"]:
963 vnfr_update_text = "vdur.{}.interfaces.{}".format(vdur_index, iface_index)
964 if icp_inst_param.get("ip-address"):
965 vnfr_update[vnfr_update_text + ".ip-address"] = increment_ip_mac(
966 icp_inst_param.get("ip-address"), vdur.get("count-index", 0))
967 if icp_inst_param.get("mac-address"):
968 vnfr_update[vnfr_update_text + ".mac-address"] = increment_ip_mac(
969 icp_inst_param.get("mac-address"), vdur.get("count-index", 0))
970 break
971 # get ip address from instantiation parameters.vld.vnfd-connection-point-ref
972 for vld_inst_param in get_iterable(indata.get("vld")):
973 for vnfcp_inst_param in get_iterable(vld_inst_param.get("vnfd-connection-point-ref")):
974 if vnfcp_inst_param["member-vnf-index-ref"] != member_vnf_index:
975 continue
976 # look for iface
977 for vdur_index, vdur in enumerate(vnfr["vdur"]):
978 for iface_index, iface in enumerate(vdur["interfaces"]):
979 if iface.get("external-connection-point-ref") == \
980 vnfcp_inst_param["vnfd-connection-point-ref"]:
981 vnfr_update_text = "vdur.{}.interfaces.{}".format(vdur_index, iface_index)
982 if vnfcp_inst_param.get("ip-address"):
983 vnfr_update[vnfr_update_text + ".ip-address"] = increment_ip_mac(
984 vnfcp_inst_param.get("ip-address"), vdur.get("count-index", 0))
985 if vnfcp_inst_param.get("mac-address"):
986 vnfr_update[vnfr_update_text + ".mac-address"] = increment_ip_mac(
987 vnfcp_inst_param.get("mac-address"), vdur.get("count-index", 0))
988 break
989
tiernocc103432018-10-19 14:10:35 +0200990 vnfr_update["vim-account-id"] = vim_account
991 vnfr_update_rollback["vim-account-id"] = vnfr.get("vim-account-id")
992
993 # get pdu
tierno36ec8602018-11-02 17:27:11 +0100994 ifaces_forcing_vim_network = self._look_for_pdu(session, rollback, vnfr, vim_account, vnfr_update,
995 vnfr_update_rollback)
tiernocc103432018-10-19 14:10:35 +0200996
tierno9cb7d672019-10-30 12:13:48 +0000997 # get kdus
998 ifaces_forcing_vim_network += self._look_for_k8scluster(session, rollback, vnfr, vim_account, vnfr_update,
999 vnfr_update_rollback)
1000 # update database vnfr
tierno36ec8602018-11-02 17:27:11 +01001001 self.db.set_one("vnfrs", {"_id": vnfr["_id"]}, vnfr_update)
1002 rollback.append({"topic": "vnfrs", "_id": vnfr["_id"], "operation": "set", "content": vnfr_update_rollback})
1003
1004 # Update indada in case pdu forces to use a concrete vim-network-name
1005 # TODO check if user has already insert a vim-network-name and raises an error
1006 if not ifaces_forcing_vim_network:
1007 continue
1008 for iface_info in ifaces_forcing_vim_network:
1009 if iface_info.get("ns-vld-id"):
1010 if "vld" not in indata:
1011 indata["vld"] = []
1012 indata["vld"].append({key: iface_info[key] for key in
1013 ("name", "vim-network-name", "vim-network-id") if iface_info.get(key)})
1014
1015 elif iface_info.get("vnf-vld-id"):
1016 if "vnf" not in indata:
1017 indata["vnf"] = []
1018 indata["vnf"].append({
1019 "member-vnf-index": member_vnf_index,
1020 "internal-vld": [{key: iface_info[key] for key in
1021 ("name", "vim-network-name", "vim-network-id") if iface_info.get(key)}]
1022 })
1023
1024 @staticmethod
1025 def _create_nslcmop(nsr_id, operation, params):
1026 """
1027 Creates a ns-lcm-opp content to be stored at database.
1028 :param nsr_id: internal id of the instance
1029 :param operation: instantiate, terminate, scale, action, ...
1030 :param params: user parameters for the operation
1031 :return: dictionary following SOL005 format
1032 """
tiernob24258a2018-10-04 18:39:49 +02001033 now = time()
1034 _id = str(uuid4())
1035 nslcmop = {
1036 "id": _id,
1037 "_id": _id,
1038 "operationState": "PROCESSING", # COMPLETED,PARTIALLY_COMPLETED,FAILED_TEMP,FAILED,ROLLING_BACK,ROLLED_BACK
tiernoecf94bd2020-01-09 12:40:45 +00001039 "queuePosition": None,
1040 "stage": None,
1041 "errorMessage": None,
1042 "detailedStatus": None,
tiernob24258a2018-10-04 18:39:49 +02001043 "statusEnteredTime": now,
tierno36ec8602018-11-02 17:27:11 +01001044 "nsInstanceId": nsr_id,
tiernob24258a2018-10-04 18:39:49 +02001045 "lcmOperationType": operation,
1046 "startTime": now,
1047 "isAutomaticInvocation": False,
1048 "operationParams": params,
1049 "isCancelPending": False,
1050 "links": {
1051 "self": "/osm/nslcm/v1/ns_lcm_op_occs/" + _id,
tierno36ec8602018-11-02 17:27:11 +01001052 "nsInstance": "/osm/nslcm/v1/ns_instances/" + nsr_id,
tiernob24258a2018-10-04 18:39:49 +02001053 }
1054 }
1055 return nslcmop
1056
magnussonlf318b302020-01-20 18:38:18 +01001057 def _get_enabled_vims(self, session):
1058 """
1059 Retrieve and return VIM accounts that are accessible by current user and has state ENABLE
1060 :param session: current session with user information
1061 """
1062 db_filter = self._get_project_filter(session)
1063 db_filter["_admin.operationalState"] = "ENABLED"
1064 vims = self.db.get_list("vim_accounts", db_filter)
1065 vimAccounts = []
1066 for vim in vims:
1067 vimAccounts.append(vim['_id'])
1068 return vimAccounts
1069
tierno65ca36d2019-02-12 19:27:52 +01001070 def new(self, rollback, session, indata=None, kwargs=None, headers=None, slice_object=False):
tiernob24258a2018-10-04 18:39:49 +02001071 """
1072 Performs a new operation over a ns
1073 :param rollback: list to append created items at database in case a rollback must to be done
tierno65ca36d2019-02-12 19:27:52 +01001074 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
tiernob24258a2018-10-04 18:39:49 +02001075 :param indata: descriptor with the parameters of the operation. It must contains among others
1076 nsInstanceId: _id of the nsr to perform the operation
1077 operation: it can be: instantiate, terminate, action, TODO: update, heal
1078 :param kwargs: used to override the indata descriptor
1079 :param headers: http request headers
tiernob24258a2018-10-04 18:39:49 +02001080 :return: id of the nslcmops
1081 """
Felipe Vicens90fbc9c2019-06-06 01:03:00 +02001082 def check_if_nsr_is_not_slice_member(session, nsr_id):
1083 nsis = None
1084 db_filter = self._get_project_filter(session)
1085 db_filter["_admin.nsrs-detailed-list.ANYINDEX.nsrId"] = nsr_id
1086 nsis = self.db.get_one("nsis", db_filter, fail_on_empty=False, fail_on_more=False)
1087 if nsis:
tierno0f9d08d2020-06-23 15:25:26 +00001088 raise EngineException("The NS instance {} cannot be terminated because is used by the slice {}".format(
Felipe Vicens90fbc9c2019-06-06 01:03:00 +02001089 nsr_id, nsis["_id"]), http_code=HTTPStatus.CONFLICT)
1090
tiernob24258a2018-10-04 18:39:49 +02001091 try:
1092 # Override descriptor with query string kwargs
tierno1c38f2f2020-03-24 11:51:39 +00001093 self._update_input_with_kwargs(indata, kwargs, yaml_format=True)
tiernob24258a2018-10-04 18:39:49 +02001094 operation = indata["lcmOperationType"]
1095 nsInstanceId = indata["nsInstanceId"]
1096
1097 validate_input(indata, self.operation_schema[operation])
1098 # get ns from nsr_id
tierno65ca36d2019-02-12 19:27:52 +01001099 _filter = BaseTopic._get_project_filter(session)
tiernob24258a2018-10-04 18:39:49 +02001100 _filter["_id"] = nsInstanceId
1101 nsr = self.db.get_one("nsrs", _filter)
1102
1103 # initial checking
Felipe Vicens90fbc9c2019-06-06 01:03:00 +02001104 if operation == "terminate" and slice_object is False:
1105 check_if_nsr_is_not_slice_member(session, nsr["_id"])
tiernob24258a2018-10-04 18:39:49 +02001106 if not nsr["_admin"].get("nsState") or nsr["_admin"]["nsState"] == "NOT_INSTANTIATED":
1107 if operation == "terminate" and indata.get("autoremove"):
1108 # NSR must be deleted
tierno586ae812019-10-17 13:56:53 +00001109 return None, None # a none in this case is used to indicate not instantiated. It can be removed
tiernob24258a2018-10-04 18:39:49 +02001110 if operation != "instantiate":
1111 raise EngineException("ns_instance '{}' cannot be '{}' because it is not instantiated".format(
1112 nsInstanceId, operation), HTTPStatus.CONFLICT)
1113 else:
tierno65ca36d2019-02-12 19:27:52 +01001114 if operation == "instantiate" and not session["force"]:
tiernob24258a2018-10-04 18:39:49 +02001115 raise EngineException("ns_instance '{}' cannot be '{}' because it is already instantiated".format(
1116 nsInstanceId, operation), HTTPStatus.CONFLICT)
1117 self._check_ns_operation(session, nsr, operation, indata)
tierno36ec8602018-11-02 17:27:11 +01001118
tiernocc103432018-10-19 14:10:35 +02001119 if operation == "instantiate":
1120 self._update_vnfrs(session, rollback, nsr, indata)
tierno36ec8602018-11-02 17:27:11 +01001121
1122 nslcmop_desc = self._create_nslcmop(nsInstanceId, operation, indata)
tierno1bfe4e22019-09-02 16:03:25 +00001123 _id = nslcmop_desc["_id"]
tierno65ca36d2019-02-12 19:27:52 +01001124 self.format_on_new(nslcmop_desc, session["project_id"], make_public=session["public"])
magnussonlf318b302020-01-20 18:38:18 +01001125 if indata.get("placement-engine"):
1126 # Save valid vim accounts in lcm operation descriptor
1127 nslcmop_desc['operationParams']['validVimAccounts'] = self._get_enabled_vims(session)
tierno1bfe4e22019-09-02 16:03:25 +00001128 self.db.create("nslcmops", nslcmop_desc)
tiernob24258a2018-10-04 18:39:49 +02001129 rollback.append({"topic": "nslcmops", "_id": _id})
Felipe Vicens07f31722018-10-29 15:16:44 +01001130 if not slice_object:
1131 self.msg.write("ns", operation, nslcmop_desc)
tiernobdebce92019-07-01 15:36:49 +00001132 return _id, None
1133 except ValidationError as e: # TODO remove try Except, it is captured at nbi.py
tiernob24258a2018-10-04 18:39:49 +02001134 raise EngineException(e, HTTPStatus.UNPROCESSABLE_ENTITY)
1135 # except DbException as e:
1136 # raise EngineException("Cannot get ns_instance '{}': {}".format(e), HTTPStatus.NOT_FOUND)
1137
tiernobee3bad2019-12-05 12:26:01 +00001138 def delete(self, session, _id, dry_run=False, not_send_msg=None):
tiernob24258a2018-10-04 18:39:49 +02001139 raise EngineException("Method delete called directly", HTTPStatus.INTERNAL_SERVER_ERROR)
1140
tierno65ca36d2019-02-12 19:27:52 +01001141 def edit(self, session, _id, indata=None, kwargs=None, content=None):
tiernob24258a2018-10-04 18:39:49 +02001142 raise EngineException("Method edit called directly", HTTPStatus.INTERNAL_SERVER_ERROR)
Felipe Vicensb57758d2018-10-16 16:00:20 +02001143
1144
1145class NsiTopic(BaseTopic):
1146 topic = "nsis"
1147 topic_msg = "nsi"
tierno6b02b052020-06-02 10:07:41 +00001148 quota_name = "slice_instances"
Felipe Vicensb57758d2018-10-16 16:00:20 +02001149
delacruzramo32bab472019-09-13 12:24:22 +02001150 def __init__(self, db, fs, msg, auth):
1151 BaseTopic.__init__(self, db, fs, msg, auth)
1152 self.nsrTopic = NsrTopic(db, fs, msg, auth)
Felipe Vicensb57758d2018-10-16 16:00:20 +02001153
Felipe Vicensc37b3842019-01-12 12:24:42 +01001154 @staticmethod
1155 def _format_ns_request(ns_request):
1156 formated_request = copy(ns_request)
1157 # TODO: Add request params
1158 return formated_request
1159
1160 @staticmethod
tiernofd160572019-01-21 10:41:37 +00001161 def _format_addional_params(slice_request):
Felipe Vicensc37b3842019-01-12 12:24:42 +01001162 """
1163 Get and format user additional params for NS or VNF
tiernofd160572019-01-21 10:41:37 +00001164 :param slice_request: User instantiation additional parameters
1165 :return: a formatted copy of additional params or None if not supplied
Felipe Vicensc37b3842019-01-12 12:24:42 +01001166 """
tiernofd160572019-01-21 10:41:37 +00001167 additional_params = copy(slice_request.get("additionalParamsForNsi"))
1168 if additional_params:
1169 for k, v in additional_params.items():
1170 if not isinstance(k, str):
1171 raise EngineException("Invalid param at additionalParamsForNsi:{}. Only string keys are allowed".
1172 format(k))
1173 if "." in k or "$" in k:
1174 raise EngineException("Invalid param at additionalParamsForNsi:{}. Keys must not contain dots or $".
1175 format(k))
1176 if isinstance(v, (dict, tuple, list)):
1177 additional_params[k] = "!!yaml " + safe_dump(v)
Felipe Vicensc37b3842019-01-12 12:24:42 +01001178 return additional_params
1179
Felipe Vicensb57758d2018-10-16 16:00:20 +02001180 def _check_descriptor_dependencies(self, session, descriptor):
1181 """
1182 Check that the dependent descriptors exist on a new descriptor or edition
tierno65ca36d2019-02-12 19:27:52 +01001183 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
Felipe Vicensb57758d2018-10-16 16:00:20 +02001184 :param descriptor: descriptor to be inserted or edit
1185 :return: None or raises exception
1186 """
Felipe Vicens07f31722018-10-29 15:16:44 +01001187 if not descriptor.get("nst-ref"):
Felipe Vicensb57758d2018-10-16 16:00:20 +02001188 return
Felipe Vicens07f31722018-10-29 15:16:44 +01001189 nstd_id = descriptor["nst-ref"]
Felipe Vicensb57758d2018-10-16 16:00:20 +02001190 if not self.get_item_list(session, "nsts", {"id": nstd_id}):
Felipe Vicens07f31722018-10-29 15:16:44 +01001191 raise EngineException("Descriptor error at nst-ref='{}' references a non exist nstd".format(nstd_id),
Felipe Vicensb57758d2018-10-16 16:00:20 +02001192 http_code=HTTPStatus.CONFLICT)
1193
tiernob4844ab2019-05-23 08:42:12 +00001194 def check_conflict_on_del(self, session, _id, db_content):
1195 """
1196 Check that NSI is not instantiated
1197 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1198 :param _id: nsi internal id
1199 :param db_content: The database content of the _id
1200 :return: None or raises EngineException with the conflict
1201 """
tierno65ca36d2019-02-12 19:27:52 +01001202 if session["force"]:
Felipe Vicensb57758d2018-10-16 16:00:20 +02001203 return
tiernob4844ab2019-05-23 08:42:12 +00001204 nsi = db_content
Felipe Vicensb57758d2018-10-16 16:00:20 +02001205 if nsi["_admin"].get("nsiState") == "INSTANTIATED":
1206 raise EngineException("nsi '{}' cannot be deleted because it is in 'INSTANTIATED' state. "
1207 "Launch 'terminate' operation first; or force deletion".format(_id),
1208 http_code=HTTPStatus.CONFLICT)
1209
tiernobee3bad2019-12-05 12:26:01 +00001210 def delete_extra(self, session, _id, db_content, not_send_msg=None):
Felipe Vicensb57758d2018-10-16 16:00:20 +02001211 """
tiernob4844ab2019-05-23 08:42:12 +00001212 Deletes associated nsilcmops from database. Deletes associated filesystem.
1213 Set usageState of nst
tierno65ca36d2019-02-12 19:27:52 +01001214 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
Felipe Vicensb57758d2018-10-16 16:00:20 +02001215 :param _id: server internal id
tiernob4844ab2019-05-23 08:42:12 +00001216 :param db_content: The database content of the descriptor
tiernobee3bad2019-12-05 12:26:01 +00001217 :param not_send_msg: To not send message (False) or store content (list) instead
tiernob4844ab2019-05-23 08:42:12 +00001218 :return: None if ok or raises EngineException with the problem
Felipe Vicensb57758d2018-10-16 16:00:20 +02001219 """
Felipe Vicens07f31722018-10-29 15:16:44 +01001220
Felipe Vicens09e65422019-01-22 15:06:46 +01001221 # Deleting the nsrs belonging to nsir
tiernob4844ab2019-05-23 08:42:12 +00001222 nsir = db_content
Felipe Vicens09e65422019-01-22 15:06:46 +01001223 for nsrs_detailed_item in nsir["_admin"]["nsrs-detailed-list"]:
1224 nsr_id = nsrs_detailed_item["nsrId"]
1225 if nsrs_detailed_item.get("shared"):
1226 _filter = {"_admin.nsrs-detailed-list.ANYINDEX.shared": True,
1227 "_admin.nsrs-detailed-list.ANYINDEX.nsrId": nsr_id,
1228 "_id.ne": nsir["_id"]}
1229 nsi = self.db.get_one("nsis", _filter, fail_on_empty=False, fail_on_more=False)
1230 if nsi: # last one using nsr
1231 continue
1232 try:
tiernobee3bad2019-12-05 12:26:01 +00001233 self.nsrTopic.delete(session, nsr_id, dry_run=False, not_send_msg=not_send_msg)
Felipe Vicens09e65422019-01-22 15:06:46 +01001234 except (DbException, EngineException) as e:
1235 if e.http_code == HTTPStatus.NOT_FOUND:
1236 pass
1237 else:
1238 raise
Felipe Vicens07f31722018-10-29 15:16:44 +01001239
tiernob4844ab2019-05-23 08:42:12 +00001240 # delete related nsilcmops database entries
1241 self.db.del_list("nsilcmops", {"netsliceInstanceId": _id})
Felipe Vicens07f31722018-10-29 15:16:44 +01001242
tiernob4844ab2019-05-23 08:42:12 +00001243 # Check and set used NST usage state
Felipe Vicens09e65422019-01-22 15:06:46 +01001244 nsir_admin = nsir.get("_admin")
tiernob4844ab2019-05-23 08:42:12 +00001245 if nsir_admin and nsir_admin.get("nst-id"):
1246 # check if used by another NSI
1247 nsis_list = self.db.get_one("nsis", {"nst-id": nsir_admin["nst-id"]},
1248 fail_on_empty=False, fail_on_more=False)
1249 if not nsis_list:
1250 self.db.set_one("nsts", {"_id": nsir_admin["nst-id"]}, {"_admin.usageState": "NOT_IN_USE"})
1251
1252 # def delete(self, session, _id, dry_run=False):
1253 # """
1254 # Delete item by its internal _id
1255 # :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
1256 # :param _id: server internal id
1257 # :param dry_run: make checking but do not delete
1258 # :return: dictionary with deleted item _id. It raises EngineException on error: not found, conflict, ...
1259 # """
1260 # # TODO add admin to filter, validate rights
1261 # BaseTopic.delete(self, session, _id, dry_run=True)
1262 # if dry_run:
1263 # return
1264 #
1265 # # Deleting the nsrs belonging to nsir
1266 # nsir = self.db.get_one("nsis", {"_id": _id})
1267 # for nsrs_detailed_item in nsir["_admin"]["nsrs-detailed-list"]:
1268 # nsr_id = nsrs_detailed_item["nsrId"]
1269 # if nsrs_detailed_item.get("shared"):
1270 # _filter = {"_admin.nsrs-detailed-list.ANYINDEX.shared": True,
1271 # "_admin.nsrs-detailed-list.ANYINDEX.nsrId": nsr_id,
1272 # "_id.ne": nsir["_id"]}
1273 # nsi = self.db.get_one("nsis", _filter, fail_on_empty=False, fail_on_more=False)
1274 # if nsi: # last one using nsr
1275 # continue
1276 # try:
1277 # self.nsrTopic.delete(session, nsr_id, dry_run=False)
1278 # except (DbException, EngineException) as e:
1279 # if e.http_code == HTTPStatus.NOT_FOUND:
1280 # pass
1281 # else:
1282 # raise
1283 # # deletes NetSlice instance object
1284 # v = self.db.del_one("nsis", {"_id": _id})
1285 #
1286 # # makes a temporal list of nsilcmops objects related to the _id given and deletes them from db
1287 # _filter = {"netsliceInstanceId": _id}
1288 # self.db.del_list("nsilcmops", _filter)
1289 #
1290 # # Search if nst is being used by other nsi
1291 # nsir_admin = nsir.get("_admin")
1292 # if nsir_admin:
1293 # if nsir_admin.get("nst-id"):
1294 # nsis_list = self.db.get_one("nsis", {"nst-id": nsir_admin["nst-id"]},
1295 # fail_on_empty=False, fail_on_more=False)
1296 # if not nsis_list:
1297 # self.db.set_one("nsts", {"_id": nsir_admin["nst-id"]}, {"_admin.usageState": "NOT_IN_USE"})
1298 # return v
Felipe Vicensb57758d2018-10-16 16:00:20 +02001299
tierno65ca36d2019-02-12 19:27:52 +01001300 def new(self, rollback, session, indata=None, kwargs=None, headers=None):
Felipe Vicensb57758d2018-10-16 16:00:20 +02001301 """
Felipe Vicens07f31722018-10-29 15:16:44 +01001302 Creates a new netslice instance record into database. It also creates needed nsrs and vnfrs
Felipe Vicensb57758d2018-10-16 16:00:20 +02001303 :param rollback: list to append the created items at database in case a rollback must be done
tierno65ca36d2019-02-12 19:27:52 +01001304 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
Felipe Vicensb57758d2018-10-16 16:00:20 +02001305 :param indata: params to be used for the nsir
1306 :param kwargs: used to override the indata descriptor
1307 :param headers: http request headers
Felipe Vicensb57758d2018-10-16 16:00:20 +02001308 :return: the _id of nsi descriptor created at database
1309 """
1310
1311 try:
delacruzramo32bab472019-09-13 12:24:22 +02001312 step = "checking quotas"
1313 self.check_quota(session)
1314
tierno99d4b172019-07-02 09:28:40 +00001315 step = ""
Felipe Vicensb57758d2018-10-16 16:00:20 +02001316 slice_request = self._remove_envelop(indata)
1317 # Override descriptor with query string kwargs
1318 self._update_input_with_kwargs(slice_request, kwargs)
tierno65ca36d2019-02-12 19:27:52 +01001319 self._validate_input_new(slice_request, session["force"])
Felipe Vicensb57758d2018-10-16 16:00:20 +02001320
Felipe Vicensb57758d2018-10-16 16:00:20 +02001321 # look for nstd
tierno9e5eea32018-11-29 09:42:09 +00001322 step = "getting nstd id='{}' from database".format(slice_request.get("nstId"))
tiernob4844ab2019-05-23 08:42:12 +00001323 _filter = self._get_project_filter(session)
1324 _filter["_id"] = slice_request["nstId"]
Felipe Vicensb57758d2018-10-16 16:00:20 +02001325 nstd = self.db.get_one("nsts", _filter)
tierno0f9d08d2020-06-23 15:25:26 +00001326 # check NST is not disabled
1327 step = "checking NST operationalState"
1328 if nstd["_admin"]["operationalState"] == "DISABLED":
1329 raise EngineException("nst with id '{}' is DISABLED, and thus cannot be used to create a netslice "
1330 "instance".format(slice_request["nstId"]), http_code=HTTPStatus.CONFLICT)
tiernob4844ab2019-05-23 08:42:12 +00001331 del _filter["_id"]
1332
Frank Brydendeb4bc22020-07-28 12:50:23 +00001333 # check NSD is not disabled
1334 step = "checking operationalState"
1335 if nstd["_admin"]["operationalState"] == "DISABLED":
1336 raise EngineException("nst with id '{}' is DISABLED, and thus cannot be used to create "
1337 "a network slice".format(slice_request["nstId"]), http_code=HTTPStatus.CONFLICT)
1338
Felipe Vicens07f31722018-10-29 15:16:44 +01001339 nstd.pop("_admin", None)
Felipe Vicens09e65422019-01-22 15:06:46 +01001340 nstd_id = nstd.pop("_id", None)
Felipe Vicensb57758d2018-10-16 16:00:20 +02001341 nsi_id = str(uuid4())
Felipe Vicensb57758d2018-10-16 16:00:20 +02001342 step = "filling nsi_descriptor with input data"
Felipe Vicens07f31722018-10-29 15:16:44 +01001343
Felipe Vicensc8bbaaa2018-12-01 04:42:40 +01001344 # Creating the NSIR
Felipe Vicensb57758d2018-10-16 16:00:20 +02001345 nsi_descriptor = {
1346 "id": nsi_id,
garciadeblasc54d4202018-11-29 23:41:37 +01001347 "name": slice_request["nsiName"],
1348 "description": slice_request.get("nsiDescription", ""),
1349 "datacenter": slice_request["vimAccountId"],
Felipe Vicensb57758d2018-10-16 16:00:20 +02001350 "nst-ref": nstd["id"],
Felipe Vicensc8bbaaa2018-12-01 04:42:40 +01001351 "instantiation_parameters": slice_request,
Felipe Vicensb57758d2018-10-16 16:00:20 +02001352 "network-slice-template": nstd,
Felipe Vicensc8bbaaa2018-12-01 04:42:40 +01001353 "nsr-ref-list": [],
1354 "vlr-list": [],
Felipe Vicensb57758d2018-10-16 16:00:20 +02001355 "_id": nsi_id,
tiernofd160572019-01-21 10:41:37 +00001356 "additionalParamsForNsi": self._format_addional_params(slice_request)
Felipe Vicensb57758d2018-10-16 16:00:20 +02001357 }
Felipe Vicensb57758d2018-10-16 16:00:20 +02001358
Felipe Vicensc8bbaaa2018-12-01 04:42:40 +01001359 step = "creating nsi at database"
tierno65ca36d2019-02-12 19:27:52 +01001360 self.format_on_new(nsi_descriptor, session["project_id"], make_public=session["public"])
Felipe Vicensc8bbaaa2018-12-01 04:42:40 +01001361 nsi_descriptor["_admin"]["nsiState"] = "NOT_INSTANTIATED"
1362 nsi_descriptor["_admin"]["netslice-subnet"] = None
Felipe Vicens09e65422019-01-22 15:06:46 +01001363 nsi_descriptor["_admin"]["deployed"] = {}
1364 nsi_descriptor["_admin"]["deployed"]["RO"] = []
1365 nsi_descriptor["_admin"]["nst-id"] = nstd_id
1366
Felipe Vicensc8bbaaa2018-12-01 04:42:40 +01001367 # Creating netslice-vld for the RO.
1368 step = "creating netslice-vld at database"
Felipe Vicensc8bbaaa2018-12-01 04:42:40 +01001369
1370 # Building the vlds list to be deployed
1371 # From netslice descriptors, creating the initial list
Felipe Vicens09e65422019-01-22 15:06:46 +01001372 nsi_vlds = []
1373
1374 for netslice_vlds in get_iterable(nstd.get("netslice-vld")):
1375 # Getting template Instantiation parameters from NST
1376 nsi_vld = deepcopy(netslice_vlds)
1377 nsi_vld["shared-nsrs-list"] = []
1378 nsi_vld["vimAccountId"] = slice_request["vimAccountId"]
1379 nsi_vlds.append(nsi_vld)
Felipe Vicensc8bbaaa2018-12-01 04:42:40 +01001380
1381 nsi_descriptor["_admin"]["netslice-vld"] = nsi_vlds
tierno3ffc7a42019-12-03 09:39:40 +00001382 # Creating netslice-subnet_record.
Felipe Vicensb57758d2018-10-16 16:00:20 +02001383 needed_nsds = {}
Felipe Vicens07f31722018-10-29 15:16:44 +01001384 services = []
Felipe Vicensc8bbaaa2018-12-01 04:42:40 +01001385
Felipe Vicens09e65422019-01-22 15:06:46 +01001386 # Updating the nstd with the nsd["_id"] associated to the nss -> services list
Felipe Vicensb57758d2018-10-16 16:00:20 +02001387 for member_ns in nstd["netslice-subnet"]:
1388 nsd_id = member_ns["nsd-ref"]
1389 step = "getting nstd id='{}' constituent-nsd='{}' from database".format(
1390 member_ns["nsd-ref"], member_ns["id"])
1391 if nsd_id not in needed_nsds:
1392 # Obtain nsd
tiernob4844ab2019-05-23 08:42:12 +00001393 _filter["id"] = nsd_id
1394 nsd = self.db.get_one("nsds", _filter, fail_on_empty=True, fail_on_more=True)
1395 del _filter["id"]
Felipe Vicensb57758d2018-10-16 16:00:20 +02001396 nsd.pop("_admin")
1397 needed_nsds[nsd_id] = nsd
1398 else:
1399 nsd = needed_nsds[nsd_id]
Felipe Vicens09e65422019-01-22 15:06:46 +01001400 member_ns["_id"] = needed_nsds[nsd_id].get("_id")
1401 services.append(member_ns)
Felipe Vicens07f31722018-10-29 15:16:44 +01001402
Felipe Vicensb57758d2018-10-16 16:00:20 +02001403 step = "filling nsir nsd-id='{}' constituent-nsd='{}' from database".format(
1404 member_ns["nsd-ref"], member_ns["id"])
Felipe Vicensb57758d2018-10-16 16:00:20 +02001405
Felipe Vicens07f31722018-10-29 15:16:44 +01001406 # creates Network Services records (NSRs)
1407 step = "creating nsrs at database using NsrTopic.new()"
Felipe Vicensc8bbaaa2018-12-01 04:42:40 +01001408 ns_params = slice_request.get("netslice-subnet")
Felipe Vicens07f31722018-10-29 15:16:44 +01001409 nsrs_list = []
Felipe Vicensc8bbaaa2018-12-01 04:42:40 +01001410 nsi_netslice_subnet = []
Felipe Vicens07f31722018-10-29 15:16:44 +01001411 for service in services:
Felipe Vicens09e65422019-01-22 15:06:46 +01001412 # Check if the netslice-subnet is shared and if it is share if the nss exists
1413 _id_nsr = None
Felipe Vicens07f31722018-10-29 15:16:44 +01001414 indata_ns = {}
Felipe Vicens09e65422019-01-22 15:06:46 +01001415 # Is the nss shared and instantiated?
tiernob4844ab2019-05-23 08:42:12 +00001416 _filter["_admin.nsrs-detailed-list.ANYINDEX.shared"] = True
1417 _filter["_admin.nsrs-detailed-list.ANYINDEX.nsd-id"] = service["nsd-ref"]
Felipe Vicens08ddb142019-08-09 15:52:40 +02001418 _filter["_admin.nsrs-detailed-list.ANYINDEX.nss-id"] = service["id"]
Felipe Vicens09e65422019-01-22 15:06:46 +01001419 nsi = self.db.get_one("nsis", _filter, fail_on_empty=False, fail_on_more=False)
Felipe Vicens09e65422019-01-22 15:06:46 +01001420 if nsi and service.get("is-shared-nss"):
1421 nsrs_detailed_list = nsi["_admin"]["nsrs-detailed-list"]
1422 for nsrs_detailed_item in nsrs_detailed_list:
1423 if nsrs_detailed_item["nsd-id"] == service["nsd-ref"]:
Felipe Vicens08ddb142019-08-09 15:52:40 +02001424 if nsrs_detailed_item["nss-id"] == service["id"]:
1425 _id_nsr = nsrs_detailed_item["nsrId"]
1426 break
Felipe Vicens09e65422019-01-22 15:06:46 +01001427 for netslice_subnet in nsi["_admin"]["netslice-subnet"]:
1428 if netslice_subnet["nss-id"] == service["id"]:
1429 indata_ns = netslice_subnet
1430 break
1431 else:
1432 indata_ns = {}
1433 if service.get("instantiation-parameters"):
1434 indata_ns = deepcopy(service["instantiation-parameters"])
1435 # del service["instantiation-parameters"]
1436
1437 indata_ns["nsdId"] = service["_id"]
1438 indata_ns["nsName"] = slice_request.get("nsiName") + "." + service["id"]
1439 indata_ns["vimAccountId"] = slice_request.get("vimAccountId")
1440 indata_ns["nsDescription"] = service["description"]
tierno99d4b172019-07-02 09:28:40 +00001441 if slice_request.get("ssh_keys"):
1442 indata_ns["ssh_keys"] = slice_request.get("ssh_keys")
Felipe Vicensc37b3842019-01-12 12:24:42 +01001443
Felipe Vicens09e65422019-01-22 15:06:46 +01001444 if ns_params:
1445 for ns_param in ns_params:
1446 if ns_param.get("id") == service["id"]:
1447 copy_ns_param = deepcopy(ns_param)
1448 del copy_ns_param["id"]
1449 indata_ns.update(copy_ns_param)
1450 break
1451
1452 # Creates Nsr objects
tiernobdebce92019-07-01 15:36:49 +00001453 _id_nsr, _ = self.nsrTopic.new(rollback, session, indata_ns, kwargs, headers)
Felipe Vicens09e65422019-01-22 15:06:46 +01001454 nsrs_item = {"nsrId": _id_nsr, "shared": service.get("is-shared-nss"), "nsd-id": service["nsd-ref"],
Felipe Vicens08ddb142019-08-09 15:52:40 +02001455 "nss-id": service["id"], "nslcmop_instantiate": None}
Felipe Vicens09e65422019-01-22 15:06:46 +01001456 indata_ns["nss-id"] = service["id"]
Felipe Vicens07f31722018-10-29 15:16:44 +01001457 nsrs_list.append(nsrs_item)
Felipe Vicensc8bbaaa2018-12-01 04:42:40 +01001458 nsi_netslice_subnet.append(indata_ns)
1459 nsr_ref = {"nsr-ref": _id_nsr}
1460 nsi_descriptor["nsr-ref-list"].append(nsr_ref)
Felipe Vicens07f31722018-10-29 15:16:44 +01001461
1462 # Adding the nsrs list to the nsi
1463 nsi_descriptor["_admin"]["nsrs-detailed-list"] = nsrs_list
Felipe Vicensc8bbaaa2018-12-01 04:42:40 +01001464 nsi_descriptor["_admin"]["netslice-subnet"] = nsi_netslice_subnet
Felipe Vicens09e65422019-01-22 15:06:46 +01001465 self.db.set_one("nsts", {"_id": slice_request["nstId"]}, {"_admin.usageState": "IN_USE"})
1466
Felipe Vicens07f31722018-10-29 15:16:44 +01001467 # Creating the entry in the database
Felipe Vicensb57758d2018-10-16 16:00:20 +02001468 self.db.create("nsis", nsi_descriptor)
1469 rollback.append({"topic": "nsis", "_id": nsi_id})
tiernobdebce92019-07-01 15:36:49 +00001470 return nsi_id, None
1471 except Exception as e: # TODO remove try Except, it is captured at nbi.py
Felipe Vicensb57758d2018-10-16 16:00:20 +02001472 self.logger.exception("Exception {} at NsiTopic.new()".format(e), exc_info=True)
1473 raise EngineException("Error {}: {}".format(step, e))
1474 except ValidationError as e:
1475 raise EngineException(e, HTTPStatus.UNPROCESSABLE_ENTITY)
1476
tierno65ca36d2019-02-12 19:27:52 +01001477 def edit(self, session, _id, indata=None, kwargs=None, content=None):
Felipe Vicensb57758d2018-10-16 16:00:20 +02001478 raise EngineException("Method edit called directly", HTTPStatus.INTERNAL_SERVER_ERROR)
Felipe Vicens07f31722018-10-29 15:16:44 +01001479
1480
1481class NsiLcmOpTopic(BaseTopic):
1482 topic = "nsilcmops"
1483 topic_msg = "nsi"
1484 operation_schema = { # mapping between operation and jsonschema to validate
1485 "instantiate": nsi_instantiate,
1486 "terminate": None
1487 }
Felipe Vicens09e65422019-01-22 15:06:46 +01001488
delacruzramo32bab472019-09-13 12:24:22 +02001489 def __init__(self, db, fs, msg, auth):
1490 BaseTopic.__init__(self, db, fs, msg, auth)
1491 self.nsi_NsLcmOpTopic = NsLcmOpTopic(self.db, self.fs, self.msg, self.auth)
Felipe Vicens07f31722018-10-29 15:16:44 +01001492
1493 def _check_nsi_operation(self, session, nsir, operation, indata):
1494 """
1495 Check that user has enter right parameters for the operation
tierno65ca36d2019-02-12 19:27:52 +01001496 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
Felipe Vicens07f31722018-10-29 15:16:44 +01001497 :param operation: it can be: instantiate, terminate, action, TODO: update, heal
1498 :param indata: descriptor with the parameters of the operation
1499 :return: None
1500 """
1501 nsds = {}
1502 nstd = nsir["network-slice-template"]
1503
Felipe Vicensc8bbaaa2018-12-01 04:42:40 +01001504 def check_valid_netslice_subnet_id(nstId):
Felipe Vicens07f31722018-10-29 15:16:44 +01001505 # TODO change to vnfR (??)
Felipe Vicensc8bbaaa2018-12-01 04:42:40 +01001506 for netslice_subnet in nstd["netslice-subnet"]:
1507 if nstId == netslice_subnet["id"]:
1508 nsd_id = netslice_subnet["nsd-ref"]
Felipe Vicens07f31722018-10-29 15:16:44 +01001509 if nsd_id not in nsds:
Felipe Vicens5403f542020-05-22 16:37:39 +02001510 _filter = self._get_project_filter(session)
1511 _filter["id"] = nsd_id
1512 nsds[nsd_id] = self.db.get_one("nsds", _filter)
Felipe Vicens07f31722018-10-29 15:16:44 +01001513 return nsds[nsd_id]
1514 else:
Felipe Vicensc8bbaaa2018-12-01 04:42:40 +01001515 raise EngineException("Invalid parameter nstId='{}' is not one of the "
1516 "nst:netslice-subnet".format(nstId))
Felipe Vicens07f31722018-10-29 15:16:44 +01001517 if operation == "instantiate":
1518 # check the existance of netslice-subnet items
Felipe Vicensc8bbaaa2018-12-01 04:42:40 +01001519 for in_nst in get_iterable(indata.get("netslice-subnet")):
1520 check_valid_netslice_subnet_id(in_nst["id"])
Felipe Vicens07f31722018-10-29 15:16:44 +01001521
1522 def _create_nsilcmop(self, session, netsliceInstanceId, operation, params):
1523 now = time()
1524 _id = str(uuid4())
1525 nsilcmop = {
1526 "id": _id,
1527 "_id": _id,
1528 "operationState": "PROCESSING", # COMPLETED,PARTIALLY_COMPLETED,FAILED_TEMP,FAILED,ROLLING_BACK,ROLLED_BACK
1529 "statusEnteredTime": now,
1530 "netsliceInstanceId": netsliceInstanceId,
1531 "lcmOperationType": operation,
1532 "startTime": now,
1533 "isAutomaticInvocation": False,
1534 "operationParams": params,
1535 "isCancelPending": False,
1536 "links": {
1537 "self": "/osm/nsilcm/v1/nsi_lcm_op_occs/" + _id,
Felipe Vicens126af572019-06-05 19:13:04 +02001538 "netsliceInstanceId": "/osm/nsilcm/v1/netslice_instances/" + netsliceInstanceId,
Felipe Vicens07f31722018-10-29 15:16:44 +01001539 }
1540 }
1541 return nsilcmop
1542
Felipe Vicens09e65422019-01-22 15:06:46 +01001543 def add_shared_nsr_2vld(self, nsir, nsr_item):
1544 for nst_sb_item in nsir["network-slice-template"].get("netslice-subnet"):
1545 if nst_sb_item.get("is-shared-nss"):
1546 for admin_subnet_item in nsir["_admin"].get("netslice-subnet"):
1547 if admin_subnet_item["nss-id"] == nst_sb_item["id"]:
1548 for admin_vld_item in nsir["_admin"].get("netslice-vld"):
1549 for admin_vld_nss_cp_ref_item in admin_vld_item["nss-connection-point-ref"]:
1550 if admin_subnet_item["nss-id"] == admin_vld_nss_cp_ref_item["nss-ref"]:
1551 if not nsr_item["nsrId"] in admin_vld_item["shared-nsrs-list"]:
1552 admin_vld_item["shared-nsrs-list"].append(nsr_item["nsrId"])
1553 break
1554 # self.db.set_one("nsis", {"_id": nsir["_id"]}, nsir)
1555 self.db.set_one("nsis", {"_id": nsir["_id"]}, {"_admin.netslice-vld": nsir["_admin"].get("netslice-vld")})
1556
tierno65ca36d2019-02-12 19:27:52 +01001557 def new(self, rollback, session, indata=None, kwargs=None, headers=None):
Felipe Vicens07f31722018-10-29 15:16:44 +01001558 """
1559 Performs a new operation over a ns
1560 :param rollback: list to append created items at database in case a rollback must to be done
tierno65ca36d2019-02-12 19:27:52 +01001561 :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
Felipe Vicens07f31722018-10-29 15:16:44 +01001562 :param indata: descriptor with the parameters of the operation. It must contains among others
Felipe Vicens126af572019-06-05 19:13:04 +02001563 netsliceInstanceId: _id of the nsir to perform the operation
Felipe Vicens07f31722018-10-29 15:16:44 +01001564 operation: it can be: instantiate, terminate, action, TODO: update, heal
1565 :param kwargs: used to override the indata descriptor
1566 :param headers: http request headers
Felipe Vicens07f31722018-10-29 15:16:44 +01001567 :return: id of the nslcmops
1568 """
1569 try:
1570 # Override descriptor with query string kwargs
1571 self._update_input_with_kwargs(indata, kwargs)
1572 operation = indata["lcmOperationType"]
Felipe Vicens126af572019-06-05 19:13:04 +02001573 netsliceInstanceId = indata["netsliceInstanceId"]
Felipe Vicens07f31722018-10-29 15:16:44 +01001574 validate_input(indata, self.operation_schema[operation])
1575
Felipe Vicens126af572019-06-05 19:13:04 +02001576 # get nsi from netsliceInstanceId
tiernob4844ab2019-05-23 08:42:12 +00001577 _filter = self._get_project_filter(session)
Felipe Vicens126af572019-06-05 19:13:04 +02001578 _filter["_id"] = netsliceInstanceId
Felipe Vicens07f31722018-10-29 15:16:44 +01001579 nsir = self.db.get_one("nsis", _filter)
tierno0f9d08d2020-06-23 15:25:26 +00001580 logging_prefix = "nsi={} {} ".format(netsliceInstanceId, operation)
tiernob4844ab2019-05-23 08:42:12 +00001581 del _filter["_id"]
Felipe Vicens07f31722018-10-29 15:16:44 +01001582
1583 # initial checking
1584 if not nsir["_admin"].get("nsiState") or nsir["_admin"]["nsiState"] == "NOT_INSTANTIATED":
1585 if operation == "terminate" and indata.get("autoremove"):
1586 # NSIR must be deleted
tierno586ae812019-10-17 13:56:53 +00001587 return None, None # a none in this case is used to indicate not instantiated. It can be removed
Felipe Vicens07f31722018-10-29 15:16:44 +01001588 if operation != "instantiate":
1589 raise EngineException("netslice_instance '{}' cannot be '{}' because it is not instantiated".format(
Felipe Vicens126af572019-06-05 19:13:04 +02001590 netsliceInstanceId, operation), HTTPStatus.CONFLICT)
Felipe Vicens07f31722018-10-29 15:16:44 +01001591 else:
tierno65ca36d2019-02-12 19:27:52 +01001592 if operation == "instantiate" and not session["force"]:
Felipe Vicens07f31722018-10-29 15:16:44 +01001593 raise EngineException("netslice_instance '{}' cannot be '{}' because it is already instantiated".
Felipe Vicens126af572019-06-05 19:13:04 +02001594 format(netsliceInstanceId, operation), HTTPStatus.CONFLICT)
Felipe Vicens07f31722018-10-29 15:16:44 +01001595
1596 # Creating all the NS_operation (nslcmop)
1597 # Get service list from db
1598 nsrs_list = nsir["_admin"]["nsrs-detailed-list"]
1599 nslcmops = []
Felipe Vicens09e65422019-01-22 15:06:46 +01001600 # nslcmops_item = None
1601 for index, nsr_item in enumerate(nsrs_list):
tierno0f9d08d2020-06-23 15:25:26 +00001602 nsr_id = nsr_item["nsrId"]
Felipe Vicens09e65422019-01-22 15:06:46 +01001603 if nsr_item.get("shared"):
Felipe Vicens58e2d2f2019-05-30 13:01:20 +02001604 _filter["_admin.nsrs-detailed-list.ANYINDEX.shared"] = True
tierno0f9d08d2020-06-23 15:25:26 +00001605 _filter["_admin.nsrs-detailed-list.ANYINDEX.nsrId"] = nsr_id
tiernob4844ab2019-05-23 08:42:12 +00001606 _filter["_admin.nsrs-detailed-list.ANYINDEX.nslcmop_instantiate.ne"] = None
Felipe Vicens126af572019-06-05 19:13:04 +02001607 _filter["_id.ne"] = netsliceInstanceId
Felipe Vicens09e65422019-01-22 15:06:46 +01001608 nsi = self.db.get_one("nsis", _filter, fail_on_empty=False, fail_on_more=False)
Felipe Vicens58e2d2f2019-05-30 13:01:20 +02001609 if operation == "terminate":
1610 _update = {"_admin.nsrs-detailed-list.{}.nslcmop_instantiate".format(index): None}
1611 self.db.set_one("nsis", {"_id": nsir["_id"]}, _update)
tierno0f9d08d2020-06-23 15:25:26 +00001612 if nsi: # other nsi is using this nsr and it needs this nsr instantiated
1613 continue # do not create nsilcmop
1614 else: # instantiate
1615 # looks the first nsi fulfilling the conditions but not being the current NSIR
1616 if nsi:
1617 nsi_nsr_item = next(n for n in nsi["_admin"]["nsrs-detailed-list"] if
1618 n["nsrId"] == nsr_id and n["shared"] and
1619 n["nslcmop_instantiate"])
1620 self.add_shared_nsr_2vld(nsir, nsr_item)
1621 nslcmops.append(nsi_nsr_item["nslcmop_instantiate"])
1622 _update = {"_admin.nsrs-detailed-list.{}".format(index): nsi_nsr_item}
1623 self.db.set_one("nsis", {"_id": nsir["_id"]}, _update)
1624 # continue to not create nslcmop since nsrs is shared and nsrs was created
1625 continue
1626 else:
1627 self.add_shared_nsr_2vld(nsir, nsr_item)
Felipe Vicens09e65422019-01-22 15:06:46 +01001628
tierno0f9d08d2020-06-23 15:25:26 +00001629 # create operation
Felipe Vicens09e65422019-01-22 15:06:46 +01001630 try:
tierno0b8752f2020-05-12 09:42:02 +00001631 indata_ns = {
1632 "lcmOperationType": operation,
tierno0f9d08d2020-06-23 15:25:26 +00001633 "nsInstanceId": nsr_id,
tierno0b8752f2020-05-12 09:42:02 +00001634 # Including netslice_id in the ns instantiate Operation
1635 "netsliceInstanceId": netsliceInstanceId,
1636 }
1637 if operation == "instantiate":
tierno0f9d08d2020-06-23 15:25:26 +00001638 service = self.db.get_one("nsrs", {"_id": nsr_id})
tierno0b8752f2020-05-12 09:42:02 +00001639 indata_ns.update(service["instantiate_params"])
1640
tierno99d4b172019-07-02 09:28:40 +00001641 # Creating NS_LCM_OP with the flag slice_object=True to not trigger the service instantiation
Felipe Vicens09e65422019-01-22 15:06:46 +01001642 # message via kafka bus
tierno0f9d08d2020-06-23 15:25:26 +00001643 nslcmop, _ = self.nsi_NsLcmOpTopic.new(rollback, session, indata_ns, None, headers,
tiernobdebce92019-07-01 15:36:49 +00001644 slice_object=True)
Felipe Vicens09e65422019-01-22 15:06:46 +01001645 nslcmops.append(nslcmop)
tierno0f9d08d2020-06-23 15:25:26 +00001646 if operation == "instantiate":
1647 _update = {"_admin.nsrs-detailed-list.{}.nslcmop_instantiate".format(index): nslcmop}
1648 self.db.set_one("nsis", {"_id": nsir["_id"]}, _update)
Felipe Vicens09e65422019-01-22 15:06:46 +01001649 except (DbException, EngineException) as e:
1650 if e.http_code == HTTPStatus.NOT_FOUND:
tierno0f9d08d2020-06-23 15:25:26 +00001651 self.logger.info(logging_prefix + "skipping NS={} because not found".format(nsr_id))
Felipe Vicens09e65422019-01-22 15:06:46 +01001652 pass
1653 else:
1654 raise
Felipe Vicens07f31722018-10-29 15:16:44 +01001655
1656 # Creates nsilcmop
1657 indata["nslcmops_ids"] = nslcmops
1658 self._check_nsi_operation(session, nsir, operation, indata)
Felipe Vicens09e65422019-01-22 15:06:46 +01001659
Felipe Vicens126af572019-06-05 19:13:04 +02001660 nsilcmop_desc = self._create_nsilcmop(session, netsliceInstanceId, operation, indata)
tierno65ca36d2019-02-12 19:27:52 +01001661 self.format_on_new(nsilcmop_desc, session["project_id"], make_public=session["public"])
Felipe Vicens07f31722018-10-29 15:16:44 +01001662 _id = self.db.create("nsilcmops", nsilcmop_desc)
1663 rollback.append({"topic": "nsilcmops", "_id": _id})
1664 self.msg.write("nsi", operation, nsilcmop_desc)
tiernobdebce92019-07-01 15:36:49 +00001665 return _id, None
Felipe Vicens07f31722018-10-29 15:16:44 +01001666 except ValidationError as e:
1667 raise EngineException(e, HTTPStatus.UNPROCESSABLE_ENTITY)
Felipe Vicens07f31722018-10-29 15:16:44 +01001668
tiernobee3bad2019-12-05 12:26:01 +00001669 def delete(self, session, _id, dry_run=False, not_send_msg=None):
Felipe Vicens07f31722018-10-29 15:16:44 +01001670 raise EngineException("Method delete called directly", HTTPStatus.INTERNAL_SERVER_ERROR)
1671
tierno65ca36d2019-02-12 19:27:52 +01001672 def edit(self, session, _id, indata=None, kwargs=None, content=None):
Felipe Vicens07f31722018-10-29 15:16:44 +01001673 raise EngineException("Method edit called directly", HTTPStatus.INTERNAL_SERVER_ERROR)