Code Coverage

Cobertura Coverage Report > osm_policy_module.autoscaling >

service.py

Trend

Classes100%
 
Lines64%
   
Conditionals100%
 

File Coverage summary

NameClassesLinesConditionals
service.py
100%
1/1
64%
152/236
100%
0/0

Coverage Breakdown by Class

NameLinesConditionals
service.py
64%
152/236
N/A

Source

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