X-Git-Url: https://osm.etsi.org/gitweb/?p=osm%2FNBI.git;a=blobdiff_plain;f=osm_nbi%2Fengine.py;h=cb274145e62eade1f40b8713c83bd158c16072b5;hp=133cb9de65dc2ffc387b2045730cc3689d3ec7de;hb=5758955b7b394517ff5caf5506a4400cdc5aa372;hpb=19b9752a7f43e1fcf1bdfd0040c1e8edfe9e6f3a diff --git a/osm_nbi/engine.py b/osm_nbi/engine.py index 133cb9d..cb27414 100644 --- a/osm_nbi/engine.py +++ b/osm_nbi/engine.py @@ -14,8 +14,17 @@ # limitations under the License. import logging + # import yaml -from osm_common import dbmongo, dbmemory, fslocal, fsmongo, msglocal, msgkafka, version as common_version +from osm_common import ( + dbmongo, + dbmemory, + fslocal, + fsmongo, + msglocal, + msgkafka, + version as common_version, +) from osm_common.dbbase import DbException from osm_common.fsbase import FsException from osm_common.msgbase import MsgException @@ -23,16 +32,30 @@ from http import HTTPStatus from osm_nbi.authconn_keystone import AuthconnKeystone from osm_nbi.authconn_internal import AuthconnInternal +from osm_nbi.authconn_tacacs import AuthconnTacacs from osm_nbi.base_topic import EngineException, versiontuple from osm_nbi.admin_topics import VimAccountTopic, WimAccountTopic, SdnTopic from osm_nbi.admin_topics import K8sClusterTopic, K8sRepoTopic, OsmRepoTopic +from osm_nbi.admin_topics import VcaTopic from osm_nbi.admin_topics import UserTopicAuth, ProjectTopicAuth, RoleTopicAuth -from osm_nbi.descriptor_topics import VnfdTopic, NsdTopic, PduTopic, NstTopic, VnfPkgOpTopic -from osm_nbi.instance_topics import NsrTopic, VnfrTopic, NsLcmOpTopic, NsiTopic, NsiLcmOpTopic +from osm_nbi.descriptor_topics import ( + VnfdTopic, + NsdTopic, + PduTopic, + NstTopic, + VnfPkgOpTopic, +) +from osm_nbi.instance_topics import ( + NsrTopic, + VnfrTopic, + NsLcmOpTopic, + NsiTopic, + NsiLcmOpTopic, +) from osm_nbi.pmjobs_topics import PmJobsTopic from osm_nbi.subscription_topics import NslcmSubscriptionsTopic from base64 import b64encode -from os import urandom # , path +from os import urandom # , path from threading import Lock __author__ = "Alfonso Tierno " @@ -52,11 +75,12 @@ class Engine(object): "wim_accounts": WimAccountTopic, "sdns": SdnTopic, "k8sclusters": K8sClusterTopic, + "vca": VcaTopic, "k8srepos": K8sRepoTopic, "osmrepos": OsmRepoTopic, - "users": UserTopicAuth, # Valid for both internal and keystone authentication backends - "projects": ProjectTopicAuth, # Valid for both internal and keystone authentication backends - "roles": RoleTopicAuth, # Valid for both internal and keystone authentication backends + "users": UserTopicAuth, # Valid for both internal and keystone authentication backends + "projects": ProjectTopicAuth, # Valid for both internal and keystone authentication backends + "roles": RoleTopicAuth, # Valid for both internal and keystone authentication backends "nsis": NsiTopic, "nsilcmops": NsiLcmOpTopic, "vnfpkgops": VnfPkgOpTopic, @@ -94,8 +118,11 @@ class Engine(object): self.config = config # check right version of common if versiontuple(common_version) < versiontuple(min_common_version): - raise EngineException("Not compatible osm/common version '{}'. Needed '{}' or higher".format( - common_version, min_common_version)) + raise EngineException( + "Not compatible osm/common version '{}'. Needed '{}' or higher".format( + common_version, min_common_version + ) + ) try: if not self.db: @@ -106,8 +133,11 @@ class Engine(object): self.db = dbmemory.DbMemory() self.db.db_connect(config["database"]) else: - raise EngineException("Invalid configuration param '{}' at '[database]':'driver'".format( - config["database"]["driver"])) + raise EngineException( + "Invalid configuration param '{}' at '[database]':'driver'".format( + config["database"]["driver"] + ) + ) if not self.fs: if config["storage"]["driver"] == "local": self.fs = fslocal.FsLocal() @@ -116,8 +146,11 @@ class Engine(object): self.fs = fsmongo.FsMongo() self.fs.fs_connect(config["storage"]) else: - raise EngineException("Invalid configuration param '{}' at '[storage]':'driver'".format( - config["storage"]["driver"])) + raise EngineException( + "Invalid configuration param '{}' at '[storage]':'driver'".format( + config["storage"]["driver"] + ) + ) if not self.msg: if config["message"]["driver"] == "local": self.msg = msglocal.MsgLocal() @@ -126,15 +159,30 @@ class Engine(object): self.msg = msgkafka.MsgKafka() self.msg.connect(config["message"]) else: - raise EngineException("Invalid configuration param '{}' at '[message]':'driver'".format( - config["message"]["driver"])) + raise EngineException( + "Invalid configuration param '{}' at '[message]':'driver'".format( + config["message"]["driver"] + ) + ) if not self.authconn: if config["authentication"]["backend"] == "keystone": - self.authconn = AuthconnKeystone(config["authentication"], self.db, - self.authenticator.role_permissions) + self.authconn = AuthconnKeystone( + config["authentication"], + self.db, + self.authenticator.role_permissions, + ) + elif config["authentication"]["backend"] == "tacacs": + self.authconn = AuthconnTacacs( + config["authentication"], + self.db, + self.authenticator.role_permissions, + ) else: - self.authconn = AuthconnInternal(config["authentication"], self.db, - self.authenticator.role_permissions) + self.authconn = AuthconnInternal( + config["authentication"], + self.db, + self.authenticator.role_permissions, + ) # if not self.operations: # if "resources_to_operations" in config["rbac"]: # resources_to_operations_file = config["rbac"]["resources_to_operations"] @@ -165,10 +213,15 @@ class Engine(object): for topic, topic_class in self.map_from_topic_to_class.items(): # if self.auth and topic_class in (UserTopicAuth, ProjectTopicAuth): # self.map_topic[topic] = topic_class(self.db, self.fs, self.msg, self.auth) - self.map_topic[topic] = topic_class(self.db, self.fs, self.msg, self.authconn) - - self.map_topic["pm_jobs"] = PmJobsTopic(self.db, config["prometheus"].get("host"), - config["prometheus"].get("port")) + self.map_topic[topic] = topic_class( + self.db, self.fs, self.msg, self.authconn + ) + + self.map_topic["pm_jobs"] = PmJobsTopic( + self.db, + config["prometheus"].get("host"), + config["prometheus"].get("port"), + ) except (DbException, FsException, MsgException) as e: raise EngineException(str(e), http_code=e.http_code) @@ -184,7 +237,9 @@ class Engine(object): except (DbException, FsException, MsgException) as e: raise EngineException(str(e), http_code=e.http_code) - def new_item(self, rollback, session, topic, indata=None, kwargs=None, headers=None): + def new_item( + self, rollback, session, topic, indata=None, kwargs=None, headers=None + ): """ 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 @@ -197,7 +252,9 @@ class Engine(object): :return: _id: identity of the inserted data. """ if topic not in self.map_topic: - raise EngineException("Unknown topic {}!!!".format(topic), HTTPStatus.INTERNAL_SERVER_ERROR) + raise EngineException( + "Unknown topic {}!!!".format(topic), HTTPStatus.INTERNAL_SERVER_ERROR + ) with self.write_lock: return self.map_topic[topic].new(rollback, session, indata, kwargs, headers) @@ -213,9 +270,13 @@ class Engine(object): :return: _id: identity of the inserted data. """ if topic not in self.map_topic: - raise EngineException("Unknown topic {}!!!".format(topic), HTTPStatus.INTERNAL_SERVER_ERROR) + raise EngineException( + "Unknown topic {}!!!".format(topic), HTTPStatus.INTERNAL_SERVER_ERROR + ) with self.write_lock: - return self.map_topic[topic].upload_content(session, _id, indata, kwargs, headers) + return self.map_topic[topic].upload_content( + session, _id, indata, kwargs, headers + ) def get_item_list(self, session, topic, filter_q=None, api_req=False): """ @@ -230,18 +291,19 @@ class Engine(object): raise EngineException("Unknown topic {}!!!".format(topic), HTTPStatus.INTERNAL_SERVER_ERROR) return self.map_topic[topic].list(session, filter_q, api_req) - def get_item(self, session, topic, _id, api_req=False): + def get_item(self, session, topic, _id, filter_q=None, api_req=False): """ Get complete information on an item :param session: contains the used login username and working project :param topic: it can be: users, projects, vnfds, nsds, :param _id: server id of the item + :param filter_q: other arguments :param api_req: True if this call is serving an external API request. False if serving internal request. :return: dictionary, raise exception if not found. """ if topic not in self.map_topic: raise EngineException("Unknown topic {}!!!".format(topic), HTTPStatus.INTERNAL_SERVER_ERROR) - return self.map_topic[topic].show(session, _id, api_req) + return self.map_topic[topic].show(session, _id, filter_q, api_req) def get_file(self, session, topic, _id, path=None, accept_header=None): """ @@ -254,7 +316,9 @@ class Engine(object): :return: opened file plus Accept format or raises an exception """ if topic not in self.map_topic: - raise EngineException("Unknown topic {}!!!".format(topic), HTTPStatus.INTERNAL_SERVER_ERROR) + raise EngineException( + "Unknown topic {}!!!".format(topic), HTTPStatus.INTERNAL_SERVER_ERROR + ) return self.map_topic[topic].get_file(session, _id, path, accept_header) def del_item_list(self, session, topic, _filter=None): @@ -266,7 +330,9 @@ class Engine(object): :return: The deleted list, it can be empty if no one match the _filter. """ if topic not in self.map_topic: - raise EngineException("Unknown topic {}!!!".format(topic), HTTPStatus.INTERNAL_SERVER_ERROR) + raise EngineException( + "Unknown topic {}!!!".format(topic), HTTPStatus.INTERNAL_SERVER_ERROR + ) with self.write_lock: return self.map_topic[topic].delete_list(session, _filter) @@ -282,7 +348,9 @@ class Engine(object): :return: dictionary with deleted item _id. It raises exception if not found. """ if topic not in self.map_topic: - raise EngineException("Unknown topic {}!!!".format(topic), HTTPStatus.INTERNAL_SERVER_ERROR) + raise EngineException( + "Unknown topic {}!!!".format(topic), HTTPStatus.INTERNAL_SERVER_ERROR + ) with self.write_lock: return self.map_topic[topic].delete(session, _id, not_send_msg=not_send_msg) @@ -297,38 +365,47 @@ class Engine(object): :return: dictionary with edited item _id, raise exception if not found. """ if topic not in self.map_topic: - raise EngineException("Unknown topic {}!!!".format(topic), HTTPStatus.INTERNAL_SERVER_ERROR) + raise EngineException( + "Unknown topic {}!!!".format(topic), HTTPStatus.INTERNAL_SERVER_ERROR + ) with self.write_lock: return self.map_topic[topic].edit(session, _id, indata, kwargs) def upgrade_db(self, current_version, target_version): if target_version not in self.map_target_version_to_int.keys(): - raise EngineException("Cannot upgrade to version '{}' with this version of code".format(target_version), - http_code=HTTPStatus.INTERNAL_SERVER_ERROR) + raise EngineException( + "Cannot upgrade to version '{}' with this version of code".format( + target_version + ), + http_code=HTTPStatus.INTERNAL_SERVER_ERROR, + ) if current_version == target_version: return - + target_version_int = self.map_target_version_to_int[target_version] if not current_version: # create database version serial = urandom(32) version_data = { - "_id": "version", # Always "version" - "version_int": 1000, # version number - "version": "1.0", # version text - "date": "2018-10-25", # version date + "_id": "version", # Always "version" + "version_int": 1000, # version number + "version": "1.0", # version text + "date": "2018-10-25", # version date "description": "added serial", # changes in this version - 'status': "ENABLED", # ENABLED, DISABLED (migration in process), ERROR, - 'serial': b64encode(serial) + "status": "ENABLED", # ENABLED, DISABLED (migration in process), ERROR, + "serial": b64encode(serial), } self.db.create("admin", version_data) self.db.set_secret_key(serial) current_version = "1.0" - - if current_version in ("1.0", "1.1") and target_version_int >= self.map_target_version_to_int["1.2"]: - if self.config['authentication']['backend'] == "internal": + + if ( + current_version in ("1.0", "1.1") + and target_version_int >= self.map_target_version_to_int["1.2"] + ): + if self.config["authentication"]["backend"] == "internal": self.db.del_list("roles") version_data = { @@ -336,14 +413,14 @@ class Engine(object): "version_int": 1002, "version": "1.2", "date": "2019-06-11", - "description": "set new format for roles_operations" + "description": "set new format for roles_operations", } self.db.set_one("admin", {"_id": "version"}, version_data) current_version = "1.2" # TODO add future migrations here - def init_db(self, target_version='1.0'): + def init_db(self, target_version="1.0"): """ Init database if empty. If not empty it checks that database version and migrates if needed If empty, it creates a new user admin/admin at 'users' and a new entry at 'version' @@ -351,11 +428,15 @@ class Engine(object): :return: None if ok, exception if error or if the version is different. """ - version_data = self.db.get_one("admin", {"_id": "version"}, fail_on_empty=False, fail_on_more=True) + version_data = self.db.get_one( + "admin", {"_id": "version"}, fail_on_empty=False, fail_on_more=True + ) # check database status is ok - if version_data and version_data.get("status") != 'ENABLED': - raise EngineException("Wrong database status '{}'".format( - version_data["status"]), HTTPStatus.INTERNAL_SERVER_ERROR) + if version_data and version_data.get("status") != "ENABLED": + raise EngineException( + "Wrong database status '{}'".format(version_data["status"]), + HTTPStatus.INTERNAL_SERVER_ERROR, + ) # check version db_version = None if not version_data else version_data.get("version")