osm_policy_module/autoscaling/service.py

   1 # -*- coding: utf-8 -*-
   2 # pylint: disable=no-member
   3
   4 # Copyright 2018 Whitestack, LLC
   5 # *************************************************************
   6
   7 # This file is part of OSM Monitoring module
   8 # All Rights Reserved to Whitestack, LLC
   9
  10 # Licensed under the Apache License, Version 2.0 (the "License"); you may
  11 # not use this file except in compliance with the License. You may obtain
  12 # a copy of the License at
  13
  14 #         http://www.apache.org/licenses/LICENSE-2.0
  15
  16 # Unless required by applicable law or agreed to in writing, software
  17 # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
  18 # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
  19 # License for the specific language governing permissions and limitations
  20 # under the License.
  21
  22 # For those usages not covered by the Apache License, Version 2.0 please
  23 # contact: bdiaz@whitestack.com or glavado@whitestack.com
  24 ##
  25 import asyncio
  26 import datetime
  27 import json
  28 import logging
  29 import operator
  30 import functools
  31
  32 from osm_policy_module.common.common_db_client import CommonDbClient
  33 from osm_policy_module.common.lcm_client import LcmClient
  34 from osm_policy_module.common.mon_client import MonClient
  35 from osm_policy_module.core import database
  36 from osm_policy_module.core.config import Config
  37 from osm_policy_module.core.database import (
  38     ScalingGroup,
  39     ScalingAlarm,
  40     ScalingPolicy,
  41     ScalingCriteria,
  42     ScalingAlarmRepository,
  43     ScalingGroupRepository,
  44     ScalingPolicyRepository,
  45     ScalingCriteriaRepository,
  46 )
  47 from osm_policy_module.core.exceptions import VdurNotFound
  48
  49 log = logging.getLogger(__name__)
  50
  51
  52 class AutoscalingService:
  53     def __init__(self, config: Config, loop=None):
  54         self.conf = config
  55         if not loop:
  56             loop = asyncio.get_event_loop()
  57         self.loop = loop
  58         self.db_client = CommonDbClient(config)
  59         self.mon_client = MonClient(config, loop=self.loop)
  60         self.lcm_client = LcmClient(config, loop=self.loop)
  61
  62     async def configure_scaling_groups(self, nsr_id: str, vnf_member_index=None):
  63         """
  64         Configures scaling groups for a network service. Creates records in DB. Creates alarms in MON.
  65         :param nsr_id: Network service record id
  66         :return:
  67         """
  68         log.info(
  69             "Configuring scaling groups for network service with nsr_id: %s", nsr_id
  70         )
  71         alarms_created = []
  72         database.db.connect()
  73         try:
  74             with database.db.atomic() as tx:
  75                 try:
  76                     if vnf_member_index is None:
  77                         vnfrs = self.db_client.get_vnfrs(nsr_id)
  78                     else:
  79                         vnfrs = []
  80                         vnfr = self.db_client.get_vnfr(nsr_id, vnf_member_index)
  81                         vnfrs.append(vnfr)
  82                     # vnfrs = self.db_client.get_vnfrs(nsr_id)
  83                     for vnfr in vnfrs:
  84                         log.debug("Processing vnfr: %s", vnfr)
  85                         vnfd = self.db_client.get_vnfd(vnfr["vnfd-id"])
  86                         # TODO: Change for multiple DF support
  87                         df = vnfd.get("df", [{}])[0]
  88                         if "scaling-aspect" not in df:
  89                             log.debug("No scaling aspect present in vnfd")
  90                             continue
  91                         # TODO: Change for multiple instantiation levels support
  92                         scaling_aspects = df["scaling-aspect"]
  93                         all_vnfd_monitoring_params = (
  94                             self._get_all_vnfd_monitoring_params(vnfd)
  95                         )
  96                         for scaling_aspect in scaling_aspects:
  97                             scaling_group_record = self._get_or_create_scaling_group(
  98                                 nsr_id, vnfr["member-vnf-index-ref"], scaling_aspect
  99                             )
 100                             vdurs = self._get_monitored_vdurs(
 101                                 scaling_aspect, vnfr["vdur"]
 102                             )
 103                             for scaling_policy in scaling_aspect.get(
 104                                 "scaling-policy", ()
 105                             ):
 106                                 if scaling_policy["scaling-type"] != "automatic":
 107                                     continue
 108                                 scaling_policy_record = (
 109                                     self._get_or_create_scaling_policy(
 110                                         nsr_id, scaling_policy, scaling_group_record
 111                                     )
 112                                 )
 113
 114                                 for scaling_criteria in scaling_policy[
 115                                     "scaling-criteria"
 116                                 ]:
 117                                     scaling_criteria_record = (
 118                                         self._get_or_create_scaling_criteria(
 119                                             nsr_id,
 120                                             scaling_criteria,
 121                                             scaling_policy_record,
 122                                         )
 123                                     )
 124                                     monitoring_param_ref = scaling_criteria.get(
 125                                         "vnf-monitoring-param-ref"
 126                                     )
 127                                     vnf_monitoring_param = all_vnfd_monitoring_params[
 128                                         monitoring_param_ref
 129                                     ]
 130
 131                                     for vdur in vdurs:
 132                                         vdu_id = vdur["vdu-id-ref"]
 133                                         log.debug("Creating alarm for vdur %s ", vdur)
 134                                         try:
 135                                             ScalingAlarmRepository.get(
 136                                                 ScalingAlarm.vdu_name == vdur["name"],
 137                                                 ScalingCriteria.name
 138                                                 == scaling_criteria["name"],
 139                                                 ScalingPolicy.name
 140                                                 == scaling_policy["name"],
 141                                                 ScalingGroup.nsr_id == nsr_id,
 142                                                 join_classes=[
 143                                                     ScalingCriteria,
 144                                                     ScalingPolicy,
 145                                                     ScalingGroup,
 146                                                 ],
 147                                             )
 148                                             log.debug(
 149                                                 "vdu %s already has an alarm configured",
 150                                                 vdur["name"],
 151                                             )
 152                                             continue
 153                                         except ScalingAlarm.DoesNotExist:
 154                                             pass
 155                                         metric_name = self._get_metric_name(
 156                                             vnf_monitoring_param
 157                                         )
 158
 159                                         db_nsr = self.db_client.get_nsr(nsr_id)
 160                                         nb_scale_op = 0
 161                                         if db_nsr["_admin"].get("scaling-group"):
 162                                             db_nsr_admin = db_nsr["_admin"][
 163                                                 "scaling-group"
 164                                             ]
 165                                             for (
 166                                                 admin_scale_index,
 167                                                 admin_scale_info,
 168                                             ) in enumerate(db_nsr_admin):
 169                                                 if (
 170                                                     admin_scale_info["name"]
 171                                                     == scaling_aspect["name"]
 172                                                 ):
 173                                                     nb_scale_op = admin_scale_info.get(
 174                                                         "nb-scale-op", 0
 175                                                     )
 176                                                     break
 177                                         min_instance_count = 1
 178                                         for vdu_profile in df.get("vdu-profile", ()):
 179                                             if vdu_profile.get("id") == vdu_id:
 180                                                 min_instance_count = int(
 181                                                     vdu_profile.get(
 182                                                         "min-number-of-instances ", 1
 183                                                     )
 184                                                 )
 185                                                 break
 186                                         if nb_scale_op >= min_instance_count:
 187                                             alarm_uuid = (
 188                                                 await self.mon_client.create_alarm(
 189                                                     metric_name=metric_name,
 190                                                     ns_id=nsr_id,
 191                                                     vdu_name=vdur["name"],
 192                                                     vnf_member_index=vnfr[
 193                                                         "member-vnf-index-ref"
 194                                                     ],
 195                                                     threshold=scaling_criteria[
 196                                                         "scale-in-threshold"
 197                                                     ],
 198                                                     operation=scaling_criteria[
 199                                                         "scale-in-relational-operation"
 200                                                     ],
 201                                                     action="scale_in",
 202                                                 )
 203                                             )
 204                                             alarm = ScalingAlarmRepository.create(
 205                                                 alarm_uuid=alarm_uuid,
 206                                                 action="scale_in",
 207                                                 vnf_member_index=vnfr[
 208                                                     "member-vnf-index-ref"
 209                                                 ],
 210                                                 vdu_name=vdur["name"],
 211                                                 scaling_criteria=scaling_criteria_record,
 212                                             )
 213                                             alarms_created.append(alarm)
 214                                         alarm_uuid = await self.mon_client.create_alarm(
 215                                             metric_name=metric_name,
 216                                             ns_id=nsr_id,
 217                                             vdu_name=vdur["name"],
 218                                             vnf_member_index=vnfr[
 219                                                 "member-vnf-index-ref"
 220                                             ],
 221                                             threshold=scaling_criteria[
 222                                                 "scale-out-threshold"
 223                                             ],
 224                                             operation=scaling_criteria[
 225                                                 "scale-out-relational-operation"
 226                                             ],
 227                                             action="scale_out",
 228                                         )
 229                                         alarm = ScalingAlarmRepository.create(
 230                                             alarm_uuid=alarm_uuid,
 231                                             action="scale_out",
 232                                             vnf_member_index=vnfr[
 233                                                 "member-vnf-index-ref"
 234                                             ],
 235                                             vdu_name=vdur["name"],
 236                                             scaling_criteria=scaling_criteria_record,
 237                                         )
 238                                         alarms_created.append(alarm)
 239
 240                 except Exception as e:
 241                     log.exception("Error configuring scaling groups:")
 242                     tx.rollback()
 243                     if len(alarms_created) > 0:
 244                         log.info("Cleaning alarm resources in MON")
 245                         for alarm in alarms_created:
 246                             await self.mon_client.delete_alarm(
 247                                 alarm.scaling_criteria.scaling_policy.scaling_group.nsr_id,
 248                                 alarm.vnf_member_index,
 249                                 alarm.vdu_name,
 250                                 alarm.alarm_uuid,
 251                             )
 252                     raise e
 253         finally:
 254             database.db.close()
 255
 256     async def delete_scaling_groups(self, nsr_id: str, vnf_member_index=None):
 257         log.debug("Deleting scaling groups for network service %s", nsr_id)
 258         database.db.connect()
 259         try:
 260             with database.db.atomic() as tx:
 261                 try:
 262                     if vnf_member_index is None:
 263                         scale_conditions = ScalingGroup.nsr_id == nsr_id
 264                     else:
 265                         query_list = [
 266                             ScalingGroup.nsr_id == nsr_id,
 267                             ScalingGroup.vnf_member_index == vnf_member_index,
 268                         ]
 269                         scale_conditions = functools.reduce(operator.and_, query_list)
 270                     for scaling_group in ScalingGroupRepository.list(scale_conditions):
 271                         for scaling_policy in scaling_group.scaling_policies:
 272                             for scaling_criteria in scaling_policy.scaling_criterias:
 273                                 for alarm in scaling_criteria.scaling_alarms:
 274                                     try:
 275                                         await self.mon_client.delete_alarm(
 276                                             alarm.scaling_criteria.scaling_policy.scaling_group.nsr_id,
 277                                             alarm.vnf_member_index,
 278                                             alarm.vdu_name,
 279                                             alarm.alarm_uuid,
 280                                         )
 281                                     except ValueError:
 282                                         log.exception(
 283                                             "Error deleting alarm in MON %s",
 284                                             alarm.alarm_uuid,
 285                                         )
 286                                     alarm.delete_instance()
 287                                 scaling_criteria.delete_instance()
 288                             scaling_policy.delete_instance()
 289                         scaling_group.delete_instance()
 290
 291                 except Exception as e:
 292                     log.exception("Error deleting scaling groups and alarms:")
 293                     tx.rollback()
 294                     raise e
 295         finally:
 296             database.db.close()
 297
 298     async def delete_orphaned_alarms(self, nsr_id):
 299         log.info("Deleting orphaned scaling alarms for network service %s", nsr_id)
 300         database.db.connect()
 301         try:
 302             with database.db.atomic() as tx:
 303                 try:
 304                     for scaling_group in ScalingGroupRepository.list(
 305                         ScalingGroup.nsr_id == nsr_id
 306                     ):
 307                         for scaling_policy in scaling_group.scaling_policies:
 308                             for scaling_criteria in scaling_policy.scaling_criterias:
 309                                 for alarm in scaling_criteria.scaling_alarms:
 310                                     try:
 311                                         self.db_client.get_vdur(
 312                                             nsr_id,
 313                                             alarm.vnf_member_index,
 314                                             alarm.vdu_name,
 315                                         )
 316                                     except VdurNotFound:
 317                                         log.debug(
 318                                             "Deleting orphaned scaling alarm %s",
 319                                             alarm.alarm_uuid,
 320                                         )
 321                                         try:
 322                                             await self.mon_client.delete_alarm(
 323                                                 alarm.scaling_criteria.scaling_policy.scaling_group.nsr_id,
 324                                                 alarm.vnf_member_index,
 325                                                 alarm.vdu_name,
 326                                                 alarm.alarm_uuid,
 327                                             )
 328                                         except ValueError:
 329                                             log.exception(
 330                                                 "Error deleting alarm in MON %s",
 331                                                 alarm.alarm_uuid,
 332                                             )
 333                                         alarm.delete_instance()
 334
 335                 except Exception as e:
 336                     log.exception("Error deleting orphaned alarms:")
 337                     tx.rollback()
 338                     raise e
 339         finally:
 340             database.db.close()
 341
 342     async def handle_alarm(self, alarm_uuid: str, status: str):
 343         await self.update_alarm_status(alarm_uuid, status)
 344         await self.evaluate_policy(alarm_uuid)
 345
 346     async def update_alarm_status(self, alarm_uuid: str, status: str):
 347         database.db.connect()
 348         try:
 349             with database.db.atomic():
 350                 alarm = ScalingAlarmRepository.get(
 351                     ScalingAlarm.alarm_uuid == alarm_uuid
 352                 )
 353                 alarm.last_status = status
 354                 alarm.save()
 355         except ScalingAlarm.DoesNotExist:
 356             log.debug(
 357                 "There is no autoscaling action configured for alarm %s.", alarm_uuid
 358             )
 359         finally:
 360             database.db.close()
 361
 362     async def evaluate_policy(self, alarm_uuid):
 363         database.db.connect()
 364         try:
 365             with database.db.atomic():
 366                 alarm = ScalingAlarmRepository.get(
 367                     ScalingAlarm.alarm_uuid == alarm_uuid
 368                 )
 369                 vnf_member_index = alarm.vnf_member_index
 370                 action = alarm.action
 371                 scaling_policy = alarm.scaling_criteria.scaling_policy
 372                 if not scaling_policy.enabled:
 373                     return
 374                 if action == "scale_in":
 375                     operation = scaling_policy.scale_in_operation
 376                 elif action == "scale_out":
 377                     operation = scaling_policy.scale_out_operation
 378                 else:
 379                     raise Exception("Unknown alarm action {}".format(alarm.action))
 380                 alarms = ScalingAlarmRepository.list(
 381                     ScalingAlarm.scaling_criteria == alarm.scaling_criteria,
 382                     ScalingAlarm.action == alarm.action,
 383                     ScalingAlarm.vnf_member_index == vnf_member_index,
 384                     ScalingAlarm.vdu_name == alarm.vdu_name,
 385                 )
 386                 statuses = []
 387                 for alarm in alarms:
 388                     statuses.append(alarm.last_status)
 389                 if (operation == "AND" and set(statuses) == {"alarm"}) or (
 390                     operation == "OR" and "alarm" in statuses
 391                 ):
 392                     delta = datetime.datetime.now() - scaling_policy.last_scale
 393                     if delta.total_seconds() > scaling_policy.cooldown_time:
 394                         log.info(
 395                             "Sending %s action message for ns: %s",
 396                             alarm.action,
 397                             scaling_policy.scaling_group.nsr_id,
 398                         )
 399                         await self.lcm_client.scale(
 400                             scaling_policy.scaling_group.nsr_id,
 401                             scaling_policy.scaling_group.name,
 402                             vnf_member_index,
 403                             action,
 404                         )
 405                         scaling_policy.last_scale = datetime.datetime.now()
 406                         scaling_policy.save()
 407
 408         except ScalingAlarm.DoesNotExist:
 409             log.debug(
 410                 "There is no autoscaling action configured for alarm %s.", alarm_uuid
 411             )
 412         finally:
 413             database.db.close()
 414
 415     def _get_all_vnfd_monitoring_params(self, vnfd):
 416         all_monitoring_params = {}
 417         for ivld in vnfd.get("int-virtual-link-desc", ()):
 418             for mp in ivld.get("monitoring-parameters", ()):
 419                 all_monitoring_params[mp.get("id")] = mp
 420
 421         for vdu in vnfd.get("vdu", ()):
 422             for mp in vdu.get("monitoring-parameter", ()):
 423                 all_monitoring_params[mp.get("id")] = mp
 424
 425         for df in vnfd.get("df", ()):
 426             for mp in df.get("monitoring-parameter", ()):
 427                 all_monitoring_params[mp.get("id")] = mp
 428
 429         return all_monitoring_params
 430
 431     def _get_or_create_scaling_group(
 432         self, nsr_id: str, vnf_member_index: str, scaling_aspect: dict
 433     ):
 434         try:
 435             scaling_group_record = ScalingGroupRepository.get(
 436                 ScalingGroup.nsr_id == nsr_id,
 437                 ScalingGroup.vnf_member_index == vnf_member_index,
 438                 ScalingGroup.name == scaling_aspect["name"],
 439             )
 440             log.debug("Found existing scaling group record in DB...")
 441         except ScalingGroup.DoesNotExist:
 442             log.debug("Creating scaling group record in DB...")
 443             scaling_group_record = ScalingGroupRepository.create(
 444                 nsr_id=nsr_id,
 445                 vnf_member_index=vnf_member_index,
 446                 name=scaling_aspect["name"],
 447                 content=json.dumps(scaling_aspect),
 448             )
 449             log.debug(
 450                 "Created scaling group record in DB : nsr_id=%s, vnf_member_index=%s, name=%s",
 451                 scaling_group_record.nsr_id,
 452                 scaling_group_record.vnf_member_index,
 453                 scaling_group_record.name,
 454             )
 455         return scaling_group_record
 456
 457     def _get_or_create_scaling_policy(
 458         self, nsr_id: str, scaling_policy: dict, scaling_group_record: ScalingGroup
 459     ):
 460         try:
 461             scaling_policy_record = ScalingPolicyRepository.get(
 462                 ScalingPolicy.name == scaling_policy["name"],
 463                 ScalingGroup.id == scaling_group_record.id,
 464                 join_classes=[ScalingGroup],
 465             )
 466             log.debug("Found existing scaling policy record in DB...")
 467         except ScalingPolicy.DoesNotExist:
 468             log.debug("Creating scaling policy record in DB...")
 469             scaling_policy_record = ScalingPolicyRepository.create(
 470                 nsr_id=nsr_id,
 471                 name=scaling_policy["name"],
 472                 cooldown_time=scaling_policy["cooldown-time"],
 473                 scaling_group=scaling_group_record,
 474             )
 475             if "scale-in-operation-type" in scaling_policy:
 476                 scaling_policy_record.scale_in_operation = scaling_policy[
 477                     "scale-in-operation-type"
 478                 ]
 479             if "scale-out-operation-type" in scaling_policy:
 480                 scaling_policy_record.scale_out_operation = scaling_policy[
 481                     "scale-out-operation-type"
 482                 ]
 483             if "enabled" in scaling_policy:
 484                 scaling_policy_record.enabled = scaling_policy["enabled"]
 485             scaling_policy_record.save()
 486             log.debug(
 487                 "Created scaling policy record in DB : name=%s, scaling_group.name=%s",
 488                 scaling_policy_record.name,
 489                 scaling_policy_record.scaling_group.name,
 490             )
 491         return scaling_policy_record
 492
 493     def _get_or_create_scaling_criteria(
 494         self, nsr_id: str, scaling_criteria: dict, scaling_policy_record: ScalingPolicy
 495     ):
 496         try:
 497             scaling_criteria_record = ScalingCriteriaRepository.get(
 498                 ScalingPolicy.id == scaling_policy_record.id,
 499                 ScalingCriteria.name == scaling_criteria["name"],
 500                 join_classes=[ScalingPolicy],
 501             )
 502             log.debug("Found existing scaling criteria record in DB...")
 503         except ScalingCriteria.DoesNotExist:
 504             log.debug("Creating scaling criteria record in DB...")
 505             scaling_criteria_record = ScalingCriteriaRepository.create(
 506                 nsr_id=nsr_id,
 507                 name=scaling_criteria["name"],
 508                 scaling_policy=scaling_policy_record,
 509             )
 510             log.debug(
 511                 "Created scaling criteria record in DB : name=%s, scaling_policy.name=%s",
 512                 scaling_criteria_record.name,
 513                 scaling_criteria_record.scaling_policy.name,
 514             )
 515         return scaling_criteria_record
 516
 517     def _get_monitored_vdurs(self, scaling_aspect: dict, vdurs):
 518         all_monitored_vdus = set()
 519         for delta in scaling_aspect.get("aspect-delta-details", {}).get("deltas", ()):
 520             for vdu_delta in delta.get("vdu-delta", ()):
 521                 all_monitored_vdus.add(vdu_delta.get("id"))
 522
 523         monitored_vdurs = list(
 524             filter(lambda vdur: vdur["vdu-id-ref"] in all_monitored_vdus, vdurs)
 525         )
 526
 527         if not monitored_vdurs:
 528             log.warning(
 529                 "Scaling criteria is referring to a vnf-monitoring-param that does not "
 530                 "contain a reference to a vdu or vnf metric."
 531             )
 532         return monitored_vdurs
 533
 534     def _get_metric_name(self, vnf_monitoring_param: dict):
 535         if "performance-metric" in vnf_monitoring_param:
 536             return vnf_monitoring_param["performance-metric"]
 537         raise ValueError(
 538             "No metric name found for vnf_monitoring_param %s"
 539             % vnf_monitoring_param["id"]
 540         )