X-Git-Url: https://osm.etsi.org/gitweb/?p=osm%2FN2VC.git;a=blobdiff_plain;f=n2vc%2Fk8s_conn.py;h=ef4f5f2a8635cd853a97f4ac83c7bc315b174134;hp=5bdc8acb2c6e804205d50510d612dafae9116be3;hb=a8980cc3f6508f2659dc4ba4fcbeed65ba3c8e95;hpb=d99f3f2f67d693c30494be7ad19b97f3f5528961 diff --git a/n2vc/k8s_conn.py b/n2vc/k8s_conn.py index 5bdc8ac..ef4f5f2 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): """ @@ -74,7 +79,14 @@ class K8sConnector(abc.ABC, Loggable): @abc.abstractmethod async def repo_add( - self, cluster_uuid: str, name: str, url: str, repo_type: str = "chart" + self, + cluster_uuid: str, + name: str, + url: str, + repo_type: str = "chart", + cert: str = None, + user: str = None, + password: str = None, ): """ Add a new repository to OSM database @@ -136,6 +148,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 +167,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 +216,63 @@ 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, + cluster_uuid: str = None, + kdu_model: str = None, + atomic: bool = True, + db_dict: dict = None, + **kwargs, + ) -> bool: + """Scale a resource in a KDU instance. + + Args: + kdu_instance: KDU instance name + scale: Scale to which to set the resource + resource_name: Resource name + total_timeout: The time, in seconds, to wait for the install + to finish + cluster_uuid: The UUID of the cluster + kdu_model: The chart/bundle reference + atomic: if set, upgrade process rolls back changes made in case of failed upgrade. + The --wait flag will be set automatically if --atomic is used + db_dict: Dictionary for any additional data + kwargs: Additional parameters + vca_id (str): VCA ID + + Returns: + True if successful, False otherwise + """ + + @abc.abstractmethod + async def get_scale_count( + self, + resource_name: str, + kdu_instance: str, + cluster_uuid: str, + kdu_model: str, + timeout: float = 300, + **kwargs, + ) -> int: + """Get a resource scale count in a KDU instance. + + Args: + resource_name: Resource name + kdu_instance: KDU instance name + cluster_uuid: The UUID of the cluster + kdu_model: chart/bundle reference + timeout: The time, in seconds, to wait + kwargs: Additional parameters + + Returns: + Resource instance count + """ + @abc.abstractmethod async def rollback( self, cluster_uuid: str, kdu_instance: str, revision=0, db_dict: dict = None @@ -288,7 +359,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 +370,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: @@ -313,10 +388,9 @@ class K8sConnector(abc.ABC, Loggable): """ @abc.abstractmethod - async def get_services(self, - cluster_uuid: str, - kdu_instance: str, - namespace: str) -> list: + 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. @@ -334,10 +408,9 @@ class K8sConnector(abc.ABC, Loggable): """ @abc.abstractmethod - async def get_service(self, - cluster_uuid: str, - service_name: str, - namespace: str = None) -> object: + 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.