# -*- coding: utf-8 -*-
-import dbmongo
-import dbmemory
-import fslocal
-import msglocal
-import msgkafka
+from osm_common import dbmongo
+from osm_common import dbmemory
+from osm_common import fslocal
+from osm_common import msglocal
+from osm_common import msgkafka
import tarfile
import yaml
import json
from random import choice as random_choice
from uuid import uuid4
from hashlib import sha256, md5
-from dbbase import DbException
-from fsbase import FsException
-from msgbase import MsgException
+from osm_common.dbbase import DbException
+from osm_common.fsbase import FsException
+from osm_common.msgbase import MsgException
from http import HTTPStatus
from time import time
from copy import deepcopy
:param dict_reference: reference
:return: none
"""
-
for k in dict_reference:
if dict_reference[k] is None: # None->Anything
if k in dict_to_change:
del dict_to_change[k]
- elif not isinstance(dict_reference[k], dict): # NotDict->Anything
+ elif not isinstance(dict_reference[k], dict): # NotDict->Anything
dict_to_change[k] = dict_reference[k]
elif k not in dict_to_change: # Dict->Empty
dict_to_change[k] = deepcopy(dict_reference[k])
dict_to_change[k] = deepcopy(dict_reference[k])
_deep_update(dict_to_change[k], dict_reference[k])
+
class Engine(object):
def __init__(self):
clean_indata = clean_indata['userDefinedData']
return clean_indata
- def _validate_new_data(self, session, item, indata, id=None):
+ def _check_dependencies_on_descriptor(self, session, item, descriptor_id):
+ """
+ Check that the descriptor to be deleded is not a dependency of others
+ :param session: client session information
+ :param item: can be vnfds, nsds
+ :param descriptor_id: id of descriptor to be deleted
+ :return: None or raises exception
+ """
+ if item == "vnfds":
+ _filter = {"constituent-vnfd.ANYINDEX.vnfd-id-ref": descriptor_id}
+ if self.get_item_list(session, "nsds", _filter):
+ raise EngineException("There are nsd that depends on this VNFD", http_code=HTTPStatus.CONFLICT)
+ elif item == "nsds":
+ _filter = {"nsdId": descriptor_id}
+ if self.get_item_list(session, "nsrs", _filter):
+ raise EngineException("There are nsr that depends on this NSD", http_code=HTTPStatus.CONFLICT)
+
+ def _check_descriptor_dependencies(self, session, item, descriptor):
+ """
+ Check that the dependent descriptors exist on a new descriptor or edition
+ :param session: client session information
+ :param item: can be nsds, nsrs
+ :param descriptor: descriptor to be inserted or edit
+ :return: None or raises exception
+ """
+ if item == "nsds":
+ if not descriptor.get("constituent-vnfd"):
+ return
+ for vnf in descriptor["constituent-vnfd"]:
+ vnfd_id = vnf["vnfd-id-ref"]
+ if not self.get_item_list(session, "vnfds", {"id": vnfd_id}):
+ raise EngineException("Descriptor error at 'constituent-vnfd':'vnfd-id-ref'='{}' references a non "
+ "existing vnfd".format(vnfd_id), http_code=HTTPStatus.CONFLICT)
+ elif item == "nsrs":
+ if not descriptor.get("nsdId"):
+ return
+ nsd_id = descriptor["nsdId"]
+ if not self.get_item_list(session, "nsds", {"id": nsd_id}):
+ raise EngineException("Descriptor error at nsdId='{}' references a non exist nsd".format(nsd_id),
+ http_code=HTTPStatus.CONFLICT)
+
+ def _validate_new_data(self, session, item, indata, id=None, force=False):
if item == "users":
if not indata.get("username"):
raise EngineException("missing 'username'", HTTPStatus.UNPROCESSABLE_ENTITY)
raise EngineException("missing 'password'", HTTPStatus.UNPROCESSABLE_ENTITY)
if not indata.get("projects"):
raise EngineException("missing 'projects'", HTTPStatus.UNPROCESSABLE_ENTITY)
- # check username not exist
+ # check username not exists
if self.db.get_one(item, {"username": indata.get("username")}, fail_on_empty=False, fail_on_more=False):
- raise EngineException("username '{}' exist".format(indata["username"]), HTTPStatus.CONFLICT)
+ raise EngineException("username '{}' exists".format(indata["username"]), HTTPStatus.CONFLICT)
elif item == "projects":
if not indata.get("name"):
raise EngineException("missing 'name'")
- # check name not exist
+ # check name not exists
if self.db.get_one(item, {"name": indata.get("name")}, fail_on_empty=False, fail_on_more=False):
- raise EngineException("name '{}' exist".format(indata["name"]), HTTPStatus.CONFLICT)
+ raise EngineException("name '{}' exists".format(indata["name"]), HTTPStatus.CONFLICT)
elif item in ("vnfds", "nsds"):
filter = {"id": indata["id"]}
if id:
# TODO add admin to filter, validate rights
self._add_read_filter(session, item, filter)
if self.db.get_one(item, filter, fail_on_empty=False):
- raise EngineException("{} with id '{}' already exist for this tenant".format(item[:-1], indata["id"]),
+ raise EngineException("{} with id '{}' already exists for this tenant".format(item[:-1], indata["id"]),
HTTPStatus.CONFLICT)
# TODO validate with pyangbind
+ if item == "nsds" and not force:
+ self._check_descriptor_dependencies(session, "nsds", indata)
elif item == "userDefinedData":
# TODO validate userDefinedData is a keypair values
pass
elif item == "nsrs":
pass
elif item == "vim_accounts" or item == "sdns":
- if self.db.get_one(item, {"name": indata.get("name")}, fail_on_empty=False, fail_on_more=False):
- raise EngineException("name '{}' already exist for {}".format(indata["name"], item),
+ filter = {"name": indata.get("name")}
+ if id:
+ filter["_id.neq"] = id
+ if self.db.get_one(item, filter, fail_on_empty=False, fail_on_more=False):
+ raise EngineException("name '{}' already exists for {}".format(indata["name"], item),
HTTPStatus.CONFLICT)
+ def _check_ns_operation(self, session, nsr, operation, indata):
+ """
+ Check that user has enter right parameters for the operation
+ :param session:
+ :param operation: it can be: instantiate, terminate, action, TODO: update, heal
+ :param indata: descriptor with the parameters of the operation
+ :return: None
+ """
+ if operation == "action":
+ if indata.get("vnf_member_index"):
+ indata["member_vnf_index"] = indata.pop("vnf_member_index") # for backward compatibility
+ for vnf in nsr["nsd"]["constituent-vnfd"]:
+ if indata["member_vnf_index"] == vnf["member-vnf-index"]:
+ # TODO get vnfd, check primitives
+ break
+ else:
+ raise EngineException("Invalid parameter member_vnf_index='{}' is not one of the nsd "
+ "constituent-vnfd".format(indata["member_vnf_index"]))
+
def _format_new_data(self, session, item, indata):
now = time()
- if not "_admin" in indata:
+ if "_admin" not in indata:
indata["_admin"] = {}
indata["_admin"]["created"] = now
indata["_admin"]["modified"] = now
else:
if not indata.get("_id"):
indata["_id"] = str(uuid4())
- if item in ("vnfds", "nsds", "nsrs"):
+ if item in ("vnfds", "nsds", "nsrs", "vnfrs"):
if not indata["_admin"].get("projects_read"):
indata["_admin"]["projects_read"] = [session["project_id"]]
if not indata["_admin"].get("projects_write"):
:return: True package has is completely uploaded or False if partial content has been uplodaed.
Raise exception on error
"""
- # Check that _id exist and it is valid
+ # Check that _id exists and it is valid
current_desc = self.get_item(session, item, _id)
content_range_text = headers.get("Content-Range")
storage["pkg-dir"] = tarname_path[0]
if len(tarname_path) == 2:
if descriptor_file_name:
- raise EngineException("Found more than one descriptor file at package descriptor tar.gz")
+ raise EngineException(
+ "Found more than one descriptor file at package descriptor tar.gz")
descriptor_file_name = tarname
if not descriptor_file_name:
raise EngineException("Not found any descriptor file at package descriptor tar.gz")
def new_nsr(self, session, ns_request):
"""
- Creates a new nsr into database
+ Creates a new nsr into database. It also creates needed vnfrs
:param session: contains the used login username and working project
:param ns_request: params to be used for the nsr
- :return: nsr descriptor to be stored at database and the _id
+ :return: the _id of nsr descriptor stored at database
"""
-
- # look for nsr
- nsd = self.get_item(session, "nsds", ns_request["nsdId"])
- _id = str(uuid4())
- nsr_descriptor = {
- "name": ns_request["nsName"],
- "name-ref": ns_request["nsName"],
- "short-name": ns_request["nsName"],
- "admin-status": "ENABLED",
- "nsd": nsd,
- "datacenter": ns_request["vimAccountId"],
- "resource-orchestrator": "osmopenmano",
- "description": ns_request.get("nsDescription", ""),
- "constituent-vnfr-ref": ["TODO datacenter-id, vnfr-id"],
-
- "operational-status": "init", # typedef ns-operational-
- "config-status": "init", # typedef config-states
- "detailed-status": "scheduled",
-
- "orchestration-progress": {}, # {"networks": {"active": 0, "total": 0}, "vms": {"active": 0, "total": 0}},
-
- "crete-time": time(),
- "nsd-name-ref": nsd["name"],
- "operational-events": [], # "id", "timestamp", "description", "event",
- "nsd-ref": nsd["id"],
- "ns-instance-config-ref": _id,
- "id": _id,
- "_id": _id,
-
- # "input-parameter": xpath, value,
- "ssh-authorized-key": ns_request.get("key-pair-ref"),
- }
- ns_request["nsr_id"] = _id
- return nsr_descriptor
+ rollback = []
+ step = ""
+ try:
+ # look for nsr
+ step = "getting nsd id='{}' from database".format(ns_request.get("nsdId"))
+ nsd = self.get_item(session, "nsds", ns_request["nsdId"])
+ nsr_id = str(uuid4())
+ now = time()
+ step = "filling nsr from input data"
+ nsr_descriptor = {
+ "name": ns_request["nsName"],
+ "name-ref": ns_request["nsName"],
+ "short-name": ns_request["nsName"],
+ "admin-status": "ENABLED",
+ "nsd": nsd,
+ "datacenter": ns_request["vimAccountId"],
+ "resource-orchestrator": "osmopenmano",
+ "description": ns_request.get("nsDescription", ""),
+ "constituent-vnfr-ref": [],
+
+ "operational-status": "init", # typedef ns-operational-
+ "config-status": "init", # typedef config-states
+ "detailed-status": "scheduled",
+
+ "orchestration-progress": {},
+ # {"networks": {"active": 0, "total": 0}, "vms": {"active": 0, "total": 0}},
+
+ "crete-time": now,
+ "nsd-name-ref": nsd["name"],
+ "operational-events": [], # "id", "timestamp", "description", "event",
+ "nsd-ref": nsd["id"],
+ "instantiate_params": ns_request,
+ "ns-instance-config-ref": nsr_id,
+ "id": nsr_id,
+ "_id": nsr_id,
+ # "input-parameter": xpath, value,
+ "ssh-authorized-key": ns_request.get("key-pair-ref"),
+ }
+ ns_request["nsr_id"] = nsr_id
+
+ # Create VNFR
+ needed_vnfds = {}
+ for member_vnf in nsd["constituent-vnfd"]:
+ vnfd_id = member_vnf["vnfd-id-ref"]
+ step = "getting vnfd id='{}' constituent-vnfd='{}' from database".format(
+ member_vnf["vnfd-id-ref"], member_vnf["member-vnf-index"])
+ if vnfd_id not in needed_vnfds:
+ # Obtain vnfd
+ vnf_filter = {"id": vnfd_id}
+ self._add_read_filter(session, "vnfds", vnf_filter)
+ vnfd = self.db.get_one("vnfds", vnf_filter)
+ vnfd.pop("_admin")
+ needed_vnfds[vnfd_id] = vnfd
+ else:
+ vnfd = needed_vnfds[vnfd_id]
+ step = "filling vnfr vnfd-id='{}' constituent-vnfd='{}'".format(
+ member_vnf["vnfd-id-ref"], member_vnf["member-vnf-index"])
+ vnfr_id = str(uuid4())
+ vnfr_descriptor = {
+ "id": vnfr_id,
+ "_id": vnfr_id,
+ "nsr-id-ref": nsr_id,
+ "member-vnf-index-ref": member_vnf["member-vnf-index"],
+ "created-time": now,
+ # "vnfd": vnfd, # at OSM model.but removed to avoid data duplication TODO: revise
+ "vnfd-ref": vnfd_id,
+ "vnfd-id": vnfr_id, # not at OSM model, but useful
+ "vim-account-id": None,
+ "vdur": [],
+ "connection-point": [],
+ "ip-address": None, # mgmt-interface filled by LCM
+ }
+ for cp in vnfd.get("connection-point", ()):
+ vnf_cp = {
+ "name": cp["name"],
+ "connection-point-id": cp.get("id"),
+ "id": cp.get("id"),
+ # "ip-address", "mac-address" # filled by LCM
+ # vim-id # TODO it would be nice having a vim port id
+ }
+ vnfr_descriptor["connection-point"].append(vnf_cp)
+ for vdu in vnfd["vdu"]:
+ vdur_id = str(uuid4())
+ vdur = {
+ "id": vdur_id,
+ "vdu-id-ref": vdu["id"],
+ "ip-address": None, # mgmt-interface filled by LCM
+ # "vim-id", "flavor-id", "image-id", "management-ip" # filled by LCM
+ "internal-connection-point": [],
+ }
+ # TODO volumes: name, volume-id
+ for icp in vdu.get("internal-connection-point", ()):
+ vdu_icp = {
+ "id": icp["id"],
+ "connection-point-id": icp["id"],
+ "name": icp.get("name"),
+ # "ip-address", "mac-address" # filled by LCM
+ # vim-id # TODO it would be nice having a vim port id
+ }
+ vdur["internal-connection-point"].append(vdu_icp)
+ vnfr_descriptor["vdur"].append(vdur)
+
+ step = "creating vnfr vnfd-id='{}' constituent-vnfd='{}' at database".format(
+ member_vnf["vnfd-id-ref"], member_vnf["member-vnf-index"])
+ self._format_new_data(session, "vnfrs", vnfr_descriptor)
+ self.db.create("vnfrs", vnfr_descriptor)
+ rollback.append({"session": session, "item": "vnfrs", "_id": vnfr_id, "force": True})
+ nsr_descriptor["constituent-vnfr-ref"].append(vnfr_id)
+
+ step = "creating nsr at database"
+ self._format_new_data(session, "nsrs", nsr_descriptor)
+ self.db.create("nsrs", nsr_descriptor)
+ return nsr_id
+ except Exception as e:
+ raise EngineException("Error {}: {}".format(step, e))
+ for rollback_item in rollback:
+ try:
+ self.engine.del_item(**rollback)
+ except Exception as e2:
+ self.logger.error("Rollback Exception {}: {}".format(rollback, e2))
@staticmethod
def _update_descriptor(desc, kwargs):
"""
- Update descriptor with the kwargs
- :param kwargs:
+ Update descriptor with the kwargs. It contains dot separated keys
+ :param desc: dictionary to be updated
+ :param kwargs: plain dictionary to be used for updating.
:return:
"""
if not kwargs:
return
try:
for k, v in kwargs.items():
- update_content = content
+ update_content = desc
kitem_old = None
klist = k.split(".")
for kitem in klist:
raise EngineException(
"Invalid query string '{}'. Index '{}' out of range".format(k, kitem_old))
- def new_item(self, session, item, indata={}, kwargs=None, headers={}):
+ def new_item(self, session, item, indata={}, kwargs=None, headers={}, force=False):
"""
Creates a new entry into database. For nsds and vnfds it creates an almost empty DISABLED entry,
that must be completed with a call to method upload_content
:param indata: data to be inserted
:param kwargs: used to override the indata descriptor
:param headers: http request headers
- :return: _id, transaction_id: identity of the inserted data. or transaction_id if Content-Range is used
+ :param force: If True avoid some dependence checks
+ :return: _id: identity of the inserted data.
"""
try:
validate_input(content, item, new=True)
if item == "nsrs":
- # in this case the imput descriptor is not the data to be stored
- ns_request = content
- content = self.new_nsr(session, ns_request)
+ # in this case the input descriptor is not the data to be stored
+ return self.new_nsr(session, ns_request=content)
- self._validate_new_data(session, item_envelop, content)
+ self._validate_new_data(session, item_envelop, content, force)
if item in ("nsds", "vnfds"):
content = {"_admin": {"userDefinedData": content}}
self._format_new_data(session, item, content)
_id = self.db.create(item, content)
- if item == "nsrs":
- pass
- # self.msg.write("ns", "created", _id) # sending just for information.
- elif item == "vim_accounts":
+
+ if item == "vim_accounts":
msg_data = self.db.get_one(item, {"_id": _id})
msg_data.pop("_admin", None)
self.msg.write("vim_account", "create", msg_data)
except ValidationError as e:
raise EngineException(e, HTTPStatus.UNPROCESSABLE_ENTITY)
- def new_nslcmop(self, session, nsInstanceId, action, params):
+ def new_nslcmop(self, session, nsInstanceId, operation, params):
now = time()
_id = str(uuid4())
nslcmop = {
"operationState": "PROCESSING", # COMPLETED,PARTIALLY_COMPLETED,FAILED_TEMP,FAILED,ROLLING_BACK,ROLLED_BACK
"statusEnteredTime": now,
"nsInstanceId": nsInstanceId,
- "lcmOperationType": action,
+ "lcmOperationType": operation,
"startTime": now,
"isAutomaticInvocation": False,
"operationParams": params,
}
return nslcmop
- def ns_action(self, session, nsInstanceId, action, indata, kwargs=None):
+ def ns_operation(self, session, nsInstanceId, operation, indata, kwargs=None):
"""
- Performs a new action over a ns
+ Performs a new operation over a ns
:param session: contains the used login username and working project
- :param nsInstanceId: _id of the nsr to perform the action
- :param action: it can be: instantiate, terminate, action, TODO: update, heal
- :param indata: descriptor with the parameters of the action
+ :param nsInstanceId: _id of the nsr to perform the operation
+ :param operation: it can be: instantiate, terminate, action, TODO: update, heal
+ :param indata: descriptor with the parameters of the operation
:param kwargs: used to override the indata descriptor
:return: id of the nslcmops
"""
try:
# Override descriptor with query string kwargs
self._update_descriptor(indata, kwargs)
- validate_input(indata, "ns_" + action, new=True)
+ validate_input(indata, "ns_" + operation, new=True)
# get ns from nsr_id
nsr = self.get_item(session, "nsrs", nsInstanceId)
- if nsr["_admin"]["nsState"] == "NOT_INSTANTIATED":
- if action == "terminate" and indata.get("autoremove"):
+ if not nsr["_admin"].get("nsState") or nsr["_admin"]["nsState"] == "NOT_INSTANTIATED":
+ if operation == "terminate" and indata.get("autoremove"):
# NSR must be deleted
return self.del_item(session, "nsrs", nsInstanceId)
- if action != "instantiate":
+ if operation != "instantiate":
raise EngineException("ns_instance '{}' cannot be '{}' because it is not instantiated".format(
- nsInstanceId, action), HTTPStatus.CONFLICT)
+ nsInstanceId, operation), HTTPStatus.CONFLICT)
else:
- if action == "instantiate" and not indata.get("force"):
+ if operation == "instantiate" and not indata.get("force"):
raise EngineException("ns_instance '{}' cannot be '{}' because it is already instantiated".format(
- nsInstanceId, action), HTTPStatus.CONFLICT)
+ nsInstanceId, operation), HTTPStatus.CONFLICT)
indata["nsInstanceId"] = nsInstanceId
- # TODO
- nslcmop = self.new_nslcmop(session, nsInstanceId, action, indata)
+ self._check_ns_operation(session, nsr, operation, indata)
+ nslcmop = self.new_nslcmop(session, nsInstanceId, operation, indata)
self._format_new_data(session, "nslcmops", nslcmop)
_id = self.db.create("nslcmops", nslcmop)
indata["_id"] = _id
- self.msg.write("ns", action, nslcmop)
+ self.msg.write("ns", operation, nslcmop)
return _id
except ValidationError as e:
raise EngineException(e, HTTPStatus.UNPROCESSABLE_ENTITY)
content = self.get_item(session, item, _id)
if content["_admin"]["onboardingState"] != "ONBOARDED":
raise EngineException("Cannot get content because this resource is not at 'ONBOARDED' state. "
- "onboardingState is {}".format(content["_admin"]["onboardingState"]),
+ "onboardingState is {}".format(content["_admin"]["onboardingState"]),
http_code=HTTPStatus.CONFLICT)
storage = content["_admin"]["storage"]
if path is not None and path != "$DESCRIPTOR": # artifacts
return self.fs.file_open((storage['folder'], storage['descriptor']), "r"), "text/plain"
elif storage.get('pkg-dir') and not accept_zip:
raise EngineException("Packages that contains several files need to be retrieved with 'application/zip'"
- "Accept header", http_code=HTTPStatus.NOT_ACCEPTABLE)
+ "Accept header", http_code=HTTPStatus.NOT_ACCEPTABLE)
else:
if not storage.get('zipfile'):
# TODO generate zipfile if not present
- raise EngineException("Only allowed 'text/plain' Accept header for this descriptor. To be solved in future versions"
- "", http_code=HTTPStatus.NOT_ACCEPTABLE)
+ raise EngineException("Only allowed 'text/plain' Accept header for this descriptor. To be solved in "
+ "future versions", http_code=HTTPStatus.NOT_ACCEPTABLE)
return self.fs.file_open((storage['folder'], storage['zipfile']), "rb"), "application/zip"
def get_item_list(self, session, item, filter={}):
:param _id: server id of the item
:return: dictionary, raise exception if not found.
"""
- database_item = item
filter = {"_id": _id}
# TODO add admin to filter, validate rights
# TODO transform data for SOL005 URL requests
def del_item(self, session, item, _id, force=False):
"""
- Get complete information on an items
+ Delete item by its internal id
:param session: contains the used login username and working project
:param item: it can be: users, projects, vnfds, nsds, ...
:param _id: server id of the item
# data = self.get_item(item, _id)
filter = {"_id": _id}
self._add_delete_filter(session, item, filter)
+ if item in ("vnfds", "nsds") and not force:
+ descriptor = self.get_item(session, item, _id)
+ descriptor_id = descriptor["id"]
+ self._check_dependencies_on_descriptor(session, item, descriptor_id)
if item == "nsrs":
nsr = self.db.get_one(item, filter)
if nsr["_admin"]["nsState"] == "INSTANTIATED" and not force:
raise EngineException("nsr '{}' cannot be deleted because it is in 'INSTANTIATED' state. "
- "Launch 'terminate' action first; or force deletion".format(_id),
+ "Launch 'terminate' operation first; or force deletion".format(_id),
http_code=HTTPStatus.CONFLICT)
v = self.db.del_one(item, {"_id": _id})
self.db.del_list("nslcmops", {"nsInstanceId": _id})
+ self.db.del_list("vnfrs", {"nsr-id-ref": _id})
self.msg.write("ns", "deleted", {"_id": _id})
return v
if item in ("vim_accounts", "sdns"):
version["status"]), HTTPStatus.INTERNAL_SERVER_ERROR)
return
- def _edit_item(self, session, item, id, content, indata={}, kwargs=None):
+ def _edit_item(self, session, item, id, content, indata={}, kwargs=None, force=False):
if indata:
indata = self._remove_envelop(item, indata)
raise EngineException(
"Invalid query string '{}'. Index '{}' out of range".format(k, kitem_old))
try:
- validate_input(content, item, new=False)
+ validate_input(indata, item, new=False)
except ValidationError as e:
raise EngineException(e, HTTPStatus.UNPROCESSABLE_ENTITY)
_deep_update(content, indata)
- self._validate_new_data(session, item, content, id)
+ self._validate_new_data(session, item, content, id, force)
# self._format_new_data(session, item, content)
self.db.replace(item, id, content)
if item in ("vim_accounts", "sdns"):
self.msg.write("sdn", "edit", indata)
return id
- def edit_item(self, session, item, _id, indata={}, kwargs=None):
+ def edit_item(self, session, item, _id, indata={}, kwargs=None, force=False):
"""
Update an existing entry at database
:param session: contains the used login username and working project
:param _id: identifier to be updated
:param indata: data to be inserted
:param kwargs: used to override the indata descriptor
+ :param force: If True avoid some dependence checks
:return: dictionary, raise exception if not found.
"""
content = self.get_item(session, item, _id)
- return self._edit_item(session, item, _id, content, indata, kwargs)
-
-
-
+ return self._edit_item(session, item, _id, content, indata, kwargs, force)
projects / osm / NBI.git / blobdiff