X-Git-Url: https://osm.etsi.org/gitweb/?p=osm%2FN2VC.git;a=blobdiff_plain;f=n2vc%2Fk8s_juju_conn.py;h=396d79be9a7f57acce7e710df96330f83ed31b53;hp=149947ddefbb58523d4e300a16947d9235722c3f;hb=764d8664333e7a6f16353bc8f578c5681f66433f;hpb=d8d4b6e70c0e4410a4b5c274faecd37ee821f3b7 diff --git a/n2vc/k8s_juju_conn.py b/n2vc/k8s_juju_conn.py index 149947d..396d79b 100644 --- a/n2vc/k8s_juju_conn.py +++ b/n2vc/k8s_juju_conn.py @@ -13,6 +13,7 @@ # limitations under the License. import asyncio +from typing import Union import os import uuid import yaml @@ -20,6 +21,7 @@ import tempfile import binascii from n2vc.config import EnvironConfig +from n2vc.definitions import RelationEndpoint from n2vc.exceptions import K8sException from n2vc.k8s_conn import K8sConnector from n2vc.kubectl import Kubectl @@ -76,6 +78,7 @@ class K8sJujuConnector(K8sConnector): db_uri = EnvironConfig(prefixes=["OSMLCM_", "OSMMON_"]).get("database_uri") self._store = MotorStore(db_uri) self.loading_libjuju = asyncio.Lock(loop=self.loop) + self.uninstall_locks = {} self.log.debug("K8S Juju connector initialized") # TODO: Remove these commented lines: @@ -121,14 +124,16 @@ class K8sJujuConnector(K8sConnector): # if it fails in the middle of the process cleanup_data = [] try: + self.log.debug("Initializing K8s cluster for juju") kubectl.create_cluster_role( name=metadata_name, labels=labels, ) + self.log.debug("Cluster role created") cleanup_data.append( { "delete": kubectl.delete_cluster_role, - "args": (metadata_name), + "args": (metadata_name,), } ) @@ -136,10 +141,11 @@ class K8sJujuConnector(K8sConnector): name=metadata_name, labels=labels, ) + self.log.debug("Service account created") cleanup_data.append( { "delete": kubectl.delete_service_account, - "args": (metadata_name), + "args": (metadata_name,), } ) @@ -147,10 +153,11 @@ class K8sJujuConnector(K8sConnector): name=metadata_name, labels=labels, ) + self.log.debug("Role binding created") cleanup_data.append( { "delete": kubectl.delete_service_account, - "args": (metadata_name), + "args": (metadata_name,), } ) token, client_cert_data = await kubectl.get_secret_data( @@ -158,6 +165,7 @@ class K8sJujuConnector(K8sConnector): ) default_storage_class = kubectl.get_default_storage_class() + self.log.debug("Default storage class: {}".format(default_storage_class)) await libjuju.add_k8s( name=cluster_uuid, rbac_id=rbac_id, @@ -167,9 +175,10 @@ class K8sJujuConnector(K8sConnector): storage_class=default_storage_class, credential_name=self._get_credential_name(cluster_uuid), ) + self.log.debug("K8s cluster added to juju controller") return cluster_uuid, True except Exception as e: - self.log.error("Error initializing k8scluster: {}".format(e)) + self.log.error("Error initializing k8scluster: {}".format(e), exc_info=True) if len(cleanup_data) > 0: self.log.debug("Cleaning up created resources in k8s cluster...") for item in cleanup_data: @@ -186,6 +195,9 @@ class K8sJujuConnector(K8sConnector): name: str, url: str, _type: str = "charm", + cert: str = None, + user: str = None, + password: str = None, ): raise MethodNotImplemented() @@ -302,6 +314,10 @@ class K8sJujuConnector(K8sConnector): raise K8sException("bundle must be set") if bundle.startswith("cs:"): + # For Juju Bundles provided by the Charm Store + pass + elif bundle.startswith("ch:"): + # For Juju Bundles provided by the Charm Hub (this only works for juju version >= 2.9) pass elif bundle.startswith("http"): # Download the file @@ -311,12 +327,16 @@ class K8sJujuConnector(K8sConnector): os.chdir(new_workdir) bundle = "local:{}".format(kdu_model) - self.log.debug("Checking for model named {}".format(kdu_instance)) + # default namespace to kdu_instance + if not namespace: + namespace = kdu_instance + + self.log.debug("Checking for model named {}".format(namespace)) # Create the new model - self.log.debug("Adding model: {}".format(kdu_instance)) + self.log.debug("Adding model: {}".format(namespace)) cloud = Cloud(cluster_uuid, self._get_credential_name(cluster_uuid)) - await libjuju.add_model(kdu_instance, cloud) + await libjuju.add_model(namespace, cloud) # if model: # TODO: Instantiation parameters @@ -335,10 +355,10 @@ class K8sJujuConnector(K8sConnector): previous_workdir = "/app/storage" self.log.debug("[install] deploying {}".format(bundle)) - await libjuju.deploy( - bundle, model_name=kdu_instance, wait=atomic, timeout=timeout - ) + await libjuju.deploy(bundle, model_name=namespace, wait=atomic, timeout=timeout) os.chdir(previous_workdir) + + # update information in the database (first, the VCA status, and then, the namespace) if self.on_update_db: await self.on_update_db( cluster_uuid, @@ -346,6 +366,13 @@ class K8sJujuConnector(K8sConnector): filter=db_dict["filter"], vca_id=kwargs.get("vca_id"), ) + + self.db.set_one( + table="nsrs", + q_filter={"_admin.deployed.K8s.kdu-instance": kdu_instance}, + update_dict={"_admin.deployed.K8s.$.namespace": namespace}, + ) + return True async def scale( @@ -354,32 +381,37 @@ class K8sJujuConnector(K8sConnector): scale: int, resource_name: str, total_timeout: float = 1800, + namespace: str = None, **kwargs, ) -> bool: """Scale an application in a model :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: scale int: Scale to which to set the application + :param: resource_name str: The application name in the Juju Bundle :param: timeout float: The time, in seconds, to wait for the install to finish + :param namespace str: The namespace (model) where the Bundle was deployed :param kwargs: Additional parameters vca_id (str): VCA ID :return: If successful, returns True """ + model_name = self._obtain_namespace( + kdu_instance=kdu_instance, namespace=namespace + ) try: libjuju = await self._get_libjuju(kwargs.get("vca_id")) await libjuju.scale_application( - model_name=kdu_instance, + model_name=model_name, application_name=resource_name, scale=scale, total_timeout=total_timeout, ) except Exception as e: - error_msg = "Error scaling application {} in kdu instance {}: {}".format( - resource_name, kdu_instance, e + error_msg = "Error scaling application {} of the model {} of the kdu instance {}: {}".format( + resource_name, model_name, kdu_instance, e ) self.log.error(error_msg) raise K8sException(message=error_msg) @@ -389,23 +421,30 @@ class K8sJujuConnector(K8sConnector): self, resource_name: str, kdu_instance: str, + namespace: str = None, **kwargs, ) -> int: """Get an application scale count - :param: resource_name str: Resource name (Application name) + :param: resource_name str: The application name in the Juju Bundle :param: kdu_instance str: KDU instance name + :param namespace str: The namespace (model) where the Bundle was deployed :param kwargs: Additional parameters vca_id (str): VCA ID :return: Return application instance count """ + + model_name = self._obtain_namespace( + kdu_instance=kdu_instance, namespace=namespace + ) try: libjuju = await self._get_libjuju(kwargs.get("vca_id")) - status = await libjuju.get_model_status(kdu_instance) + status = await libjuju.get_model_status(model_name=model_name) return len(status.applications[resource_name].units) except Exception as e: - error_msg = "Error getting scale count from application {} in kdu instance {}: {}".format( - resource_name, kdu_instance, e + error_msg = ( + f"Error getting scale count from application {resource_name} of the model {model_name} of " + f"the kdu instance {kdu_instance}: {e}" ) self.log.error(error_msg) raise K8sException(message=error_msg) @@ -478,31 +517,72 @@ class K8sJujuConnector(K8sConnector): self, cluster_uuid: str, kdu_instance: str, + namespace: str = None, **kwargs, ) -> bool: """Uninstall a KDU instance :param cluster_uuid str: The UUID of the cluster :param kdu_instance str: The unique name of the KDU instance + :param namespace str: The namespace (model) where the Bundle was deployed :param kwargs: Additional parameters vca_id (str): VCA ID :return: Returns True if successful, or raises an exception """ + model_name = self._obtain_namespace( + kdu_instance=kdu_instance, namespace=namespace + ) - self.log.debug("[uninstall] Destroying model") - libjuju = await self._get_libjuju(kwargs.get("vca_id")) + self.log.debug(f"[uninstall] Destroying model: {model_name}") - await libjuju.destroy_model(kdu_instance, total_timeout=3600) + will_not_delete = False + if model_name not in self.uninstall_locks: + self.uninstall_locks[model_name] = asyncio.Lock(loop=self.loop) + delete_lock = self.uninstall_locks[model_name] - # self.log.debug("[uninstall] Model destroyed and disconnecting") - # await controller.disconnect() + while delete_lock.locked(): + will_not_delete = True + await asyncio.sleep(0.1) + if will_not_delete: + self.log.info("Model {} deleted by another worker.".format(model_name)) + return True + + try: + async with delete_lock: + libjuju = await self._get_libjuju(kwargs.get("vca_id")) + + await libjuju.destroy_model(model_name, total_timeout=3600) + finally: + self.uninstall_locks.pop(model_name) + + self.log.debug(f"[uninstall] Model {model_name} destroyed") return True - # TODO: Remove these commented lines - # if not self.authenticated: - # self.log.debug("[uninstall] Connecting to controller") - # await self.login(cluster_uuid) + + async def upgrade_charm( + self, + ee_id: str = None, + path: str = None, + charm_id: str = None, + charm_type: str = None, + timeout: float = None, + ) -> str: + """This method upgrade charms in VNFs + + Args: + ee_id: Execution environment id + path: Local path to the charm + charm_id: charm-id + charm_type: Charm type can be lxc-proxy-charm, native-charm or k8s-proxy-charm + timeout: (Float) Timeout for the ns update operation + + Returns: + The output of the update operation if status equals to "completed" + """ + raise K8sException( + "KDUs deployed with Juju Bundle do not support charm upgrade" + ) async def exec_primitive( self, @@ -512,6 +592,7 @@ class K8sJujuConnector(K8sConnector): timeout: float = 300, params: dict = None, db_dict: dict = None, + namespace: str = None, **kwargs, ) -> str: """Exec primitive (Juju action) @@ -522,6 +603,7 @@ class K8sJujuConnector(K8sConnector): :param timeout: Timeout for action execution :param params: Dictionary of all the parameters needed for the action :param db_dict: Dictionary for any additional data + :param namespace str: The namespace (model) where the Bundle was deployed :param kwargs: Additional parameters vca_id (str): VCA ID @@ -529,6 +611,10 @@ class K8sJujuConnector(K8sConnector): """ libjuju = await self._get_libjuju(kwargs.get("vca_id")) + namespace = self._obtain_namespace( + kdu_instance=kdu_instance, namespace=namespace + ) + if not params or "application-name" not in params: raise K8sException( "Missing application-name argument, \ @@ -537,14 +623,19 @@ class K8sJujuConnector(K8sConnector): try: self.log.debug( "[exec_primitive] Getting model " - "kdu_instance: {}".format(kdu_instance) + "{} for the kdu_instance: {}".format(namespace, kdu_instance) ) application_name = params["application-name"] - actions = await libjuju.get_actions(application_name, kdu_instance) + actions = await libjuju.get_actions( + application_name=application_name, model_name=namespace + ) if primitive_name not in actions: raise K8sException("Primitive {} not found".format(primitive_name)) output, status = await libjuju.execute_action( - application_name, kdu_instance, primitive_name, **params + application_name=application_name, + model_name=namespace, + action_name=primitive_name, + **params, ) if status != "completed": @@ -553,7 +644,9 @@ class K8sJujuConnector(K8sConnector): ) if self.on_update_db: await self.on_update_db( - cluster_uuid, kdu_instance, filter=db_dict["filter"] + cluster_uuid=cluster_uuid, + kdu_instance=kdu_instance, + filter=db_dict["filter"], ) return output @@ -616,11 +709,11 @@ class K8sJujuConnector(K8sConnector): ) -> str: """View the README - If available, returns the README of the bundle. + If available, returns the README of the bundle. - :param kdu_model str: The name or path of a bundle - - :return: If found, returns the contents of the README. + :param kdu_model str: The name or path of a bundle + f + :return: If found, returns the contents of the README. """ readme = None @@ -640,8 +733,9 @@ class K8sJujuConnector(K8sConnector): kdu_instance: str, complete_status: bool = False, yaml_format: bool = False, + namespace: str = None, **kwargs, - ) -> dict: + ) -> Union[str, dict]: """Get the status of the KDU Get the current status of the KDU instance. @@ -650,6 +744,7 @@ class K8sJujuConnector(K8sConnector): :param kdu_instance str: The unique id of the KDU instance :param complete_status: To get the complete_status of the KDU :param yaml_format: To get the status in proper format for NSR record + :param namespace str: The namespace (model) where the Bundle was deployed :param: kwargs: Additional parameters vca_id (str): VCA ID @@ -659,7 +754,10 @@ class K8sJujuConnector(K8sConnector): libjuju = await self._get_libjuju(kwargs.get("vca_id")) status = {} - model_status = await libjuju.get_model_status(kdu_instance) + model_name = self._obtain_namespace( + kdu_instance=kdu_instance, namespace=namespace + ) + model_status = await libjuju.get_model_status(model_name=model_name) if not complete_status: for name in model_status.applications: @@ -673,34 +771,91 @@ class K8sJujuConnector(K8sConnector): return status - async def update_vca_status(self, vcastatus: dict, kdu_instance: str, **kwargs): + async def add_relation( + self, + provider: RelationEndpoint, + requirer: RelationEndpoint, + ): + """ + Add relation between two charmed endpoints + + :param: provider: Provider relation endpoint + :param: requirer: Requirer relation endpoint + """ + self.log.debug(f"adding new relation between {provider} and {requirer}") + cross_model_relation = ( + provider.model_name != requirer.model_name + or requirer.vca_id != requirer.vca_id + ) + try: + if cross_model_relation: + # Cross-model relation + provider_libjuju = await self._get_libjuju(provider.vca_id) + requirer_libjuju = await self._get_libjuju(requirer.vca_id) + offer = await provider_libjuju.offer(provider) + if offer: + saas_name = await requirer_libjuju.consume( + requirer.model_name, offer, provider_libjuju + ) + await requirer_libjuju.add_relation( + requirer.model_name, + requirer.endpoint, + saas_name, + ) + else: + # Standard relation + vca_id = provider.vca_id + model = provider.model_name + libjuju = await self._get_libjuju(vca_id) + # add juju relations between two applications + await libjuju.add_relation( + model_name=model, + endpoint_1=provider.endpoint, + endpoint_2=requirer.endpoint, + ) + except Exception as e: + message = f"Error adding relation between {provider} and {requirer}: {e}" + self.log.error(message) + raise Exception(message=message) + + async def update_vca_status( + self, vcastatus: dict, kdu_instance: str, namespace: str = None, **kwargs + ): """ Add all configs, actions, executed actions of all applications in a model to vcastatus dict :param vcastatus dict: dict containing vcastatus :param kdu_instance str: The unique id of the KDU instance + :param namespace str: The namespace (model) where the Bundle was deployed :param: kwargs: Additional parameters vca_id (str): VCA ID :return: None """ + + model_name = self._obtain_namespace( + kdu_instance=kdu_instance, namespace=namespace + ) + libjuju = await self._get_libjuju(kwargs.get("vca_id")) try: - for model_name in vcastatus: + for vca_model_name in vcastatus: # Adding executed actions - vcastatus[model_name][ + vcastatus[vca_model_name][ "executedActions" - ] = await libjuju.get_executed_actions(kdu_instance) + ] = await libjuju.get_executed_actions(model_name=model_name) - for application in vcastatus[model_name]["applications"]: + for application in vcastatus[vca_model_name]["applications"]: # Adding application actions - vcastatus[model_name]["applications"][application][ + vcastatus[vca_model_name]["applications"][application][ "actions" - ] = await libjuju.get_actions(application, kdu_instance) + ] = {} # Adding application configs - vcastatus[model_name]["applications"][application][ + vcastatus[vca_model_name]["applications"][application][ "configs" - ] = await libjuju.get_application_configs(kdu_instance, application) + ] = await libjuju.get_application_configs( + model_name=model_name, application_name=application + ) except Exception as e: self.log.debug("Error in updating vca status: {}".format(str(e))) @@ -710,10 +865,14 @@ class K8sJujuConnector(K8sConnector): ) -> list: """Return a list of services of a kdu_instance""" + namespace = self._obtain_namespace( + kdu_instance=kdu_instance, namespace=namespace + ) + credentials = self.get_credentials(cluster_uuid=cluster_uuid) kubectl = self._get_kubectl(credentials) return kubectl.get_services( - field_selector="metadata.namespace={}".format(kdu_instance) + field_selector="metadata.namespace={}".format(namespace) ) async def get_service( @@ -819,3 +978,34 @@ class K8sJujuConnector(K8sConnector): with open(kubecfg.name, "w") as kubecfg_file: kubecfg_file.write(credentials) return Kubectl(config_file=kubecfg.name) + + def _obtain_namespace(self, kdu_instance: str, namespace: str = None) -> str: + """ + Obtain the namespace/model name to use in the instantiation of a Juju Bundle in K8s. The default namespace is + the kdu_instance name. However, if the user passes the namespace where he wants to deploy the bundle, + that namespace will be used. + + :param kdu_instance: the default KDU instance name + :param namespace: the namespace passed by the User + """ + + # deault the namespace/model name to the kdu_instance name TODO -> this should be the real return... But + # once the namespace is not passed in most methods, I had to do this in another way. But I think this should + # be the procedure in the future return namespace if namespace else kdu_instance + + # TODO -> has referred above, this should be avoided in the future, this is temporary, in order to avoid + # compatibility issues + return ( + namespace + if namespace + else self._obtain_namespace_from_db(kdu_instance=kdu_instance) + ) + + def _obtain_namespace_from_db(self, kdu_instance: str) -> str: + db_nsrs = self.db.get_one( + table="nsrs", q_filter={"_admin.deployed.K8s.kdu-instance": kdu_instance} + ) + for k8s in db_nsrs["_admin"]["deployed"]["K8s"]: + if k8s.get("kdu-instance") == kdu_instance: + return k8s.get("namespace") + return ""