osm_policy_module/core/agent.py

   1 # -*- coding: utf-8 -*-
   2
   3 # Copyright 2018 Whitestack, LLC
   4 # *************************************************************
   5
   6 # This file is part of OSM Monitoring module
   7 # All Rights Reserved to Whitestack, LLC
   8
   9 # Licensed under the Apache License, Version 2.0 (the "License"); you may
  10 # not use this file except in compliance with the License. You may obtain
  11 # a copy of the License at
  12
  13 #         http://www.apache.org/licenses/LICENSE-2.0
  14
  15 # Unless required by applicable law or agreed to in writing, software
  16 # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
  17 # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
  18 # License for the specific language governing permissions and limitations
  19 # under the License.
  20
  21 # For those usages not covered by the Apache License, Version 2.0 please
  22 # contact: bdiaz@whitestack.com or glavado@whitestack.com
  23 ##
  24 import datetime
  25 import json
  26 import logging
  27 import threading
  28 from json import JSONDecodeError
  29
  30 import yaml
  31 from kafka import KafkaConsumer
  32
  33 from osm_policy_module.common.db_client import DbClient
  34 from osm_policy_module.common.lcm_client import LcmClient
  35 from osm_policy_module.common.mon_client import MonClient
  36 from osm_policy_module.core import database
  37 from osm_policy_module.core.config import Config
  38 from osm_policy_module.core.database import ScalingGroup, ScalingAlarm, ScalingPolicy, ScalingCriteria
  39
  40 log = logging.getLogger(__name__)
  41
  42 ALLOWED_KAFKA_KEYS = ['instantiated', 'scaled', 'notify_alarm']
  43
  44
  45 class PolicyModuleAgent:
  46     def __init__(self):
  47         cfg = Config.instance()
  48         self.db_client = DbClient()
  49         self.mon_client = MonClient()
  50         self.lcm_client = LcmClient()
  51         self.kafka_server = '{}:{}'.format(cfg.OSMPOL_MESSAGE_HOST,
  52                                            cfg.OSMPOL_MESSAGE_PORT)
  53
  54     def run(self):
  55         consumer = KafkaConsumer(bootstrap_servers=self.kafka_server,
  56                                  key_deserializer=bytes.decode,
  57                                  value_deserializer=bytes.decode,
  58                                  group_id='pol-consumer')
  59         consumer.subscribe(["ns", "alarm_response"])
  60
  61         for message in consumer:
  62             t = threading.Thread(target=self._process_msg, args=(message.topic, message.key, message.value,))
  63             t.start()
  64
  65     def _process_msg(self, topic, key, msg):
  66         log.debug("_process_msg topic=%s key=%s msg=%s", topic, key, msg)
  67         try:
  68             if key in ALLOWED_KAFKA_KEYS:
  69                 try:
  70                     content = json.loads(msg)
  71                 except JSONDecodeError:
  72                     content = yaml.safe_load(msg)
  73
  74                 if key == 'instantiated' or key == 'scaled':
  75                     self._handle_instantiated_or_scaled(content)
  76
  77                 if key == 'notify_alarm':
  78                     self._handle_alarm_notification(content)
  79             else:
  80                 log.debug("Key %s is not in ALLOWED_KAFKA_KEYS", key)
  81         except Exception:
  82             log.exception("Error consuming message: ")
  83
  84     def _handle_alarm_notification(self, content):
  85         log.debug("_handle_alarm_notification: %s", content)
  86         alarm_id = content['notify_details']['alarm_uuid']
  87         metric_name = content['notify_details']['metric_name']
  88         operation = content['notify_details']['operation']
  89         threshold = content['notify_details']['threshold_value']
  90         vdu_name = content['notify_details']['vdu_name']
  91         vnf_member_index = content['notify_details']['vnf_member_index']
  92         ns_id = content['notify_details']['ns_id']
  93         log.info(
  94             "Received alarm notification for alarm %s, \
  95             metric %s, \
  96             operation %s, \
  97             threshold %s, \
  98             vdu_name %s, \
  99             vnf_member_index %s, \
 100             ns_id %s ",
 101             alarm_id, metric_name, operation, threshold, vdu_name, vnf_member_index, ns_id)
 102         try:
 103             alarm = ScalingAlarm.select().where(ScalingAlarm.alarm_id == alarm_id).get()
 104             delta = datetime.datetime.now() - alarm.scaling_criteria.scaling_policy.last_scale
 105             log.debug("last_scale: %s", alarm.scaling_criteria.scaling_policy.last_scale)
 106             log.debug("now: %s", datetime.datetime.now())
 107             log.debug("delta: %s", delta)
 108             if delta.total_seconds() < alarm.scaling_criteria.scaling_policy.cooldown_time:
 109                 log.info("Time between last scale and now is less than cooldown time. Skipping.")
 110                 return
 111             log.info("Sending scaling action message for ns: %s", alarm_id)
 112             self.lcm_client.scale(alarm.scaling_criteria.scaling_policy.scaling_group.nsr_id,
 113                                   alarm.scaling_criteria.scaling_policy.scaling_group.name,
 114                                   alarm.vnf_member_index,
 115                                   alarm.action)
 116             alarm.scaling_criteria.scaling_policy.last_scale = datetime.datetime.now()
 117             alarm.scaling_criteria.scaling_policy.save()
 118         except ScalingAlarm.DoesNotExist:
 119             log.info("There is no action configured for alarm %s.", alarm_id)
 120
 121     def _handle_instantiated_or_scaled(self, content):
 122         log.debug("_handle_instantiated_or_scaled: %s", content)
 123         nslcmop_id = content['nslcmop_id']
 124         nslcmop = self.db_client.get_nslcmop(nslcmop_id)
 125         if nslcmop['operationState'] == 'COMPLETED' or nslcmop['operationState'] == 'PARTIALLY_COMPLETED':
 126             nsr_id = nslcmop['nsInstanceId']
 127             log.info("Configuring scaling groups for network service with nsr_id: %s", nsr_id)
 128             self._configure_scaling_groups(nsr_id)
 129         else:
 130             log.info(
 131                 "Network service is not in COMPLETED or PARTIALLY_COMPLETED state. "
 132                 "Current state is %s. Skipping...",
 133                 nslcmop['operationState'])
 134
 135     def _configure_scaling_groups(self, nsr_id: str):
 136         log.debug("_configure_scaling_groups: %s", nsr_id)
 137         # TODO(diazb): Check for alarm creation on exception and clean resources if needed.
 138         # TODO: Add support for non-nfvi metrics
 139         with database.db.atomic():
 140             vnfrs = self.db_client.get_vnfrs(nsr_id)
 141             log.info("Found %s vnfrs", len(vnfrs))
 142             for vnfr in vnfrs:
 143                 vnfd = self.db_client.get_vnfd(vnfr['vnfd-id'])
 144                 log.info("Looking for vnfd %s", vnfr['vnfd-id'])
 145                 scaling_groups = vnfd['scaling-group-descriptor']
 146                 vnf_monitoring_params = vnfd['monitoring-param']
 147                 for scaling_group in scaling_groups:
 148                     try:
 149                         scaling_group_record = ScalingGroup.select().where(
 150                             ScalingGroup.nsr_id == nsr_id,
 151                             ScalingGroup.vnf_member_index == vnfr['member-vnf-index-ref'],
 152                             ScalingGroup.name == scaling_group['name']
 153                         ).get()
 154                         log.info("Found existing scaling group record in DB...")
 155                     except ScalingGroup.DoesNotExist:
 156                         log.info("Creating scaling group record in DB...")
 157                         scaling_group_record = ScalingGroup.create(
 158                             nsr_id=nsr_id,
 159                             vnf_member_index=vnfr['member-vnf-index-ref'],
 160                             name=scaling_group['name'],
 161                             content=json.dumps(scaling_group)
 162                         )
 163                         log.info(
 164                             "Created scaling group record in DB : nsr_id=%s, vnf_member_index=%d, name=%s, content=%s",
 165                             scaling_group_record.nsr_id,
 166                             scaling_group_record.vnf_member_index,
 167                             scaling_group_record.name,
 168                             scaling_group_record.content)
 169                     for scaling_policy in scaling_group['scaling-policy']:
 170                         if scaling_policy['scaling-type'] != 'automatic':
 171                             continue
 172                         try:
 173                             scaling_policy_record = ScalingPolicy.select().join(ScalingGroup).where(
 174                                 ScalingPolicy.name == scaling_policy['name'],
 175                                 ScalingGroup.id == scaling_group_record.id
 176                             ).get()
 177                             log.info("Found existing scaling policy record in DB...")
 178                         except ScalingPolicy.DoesNotExist:
 179                             log.info("Creating scaling policy record in DB...")
 180                             scaling_policy_record = ScalingPolicy.create(
 181                                 nsr_id=nsr_id,
 182                                 name=scaling_policy['name'],
 183                                 cooldown_time=scaling_policy['cooldown-time'],
 184                                 scaling_group=scaling_group_record
 185                             )
 186                             log.info("Created scaling policy record in DB : name=%s, scaling_group.name=%s",
 187                                      scaling_policy_record.name,
 188                                      scaling_policy_record.scaling_group.name)
 189
 190                         for scaling_criteria in scaling_policy['scaling-criteria']:
 191                             try:
 192                                 scaling_criteria_record = ScalingCriteria.select().join(ScalingPolicy).where(
 193                                     ScalingPolicy.id == scaling_policy_record.id,
 194                                     ScalingCriteria.name == scaling_criteria['name']
 195                                 ).get()
 196                                 log.info("Found existing scaling criteria record in DB...")
 197                             except ScalingCriteria.DoesNotExist:
 198                                 log.info("Creating scaling criteria record in DB...")
 199                                 scaling_criteria_record = ScalingCriteria.create(
 200                                     nsr_id=nsr_id,
 201                                     name=scaling_criteria['name'],
 202                                     scaling_policy=scaling_policy_record
 203                                 )
 204                                 log.info(
 205                                     "Created scaling criteria record in DB : name=%s, scaling_policy.name=%s",
 206                                     scaling_criteria_record.name,
 207                                     scaling_criteria_record.scaling_policy.name)
 208
 209                             for vdu_ref in scaling_group['vdu']:
 210                                 vnf_monitoring_param = next(
 211                                     filter(lambda param: param['id'] == scaling_criteria['vnf-monitoring-param-ref'],
 212                                            vnf_monitoring_params))
 213                                 if not vdu_ref['vdu-id-ref'] == vnf_monitoring_param['vdu-ref']:
 214                                     continue
 215                                 vdu = next(
 216                                     filter(lambda vdu: vdu['id'] == vdu_ref['vdu-id-ref'], vnfd['vdu'])
 217                                 )
 218                                 vdu_monitoring_params = vdu['monitoring-param']
 219                                 vdu_monitoring_param = next(
 220                                     filter(
 221                                         lambda param: param['id'] == vnf_monitoring_param['vdu-monitoring-param-ref'],
 222                                         vdu_monitoring_params))
 223                                 vdurs = list(filter(lambda vdur: vdur['vdu-id-ref'] == vnf_monitoring_param['vdu-ref'],
 224                                                     vnfr['vdur']))
 225                                 for vdur in vdurs:
 226                                     try:
 227                                         ScalingAlarm.select().join(ScalingCriteria).where(
 228                                             ScalingAlarm.vdu_name == vdur['name'],
 229                                             ScalingCriteria.name == scaling_criteria['name']
 230                                         ).get()
 231                                         log.debug("vdu %s already has an alarm configured", vdur['name'])
 232                                         continue
 233                                     except ScalingAlarm.DoesNotExist:
 234                                         pass
 235                                     alarm_uuid = self.mon_client.create_alarm(
 236                                         metric_name=vdu_monitoring_param['nfvi-metric'],
 237                                         ns_id=nsr_id,
 238                                         vdu_name=vdur['name'],
 239                                         vnf_member_index=vnfr['member-vnf-index-ref'],
 240                                         threshold=scaling_criteria['scale-in-threshold'],
 241                                         operation=scaling_criteria['scale-in-relational-operation'],
 242                                         statistic=vnf_monitoring_param['aggregation-type']
 243                                     )
 244                                     ScalingAlarm.create(
 245                                         alarm_id=alarm_uuid,
 246                                         action='scale_in',
 247                                         vnf_member_index=int(vnfr['member-vnf-index-ref']),
 248                                         vdu_name=vdur['name'],
 249                                         scaling_criteria=scaling_criteria_record
 250                                     )
 251                                     alarm_uuid = self.mon_client.create_alarm(
 252                                         metric_name=vdu_monitoring_param['nfvi-metric'],
 253                                         ns_id=nsr_id,
 254                                         vdu_name=vdur['name'],
 255                                         vnf_member_index=vnfr['member-vnf-index-ref'],
 256                                         threshold=scaling_criteria['scale-out-threshold'],
 257                                         operation=scaling_criteria['scale-out-relational-operation'],
 258                                         statistic=vnf_monitoring_param['aggregation-type']
 259                                     )
 260                                     ScalingAlarm.create(
 261                                         alarm_id=alarm_uuid,
 262                                         action='scale_out',
 263                                         vnf_member_index=int(vnfr['member-vnf-index-ref']),
 264                                         vdu_name=vdur['name'],
 265                                         scaling_criteria=scaling_criteria_record
 266                                     )