Adding slice templates to NBI
[osm/NBI.git] / osm_nbi / instance_topics.py
index de2a1e6..4228bc5 100644 (file)
@@ -4,7 +4,7 @@
 from uuid import uuid4
 from http import HTTPStatus
 from time import time
-from copy import copy
+from copy import copy, deepcopy
 from validation import validate_input, ValidationError, ns_instantiate, ns_action, ns_scale
 from base_topic import BaseTopic, EngineException, get_iterable
 from descriptor_topics import DescriptorTopic
@@ -170,9 +170,7 @@ class NsrTopic(BaseTopic):
                     }
                     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"],
                         # TODO      "name": ""     Name of the VDU in the VIM
                         "ip-address": None,  # mgmt-interface filled by LCM
@@ -180,6 +178,8 @@ class NsrTopic(BaseTopic):
                         "internal-connection-point": [],
                         "interfaces": [],
                     }
+                    if vdu.get("pdu-type"):
+                        vdur["pdu-type"] = vdu["pdu-type"]
                     # TODO volumes: name, volume-id
                     for icp in vdu.get("internal-connection-point", ()):
                         vdu_icp = {
@@ -196,8 +196,20 @@ class NsrTopic(BaseTopic):
                             # "ip-address", "mac-address" # filled by LCM
                             # vim-id  # TODO it would be nice having a vim port id
                         }
+                        if iface.get("mgmt-interface"):
+                            vdu_iface["mgmt-interface"] = True
+
                         vdur["interfaces"].append(vdu_iface)
-                    vnfr_descriptor["vdur"].append(vdur)
+                    count = vdu.get("count", 1)
+                    if count is None:
+                        count = 1
+                    count = int(count)    # TODO remove when descriptor serialized with payngbind
+                    for index in range(0, count):
+                        if index:
+                            vdur = deepcopy(vdur)
+                        vdur["_id"] = str(uuid4())
+                        vdur["count-index"] = index
+                        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"])
@@ -291,38 +303,31 @@ class NsLcmOpTopic(BaseTopic):
 
         def _check_vnf_instantiation_params(in_vnfd, vnfd):
 
-            for in_vdu in get_iterable(in_vnfd["vdu"]):
-                if in_vdu.get("id"):
-                    for vdu in get_iterable(vnfd["vdu"]):
-                        if in_vdu["id"] == vdu["id"]:
-                            for volume in get_iterable(in_vdu.get("volume")):
-                                for volumed in get_iterable(vdu.get("volumes")):
-                                    if volumed["name"] == volume["name"]:
-                                        break
-                                else:
-                                    raise EngineException("Invalid parameter vnf[member-vnf-index='{}']:vdu[id='{}']:"
-                                                          "volume:name='{}' is not present at vnfd:vdu:volumes list".
-                                                          format(in_vnf["member-vnf-index"], in_vdu["id"],
-                                                                 volume["name"]))
-                            for in_iface in get_iterable(in_vdu["interface"]):
-                                if in_iface.get("name"):
-                                    for iface in vdu["interface"]:
-                                        if in_iface["name"] == iface["name"]:
-                                            break
-                                    else:
-                                        raise EngineException("vdu[id='{}']:interface[name='{}'] defined in "
-                                                              "additional configuration, is not present at vnfd '{}'"
-                                                              .format(in_vdu["id"], in_iface["name"], vnfd["id"]))
-                                else:
-                                    raise EngineException("vdu[id='{}']:interface defined in additional "
-                                                          "configuration needs 'name' parameter to be defined"
-                                                          .format(in_vdu["id"]))
-                            break
-                    else:
-                        raise EngineException("VDU '{}' defined in additional configuration, is not present at vnfd "
-                                              "'{}'".format(in_vdu["id"], vnfd["id"]))
+            for in_vdu in get_iterable(in_vnfd.get("vdu")):
+                for vdu in get_iterable(vnfd.get("vdu")):
+                    if in_vdu["id"] == vdu["id"]:
+                        for volume in get_iterable(in_vdu.get("volume")):
+                            for volumed in get_iterable(vdu.get("volumes")):
+                                if volumed["name"] == volume["name"]:
+                                    break
+                            else:
+                                raise EngineException("Invalid parameter vnf[member-vnf-index='{}']:vdu[id='{}']:"
+                                                      "volume:name='{}' is not present at vnfd:vdu:volumes list".
+                                                      format(in_vnf["member-vnf-index"], in_vdu["id"],
+                                                             volume["name"]))
+                        for in_iface in get_iterable(in_vdu["interface"]):
+                            for iface in get_iterable(vdu.get("interface")):
+                                if in_iface["name"] == iface["name"]:
+                                    break
+                            else:
+                                raise EngineException("Invalid parameter vnf[member-vnf-index='{}']:vdu[id='{}']:"
+                                                      "interface[name='{}'] is not present at vnfd:vdu:interface"
+                                                      .format(in_vnf["member-vnf-index"], in_vdu["id"],
+                                                              in_iface["name"]))
+                        break
                 else:
