X-Git-Url: https://osm.etsi.org/gitweb/?a=blobdiff_plain;f=n2vc%2Fk8s_conn.py;h=632ac29949bf2e48b0f0c28429844308f5ada41e;hb=6d6707771792dd1a917b32c77b40920760aa0a08;hp=a3ad29aa3529d01a1545274c133e29d8d9bfbaf0;hpb=f52cb7cfeb4e24febe7c66af3d5bb275a50d7f99;p=osm%2FN2VC.git diff --git a/n2vc/k8s_conn.py b/n2vc/k8s_conn.py index a3ad29a..632ac29 100644 --- a/n2vc/k8s_conn.py +++ b/n2vc/k8s_conn.py @@ -22,6 +22,7 @@ import abc import asyncio +from typing import Union import time from n2vc.loggable import Loggable @@ -34,6 +35,10 @@ class K8sConnector(abc.ABC, Loggable): #################################################################################### """ + @staticmethod + def generate_kdu_instance_name(**kwargs): + raise NotImplementedError("Method not implemented") + def __init__(self, db: object, log: object = None, on_update_db=None): """ @@ -136,6 +141,7 @@ class K8sConnector(abc.ABC, Loggable): self, cluster_uuid: str, kdu_model: str, + kdu_instance: str, atomic: bool = True, timeout: float = 300, params: dict = None, @@ -154,6 +160,7 @@ class K8sConnector(abc.ABC, Loggable): - a name of chart/bundle available via the repos known by OSM - a path to a packaged chart/bundle - a path to an unpacked chart/bundle directory or a URL + :param kdu_instance: Kdu instance name :param atomic: If set, installation process purges chart/bundle on fail, also will wait until all the K8s objects are active :param timeout: Time in seconds to wait for the install of the chart/bundle @@ -202,6 +209,45 @@ class K8sConnector(abc.ABC, Loggable): :return: reference to the new revision number of the KDU instance """ + @abc.abstractmethod + async def scale( + self, + kdu_instance: str, + scale: int, + resource_name: str, + total_timeout: float = 1800, + **kwargs, + ) -> bool: + """ + Scales an application in KDU instance. + + :param: kdu_instance str: KDU instance name + :param: scale int: Scale to which to set this application + :param: resource_name str: Resource name (Application name) + :param: timeout float: The time, in seconds, to wait for the install + to finish + :param kwargs: Additional parameters + + :return: If successful, returns True + """ + + @abc.abstractmethod + async def get_scale_count( + self, + resource_name: str, + kdu_instance: str, + **kwargs, + ) -> int: + """ + Get an application scale count. + + :param: resource_name str: Resource name (Application name) + :param: kdu_instance str: KDU instance name + :param kwargs: Additional parameters + + :return: Return application instance count + """ + @abc.abstractmethod async def rollback( self, cluster_uuid: str, kdu_instance: str, revision=0, db_dict: dict = None @@ -288,7 +334,9 @@ class K8sConnector(abc.ABC, Loggable): """ @abc.abstractmethod - async def status_kdu(self, cluster_uuid: str, kdu_instance: str) -> str: + async def status_kdu( + self, cluster_uuid: str, kdu_instance: str, yaml_format: str + ) -> Union[str, dict]: """ This call would retrieve tha current state of a given KDU instance. It would be would allow to retrieve the _composition_ (i.e. K8s objects) and _specific @@ -297,6 +345,8 @@ class K8sConnector(abc.ABC, Loggable): :param cluster_uuid: UUID of a K8s cluster known by OSM :param kdu_instance: unique name for the KDU instance + :param yaml_format: if the return shall be returned as an YAML string or as a + dictionary :return: If successful, it will return the following vector of arguments: - K8s `namespace` in the cluster where the KDU lives - `state` of the KDU instance. It can be: @@ -312,6 +362,46 @@ class K8sConnector(abc.ABC, Loggable): """ + @abc.abstractmethod + async def get_services( + self, cluster_uuid: str, kdu_instance: str, namespace: str + ) -> list: + """ + Returns a list of services defined for the specified kdu instance. + + :param cluster_uuid: UUID of a K8s cluster known by OSM + :param kdu_instance: unique name for the KDU instance + :param namespace: K8s namespace used by the KDU instance + :return: If successful, it will return a list of services, Each service + can have the following data: + - `name` of the service + - `type` type of service in the k8 cluster + - `ports` List of ports offered by the service, for each port includes at least + name, port, protocol + - `cluster_ip` Internal ip to be used inside k8s cluster + - `external_ip` List of external ips (in case they are available) + """ + + @abc.abstractmethod + async def get_service( + self, cluster_uuid: str, service_name: str, namespace: str = None + ) -> object: + """ + Obtains the data of the specified service in the k8cluster. + + :param cluster_uuid: UUID of a K8s cluster known by OSM + :param service_name: name of the K8s service in the specified namespace + :param namespace: K8s namespace used by the KDU instance + :return: If successful, it will return a list of services, Each service can have + the following data: + - `name` of the service + - `type` type of service in the k8 cluster + - `ports` List of ports offered by the service, for each port includes at least + name, port, protocol + - `cluster_ip` Internal ip to be used inside k8s cluster + - `external_ip` List of external ips (in case they are available) + """ + """ #################################################################################### ################################### P R I V A T E ################################## @@ -321,6 +411,18 @@ class K8sConnector(abc.ABC, Loggable): async def write_app_status_to_db( self, db_dict: dict, status: str, detailed_status: str, operation: str ) -> bool: + """ + This method will write the status of the application to the database. + + :param db_dict: A dictionary with the database necessary information. It shall contain the values for the keys: + - "collection": The Mongo DB collection to write to + - "filter": The query filter to use in the update process + - "path": The dot separated keys which targets the object to be updated + :param status: Status of the application + :param detailed_status: Detailed status of the application + :param operation: Operation that is being performed on the application + :return: True if successful + """ if not self.db: self.warning("No db => No database write")