n2vc/k8s_juju_conn.py

   1 # Copyright 2019 Canonical Ltd.
   2 #
   3 # Licensed under the Apache License, Version 2.0 (the "License");
   4 # you may not use this file except in compliance with the License.
   5 # You may obtain a copy of the License at
   6 #
   7 #     http://www.apache.org/licenses/LICENSE-2.0
   8 #
   9 #     Unless required by applicable law or agreed to in writing, software
  10 #     distributed under the License is distributed on an "AS IS" BASIS,
  11 #     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12 #     See the License for the specific language governing permissions and
  13 #     limitations under the License.
  14
  15 import asyncio
  16 import os
  17 import uuid
  18 import yaml
  19 import tempfile
  20 import binascii
  21
  22 from n2vc.config import EnvironConfig
  23 from n2vc.definitions import RelationEndpoint
  24 from n2vc.exceptions import K8sException
  25 from n2vc.k8s_conn import K8sConnector
  26 from n2vc.kubectl import Kubectl
  27 from .exceptions import MethodNotImplemented
  28 from n2vc.libjuju import Libjuju
  29 from n2vc.utils import obj_to_dict, obj_to_yaml
  30 from n2vc.store import MotorStore
  31 from n2vc.vca.cloud import Cloud
  32 from n2vc.vca.connection import get_connection
  33
  34
  35 RBAC_LABEL_KEY_NAME = "rbac-id"
  36 RBAC_STACK_PREFIX = "juju-credential"
  37
  38
  39 def generate_rbac_id():
  40     return binascii.hexlify(os.urandom(4)).decode()
  41
  42
  43 class K8sJujuConnector(K8sConnector):
  44     libjuju = None
  45
  46     def __init__(
  47         self,
  48         fs: object,
  49         db: object,
  50         kubectl_command: str = "/usr/bin/kubectl",
  51         juju_command: str = "/usr/bin/juju",
  52         log: object = None,
  53         loop: object = None,
  54         on_update_db=None,
  55     ):
  56         """
  57         :param fs: file system for kubernetes and helm configuration
  58         :param db: Database object
  59         :param kubectl_command: path to kubectl executable
  60         :param helm_command: path to helm executable
  61         :param log: logger
  62         :param: loop: Asyncio loop
  63         """
  64
  65         # parent class
  66         K8sConnector.__init__(
  67             self,
  68             db,
  69             log=log,
  70             on_update_db=on_update_db,
  71         )
  72
  73         self.fs = fs
  74         self.loop = loop or asyncio.get_event_loop()
  75         self.log.debug("Initializing K8S Juju connector")
  76
  77         db_uri = EnvironConfig(prefixes=["OSMLCM_", "OSMMON_"]).get("database_uri")
  78         self._store = MotorStore(db_uri)
  79         self.loading_libjuju = asyncio.Lock(loop=self.loop)
  80
  81         self.log.debug("K8S Juju connector initialized")
  82         # TODO: Remove these commented lines:
  83         # self.authenticated = False
  84         # self.models = {}
  85         # self.juju_secret = ""
  86
  87     """Initialization"""
  88
  89     async def init_env(
  90         self,
  91         k8s_creds: str,
  92         namespace: str = "kube-system",
  93         reuse_cluster_uuid: str = None,
  94         **kwargs,
  95     ) -> (str, bool):
  96         """
  97         It prepares a given K8s cluster environment to run Juju bundles.
  98
  99         :param k8s_creds: credentials to access a given K8s cluster, i.e. a valid
 100             '.kube/config'
 101         :param namespace: optional namespace to be used for juju. By default,
 102             'kube-system' will be used
 103         :param reuse_cluster_uuid: existing cluster uuid for reuse
 104         :param: kwargs: Additional parameters
 105             vca_id (str): VCA ID
 106
 107         :return: uuid of the K8s cluster and True if connector has installed some
 108             software in the cluster
 109             (on error, an exception will be raised)
 110         """
 111         libjuju = await self._get_libjuju(kwargs.get("vca_id"))
 112
 113         cluster_uuid = reuse_cluster_uuid or str(uuid.uuid4())
 114         kubectl = self._get_kubectl(k8s_creds)
 115
 116         # CREATING RESOURCES IN K8S
 117         rbac_id = generate_rbac_id()
 118         metadata_name = "{}-{}".format(RBAC_STACK_PREFIX, rbac_id)
 119         labels = {RBAC_STACK_PREFIX: rbac_id}
 120
 121         # Create cleanup dictionary to clean up created resources
 122         # if it fails in the middle of the process
 123         cleanup_data = []
 124         try:
 125             kubectl.create_cluster_role(
 126                 name=metadata_name,
 127                 labels=labels,
 128             )
 129             cleanup_data.append(
 130                 {
 131                     "delete": kubectl.delete_cluster_role,
 132                     "args": (metadata_name,),
 133                 }
 134             )
 135
 136             kubectl.create_service_account(
 137                 name=metadata_name,
 138                 labels=labels,
 139             )
 140             cleanup_data.append(
 141                 {
 142                     "delete": kubectl.delete_service_account,
 143                     "args": (metadata_name,),
 144                 }
 145             )
 146
 147             kubectl.create_cluster_role_binding(
 148                 name=metadata_name,
 149                 labels=labels,
 150             )
 151             cleanup_data.append(
 152                 {
 153                     "delete": kubectl.delete_service_account,
 154                     "args": (metadata_name,),
 155                 }
 156             )
 157             token, client_cert_data = await kubectl.get_secret_data(
 158                 metadata_name,
 159             )
 160
 161             default_storage_class = kubectl.get_default_storage_class()
 162             await libjuju.add_k8s(
 163                 name=cluster_uuid,
 164                 rbac_id=rbac_id,
 165                 token=token,
 166                 client_cert_data=client_cert_data,
 167                 configuration=kubectl.configuration,
 168                 storage_class=default_storage_class,
 169                 credential_name=self._get_credential_name(cluster_uuid),
 170             )
 171             return cluster_uuid, True
 172         except Exception as e:
 173             self.log.error("Error initializing k8scluster: {}".format(e))
 174             if len(cleanup_data) > 0:
 175                 self.log.debug("Cleaning up created resources in k8s cluster...")
 176                 for item in cleanup_data:
 177                     delete_function = item["delete"]
 178                     delete_args = item["args"]
 179                     delete_function(*delete_args)
 180                 self.log.debug("Cleanup finished")
 181             raise e
 182
 183     """Repo Management"""
 184
 185     async def repo_add(
 186         self,
 187         name: str,
 188         url: str,
 189         _type: str = "charm",
 190     ):
 191         raise MethodNotImplemented()
 192
 193     async def repo_list(self):
 194         raise MethodNotImplemented()
 195
 196     async def repo_remove(
 197         self,
 198         name: str,
 199     ):
 200         raise MethodNotImplemented()
 201
 202     async def synchronize_repos(self, cluster_uuid: str, name: str):
 203         """
 204         Returns None as currently add_repo is not implemented
 205         """
 206         return None
 207
 208     """Reset"""
 209
 210     async def reset(
 211         self,
 212         cluster_uuid: str,
 213         force: bool = False,
 214         uninstall_sw: bool = False,
 215         **kwargs,
 216     ) -> bool:
 217         """Reset a cluster
 218
 219         Resets the Kubernetes cluster by removing the model that represents it.
 220
 221         :param cluster_uuid str: The UUID of the cluster to reset
 222         :param force: Force reset
 223         :param uninstall_sw: Boolean to uninstall sw
 224         :param: kwargs: Additional parameters
 225             vca_id (str): VCA ID
 226
 227         :return: Returns True if successful or raises an exception.
 228         """
 229
 230         try:
 231             self.log.debug("[reset] Removing k8s cloud")
 232             libjuju = await self._get_libjuju(kwargs.get("vca_id"))
 233
 234             cloud = Cloud(cluster_uuid, self._get_credential_name(cluster_uuid))
 235
 236             cloud_creds = await libjuju.get_cloud_credentials(cloud)
 237
 238             await libjuju.remove_cloud(cluster_uuid)
 239
 240             credentials = self.get_credentials(cluster_uuid=cluster_uuid)
 241
 242             kubectl = self._get_kubectl(credentials)
 243
 244             delete_functions = [
 245                 kubectl.delete_cluster_role_binding,
 246                 kubectl.delete_service_account,
 247                 kubectl.delete_cluster_role,
 248             ]
 249
 250             credential_attrs = cloud_creds[0].result["attrs"]
 251             if RBAC_LABEL_KEY_NAME in credential_attrs:
 252                 rbac_id = credential_attrs[RBAC_LABEL_KEY_NAME]
 253                 metadata_name = "{}-{}".format(RBAC_STACK_PREFIX, rbac_id)
 254                 for delete_func in delete_functions:
 255                     try:
 256                         delete_func(metadata_name)
 257                     except Exception as e:
 258                         self.log.warning("Cannot remove resource in K8s {}".format(e))
 259
 260         except Exception as e:
 261             self.log.debug("Caught exception during reset: {}".format(e))
 262             raise e
 263         return True
 264
 265     """Deployment"""
 266
 267     async def install(
 268         self,
 269         cluster_uuid: str,
 270         kdu_model: str,
 271         kdu_instance: str,
 272         atomic: bool = True,
 273         timeout: float = 1800,
 274         params: dict = None,
 275         db_dict: dict = None,
 276         kdu_name: str = None,
 277         namespace: str = None,
 278         **kwargs,
 279     ) -> bool:
 280         """Install a bundle
 281
 282         :param cluster_uuid str: The UUID of the cluster to install to
 283         :param kdu_model str: The name or path of a bundle to install
 284         :param kdu_instance: Kdu instance name
 285         :param atomic bool: If set, waits until the model is active and resets
 286                             the cluster on failure.
 287         :param timeout int: The time, in seconds, to wait for the install
 288                             to finish
 289         :param params dict: Key-value pairs of instantiation parameters
 290         :param kdu_name: Name of the KDU instance to be installed
 291         :param namespace: K8s namespace to use for the KDU instance
 292         :param kwargs: Additional parameters
 293             vca_id (str): VCA ID
 294
 295         :return: If successful, returns ?
 296         """
 297         libjuju = await self._get_libjuju(kwargs.get("vca_id"))
 298         bundle = kdu_model
 299
 300         if not db_dict:
 301             raise K8sException("db_dict must be set")
 302         if not bundle:
 303             raise K8sException("bundle must be set")
 304
 305         if bundle.startswith("cs:"):
 306             # For Juju Bundles provided by the Charm Store
 307             pass
 308         elif bundle.startswith("ch:"):
 309             # For Juju Bundles provided by the Charm Hub (this only works for juju version >= 2.9)
 310             pass
 311         elif bundle.startswith("http"):
 312             # Download the file
 313             pass
 314         else:
 315             new_workdir = kdu_model.strip(kdu_model.split("/")[-1])
 316             os.chdir(new_workdir)
 317             bundle = "local:{}".format(kdu_model)
 318
 319         self.log.debug("Checking for model named {}".format(kdu_instance))
 320
 321         # Create the new model
 322         self.log.debug("Adding model: {}".format(kdu_instance))
 323         cloud = Cloud(cluster_uuid, self._get_credential_name(cluster_uuid))
 324         await libjuju.add_model(kdu_instance, cloud)
 325
 326         # if model:
 327         # TODO: Instantiation parameters
 328
 329         """
 330         "Juju bundle that models the KDU, in any of the following ways:
 331             - <juju-repo>/<juju-bundle>
 332             - <juju-bundle folder under k8s_models folder in the package>
 333             - <juju-bundle tgz file (w/ or w/o extension) under k8s_models folder
 334                 in the package>
 335             - <URL_where_to_fetch_juju_bundle>
 336         """
 337         try:
 338             previous_workdir = os.getcwd()
 339         except FileNotFoundError:
 340             previous_workdir = "/app/storage"
 341
 342         self.log.debug("[install] deploying {}".format(bundle))
 343         await libjuju.deploy(
 344             bundle, model_name=kdu_instance, wait=atomic, timeout=timeout
 345         )
 346         os.chdir(previous_workdir)
 347         if self.on_update_db:
 348             await self.on_update_db(
 349                 cluster_uuid,
 350                 kdu_instance,
 351                 filter=db_dict["filter"],
 352                 vca_id=kwargs.get("vca_id"),
 353             )
 354         return True
 355
 356     async def scale(
 357         self,
 358         kdu_instance: str,
 359         scale: int,
 360         resource_name: str,
 361         total_timeout: float = 1800,
 362         **kwargs,
 363     ) -> bool:
 364         """Scale an application in a model
 365
 366         :param: kdu_instance str:        KDU instance name
 367         :param: scale int:               Scale to which to set the application
 368         :param: resource_name str:       The application name in the Juju Bundle
 369         :param: timeout float:           The time, in seconds, to wait for the install
 370                                          to finish
 371         :param kwargs:                   Additional parameters
 372                                             vca_id (str): VCA ID
 373
 374         :return: If successful, returns True
 375         """
 376
 377         try:
 378             libjuju = await self._get_libjuju(kwargs.get("vca_id"))
 379             await libjuju.scale_application(
 380                 model_name=kdu_instance,
 381                 application_name=resource_name,
 382                 scale=scale,
 383                 total_timeout=total_timeout,
 384             )
 385         except Exception as e:
 386             error_msg = "Error scaling application {} in kdu instance {}: {}".format(
 387                 resource_name, kdu_instance, e
 388             )
 389             self.log.error(error_msg)
 390             raise K8sException(message=error_msg)
 391         return True
 392
 393     async def get_scale_count(
 394         self,
 395         resource_name: str,
 396         kdu_instance: str,
 397         **kwargs,
 398     ) -> int:
 399         """Get an application scale count
 400
 401         :param: resource_name str:       The application name in the Juju Bundle
 402         :param: kdu_instance str:        KDU instance name
 403         :param kwargs:                   Additional parameters
 404                                             vca_id (str): VCA ID
 405         :return: Return application instance count
 406         """
 407
 408         try:
 409             libjuju = await self._get_libjuju(kwargs.get("vca_id"))
 410             status = await libjuju.get_model_status(kdu_instance)
 411             return len(status.applications[resource_name].units)
 412         except Exception as e:
 413             error_msg = "Error getting scale count from application {} in kdu instance {}: {}".format(
 414                 resource_name, kdu_instance, e
 415             )
 416             self.log.error(error_msg)
 417             raise K8sException(message=error_msg)
 418
 419     async def instances_list(self, cluster_uuid: str) -> list:
 420         """
 421         returns a list of deployed releases in a cluster
 422
 423         :param cluster_uuid: the cluster
 424         :return:
 425         """
 426         return []
 427
 428     async def upgrade(
 429         self,
 430         cluster_uuid: str,
 431         kdu_instance: str,
 432         kdu_model: str = None,
 433         params: dict = None,
 434     ) -> str:
 435         """Upgrade a model
 436
 437         :param cluster_uuid str: The UUID of the cluster to upgrade
 438         :param kdu_instance str: The unique name of the KDU instance
 439         :param kdu_model str: The name or path of the bundle to upgrade to
 440         :param params dict: Key-value pairs of instantiation parameters
 441
 442         :return: If successful, reference to the new revision number of the
 443                  KDU instance.
 444         """
 445
 446         # TODO: Loop through the bundle and upgrade each charm individually
 447
 448         """
 449         The API doesn't have a concept of bundle upgrades, because there are
 450         many possible changes: charm revision, disk, number of units, etc.
 451
 452         As such, we are only supporting a limited subset of upgrades. We'll
 453         upgrade the charm revision but leave storage and scale untouched.
 454
 455         Scale changes should happen through OSM constructs, and changes to
 456         storage would require a redeployment of the service, at least in this
 457         initial release.
 458         """
 459         raise MethodNotImplemented()
 460
 461     """Rollback"""
 462
 463     async def rollback(
 464         self,
 465         cluster_uuid: str,
 466         kdu_instance: str,
 467         revision: int = 0,
 468     ) -> str:
 469         """Rollback a model
 470
 471         :param cluster_uuid str: The UUID of the cluster to rollback
 472         :param kdu_instance str: The unique name of the KDU instance
 473         :param revision int: The revision to revert to. If omitted, rolls back
 474                              the previous upgrade.
 475
 476         :return: If successful, returns the revision of active KDU instance,
 477                  or raises an exception
 478         """
 479         raise MethodNotImplemented()
 480
 481     """Deletion"""
 482
 483     async def uninstall(
 484         self,
 485         cluster_uuid: str,
 486         kdu_instance: str,
 487         **kwargs,
 488     ) -> bool:
 489         """Uninstall a KDU instance
 490
 491         :param cluster_uuid str: The UUID of the cluster
 492         :param kdu_instance str: The unique name of the KDU instance
 493         :param kwargs: Additional parameters
 494             vca_id (str): VCA ID
 495
 496         :return: Returns True if successful, or raises an exception
 497         """
 498
 499         self.log.debug("[uninstall] Destroying model")
 500         libjuju = await self._get_libjuju(kwargs.get("vca_id"))
 501
 502         await libjuju.destroy_model(kdu_instance, total_timeout=3600)
 503
 504         # self.log.debug("[uninstall] Model destroyed and disconnecting")
 505         # await controller.disconnect()
 506
 507         return True
 508         # TODO: Remove these commented lines
 509         # if not self.authenticated:
 510         #     self.log.debug("[uninstall] Connecting to controller")
 511         #     await self.login(cluster_uuid)
 512
 513     async def exec_primitive(
 514         self,
 515         cluster_uuid: str = None,
 516         kdu_instance: str = None,
 517         primitive_name: str = None,
 518         timeout: float = 300,
 519         params: dict = None,
 520         db_dict: dict = None,
 521         **kwargs,
 522     ) -> str:
 523         """Exec primitive (Juju action)
 524
 525         :param cluster_uuid str: The UUID of the cluster
 526         :param kdu_instance str: The unique name of the KDU instance
 527         :param primitive_name: Name of action that will be executed
 528         :param timeout: Timeout for action execution
 529         :param params: Dictionary of all the parameters needed for the action
 530         :param db_dict: Dictionary for any additional data
 531         :param kwargs: Additional parameters
 532             vca_id (str): VCA ID
 533
 534         :return: Returns the output of the action
 535         """
 536         libjuju = await self._get_libjuju(kwargs.get("vca_id"))
 537
 538         if not params or "application-name" not in params:
 539             raise K8sException(
 540                 "Missing application-name argument, \
 541                                 argument needed for K8s actions"
 542             )
 543         try:
 544             self.log.debug(
 545                 "[exec_primitive] Getting model "
 546                 "kdu_instance: {}".format(kdu_instance)
 547             )
 548             application_name = params["application-name"]
 549             actions = await libjuju.get_actions(application_name, kdu_instance)
 550             if primitive_name not in actions:
 551                 raise K8sException("Primitive {} not found".format(primitive_name))
 552             output, status = await libjuju.execute_action(
 553                 application_name, kdu_instance, primitive_name, **params
 554             )
 555
 556             if status != "completed":
 557                 raise K8sException(
 558                     "status is not completed: {} output: {}".format(status, output)
 559                 )
 560             if self.on_update_db:
 561                 await self.on_update_db(
 562                     cluster_uuid, kdu_instance, filter=db_dict["filter"]
 563                 )
 564
 565             return output
 566
 567         except Exception as e:
 568             error_msg = "Error executing primitive {}: {}".format(primitive_name, e)
 569             self.log.error(error_msg)
 570             raise K8sException(message=error_msg)
 571
 572     """Introspection"""
 573
 574     async def inspect_kdu(
 575         self,
 576         kdu_model: str,
 577     ) -> dict:
 578         """Inspect a KDU
 579
 580         Inspects a bundle and returns a dictionary of config parameters and
 581         their default values.
 582
 583         :param kdu_model str: The name or path of the bundle to inspect.
 584
 585         :return: If successful, returns a dictionary of available parameters
 586                  and their default values.
 587         """
 588
 589         kdu = {}
 590         if not os.path.exists(kdu_model):
 591             raise K8sException("file {} not found".format(kdu_model))
 592
 593         with open(kdu_model, "r") as f:
 594             bundle = yaml.safe_load(f.read())
 595
 596             """
 597             {
 598                 'description': 'Test bundle',
 599                 'bundle': 'kubernetes',
 600                 'applications': {
 601                     'mariadb-k8s': {
 602                         'charm': 'cs:~charmed-osm/mariadb-k8s-20',
 603                         'scale': 1,
 604                         'options': {
 605                             'password': 'manopw',
 606                             'root_password': 'osm4u',
 607                             'user': 'mano'
 608                         },
 609                         'series': 'kubernetes'
 610                     }
 611                 }
 612             }
 613             """
 614             # TODO: This should be returned in an agreed-upon format
 615             kdu = bundle["applications"]
 616
 617         return kdu
 618
 619     async def help_kdu(
 620         self,
 621         kdu_model: str,
 622     ) -> str:
 623         """View the README
 624
 625         If available, returns the README of the bundle.
 626
 627         :param kdu_model str: The name or path of a bundle
 628
 629         :return: If found, returns the contents of the README.
 630         """
 631         readme = None
 632
 633         files = ["README", "README.txt", "README.md"]
 634         path = os.path.dirname(kdu_model)
 635         for file in os.listdir(path):
 636             if file in files:
 637                 with open(file, "r") as f:
 638                     readme = f.read()
 639                     break
 640
 641         return readme
 642
 643     async def status_kdu(
 644         self,
 645         cluster_uuid: str,
 646         kdu_instance: str,
 647         complete_status: bool = False,
 648         yaml_format: bool = False,
 649         **kwargs,
 650     ) -> dict:
 651         """Get the status of the KDU
 652
 653         Get the current status of the KDU instance.
 654
 655         :param cluster_uuid str: The UUID of the cluster
 656         :param kdu_instance str: The unique id of the KDU instance
 657         :param complete_status: To get the complete_status of the KDU
 658         :param yaml_format: To get the status in proper format for NSR record
 659         :param: kwargs: Additional parameters
 660             vca_id (str): VCA ID
 661
 662         :return: Returns a dictionary containing namespace, state, resources,
 663                  and deployment_time and returns complete_status if complete_status is True
 664         """
 665         libjuju = await self._get_libjuju(kwargs.get("vca_id"))
 666         status = {}
 667
 668         model_status = await libjuju.get_model_status(kdu_instance)
 669
 670         if not complete_status:
 671             for name in model_status.applications:
 672                 application = model_status.applications[name]
 673                 status[name] = {"status": application["status"]["status"]}
 674         else:
 675             if yaml_format:
 676                 return obj_to_yaml(model_status)
 677             else:
 678                 return obj_to_dict(model_status)
 679
 680         return status
 681
 682     async def add_relation(
 683         self,
 684         provider: RelationEndpoint,
 685         requirer: RelationEndpoint,
 686     ):
 687         """
 688         Add relation between two charmed endpoints
 689
 690         :param: provider: Provider relation endpoint
 691         :param: requirer: Requirer relation endpoint
 692         """
 693         self.log.debug(f"adding new relation between {provider} and {requirer}")
 694         cross_model_relation = (
 695             provider.model_name != requirer.model_name
 696             or requirer.vca_id != requirer.vca_id
 697         )
 698         try:
 699             if cross_model_relation:
 700                 # Cross-model relation
 701                 provider_libjuju = await self._get_libjuju(provider.vca_id)
 702                 requirer_libjuju = await self._get_libjuju(requirer.vca_id)
 703                 offer = await provider_libjuju.offer(provider)
 704                 if offer:
 705                     saas_name = await requirer_libjuju.consume(
 706                         requirer.model_name, offer, provider_libjuju
 707                     )
 708                     await requirer_libjuju.add_relation(
 709                         requirer.model_name,
 710                         requirer.endpoint,
 711                         saas_name,
 712                     )
 713             else:
 714                 # Standard relation
 715                 vca_id = provider.vca_id
 716                 model = provider.model_name
 717                 libjuju = await self._get_libjuju(vca_id)
 718                 # add juju relations between two applications
 719                 await libjuju.add_relation(
 720                     model_name=model,
 721                     endpoint_1=provider.endpoint,
 722                     endpoint_2=requirer.endpoint,
 723                 )
 724         except Exception as e:
 725             message = f"Error adding relation between {provider} and {requirer}: {e}"
 726             self.log.error(message)
 727             raise Exception(message=message)
 728
 729     async def update_vca_status(self, vcastatus: dict, kdu_instance: str, **kwargs):
 730         """
 731         Add all configs, actions, executed actions of all applications in a model to vcastatus dict
 732
 733         :param vcastatus dict: dict containing vcastatus
 734         :param kdu_instance str: The unique id of the KDU instance
 735         :param: kwargs: Additional parameters
 736             vca_id (str): VCA ID
 737
 738         :return: None
 739         """
 740         libjuju = await self._get_libjuju(kwargs.get("vca_id"))
 741         try:
 742             for model_name in vcastatus:
 743                 # Adding executed actions
 744                 vcastatus[model_name][
 745                     "executedActions"
 746                 ] = await libjuju.get_executed_actions(kdu_instance)
 747
 748                 for application in vcastatus[model_name]["applications"]:
 749                     # Adding application actions
 750                     vcastatus[model_name]["applications"][application][
 751                         "actions"
 752                     ] = await libjuju.get_actions(application, kdu_instance)
 753                     # Adding application configs
 754                     vcastatus[model_name]["applications"][application][
 755                         "configs"
 756                     ] = await libjuju.get_application_configs(kdu_instance, application)
 757
 758         except Exception as e:
 759             self.log.debug("Error in updating vca status: {}".format(str(e)))
 760
 761     async def get_services(
 762         self, cluster_uuid: str, kdu_instance: str, namespace: str
 763     ) -> list:
 764         """Return a list of services of a kdu_instance"""
 765
 766         credentials = self.get_credentials(cluster_uuid=cluster_uuid)
 767         kubectl = self._get_kubectl(credentials)
 768         return kubectl.get_services(
 769             field_selector="metadata.namespace={}".format(kdu_instance)
 770         )
 771
 772     async def get_service(
 773         self, cluster_uuid: str, service_name: str, namespace: str
 774     ) -> object:
 775         """Return data for a specific service inside a namespace"""
 776
 777         credentials = self.get_credentials(cluster_uuid=cluster_uuid)
 778         kubectl = self._get_kubectl(credentials)
 779         return kubectl.get_services(
 780             field_selector="metadata.name={},metadata.namespace={}".format(
 781                 service_name, namespace
 782             )
 783         )[0]
 784
 785     def get_credentials(self, cluster_uuid: str) -> str:
 786         """
 787         Get Cluster Kubeconfig
 788         """
 789         k8scluster = self.db.get_one(
 790             "k8sclusters", q_filter={"_id": cluster_uuid}, fail_on_empty=False
 791         )
 792
 793         self.db.encrypt_decrypt_fields(
 794             k8scluster.get("credentials"),
 795             "decrypt",
 796             ["password", "secret"],
 797             schema_version=k8scluster["schema_version"],
 798             salt=k8scluster["_id"],
 799         )
 800
 801         return yaml.safe_dump(k8scluster.get("credentials"))
 802
 803     def _get_credential_name(self, cluster_uuid: str) -> str:
 804         """
 805         Get credential name for a k8s cloud
 806
 807         We cannot use the cluster_uuid for the credential name directly,
 808         because it cannot start with a number, it must start with a letter.
 809         Therefore, the k8s cloud credential name will be "cred-" followed
 810         by the cluster uuid.
 811
 812         :param: cluster_uuid:   Cluster UUID of the kubernetes cloud (=cloud_name)
 813
 814         :return:                Name to use for the credential name.
 815         """
 816         return "cred-{}".format(cluster_uuid)
 817
 818     def get_namespace(
 819         self,
 820         cluster_uuid: str,
 821     ) -> str:
 822         """Get the namespace UUID
 823         Gets the namespace's unique name
 824
 825         :param cluster_uuid str: The UUID of the cluster
 826         :returns: The namespace UUID, or raises an exception
 827         """
 828         pass
 829
 830     @staticmethod
 831     def generate_kdu_instance_name(**kwargs):
 832         db_dict = kwargs.get("db_dict")
 833         kdu_name = kwargs.get("kdu_name", None)
 834         if kdu_name:
 835             kdu_instance = "{}-{}".format(kdu_name, db_dict["filter"]["_id"])
 836         else:
 837             kdu_instance = db_dict["filter"]["_id"]
 838         return kdu_instance
 839
 840     async def _get_libjuju(self, vca_id: str = None) -> Libjuju:
 841         """
 842         Get libjuju object
 843
 844         :param: vca_id: VCA ID
 845                         If None, get a libjuju object with a Connection to the default VCA
 846                         Else, geta libjuju object with a Connection to the specified VCA
 847         """
 848         if not vca_id:
 849             while self.loading_libjuju.locked():
 850                 await asyncio.sleep(0.1)
 851             if not self.libjuju:
 852                 async with self.loading_libjuju:
 853                     vca_connection = await get_connection(self._store)
 854                     self.libjuju = Libjuju(vca_connection, loop=self.loop, log=self.log)
 855             return self.libjuju
 856         else:
 857             vca_connection = await get_connection(self._store, vca_id)
 858             return Libjuju(
 859                 vca_connection,
 860                 loop=self.loop,
 861                 log=self.log,
 862                 n2vc=self,
 863             )
 864
 865     def _get_kubectl(self, credentials: str) -> Kubectl:
 866         """
 867         Get Kubectl object
 868
 869         :param: kubeconfig_credentials: Kubeconfig credentials
 870         """
 871         kubecfg = tempfile.NamedTemporaryFile()
 872         with open(kubecfg.name, "w") as kubecfg_file:
 873             kubecfg_file.write(credentials)
 874         return Kubectl(config_file=kubecfg.name)