X-Git-Url: https://osm.etsi.org/gitweb/?p=osm%2FN2VC.git;a=blobdiff_plain;f=n2vc%2Fk8s_conn.py;h=4fdaee8df0686052ecd882ed2d738cf56245bdb2;hp=d951c2c16200373ce72819ce74ecd84b11f2efc2;hb=2ce889dd990cb4e20a1de19dc1a1f974be31d70d;hpb=9ae4d929c2b739d146e3e27388dc4825ca046e50 diff --git a/n2vc/k8s_conn.py b/n2vc/k8s_conn.py index d951c2c..4fdaee8 100644 --- a/n2vc/k8s_conn.py +++ b/n2vc/k8s_conn.py @@ -63,7 +63,7 @@ class K8sConnector(abc.ABC, Loggable): self, k8s_creds: str, namespace: str = 'kube-system', - reuse_cluster_uuid = None + reuse_cluster_uuid=None ) -> (str, bool): """ It prepares a given K8s cluster environment to run Charts or juju Bundles on both sides: @@ -71,7 +71,8 @@ class K8sConnector(abc.ABC, Loggable): server (Tiller/Charm) :param k8s_creds: credentials to access a given K8s cluster, i.e. a valid '.kube/config' - :param namespace: optional namespace for helm tiller. By default, 'kube-system' will be used + :param namespace: optional namespace to be used for the K8s engine (helm tiller, juju). + By default, 'kube-system' will be used :param reuse_cluster_uuid: existing cluster uuid for reuse :return: uuid of the K8s cluster and True if connector has installed some software in the cluster (on error, an exception will be raised) @@ -237,30 +238,33 @@ class K8sConnector(abc.ABC, Loggable): @abc.abstractmethod async def inspect_kdu( self, - kdu_model: str + kdu_model: str, + repo_url: str = None ) -> str: """ - These calls will retrieve from the Charm/Bundle: + These calls will retrieve from the Chart/Bundle: - The list of configurable values and their defaults (e.g. in Charts, it would retrieve the contents of `values.yaml`). - If available, any embedded help file (e.g. `readme.md`) embedded in the Chart/Bundle. - :param cluster_uuid: the cluster to get the information :param kdu_model: chart/bundle reference - :return: If successful, it will return a dictionary containing the list of available parameters - and their default values + :param repo_url: optional, reposotory URL (None if tar.gz, URl in other cases, even stable URL) + :return: + + If successful, it will return the available parameters and their default values as provided by the backend. """ @abc.abstractmethod async def help_kdu( self, - kdu_model: str + kdu_model: str, + repo_url: str = None ) -> str: """ - :param cluster_uuid: the cluster to get the information :param kdu_model: chart/bundle reference + :param repo_url: optional, reposotory URL (None if tar.gz, URl in other cases, even stable URL) :return: If successful, it will return the contents of the 'readme.md' """