from threading import Lock
from time import time
from traceback import format_exc as traceback_format_exc
-from typing import Any, Dict, Tuple
+from typing import Any, Dict, Tuple, Type
from uuid import uuid4
from cryptography.hazmat.backends import default_backend as crypto_default_backend
msglocal,
version as common_version,
)
-from osm_common.dbbase import DbException
-from osm_common.fsbase import FsException
+from osm_common.dbbase import DbBase, DbException
+from osm_common.fsbase import FsBase, FsException
from osm_common.msgbase import MsgException
from osm_ng_ro.ns_thread import deep_get, NsWorker, NsWorkerException
from osm_ng_ro.validation import deploy_schema, validate_input
self.next_worker = 0
self.plugins = {}
self.workers = []
+ self.process_params_function_map = {
+ "net": Ns._process_net_params,
+ "image": Ns._process_image_params,
+ "flavor": Ns._process_flavor_params,
+ "vdu": Ns._process_vdu_params,
+ }
+ self.db_path_map = {
+ "net": "vld",
+ "image": "image",
+ "flavor": "flavor",
+ "vdu": "vdur",
+ }
def init_db(self, target_version):
pass
for target_id in vims_to_unload:
self._unload_vim(target_id)
- def _get_cloud_init(self, where):
- """
- Not used as cloud init content is provided in the http body. This method reads cloud init from a file
- :param where: can be 'vnfr_id:file:file_name' or 'vnfr_id:vdu:vdu_idex'
- :return:
+ @staticmethod
+ def _get_cloud_init(
+ db: Type[DbBase],
+ fs: Type[FsBase],
+ location: str,
+ ) -> str:
+ """This method reads cloud init from a file.
+
+ Note: Not used as cloud init content is provided in the http body.
+
+ Args:
+ db (Type[DbBase]): [description]
+ fs (Type[FsBase]): [description]
+ location (str): can be 'vnfr_id:file:file_name' or 'vnfr_id:vdu:vdu_idex'
+
+ Raises:
+ NsException: [description]
+ NsException: [description]
+
+ Returns:
+ str: [description]
"""
- vnfd_id, _, other = where.partition(":")
+ vnfd_id, _, other = location.partition(":")
_type, _, name = other.partition(":")
- vnfd = self.db.get_one("vnfds", {"_id": vnfd_id})
+ vnfd = db.get_one("vnfds", {"_id": vnfd_id})
if _type == "file":
base_folder = vnfd["_admin"]["storage"]
base_folder["folder"], base_folder["pkg-dir"], name
)
- if not self.fs:
+ if not fs:
raise NsException(
"Cannot read file '{}'. Filesystem not loaded, change configuration at storage.driver".format(
cloud_init_file
)
)
- with self.fs.file_open(cloud_init_file, "r") as ci_file:
+ with fs.file_open(cloud_init_file, "r") as ci_file:
cloud_init_content = ci_file.read()
elif _type == "vdu":
cloud_init_content = vnfd["vdu"][int(name)]["cloud-init"]
else:
- raise NsException("Mismatch descriptor for cloud init: {}".format(where))
+ raise NsException("Mismatch descriptor for cloud init: {}".format(location))
return cloud_init_content
- def _parse_jinja2(self, cloud_init_content, params, context):
+ @staticmethod
+ def _parse_jinja2(
+ cloud_init_content: str,
+ params: Dict[str, Any],
+ context: str,
+ ) -> str:
+ """Function that processes the cloud init to replace Jinja2 encoded parameters.
+
+ Args:
+ cloud_init_content (str): [description]
+ params (Dict[str, Any]): [description]
+ context (str): [description]
+
+ Raises:
+ NsException: [description]
+ NsException: [description]
+
+ Returns:
+ str: [description]
+ """
try:
env = Environment(undefined=StrictUndefined)
template = env.from_string(cloud_init_content)
indata: Dict[str, Any],
vim_info: Dict[str, Any],
target_record_id: str,
+ **kwargs: Dict[str, Any],
) -> Dict[str, Any]:
"""Function to process VDU image parameters.
indata: Dict[str, Any],
vim_info: Dict[str, Any],
target_record_id: str,
+ **kwargs: Dict[str, Any],
) -> Dict[str, Any]:
"""[summary]
indata: Dict[str, Any],
vim_info: Dict[str, Any],
target_record_id: str,
+ **kwargs: Dict[str, Any],
) -> Dict[str, Any]:
"""Function to process network parameters.
return extra_dict
- def deploy(self, session, indata, version, nsr_id, *args, **kwargs):
- self.logger.debug("ns.deploy nsr_id={} indata={}".format(nsr_id, indata))
- validate_input(indata, deploy_schema)
- action_id = indata.get("action_id", str(uuid4()))
- task_index = 0
- # get current deployment
- db_nsr_update = {} # update operation on nsrs
- db_vnfrs_update = {}
- db_vnfrs = {} # vnf's info indexed by _id
- nb_ro_tasks = 0 # for logging
- vdu2cloud_init = indata.get("cloud_init_content") or {}
- step = ""
- logging_text = "Task deploy nsr_id={} action_id={} ".format(nsr_id, action_id)
- self.logger.debug(logging_text + "Enter")
+ @staticmethod
+ def _process_vdu_params(
+ target_vdu: Dict[str, Any],
+ indata: Dict[str, Any],
+ vim_info: Dict[str, Any],
+ target_record_id: str,
+ **kwargs: Dict[str, Any],
+ ) -> Dict[str, Any]:
+ """Function to process VDU parameters.
- try:
- step = "Getting ns and vnfr record from db"
- db_nsr = self.db.get_one("nsrs", {"_id": nsr_id})
- db_new_tasks = []
- tasks_by_target_record_id = {}
- # read from db: vnf's of this ns
- step = "Getting vnfrs from db"
- db_vnfrs_list = self.db.get_list("vnfrs", {"nsr-id-ref": nsr_id})
+ Args:
+ target_vdu (Dict[str, Any]): [description]
+ indata (Dict[str, Any]): [description]
+ vim_info (Dict[str, Any]): [description]
+ target_record_id (str): [description]
- if not db_vnfrs_list:
- raise NsException("Cannot obtain associated VNF for ns")
+ Returns:
+ Dict[str, Any]: [description]
+ """
+ vnfr_id = kwargs.get("vnfr_id")
+ nsr_id = kwargs.get("nsr_id")
+ vnfr = kwargs.get("vnfr")
+ vdu2cloud_init = kwargs.get("vdu2cloud_init")
+ tasks_by_target_record_id = kwargs.get("tasks_by_target_record_id")
+ logger = kwargs.get("logger")
+ db = kwargs.get("db")
+ fs = kwargs.get("fs")
+ ro_nsr_public_key = kwargs.get("ro_nsr_public_key")
+
+ vnf_preffix = "vnfrs:{}".format(vnfr_id)
+ ns_preffix = "nsrs:{}".format(nsr_id)
+ image_text = ns_preffix + ":image." + target_vdu["ns-image-id"]
+ flavor_text = ns_preffix + ":flavor." + target_vdu["ns-flavor-id"]
+ extra_dict = {"depends_on": [image_text, flavor_text]}
+ net_list = []
+
+ for iface_index, interface in enumerate(target_vdu["interfaces"]):
+ if interface.get("ns-vld-id"):
+ net_text = ns_preffix + ":vld." + interface["ns-vld-id"]
+ elif interface.get("vnf-vld-id"):
+ net_text = vnf_preffix + ":vld." + interface["vnf-vld-id"]
+ else:
+ logger.error(
+ "Interface {} from vdu {} not connected to any vld".format(
+ iface_index, target_vdu["vdu-name"]
+ )
+ )
- for vnfr in db_vnfrs_list:
- db_vnfrs[vnfr["_id"]] = vnfr
- db_vnfrs_update[vnfr["_id"]] = {}
+ continue # interface not connected to any vld
- now = time()
- db_ro_nsr = self.db.get_one("ro_nsrs", {"_id": nsr_id}, fail_on_empty=False)
+ extra_dict["depends_on"].append(net_text)
- if not db_ro_nsr:
- db_ro_nsr = self._create_db_ro_nsrs(nsr_id, now)
+ if "port-security-enabled" in interface:
+ interface["port_security"] = interface.pop("port-security-enabled")
- ro_nsr_public_key = db_ro_nsr["public_key"]
+ if "port-security-disable-strategy" in interface:
+ interface["port_security_disable_strategy"] = interface.pop(
+ "port-security-disable-strategy"
+ )
- # check that action_id is not in the list of actions. Suffixed with :index
- if action_id in db_ro_nsr["actions"]:
- index = 1
+ net_item = {
+ x: v
+ for x, v in interface.items()
+ if x
+ in (
+ "name",
+ "vpci",
+ "port_security",
+ "port_security_disable_strategy",
+ "floating_ip",
+ )
+ }
+ net_item["net_id"] = "TASK-" + net_text
+ net_item["type"] = "virtual"
+
+ # TODO mac_address: used for SR-IOV ifaces #TODO for other types
+ # TODO floating_ip: True/False (or it can be None)
+ if interface.get("type") in ("SR-IOV", "PCI-PASSTHROUGH"):
+ # mark the net create task as type data
+ if deep_get(
+ tasks_by_target_record_id,
+ net_text,
+ "extra_dict",
+ "params",
+ "net_type",
+ ):
+ tasks_by_target_record_id[net_text]["extra_dict"]["params"][
+ "net_type"
+ ] = "data"
+
+ net_item["use"] = "data"
+ net_item["model"] = interface["type"]
+ net_item["type"] = interface["type"]
+ elif (
+ interface.get("type") == "OM-MGMT"
+ or interface.get("mgmt-interface")
+ or interface.get("mgmt-vnf")
+ ):
+ net_item["use"] = "mgmt"
+ else:
+ # if interface.get("type") in ("VIRTIO", "E1000", "PARAVIRT"):
+ net_item["use"] = "bridge"
+ net_item["model"] = interface.get("type")
- while True:
- new_action_id = "{}:{}".format(action_id, index)
+ if interface.get("ip-address"):
+ net_item["ip_address"] = interface["ip-address"]
- if new_action_id not in db_ro_nsr["actions"]:
- action_id = new_action_id
- self.logger.debug(
- logging_text
- + "Changing action_id in use to {}".format(action_id)
- )
- break
+ if interface.get("mac-address"):
+ net_item["mac_address"] = interface["mac-address"]
- index += 1
+ net_list.append(net_item)
- def _process_vdu_params(target_vdu, indata, vim_info, target_record_id):
- nonlocal vnfr_id
- nonlocal nsr_id
- nonlocal vnfr
- nonlocal vdu2cloud_init
- nonlocal tasks_by_target_record_id
-
- vnf_preffix = "vnfrs:{}".format(vnfr_id)
- ns_preffix = "nsrs:{}".format(nsr_id)
- image_text = ns_preffix + ":image." + target_vdu["ns-image-id"]
- flavor_text = ns_preffix + ":flavor." + target_vdu["ns-flavor-id"]
- extra_dict = {"depends_on": [image_text, flavor_text]}
- net_list = []
-
- for iface_index, interface in enumerate(target_vdu["interfaces"]):
- if interface.get("ns-vld-id"):
- net_text = ns_preffix + ":vld." + interface["ns-vld-id"]
- elif interface.get("vnf-vld-id"):
- net_text = vnf_preffix + ":vld." + interface["vnf-vld-id"]
- else:
- self.logger.error(
- "Interface {} from vdu {} not connected to any vld".format(
- iface_index, target_vdu["vdu-name"]
- )
- )
+ if interface.get("mgmt-vnf"):
+ extra_dict["mgmt_vnf_interface"] = iface_index
+ elif interface.get("mgmt-interface"):
+ extra_dict["mgmt_vdu_interface"] = iface_index
+
+ # cloud config
+ cloud_config = {}
- continue # interface not connected to any vld
+ if target_vdu.get("cloud-init"):
+ if target_vdu["cloud-init"] not in vdu2cloud_init:
+ vdu2cloud_init[target_vdu["cloud-init"]] = Ns._get_cloud_init(
+ db=db,
+ fs=fs,
+ location=target_vdu["cloud-init"],
+ )
- extra_dict["depends_on"].append(net_text)
+ cloud_content_ = vdu2cloud_init[target_vdu["cloud-init"]]
+ cloud_config["user-data"] = Ns._parse_jinja2(
+ cloud_init_content=cloud_content_,
+ params=target_vdu.get("additionalParams"),
+ context=target_vdu["cloud-init"],
+ )
- if "port-security-enabled" in interface:
- interface["port_security"] = interface.pop(
- "port-security-enabled"
- )
+ if target_vdu.get("boot-data-drive"):
+ cloud_config["boot-data-drive"] = target_vdu.get("boot-data-drive")
- if "port-security-disable-strategy" in interface:
- interface["port_security_disable_strategy"] = interface.pop(
- "port-security-disable-strategy"
- )
+ ssh_keys = []
- net_item = {
- x: v
- for x, v in interface.items()
- if x
- in (
- "name",
- "vpci",
- "port_security",
- "port_security_disable_strategy",
- "floating_ip",
- )
+ if target_vdu.get("ssh-keys"):
+ ssh_keys += target_vdu.get("ssh-keys")
+
+ if target_vdu.get("ssh-access-required"):
+ ssh_keys.append(ro_nsr_public_key)
+
+ if ssh_keys:
+ cloud_config["key-pairs"] = ssh_keys
+
+ disk_list = None
+ if target_vdu.get("virtual-storages"):
+ disk_list = [
+ {"size": disk["size-of-storage"]}
+ for disk in target_vdu["virtual-storages"]
+ if disk.get("type-of-storage")
+ == "persistent-storage:persistent-storage"
+ ]
+
+ extra_dict["params"] = {
+ "name": "{}-{}-{}-{}".format(
+ indata["name"][:16],
+ vnfr["member-vnf-index-ref"][:16],
+ target_vdu["vdu-name"][:32],
+ target_vdu.get("count-index") or 0,
+ ),
+ "description": target_vdu["vdu-name"],
+ "start": True,
+ "image_id": "TASK-" + image_text,
+ "flavor_id": "TASK-" + flavor_text,
+ "net_list": net_list,
+ "cloud_config": cloud_config or None,
+ "disk_list": disk_list,
+ "availability_zone_index": None, # TODO
+ "availability_zone_list": None, # TODO
+ }
+
+ return extra_dict
+
+ def calculate_diff_items(
+ self,
+ indata,
+ db_nsr,
+ db_ro_nsr,
+ db_nsr_update,
+ item,
+ tasks_by_target_record_id,
+ action_id,
+ nsr_id,
+ task_index,
+ vnfr_id=None,
+ vnfr=None,
+ ):
+ """Function that returns the incremental changes (creation, deletion)
+ related to a specific item `item` to be done. This function should be
+ called for NS instantiation, NS termination, NS update to add a new VNF
+ or a new VLD, remove a VNF or VLD, etc.
+ Item can be `net, `flavor`, `image` or `vdu`.
+ It takes a list of target items from indata (which came from the REST API)
+ and compares with the existing items from db_ro_nsr, identifying the
+ incremental changes to be done. During the comparison, it calls the method
+ `process_params` (which was passed as parameter, and is particular for each
+ `item`)
+
+ Args:
+ indata (Dict[str, Any]): deployment info
+ db_nsr: NSR record from DB
+ db_ro_nsr (Dict[str, Any]): record from "ro_nsrs"
+ db_nsr_update (Dict[str, Any]): NSR info to update in DB
+ item (str): element to process (net, vdu...)
+ tasks_by_target_record_id (Dict[str, Any]):
+ [<target_record_id>, <task>]
+ action_id (str): action id
+ nsr_id (str): NSR id
+ task_index (number): task index to add to task name
+ vnfr_id (str): VNFR id
+ vnfr (Dict[str, Any]): VNFR info
+
+ Returns:
+ List: list with the incremental changes (deletes, creates) for each item
+ number: current task index
+ """
+
+ diff_items = []
+ db_path = ""
+ db_record = ""
+ target_list = []
+ existing_list = []
+ process_params = None
+ vdu2cloud_init = indata.get("cloud_init_content") or {}
+ ro_nsr_public_key = db_ro_nsr["public_key"]
+
+ # According to the type of item, the path, the target_list,
+ # the existing_list and the method to process params are set
+ db_path = self.db_path_map[item]
+ process_params = self.process_params_function_map[item]
+ if item in ("net", "vdu"):
+ if vnfr is None:
+ db_record = "nsrs:{}:{}".format(nsr_id, db_path)
+ target_list = indata.get("ns", []).get(db_path, [])
+ existing_list = db_nsr.get(db_path, [])
+ else:
+ db_record = "vnfrs:{}:{}".format(vnfr_id, db_path)
+ target_vnf = next(
+ (vnf for vnf in indata.get("vnf", ()) if vnf["_id"] == vnfr_id),
+ None,
+ )
+ target_list = target_vnf.get(db_path, []) if target_vnf else []
+ existing_list = vnfr.get(db_path, [])
+ elif item in ("image", "flavor"):
+ db_record = "nsrs:{}:{}".format(nsr_id, db_path)
+ target_list = indata.get(item, [])
+ existing_list = db_nsr.get(item, [])
+ else:
+ raise NsException("Item not supported: {}", item)
+
+ # ensure all the target_list elements has an "id". If not assign the index as id
+ if target_list is None:
+ target_list = []
+ for target_index, tl in enumerate(target_list):
+ if tl and not tl.get("id"):
+ tl["id"] = str(target_index)
+
+ # step 1 items (networks,vdus,...) to be deleted/updated
+ for item_index, existing_item in enumerate(existing_list):
+ target_item = next(
+ (t for t in target_list if t["id"] == existing_item["id"]),
+ None,
+ )
+
+ for target_vim, existing_viminfo in existing_item.get(
+ "vim_info", {}
+ ).items():
+ if existing_viminfo is None:
+ continue
+
+ if target_item:
+ target_viminfo = target_item.get("vim_info", {}).get(target_vim)
+ else:
+ target_viminfo = None
+
+ if target_viminfo is None:
+ # must be deleted
+ self._assign_vim(target_vim)
+ target_record_id = "{}.{}".format(db_record, existing_item["id"])
+ item_ = item
+
+ if target_vim.startswith("sdn"):
+ # item must be sdn-net instead of net if target_vim is a sdn
+ item_ = "sdn_net"
+ target_record_id += ".sdn"
+
+ deployment_info = {
+ "action_id": action_id,
+ "nsr_id": nsr_id,
+ "task_index": task_index,
}
- net_item["net_id"] = "TASK-" + net_text
- net_item["type"] = "virtual"
-
- # TODO mac_address: used for SR-IOV ifaces #TODO for other types
- # TODO floating_ip: True/False (or it can be None)
- if interface.get("type") in ("SR-IOV", "PCI-PASSTHROUGH"):
- # mark the net create task as type data
- if deep_get(
- tasks_by_target_record_id, net_text, "params", "net_type"
- ):
- tasks_by_target_record_id[net_text]["params"][
- "net_type"
- ] = "data"
-
- net_item["use"] = "data"
- net_item["model"] = interface["type"]
- net_item["type"] = interface["type"]
- elif (
- interface.get("type") == "OM-MGMT"
- or interface.get("mgmt-interface")
- or interface.get("mgmt-vnf")
- ):
- net_item["use"] = "mgmt"
- else:
- # if interface.get("type") in ("VIRTIO", "E1000", "PARAVIRT"):
- net_item["use"] = "bridge"
- net_item["model"] = interface.get("type")
- if interface.get("ip-address"):
- net_item["ip_address"] = interface["ip-address"]
+ diff_items.append(
+ {
+ "deployment_info": deployment_info,
+ "target_id": target_vim,
+ "item": item_,
+ "action": "DELETE",
+ "target_record": f"{db_record}.{item_index}.vim_info.{target_vim}",
+ "target_record_id": target_record_id,
+ }
+ )
+ task_index += 1
- if interface.get("mac-address"):
- net_item["mac_address"] = interface["mac-address"]
+ # step 2 items (networks,vdus,...) to be created
+ for target_item in target_list:
+ item_index = -1
- net_list.append(net_item)
+ for item_index, existing_item in enumerate(existing_list):
+ if existing_item["id"] == target_item["id"]:
+ break
+ else:
+ item_index += 1
+ db_nsr_update[db_path + ".{}".format(item_index)] = target_item
+ existing_list.append(target_item)
+ existing_item = None
- if interface.get("mgmt-vnf"):
- extra_dict["mgmt_vnf_interface"] = iface_index
- elif interface.get("mgmt-interface"):
- extra_dict["mgmt_vdu_interface"] = iface_index
+ for target_vim, target_viminfo in target_item.get("vim_info", {}).items():
+ existing_viminfo = None
- # cloud config
- cloud_config = {}
+ if existing_item:
+ existing_viminfo = existing_item.get("vim_info", {}).get(target_vim)
- if target_vdu.get("cloud-init"):
- if target_vdu["cloud-init"] not in vdu2cloud_init:
- vdu2cloud_init[target_vdu["cloud-init"]] = self._get_cloud_init(
- target_vdu["cloud-init"]
- )
+ if existing_viminfo is not None:
+ continue
- cloud_content_ = vdu2cloud_init[target_vdu["cloud-init"]]
- cloud_config["user-data"] = self._parse_jinja2(
- cloud_content_,
- target_vdu.get("additionalParams"),
- target_vdu["cloud-init"],
+ target_record_id = "{}.{}".format(db_record, target_item["id"])
+ item_ = item
+
+ if target_vim.startswith("sdn"):
+ # item must be sdn-net instead of net if target_vim is a sdn
+ item_ = "sdn_net"
+ target_record_id += ".sdn"
+
+ kwargs = {}
+ if process_params == Ns._process_vdu_params:
+ kwargs.update(
+ {
+ "vnfr_id": vnfr_id,
+ "nsr_id": nsr_id,
+ "vnfr": vnfr,
+ "vdu2cloud_init": vdu2cloud_init,
+ "tasks_by_target_record_id": tasks_by_target_record_id,
+ "logger": self.logger,
+ "db": self.db,
+ "fs": self.fs,
+ "ro_nsr_public_key": ro_nsr_public_key,
+ }
)
- if target_vdu.get("boot-data-drive"):
- cloud_config["boot-data-drive"] = target_vdu.get("boot-data-drive")
-
- ssh_keys = []
-
- if target_vdu.get("ssh-keys"):
- ssh_keys += target_vdu.get("ssh-keys")
-
- if target_vdu.get("ssh-access-required"):
- ssh_keys.append(ro_nsr_public_key)
-
- if ssh_keys:
- cloud_config["key-pairs"] = ssh_keys
-
- disk_list = None
- if target_vdu.get("virtual-storages"):
- disk_list = [
- {"size": disk["size-of-storage"]}
- for disk in target_vdu["virtual-storages"]
- if disk.get("type-of-storage")
- == "persistent-storage:persistent-storage"
- ]
-
- extra_dict["params"] = {
- "name": "{}-{}-{}-{}".format(
- indata["name"][:16],
- vnfr["member-vnf-index-ref"][:16],
- target_vdu["vdu-name"][:32],
- target_vdu.get("count-index") or 0,
- ),
- "description": target_vdu["vdu-name"],
- "start": True,
- "image_id": "TASK-" + image_text,
- "flavor_id": "TASK-" + flavor_text,
- "net_list": net_list,
- "cloud_config": cloud_config or None,
- "disk_list": disk_list,
- "availability_zone_index": None, # TODO
- "availability_zone_list": None, # TODO
+ extra_dict = process_params(
+ target_item,
+ indata,
+ target_viminfo,
+ target_record_id,
+ **kwargs,
+ )
+ self._assign_vim(target_vim)
+
+ deployment_info = {
+ "action_id": action_id,
+ "nsr_id": nsr_id,
+ "task_index": task_index,
}
- return extra_dict
+ new_item = {
+ "deployment_info": deployment_info,
+ "target_id": target_vim,
+ "item": item_,
+ "action": "CREATE",
+ "target_record": f"{db_record}.{item_index}.vim_info.{target_vim}",
+ "target_record_id": target_record_id,
+ "extra_dict": extra_dict,
+ "common_id": target_item.get("common_id", None),
+ }
+ diff_items.append(new_item)
+ tasks_by_target_record_id[target_record_id] = new_item
+ task_index += 1
+
+ db_nsr_update[db_path + ".{}".format(item_index)] = target_item
+
+ return diff_items, task_index
+
+ def calculate_all_differences_to_deploy(
+ self,
+ indata,
+ nsr_id,
+ db_nsr,
+ db_vnfrs,
+ db_ro_nsr,
+ db_nsr_update,
+ db_vnfrs_update,
+ action_id,
+ tasks_by_target_record_id,
+ ):
+ """This method calculates the ordered list of items (`changes_list`)
+ to be created and deleted.
- def _process_items(
- target_list,
- existing_list,
- db_record,
- db_update,
- db_path,
- item,
- process_params,
- ):
- nonlocal db_new_tasks
- nonlocal tasks_by_target_record_id
- nonlocal action_id
- nonlocal nsr_id
- nonlocal task_index
- nonlocal indata
+ Args:
+ indata (Dict[str, Any]): deployment info
+ nsr_id (str): NSR id
+ db_nsr: NSR record from DB
+ db_vnfrs: VNFRS record from DB
+ db_ro_nsr (Dict[str, Any]): record from "ro_nsrs"
+ db_nsr_update (Dict[str, Any]): NSR info to update in DB
+ db_vnfrs_update (Dict[str, Any]): VNFRS info to update in DB
+ action_id (str): action id
+ tasks_by_target_record_id (Dict[str, Any]):
+ [<target_record_id>, <task>]
- # ensure all the target_list elements has an "id". If not assign the index as id
- for target_index, tl in enumerate(target_list):
- if tl and not tl.get("id"):
- tl["id"] = str(target_index)
+ Returns:
+ List: ordered list of items to be created and deleted.
+ """
- # step 1 items (networks,vdus,...) to be deleted/updated
- for item_index, existing_item in enumerate(existing_list):
- target_item = next(
- (t for t in target_list if t["id"] == existing_item["id"]), None
- )
+ task_index = 0
+ # set list with diffs:
+ changes_list = []
+
+ # NS vld, image and flavor
+ for item in ["net", "image", "flavor"]:
+ self.logger.debug("process NS={} {}".format(nsr_id, item))
+ diff_items, task_index = self.calculate_diff_items(
+ indata=indata,
+ db_nsr=db_nsr,
+ db_ro_nsr=db_ro_nsr,
+ db_nsr_update=db_nsr_update,
+ item=item,
+ tasks_by_target_record_id=tasks_by_target_record_id,
+ action_id=action_id,
+ nsr_id=nsr_id,
+ task_index=task_index,
+ vnfr_id=None,
+ )
+ changes_list += diff_items
+
+ # VNF vlds and vdus
+ for vnfr_id, vnfr in db_vnfrs.items():
+ # vnfr_id need to be set as global variable for among others nested method _process_vdu_params
+ for item in ["net", "vdu"]:
+ self.logger.debug("process VNF={} {}".format(vnfr_id, item))
+ diff_items, task_index = self.calculate_diff_items(
+ indata=indata,
+ db_nsr=db_nsr,
+ db_ro_nsr=db_ro_nsr,
+ db_nsr_update=db_vnfrs_update[vnfr["_id"]],
+ item=item,
+ tasks_by_target_record_id=tasks_by_target_record_id,
+ action_id=action_id,
+ nsr_id=nsr_id,
+ task_index=task_index,
+ vnfr_id=vnfr_id,
+ vnfr=vnfr,
+ )
+ changes_list += diff_items
- for target_vim, existing_viminfo in existing_item.get(
- "vim_info", {}
- ).items():
- if existing_viminfo is None:
- continue
+ return changes_list
- if target_item:
- target_viminfo = target_item.get("vim_info", {}).get(
- target_vim
- )
- else:
- target_viminfo = None
+ def define_all_tasks(
+ self,
+ changes_list,
+ db_new_tasks,
+ tasks_by_target_record_id,
+ ):
+ """Function to create all the task structures obtanied from
+ the method calculate_all_differences_to_deploy
- if target_viminfo is None:
- # must be deleted
- self._assign_vim(target_vim)
- target_record_id = "{}.{}".format(
- db_record, existing_item["id"]
- )
- item_ = item
+ Args:
+ changes_list (List): ordered list of items to be created or deleted
+ db_new_tasks (List): tasks list to be created
+ action_id (str): action id
+ tasks_by_target_record_id (Dict[str, Any]):
+ [<target_record_id>, <task>]
- if target_vim.startswith("sdn"):
- # item must be sdn-net instead of net if target_vim is a sdn
- item_ = "sdn_net"
- target_record_id += ".sdn"
+ """
- deployment_info = {
- "action_id": action_id,
- "nsr_id": nsr_id,
- "task_index": task_index,
- }
+ for change in changes_list:
+ task = Ns._create_task(
+ deployment_info=change["deployment_info"],
+ target_id=change["target_id"],
+ item=change["item"],
+ action=change["action"],
+ target_record=change["target_record"],
+ target_record_id=change["target_record_id"],
+ extra_dict=change.get("extra_dict", None),
+ )
- task = Ns._create_task(
- deployment_info=deployment_info,
- target_id=target_vim,
- item=item_,
- action="DELETE",
- target_record=f"{db_record}.{item_index}.vim_info.{target_vim}",
- target_record_id=target_record_id,
- )
+ tasks_by_target_record_id[change["target_record_id"]] = task
+ db_new_tasks.append(task)
- task_index = deployment_info.get("task_index")
+ if change.get("common_id"):
+ task["common_id"] = change["common_id"]
- tasks_by_target_record_id[target_record_id] = task
- db_new_tasks.append(task)
- # TODO delete
- # TODO check one by one the vims to be created/deleted
+ def upload_all_tasks(
+ self,
+ db_new_tasks,
+ now,
+ ):
+ """Function to save all tasks in the common DB
- # step 2 items (networks,vdus,...) to be created
- for target_item in target_list:
- item_index = -1
+ Args:
+ db_new_tasks (List): tasks list to be created
+ now (time): current time
- for item_index, existing_item in enumerate(existing_list):
- if existing_item["id"] == target_item["id"]:
- break
- else:
- item_index += 1
- db_update[db_path + ".{}".format(item_index)] = target_item
- existing_list.append(target_item)
- existing_item = None
-
- for target_vim, target_viminfo in target_item.get(
- "vim_info", {}
- ).items():
- existing_viminfo = None
-
- if existing_item:
- existing_viminfo = existing_item.get("vim_info", {}).get(
- target_vim
- )
+ """
- # TODO check if different. Delete and create???
- # TODO delete if not exist
- if existing_viminfo is not None:
- continue
+ nb_ro_tasks = 0 # for logging
- target_record_id = "{}.{}".format(db_record, target_item["id"])
- item_ = item
+ for db_task in db_new_tasks:
+ target_id = db_task.pop("target_id")
+ common_id = db_task.get("common_id")
- if target_vim.startswith("sdn"):
- # item must be sdn-net instead of net if target_vim is a sdn
- item_ = "sdn_net"
- target_record_id += ".sdn"
+ if common_id:
+ if self.db.set_one(
+ "ro_tasks",
+ q_filter={
+ "target_id": target_id,
+ "tasks.common_id": common_id,
+ },
+ update_dict={"to_check_at": now, "modified_at": now},
+ push={"tasks": db_task},
+ fail_on_empty=False,
+ ):
+ continue
- extra_dict = process_params(
- target_item, indata, target_viminfo, target_record_id
- )
- self._assign_vim(target_vim)
+ if not self.db.set_one(
+ "ro_tasks",
+ q_filter={
+ "target_id": target_id,
+ "tasks.target_record": db_task["target_record"],
+ },
+ update_dict={"to_check_at": now, "modified_at": now},
+ push={"tasks": db_task},
+ fail_on_empty=False,
+ ):
+ # Create a ro_task
+ self.logger.debug("Updating database, Creating ro_tasks")
+ db_ro_task = Ns._create_ro_task(target_id, db_task)
+ nb_ro_tasks += 1
+ self.db.create("ro_tasks", db_ro_task)
+
+ self.logger.debug(
+ "Created {} ro_tasks; {} tasks - db_new_tasks={}".format(
+ nb_ro_tasks, len(db_new_tasks), db_new_tasks
+ )
+ )
- deployment_info = {
- "action_id": action_id,
- "nsr_id": nsr_id,
- "task_index": task_index,
- }
+ def deploy(self, session, indata, version, nsr_id, *args, **kwargs):
+ self.logger.debug("ns.deploy nsr_id={} indata={}".format(nsr_id, indata))
+ validate_input(indata, deploy_schema)
+ action_id = indata.get("action_id", str(uuid4()))
+ task_index = 0
+ # get current deployment
+ db_nsr_update = {} # update operation on nsrs
+ db_vnfrs_update = {}
+ db_vnfrs = {} # vnf's info indexed by _id
+ step = ""
+ logging_text = "Task deploy nsr_id={} action_id={} ".format(nsr_id, action_id)
+ self.logger.debug(logging_text + "Enter")
- task = Ns._create_task(
- deployment_info=deployment_info,
- target_id=target_vim,
- item=item_,
- action="CREATE",
- target_record=f"{db_record}.{item_index}.vim_info.{target_vim}",
- target_record_id=target_record_id,
- extra_dict=extra_dict,
- )
+ try:
+ step = "Getting ns and vnfr record from db"
+ db_nsr = self.db.get_one("nsrs", {"_id": nsr_id})
+ db_new_tasks = []
+ tasks_by_target_record_id = {}
+ # read from db: vnf's of this ns
+ step = "Getting vnfrs from db"
+ db_vnfrs_list = self.db.get_list("vnfrs", {"nsr-id-ref": nsr_id})
+
+ if not db_vnfrs_list:
+ raise NsException("Cannot obtain associated VNF for ns")
+
+ for vnfr in db_vnfrs_list:
+ db_vnfrs[vnfr["_id"]] = vnfr
+ db_vnfrs_update[vnfr["_id"]] = {}
+
+ now = time()
+ db_ro_nsr = self.db.get_one("ro_nsrs", {"_id": nsr_id}, fail_on_empty=False)
- task_index = deployment_info.get("task_index")
+ if not db_ro_nsr:
+ db_ro_nsr = self._create_db_ro_nsrs(nsr_id, now)
- tasks_by_target_record_id[target_record_id] = task
- db_new_tasks.append(task)
+ # check that action_id is not in the list of actions. Suffixed with :index
+ if action_id in db_ro_nsr["actions"]:
+ index = 1
- if target_item.get("common_id"):
- task["common_id"] = target_item["common_id"]
+ while True:
+ new_action_id = "{}:{}".format(action_id, index)
- db_update[db_path + ".{}".format(item_index)] = target_item
+ if new_action_id not in db_ro_nsr["actions"]:
+ action_id = new_action_id
+ self.logger.debug(
+ logging_text
+ + "Changing action_id in use to {}".format(action_id)
+ )
+ break
+
+ index += 1
def _process_action(indata):
nonlocal db_new_tasks
_process_action(indata)
else:
# compute network differences
- # NS.vld
- step = "process NS VLDs"
- _process_items(
- target_list=indata["ns"]["vld"] or [],
- existing_list=db_nsr.get("vld") or [],
- db_record="nsrs:{}:vld".format(nsr_id),
- db_update=db_nsr_update,
- db_path="vld",
- item="net",
- process_params=Ns._process_net_params,
+ # NS
+ step = "process NS elements"
+ changes_list = self.calculate_all_differences_to_deploy(
+ indata=indata,
+ nsr_id=nsr_id,
+ db_nsr=db_nsr,
+ db_vnfrs=db_vnfrs,
+ db_ro_nsr=db_ro_nsr,
+ db_nsr_update=db_nsr_update,
+ db_vnfrs_update=db_vnfrs_update,
+ action_id=action_id,
+ tasks_by_target_record_id=tasks_by_target_record_id,
)
-
- step = "process NS images"
- _process_items(
- target_list=indata.get("image") or [],
- existing_list=db_nsr.get("image") or [],
- db_record="nsrs:{}:image".format(nsr_id),
- db_update=db_nsr_update,
- db_path="image",
- item="image",
- process_params=Ns._process_image_params,
+ self.define_all_tasks(
+ changes_list=changes_list,
+ db_new_tasks=db_new_tasks,
+ tasks_by_target_record_id=tasks_by_target_record_id,
)
- step = "process NS flavors"
- _process_items(
- target_list=indata.get("flavor") or [],
- existing_list=db_nsr.get("flavor") or [],
- db_record="nsrs:{}:flavor".format(nsr_id),
- db_update=db_nsr_update,
- db_path="flavor",
- item="flavor",
- process_params=Ns._process_flavor_params,
- )
-
- # VNF.vld
- for vnfr_id, vnfr in db_vnfrs.items():
- # vnfr_id need to be set as global variable for among others nested method _process_vdu_params
- step = "process VNF={} VLDs".format(vnfr_id)
- target_vnf = next(
- (
- vnf
- for vnf in indata.get("vnf", ())
- if vnf["_id"] == vnfr_id
- ),
- None,
- )
- target_list = target_vnf.get("vld") if target_vnf else None
- _process_items(
- target_list=target_list or [],
- existing_list=vnfr.get("vld") or [],
- db_record="vnfrs:{}:vld".format(vnfr_id),
- db_update=db_vnfrs_update[vnfr["_id"]],
- db_path="vld",
- item="net",
- process_params=Ns._process_net_params,
- )
-
- target_list = target_vnf.get("vdur") if target_vnf else None
- step = "process VNF={} VDUs".format(vnfr_id)
- _process_items(
- target_list=target_list or [],
- existing_list=vnfr.get("vdur") or [],
- db_record="vnfrs:{}:vdur".format(vnfr_id),
- db_update=db_vnfrs_update[vnfr["_id"]],
- db_path="vdur",
- item="vdu",
- process_params=_process_vdu_params,
- )
-
- for db_task in db_new_tasks:
- step = "Updating database, Appending tasks to ro_tasks"
- target_id = db_task.pop("target_id")
- common_id = db_task.get("common_id")
-
- if common_id:
- if self.db.set_one(
- "ro_tasks",
- q_filter={
- "target_id": target_id,
- "tasks.common_id": common_id,
- },
- update_dict={"to_check_at": now, "modified_at": now},
- push={"tasks": db_task},
- fail_on_empty=False,
- ):
- continue
-
- if not self.db.set_one(
- "ro_tasks",
- q_filter={
- "target_id": target_id,
- "tasks.target_record": db_task["target_record"],
- },
- update_dict={"to_check_at": now, "modified_at": now},
- push={"tasks": db_task},
- fail_on_empty=False,
- ):
- # Create a ro_task
- step = "Updating database, Creating ro_tasks"
- db_ro_task = Ns._create_ro_task(target_id, db_task)
- nb_ro_tasks += 1
- self.db.create("ro_tasks", db_ro_task)
+ step = "Updating database, Appending tasks to ro_tasks"
+ self.upload_all_tasks(
+ db_new_tasks=db_new_tasks,
+ now=now,
+ )
step = "Updating database, nsrs"
if db_nsr_update:
self.db.set_one("vnfrs", {"_id": vnfr_id}, db_vnfr_update)
self.logger.debug(
- logging_text
- + "Exit. Created {} ro_tasks; {} tasks".format(
- nb_ro_tasks, len(db_new_tasks)
- )
+ logging_text + "Exit. Created {} tasks".format(len(db_new_tasks))
)
return (