-                    raise EngineException("No ID defined for VDU in the additional configuration")
+                    raise EngineException("Invalid parameter vnf[member-vnf-index='{}']:vdu[id='{}'] is is not present "
+                                          "at vnfd:vdu".format(in_vnf["member-vnf-index"], in_vdu["id"]))
 
             for in_ivld in get_iterable(in_vnfd.get("internal-vld")):
                 for ivld in get_iterable(vnfd.get("internal-vld")):
@@ -332,10 +337,11 @@ class NsLcmOpTopic(BaseTopic):
                                 if in_icp["id-ref"] == icp["id-ref"]:
                                     break
                             else:
-                                raise EngineException("internal-vld:name='{}':internal-connection-point:"
-                                                      "id-ref='{}' defined in additional configuration, is not "
-                                                      "present at vnfd '{}'".format(in_ivld["name"],
-                                                                                    in_icp["id-ref"], vnfd["id"]))
+                                raise EngineException("Invalid parameter vnf[member-vnf-index='{}']:internal-vld[name"
+                                                      "='{}']:internal-connection-point[id-ref:'{}'] is not present at "
+                                                      "vnfd:internal-vld:name/id:internal-connection-point"
+                                                      .format(in_vnf["member-vnf-index"], in_ivld["name"],
+                                                              in_icp["id-ref"], vnfd["id"]))
                         break
                 else:
                     raise EngineException("Invalid parameter vnf[member-vnf-index='{}']:internal-vld:name='{}'"
@@ -346,10 +352,11 @@ class NsLcmOpTopic(BaseTopic):
             if vim_account in vim_accounts:
                 return
             try:
-                # TODO add _get_project_filter
-                self.db.get_one("vim_accounts", {"_id": vim_account})
+                db_filter = self._get_project_filter(session, write=False, show_all=True)
+                db_filter["_id"] = vim_account
+                self.db.get_one("vim_accounts", db_filter)
             except Exception:
-                raise EngineException("Invalid vimAccountId='{}' not present".format(vim_account))
+                raise EngineException("Invalid vimAccountId='{}' not present for the project".format(vim_account))
             vim_accounts.append(vim_account)
 
         if operation == "action":
@@ -406,6 +413,107 @@ class NsLcmOpTopic(BaseTopic):
                     raise EngineException("Invalid parameter vld:name='{}' is not present at nsd:vld".format(
                         in_vld["name"]))
 
+    def _look_for_pdu(self, session, rollback, vnfr, vim_account):
+        """
+        Look for a free PDU in the catalog matching vdur type and interfaces. Fills vdur with ip_address information
+        :param vdur: vnfr:vdur descriptor. It is modified with pdu interface info if pdu is found
+        :param member_vnf_index: used just for logging. Target vnfd of nsd
+        :param vim_account:
+        :return: vder_update: dictionary to update vnfr:vdur with pdu info. In addition it modified choosen pdu to set
+        at status IN_USE
+        """
+        vnfr_update = {}
+        rollback_vnfr = {}
+        for vdur_index, vdur in enumerate(get_iterable(vnfr.get("vdur"))):
+            if not vdur.get("pdu-type"):
+                continue
+            pdu_type = vdur.get("pdu-type")
+            pdu_filter = self._get_project_filter(session, write=True, show_all=True)
+            pdu_filter["vim.vim_accounts"] = vim_account
+            pdu_filter["type"] = pdu_type
+            pdu_filter["_admin.operationalState"] = "ENABLED"
+            pdu_filter["_admin.usageSate"] = "NOT_IN_USE",
+            # TODO feature 1417: "shared": True,
+
+            available_pdus = self.db.get_list("pdus", pdu_filter)
+            for pdu in available_pdus:
+                # step 1 check if this pdu contains needed interfaces:
+                match_interfaces = True
+                for vdur_interface in vdur["interfaces"]:
+                    for pdu_interface in pdu["interfaces"]:
+                        if pdu_interface["name"] == vdur_interface["name"]:
+                            # TODO feature 1417: match per mgmt type
+                            break
+                    else:  # no interface found for name
+                        match_interfaces = False
+                        break
+                if match_interfaces:
+                    break
+            else:
+                raise EngineException(
+                    "No PDU of type={} found for member_vnf_index={} at vim_account={} matching interface "
+                    "names".format(vdur["vdu-id-ref"], vnfr["member-vnf-index-ref"], pdu_type))
+
+            # step 2. Update pdu
+            rollback_pdu = {
+                "_admin.usageState": pdu["_admin"]["usageState"],
+                "_admin.usage.vnfr_id": None,
+                "_admin.usage.nsr_id": None,
+                "_admin.usage.vdur": None,
+            }
+            self.db.set_one("pdus", {"_id": pdu["_id"]},
+                            {"_admin.usageSate": "IN_USE",
+                             "_admin.usage.vnfr_id": vnfr["_id"],
+                             "_admin.usage.nsr_id": vnfr["nsr-id-ref"],
+                             "_admin.usage.vdur": vdur["vdu-id-ref"]}
+                            )
+            rollback.append({"topic": "pdus", "_id": pdu["_id"], "operation": "set", "content": rollback_pdu})
+
+            # step 3. Fill vnfr info by filling vdur
+            vdu_text = "vdur.{}".format(vdur_index)
+            rollback_vnfr[vdu_text + ".pdu-id"] = None
+            vnfr_update[vdu_text + ".pdu-id"] = pdu["_id"]
+            for iface_index, vdur_interface in enumerate(vdur["interfaces"]):
+                for pdu_interface in pdu["interfaces"]:
+                    if pdu_interface["name"] == vdur_interface["name"]:
+                        iface_text = vdu_text + ".interfaces.{}".format(iface_index)
+                        for k, v in pdu_interface.items():
+                            vnfr_update[iface_text + ".{}".format(k)] = v
+                            rollback_vnfr[iface_text + ".{}".format(k)] = vdur_interface.get(v)
+                        break
+
+        if vnfr_update:
+            self.db.set_one("vnfrs", {"_id": vnfr["_id"]}, vnfr_update)
+            rollback.append({"topic": "vnfrs", "_id": vnfr["_id"], "operation": "set", "content": rollback_vnfr})
+        return
+
+    def _update_vnfrs(self, session, rollback, nsr, indata):
+        vnfrs = None
+        # get vnfr
+        nsr_id = nsr["_id"]
+        vnfrs = self.db.get_list("vnfrs", {"nsr-id-ref": nsr_id})
+
+        for vnfr in vnfrs:
+            vnfr_update = {}
+            vnfr_update_rollback = {}
+            member_vnf_index = vnfr["member-vnf-index-ref"]
+            # update vim-account-id
+
+            vim_account = indata["vimAccountId"]
+            # check instantiate parameters
+            for vnf_inst_params in get_iterable(indata.get("vnf")):
+                if vnf_inst_params["member-vnf-index"] != member_vnf_index:
+                    continue
+                if vnf_inst_params.get("vimAccountId"):
+                    vim_account = vnf_inst_params.get("vimAccountId")
+
+            vnfr_update["vim-account-id"] = vim_account
+            vnfr_update_rollback["vim-account-id"] = vnfr.get("vim-account-id")
+
+            # get pdu
+            self._look_for_pdu(session, rollback, vnfr, vim_account)
+            # TODO change instantiation parameters to set network
+
     def _create_nslcmop(self, session, nsInstanceId, operation, params):
         now = time()
         _id = str(uuid4())
@@ -466,6 +574,8 @@ class NsLcmOpTopic(BaseTopic):
                     raise EngineException("ns_instance '{}' cannot be '{}' because it is already instantiated".format(
                         nsInstanceId, operation), HTTPStatus.CONFLICT)
             self._check_ns_operation(session, nsr, operation, indata)
+            if operation == "instantiate":
+                self._update_vnfrs(session, rollback, nsr, indata)
             nslcmop_desc = self._create_nslcmop(session, nsInstanceId, operation, indata)
             self.format_on_new(nslcmop_desc, session["project_id"], make_public=make_public)
             _id = self.db.create("nslcmops", nslcmop_desc)
@@ -482,3 +592,152 @@ class NsLcmOpTopic(BaseTopic):
 
     def edit(self, session, _id, indata=None, kwargs=None, force=False, content=None):
         raise EngineException("Method edit called directly", HTTPStatus.INTERNAL_SERVER_ERROR)
+
+
+class NsiTopic(BaseTopic):
+    topic = "nsis"
+    topic_msg = "nsi"
+
+    def __init__(self, db, fs, msg):
+        BaseTopic.__init__(self, db, fs, msg)
+
+    def _check_descriptor_dependencies(self, session, descriptor):
+        """
+        Check that the dependent descriptors exist on a new descriptor or edition
+        :param session: client session information
+        :param descriptor: descriptor to be inserted or edit
+        :return: None or raises exception
+        """
+        if not descriptor.get("nstdId"):
+            return
+        nstd_id = descriptor["nstdId"]
+        if not self.get_item_list(session, "nsts", {"id": nstd_id}):
+            raise EngineException("Descriptor error at nstdId='{}' references a non exist nstd".format(nstd_id),
+                                  http_code=HTTPStatus.CONFLICT)
+
+    @staticmethod
+    def format_on_new(content, project_id=None, make_public=False):
+        BaseTopic.format_on_new(content, project_id=project_id, make_public=make_public)
+        content["_admin"]["nstState"] = "NOT_INSTANTIATED"
+
+    def check_conflict_on_del(self, session, _id, force=False):
+        if force:
+            return
+        nsi = self.db.get_one("nsis", {"_id": _id})
+        if nsi["_admin"].get("nsiState") == "INSTANTIATED":
+            raise EngineException("nsi '{}' cannot be deleted because it is in 'INSTANTIATED' state. "
+                                  "Launch 'terminate' operation first; or force deletion".format(_id),
+                                  http_code=HTTPStatus.CONFLICT)
+
+    def delete(self, session, _id, force=False, dry_run=False):
+        """
+        Delete item by its internal _id
+        :param session: contains the used login username, working project, and admin rights
+        :param _id: server internal id
+        :param force: indicates if deletion must be forced in case of conflict
+        :param dry_run: make checking but do not delete
+        :return: dictionary with deleted item _id. It raises EngineException on error: not found, conflict, ...
+        """
+        # TODO add admin to filter, validate rights
+        BaseTopic.delete(self, session, _id, force, dry_run=True)
+        if dry_run:
+            return
+        v = self.db.del_one("nsis", {"_id": _id})
+        self.db.del_list("nstlcmops", {"nstInstanceId": _id})
+        self.db.del_list("vnfrs", {"nsr-id-ref": _id})
+        # set all used pdus as free
+        self.db.set_list("pdus", {"_admin.usage.nsr_id": _id}, {"_admin.usageSate": "NOT_IN_USE", "_admin.usage": None})
+        self._send_msg("deleted", {"_id": _id})
+        return v
+
+    def new(self, rollback, session, indata=None, kwargs=None, headers=None, force=False, make_public=False):
+        """
+        Creates a new nsr into database. It also creates needed vnfrs
+        :param rollback: list to append the created items at database in case a rollback must be done
+        :param session: contains the used login username and working project
+        :param indata: params to be used for the nsir
+        :param kwargs: used to override the indata descriptor
+        :param headers: http request headers
+        :param force: If True avoid some dependence checks
+        :param make_public: Make the created item public to all projects
+        :return: the _id of nsi descriptor created at database
+        """
+
+        try:
+            slice_request = self._remove_envelop(indata)
+            # Override descriptor with query string kwargs
+            self._update_input_with_kwargs(slice_request, kwargs)
+            self._validate_input_new(slice_request, force)
+
+            step = ""
+            # look for nstd
+            step = "getting nstd id='{}' from database".format(slice_request.get("nstdId"))
+            _filter = {"_id": slice_request["nstdId"]}
+            _filter.update(BaseTopic._get_project_filter(session, write=False, show_all=True))
+            nstd = self.db.get_one("nsts", _filter)
+            nsi_id = str(uuid4())
+            # now = time()
+            step = "filling nsi_descriptor with input data"
+            nsi_descriptor = {
+                "id": nsi_id,
+                "nst-ref": nstd["id"],
+                "instantiation-parameters": {
+                    "netslice-subnet": []
+                },
+                "network-slice-template": nstd,
+                # "nsr-ref-list": [],    #TODO: not used for now...
+                # "vlr-ref-list": [],    #TODO: not used for now...
+                "_id": nsi_id,
+                
+                # TODO CHECK: what about the following params?
+                # "admin-status": "ENABLED",
+                # "description": slice_request.get("nsDescription", ""),
+                # "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}},
+                # "create-time": now,
+                # "operational-events": [],   # "id", "timestamp", "description", "event",
+                # "ssh-authorized-key": slice_request.get("key-pair-ref"),
+            }
+            # nstd["nsi_id"] = nsi_id
+
+            # TODO: ask if we have to develop the VNFR here or we can imply call the NsrTopic() for each service to 
+            # instantiate.
+            # Create netslice-subnet_record
+            needed_nsds = {}
+            for member_ns in nstd["netslice-subnet"]:
+                nsd_id = member_ns["nsd-ref"]
+                step = "getting nstd id='{}' constituent-nsd='{}' from database".format(
+                    member_ns["nsd-ref"], member_ns["id"])
+                if nsd_id not in needed_nsds:
+                    # Obtain nsd
+                    nsd = DescriptorTopic.get_one_by_id(self.db, session, "nsds", nsd_id)
+                    nsd.pop("_admin")
+                    needed_nsds[nsd_id] = nsd
+                else:
+                    nsd = needed_nsds[nsd_id]
+                
+                step = "filling nsir nsd-id='{}' constituent-nsd='{}' from database".format(
+                    member_ns["nsd-ref"], member_ns["id"])
+                netslice_subnet_descriptor = {
+                    "nsName": member_ns["instantiation-parameters"]["name"],
+                    "nsdId": member_ns["instantiation-parameters"]["nsdId"],
+                    "vimAccountId": member_ns["instantiation-parameters"]["vimAccountId"]
+                }
+                nsi_descriptor["instantiation-parameters"]["netslice-subnet"].append(netslice_subnet_descriptor)
+
+            step = "creating nsi at database"
+            self.format_on_new(nsi_descriptor, session["project_id"], make_public=make_public)
+            self.db.create("nsis", nsi_descriptor)
+            rollback.append({"topic": "nsis", "_id": nsi_id})
+            return nsi_id
+        except Exception as e:
+            self.logger.exception("Exception {} at NsiTopic.new()".format(e), exc_info=True)
+            raise EngineException("Error {}: {}".format(step, e))
+        except ValidationError as e:
+            raise EngineException(e, HTTPStatus.UNPROCESSABLE_ENTITY)
+
+    def edit(self, session, _id, indata=None, kwargs=None, force=False, content=None):
+        raise EngineException("Method edit called directly", HTTPStatus.INTERNAL_SERVER_ERROR)