X-Git-Url: https://osm.etsi.org/gitweb/?p=osm%2FN2VC.git;a=blobdiff_plain;f=n2vc%2Fn2vc_conn.py;h=6b0df891e822aac41be67abf2382beaf5917a12b;hp=3fc7c575e23018302a81af18859c63ed1711ce49;hb=82b591ceed704c798ead2d9104085a08e75b511b;hpb=4fee80e46dff88732b7927e502007203fcd8a15c diff --git a/n2vc/n2vc_conn.py b/n2vc/n2vc_conn.py index 3fc7c57..6b0df89 100644 --- a/n2vc/n2vc_conn.py +++ b/n2vc/n2vc_conn.py @@ -34,7 +34,7 @@ from osm_common.dbmongo import DbException import yaml from n2vc.loggable import Loggable -from n2vc.utils import EntityType, JujuStatusToOSM, N2VCDeploymentStatus +from n2vc.utils import JujuStatusToOSM, N2VCDeploymentStatus class N2VCConnector(abc.ABC, Loggable): @@ -55,10 +55,8 @@ class N2VCConnector(abc.ABC, Loggable): fs: object, log: object, loop: object, - url: str, - username: str, - vca_config: dict, on_update_db=None, + **kwargs, ): """Initialize N2VC abstract connector. It defines de API for VCA connectors @@ -67,14 +65,6 @@ class N2VCConnector(abc.ABC, Loggable): FsBase) :param object log: the logging object to log to :param object loop: the loop to use for asyncio (default current thread loop) - :param str url: a string that how to connect to the VCA (if needed, IP and port - can be obtained from there) - :param str username: the username to authenticate with VCA - :param dict vca_config: Additional parameters for the specific VCA. For example, - for juju it will contain: - secret: The password to authenticate with - public_key: The contents of the juju public SSH key - ca_cert str: The CA certificate used to authenticate :param on_update_db: callback called when n2vc connector updates database. Received arguments: table: e.g. "nsrs" @@ -92,32 +82,15 @@ class N2VCConnector(abc.ABC, Loggable): if fs is None: raise N2VCBadArgumentsException("Argument fs is mandatory", ["fs"]) - self.log.info( - "url={}, username={}, vca_config={}".format( - url, - username, - { - k: v - for k, v in vca_config.items() - if k - not in ("host", "port", "user", "secret", "public_key", "ca_cert") - }, - ) - ) - # store arguments into self self.db = db self.fs = fs self.loop = loop or asyncio.get_event_loop() - self.url = url - self.username = username - self.vca_config = vca_config self.on_update_db = on_update_db # generate private/public key-pair self.private_key_path = None self.public_key_path = None - self.get_public_key() @abc.abstractmethod async def get_status(self, namespace: str, yaml_format: bool = True): @@ -142,7 +115,7 @@ class N2VCConnector(abc.ABC, Loggable): # Find the path where we expect our key lives (~/.ssh) homedir = os.environ.get("HOME") if not homedir: - self.warning("No HOME environment variable, using /tmp") + self.log.warning("No HOME environment variable, using /tmp") homedir = "/tmp" sshdir = "{}/.ssh".format(homedir) if not os.path.exists(sshdir): @@ -245,6 +218,38 @@ class N2VCConnector(abc.ABC, Loggable): :param float total_timeout: """ + @abc.abstractmethod + async def install_k8s_proxy_charm( + self, + charm_name: str, + namespace: str, + artifact_path: str, + db_dict: dict, + progress_timeout: float = None, + total_timeout: float = None, + config: dict = None, + ) -> str: + """ + Install a k8s proxy charm + + :param charm_name: Name of the charm being deployed + :param namespace: collection of all the uuids related to the charm. + :param str artifact_path: where to locate the artifacts (parent folder) using + the self.fs + the final artifact path will be a combination of this artifact_path and + additional string from the config_dict (e.g. charm name) + :param dict db_dict: where to write into database when the status changes. + It contains a dict with + {collection: , filter: {}, path: }, + e.g. {collection: "nsrs", filter: + {_id: , path: "_admin.deployed.VCA.3"} + :param float progress_timeout: + :param float total_timeout: + :param config: Dictionary with additional configuration + + :returns ee_id: execution environment id. + """ + @abc.abstractmethod async def get_ee_ssh_public__key( self, @@ -289,14 +294,12 @@ class N2VCConnector(abc.ABC, Loggable): # TODO @abc.abstractmethod async def remove_relation(self): - """ - """ + """ """ # TODO @abc.abstractmethod async def deregister_execution_environments(self): - """ - """ + """ """ @abc.abstractmethod async def delete_namespace( @@ -411,7 +414,18 @@ class N2VCConnector(abc.ABC, Loggable): detailed_status: str, vca_status: str, entity_type: str, + vca_id: str = None, ): + """ + Write application status to database + + :param: db_dict: DB dictionary + :param: status: Status of the application + :param: detailed_status: Detailed status + :param: vca_status: VCA status + :param: entity_type: Entity type ("application", "machine, and "action") + :param: vca_id: Id of the VCA. If None, the default VCA will be used. + """ if not db_dict: self.log.debug("No db_dict => No database write") return @@ -445,10 +459,12 @@ class N2VCConnector(abc.ABC, Loggable): if self.on_update_db: if asyncio.iscoroutinefunction(self.on_update_db): await self.on_update_db( - the_table, the_filter, the_path, update_dict + the_table, the_filter, the_path, update_dict, vca_id=vca_id ) else: - self.on_update_db(the_table, the_filter, the_path, update_dict) + self.on_update_db( + the_table, the_filter, the_path, update_dict, vca_id=vca_id + ) except DbException as e: if e.http_code == HTTPStatus.NOT_FOUND: @@ -460,44 +476,13 @@ class N2VCConnector(abc.ABC, Loggable): else: self.log.info("Exception writing status to database: {}".format(e)) - def osm_status(self, entity_type: EntityType, status: str) -> N2VCDeploymentStatus: + def osm_status(self, entity_type: str, status: str) -> N2VCDeploymentStatus: if status not in JujuStatusToOSM[entity_type]: - self.log.warning("Status {} not found in JujuStatusToOSM.") + self.log.warning("Status {} not found in JujuStatusToOSM.".format(status)) return N2VCDeploymentStatus.UNKNOWN return JujuStatusToOSM[entity_type][status] -# DEPRECATED -def juju_status_2_osm_status(statustype: str, status: str) -> N2VCDeploymentStatus: - if statustype == "application" or statustype == "unit": - if status in ["waiting", "maintenance"]: - return N2VCDeploymentStatus.RUNNING - if status in ["error"]: - return N2VCDeploymentStatus.FAILED - elif status in ["active"]: - return N2VCDeploymentStatus.COMPLETED - elif status in ["blocked"]: - return N2VCDeploymentStatus.RUNNING - else: - return N2VCDeploymentStatus.UNKNOWN - elif statustype == "action": - if status in ["running"]: - return N2VCDeploymentStatus.RUNNING - elif status in ["completed"]: - return N2VCDeploymentStatus.COMPLETED - else: - return N2VCDeploymentStatus.UNKNOWN - elif statustype == "machine": - if status in ["pending"]: - return N2VCDeploymentStatus.PENDING - elif status in ["started"]: - return N2VCDeploymentStatus.COMPLETED - else: - return N2VCDeploymentStatus.UNKNOWN - - return N2VCDeploymentStatus.FAILED - - def obj_to_yaml(obj: object) -> str: # dump to yaml dump_text = yaml.dump(obj, default_flow_style=False, indent=2)