n2vc/k8s_conn.py

   1 ##
   2 # Copyright 2019 Telefonica Investigacion y Desarrollo, S.A.U.
   3 # This file is part of OSM
   4 # All Rights Reserved.
   5 #
   6 # Licensed under the Apache License, Version 2.0 (the "License");
   7 # you may not use this file except in compliance with the License.
   8 # You may obtain a copy of the License at
   9 #
  10 #    http://www.apache.org/licenses/LICENSE-2.0
  11 #
  12 # Unless required by applicable law or agreed to in writing, software
  13 # distributed under the License is distributed on an "AS IS" BASIS,
  14 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
  15 # implied.
  16 # See the License for the specific language governing permissions and
  17 # limitations under the License.
  18 #
  19 # For those usages not covered by the Apache License, Version 2.0 please
  20 # contact with: nfvlabs@tid.es
  21 ##
  22
  23 import asyncio
  24 from n2vc.loggable import Loggable
  25 import abc
  26 import time
  27
  28
  29 class K8sConnector(abc.ABC, Loggable):
  30
  31     """
  32     ##################################################################################################
  33     ########################################## P U B L I C ###########################################
  34     ##################################################################################################
  35     """
  36
  37     def __init__(
  38             self,
  39             db: object,
  40             log: object = None,
  41             on_update_db=None
  42     ):
  43         """
  44
  45         :param db: database object to write current operation status
  46         :param log: logger for tracing
  47         :param on_update_db: callback called when k8s connector updates database
  48         """
  49
  50         # parent class
  51         Loggable.__init__(self, log=log, log_to_console=True, prefix='\nK8S')
  52
  53         self.info('Initializing generic K8S connector')
  54
  55         # the database and update callback
  56         self.db = db
  57         self.on_update_db = on_update_db
  58
  59         self.info('K8S generic connector initialized')
  60
  61     @abc.abstractmethod
  62     async def init_env(
  63             self,
  64             k8s_creds: str,
  65             namespace: str = 'kube-system',
  66             reuse_cluster_uuid=None
  67     ) -> (str, bool):
  68         """
  69         It prepares a given K8s cluster environment to run Charts or juju Bundles on both sides:
  70             client (OSM)
  71             server (Tiller/Charm)
  72
  73         :param k8s_creds: credentials to access a given K8s cluster, i.e. a valid '.kube/config'
  74         :param namespace: optional namespace to be used for the K8s engine (helm tiller, juju).
  75         By default, 'kube-system' will be used
  76         :param reuse_cluster_uuid: existing cluster uuid for reuse
  77         :return: uuid of the K8s cluster and True if connector has installed some software in the cluster
  78         (on error, an exception will be raised)
  79         """
  80
  81     @abc.abstractmethod
  82     async def repo_add(
  83             self,
  84             cluster_uuid: str,
  85             name: str,
  86             url: str,
  87             repo_type: str = 'chart'
  88     ):
  89         """
  90         Add a new repository to OSM database
  91
  92         :param cluster_uuid: the cluster
  93         :param name: name for the repo in OSM
  94         :param url: URL of the repo
  95         :param repo_type: either "chart" or "bundle"
  96         :return: True if successful
  97         """
  98
  99     @abc.abstractmethod
 100     async def repo_list(
 101             self,
 102             cluster_uuid: str
 103     ):
 104         """
 105         Get the list of registered repositories
 106
 107         :param cluster_uuid: the cluster
 108         :return: list of registered repositories: [ (name, url) .... ]
 109         """
 110
 111     @abc.abstractmethod
 112     async def repo_remove(
 113             self,
 114             cluster_uuid: str,
 115             name: str
 116     ):
 117         """
 118         Remove a repository from OSM
 119
 120         :param name: repo name in OSM
 121         :param cluster_uuid: the cluster
 122         :return: True if successful
 123         """
 124
 125     @abc.abstractmethod
 126     async def reset(
 127             self,
 128             cluster_uuid: str,
 129             force: bool = False,
 130             uninstall_sw: bool = False
 131     ) -> bool:
 132         """
 133         Uninstalls Tiller/Charm from a known K8s cluster and removes it from the list of known K8s clusters.
 134         Intended to be used e.g. when the NS instance is deleted.
 135
 136         :param cluster_uuid: UUID of a K8s cluster known by OSM.
 137         :param force: force deletion, even in case there are deployed releases
 138         :param uninstall_sw: flag to indicate that sw uninstallation from software is needed
 139         :return: str: kdu_instance generated by helm
 140         """
 141
 142     @abc.abstractmethod
 143     async def install(
 144             self,
 145             cluster_uuid: str,
 146             kdu_model: str,
 147             atomic: bool = True,
 148             timeout: float = 300,
 149             params: dict = None,
 150             db_dict: dict = None
 151     ):
 152         """
 153         Deploys of a new KDU instance. It would implicitly rely on the `install` call to deploy the Chart/Bundle
 154         properly parametrized (in practice, this call would happen before any _initial-config-primitive_
 155         of the VNF is called).
 156
 157         :param cluster_uuid: UUID of a K8s cluster known by OSM
 158         :param kdu_model: chart/bundle:version reference (string), which can be either of these options:
 159             - a name of chart/bundle available via the repos known by OSM
 160             - a path to a packaged chart/bundle
 161             - a path to an unpacked chart/bundle directory or a URL
 162         :param atomic: If set, installation process purges chart/bundle on fail, also will wait until
 163             all the K8s objects are active
 164         :param timeout: Time in seconds to wait for the install of the chart/bundle (defaults to
 165             Helm default timeout: 300s)
 166         :param params: dictionary of key-value pairs for instantiation parameters (overriding default values)
 167         :param dict db_dict: where to write into database when the status changes.
 168                         It contains a dict with {collection: <str>, filter: {},  path: <str>},
 169                             e.g. {collection: "nsrs", filter: {_id: <nsd-id>, path: "_admin.deployed.K8S.3"}
 170         :return: True if successful
 171         """
 172
 173     @abc.abstractmethod
 174     async def upgrade(
 175             self,
 176             cluster_uuid: str,
 177             kdu_instance: str,
 178             kdu_model: str = None,
 179             atomic: bool = True,
 180             timeout: float = 300,
 181             params: dict = None,
 182             db_dict: dict = None
 183     ):
 184         """
 185         Upgrades an existing KDU instance. It would implicitly use the `upgrade` call over an existing Chart/Bundle.
 186         It can be used both to upgrade the chart or to reconfigure it. This would be exposed as Day-2 primitive.
 187
 188         :param cluster_uuid: UUID of a K8s cluster known by OSM
 189         :param kdu_instance: unique name for the KDU instance to be updated
 190         :param kdu_model: new chart/bundle:version reference
 191         :param atomic: rollback in case of fail and wait for pods and services are available
 192         :param timeout: Time in seconds to wait for the install of the chart/bundle (defaults to
 193             Helm default timeout: 300s)
 194         :param params: new dictionary of key-value pairs for instantiation parameters
 195         :param dict db_dict: where to write into database when the status changes.
 196                         It contains a dict with {collection: <str>, filter: {},  path: <str>},
 197                             e.g. {collection: "nsrs", filter: {_id: <nsd-id>, path: "_admin.deployed.K8S.3"}
 198         :return: reference to the new revision number of the KDU instance
 199         """
 200
 201     @abc.abstractmethod
 202     async def rollback(
 203             self,
 204             cluster_uuid: str,
 205             kdu_instance: str,
 206             revision=0,
 207             db_dict: dict = None
 208     ):
 209         """
 210         Rolls back a previous update of a KDU instance. It would implicitly use the `rollback` call.
 211         It can be used both to rollback from a Chart/Bundle version update or from a reconfiguration.
 212         This would be exposed as Day-2 primitive.
 213
 214         :param cluster_uuid: UUID of a K8s cluster known by OSM
 215         :param kdu_instance: unique name for the KDU instance
 216         :param revision: revision to which revert changes. If omitted, it will revert the last update only
 217         :param dict db_dict: where to write into database when the status changes.
 218                         It contains a dict with {collection: <str>, filter: {},  path: <str>},
 219                             e.g. {collection: "nsrs", filter: {_id: <nsd-id>, path: "_admin.deployed.K8S.3"}
 220         :return:If successful, reference to the current active revision of the KDU instance after the rollback
 221         """
 222
 223     @abc.abstractmethod
 224     async def uninstall(
 225             self,
 226             cluster_uuid: str,
 227             kdu_instance: str
 228     ):
 229         """
 230         Removes an existing KDU instance. It would implicitly use the `delete` call (this call would happen
 231         after all _terminate-config-primitive_ of the VNF are invoked).
 232
 233         :param cluster_uuid: UUID of a K8s cluster known by OSM
 234         :param kdu_instance: unique name for the KDU instance to be deleted
 235         :return: True if successful
 236         """
 237
 238     @abc.abstractmethod
 239     async def inspect_kdu(
 240             self,
 241             kdu_model: str,
 242             repo_url: str = None
 243     ) -> str:
 244         """
 245         These calls will retrieve from the Chart/Bundle:
 246
 247             - The list of configurable values and their defaults (e.g. in Charts, it would retrieve
 248                 the contents of `values.yaml`).
 249             - If available, any embedded help file (e.g. `readme.md`) embedded in the Chart/Bundle.
 250
 251         :param kdu_model: chart/bundle reference
 252         :param repo_url: optional, reposotory URL (None if tar.gz, URl in other cases, even stable URL)
 253         :return:
 254
 255         If successful, it will return the available parameters and their default values as provided by the backend.
 256         """
 257
 258     @abc.abstractmethod
 259     async def help_kdu(
 260             self,
 261             kdu_model: str,
 262             repo_url: str = None
 263     ) -> str:
 264         """
 265
 266         :param kdu_model: chart/bundle reference
 267         :param repo_url: optional, reposotory URL (None if tar.gz, URl in other cases, even stable URL)
 268         :return: If successful, it will return the contents of the 'readme.md'
 269         """
 270
 271     @abc.abstractmethod
 272     async def status_kdu(
 273             self,
 274             cluster_uuid: str,
 275             kdu_instance: str
 276     ) -> str:
 277         """
 278         This call would retrieve tha current state of a given KDU instance. It would be would allow to retrieve
 279         the _composition_ (i.e. K8s objects) and _specific values_ of the configuration parameters applied
 280         to a given instance. This call would be based on the `status` call.
 281
 282         :param cluster_uuid: UUID of a K8s cluster known by OSM
 283         :param kdu_instance: unique name for the KDU instance
 284         :return: If successful, it will return the following vector of arguments:
 285         - K8s `namespace` in the cluster where the KDU lives
 286         - `state` of the KDU instance. It can be:
 287               - UNKNOWN
 288               - DEPLOYED
 289               - DELETED
 290               - SUPERSEDED
 291               - FAILED or
 292               - DELETING
 293         - List of `resources` (objects) that this release consists of, sorted by kind, and the status of those resources
 294         - Last `deployment_time`.
 295
 296         """
 297
 298     """
 299     ##################################################################################################
 300     ########################################## P R I V A T E #########################################
 301     ##################################################################################################
 302     """
 303
 304     async def write_app_status_to_db(
 305             self,
 306             db_dict: dict,
 307             status: str,
 308             detailed_status: str,
 309             operation: str
 310     ) -> bool:
 311
 312         if not self.db:
 313             self.warning('No db => No database write')
 314             return False
 315
 316         if not db_dict:
 317             self.warning('No db_dict => No database write')
 318             return False
 319
 320         self.debug('status={}'.format(status))
 321
 322         try:
 323
 324             the_table = db_dict['collection']
 325             the_filter = db_dict['filter']
 326             the_path = db_dict['path']
 327             if not the_path[-1] == '.':
 328                 the_path = the_path + '.'
 329             update_dict = {
 330                 the_path + 'operation': operation,
 331                 the_path + 'status': status,
 332                 the_path + 'detailed-status': detailed_status,
 333                 the_path + 'status-time': str(time.time()),
 334             }
 335
 336             self.db.set_one(
 337                 table=the_table,
 338                 q_filter=the_filter,
 339                 update_dict=update_dict,
 340                 fail_on_empty=True
 341             )
 342
 343             # database callback
 344             if self.on_update_db:
 345                 if asyncio.iscoroutinefunction(self.on_update_db):
 346                     await self.on_update_db(the_table, the_filter, the_path, update_dict)
 347                 else:
 348                     self.on_update_db(the_table, the_filter, the_path, update_dict)
 349
 350             return True
 351
 352         except Exception as e:
 353             self.info('Exception writing status to database: {}'.format(e))
 354             return False