1 # -*- coding: utf-8 -*-
2 # pylint: disable=no-member
4 # Copyright 2018 Whitestack, LLC
5 # *************************************************************
7 # This file is part of OSM Monitoring module
8 # All Rights Reserved to Whitestack, LLC
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
14 # http://www.apache.org/licenses/LICENSE-2.0
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
22 # For those usages not covered by the Apache License, Version 2.0 please
23 # contact: bdiaz@whitestack.com or glavado@whitestack.com
30 from osm_policy_module
.common
.common_db_client
import CommonDbClient
31 from osm_policy_module
.common
.lcm_client
import LcmClient
32 from osm_policy_module
.common
.mon_client
import MonClient
33 from osm_policy_module
.core
import database
34 from osm_policy_module
.core
.config
import Config
35 from osm_policy_module
.core
.database
import (
40 ScalingAlarmRepository
,
41 ScalingGroupRepository
,
42 ScalingPolicyRepository
,
43 ScalingCriteriaRepository
,
45 from osm_policy_module
.core
.exceptions
import VdurNotFound
47 log
= logging
.getLogger(__name__
)
50 class AutoscalingService
:
51 def __init__(self
, config
: Config
, loop
=None):
54 loop
= asyncio
.get_event_loop()
56 self
.db_client
= CommonDbClient(config
)
57 self
.mon_client
= MonClient(config
, loop
=self
.loop
)
58 self
.lcm_client
= LcmClient(config
, loop
=self
.loop
)
60 async def configure_scaling_groups(self
, nsr_id
: str):
62 Configures scaling groups for a network service. Creates records in DB. Creates alarms in MON.
63 :param nsr_id: Network service record id
67 "Configuring scaling groups for network service with nsr_id: %s", nsr_id
72 with database
.db
.atomic() as tx
:
74 vnfrs
= self
.db_client
.get_vnfrs(nsr_id
)
76 log
.debug("Processing vnfr: %s", vnfr
)
77 vnfd
= self
.db_client
.get_vnfd(vnfr
["vnfd-id"])
78 # TODO: Change for multiple DF support
79 df
= vnfd
.get("df", [{}])[0]
80 if "scaling-aspect" not in df
:
81 log
.debug("No scaling aspect present in vnfd")
83 # TODO: Change for multiple instantiation levels support
84 scaling_aspects
= df
["scaling-aspect"]
85 all_vnfd_monitoring_params
= (
86 self
._get
_all
_vnfd
_monitoring
_params
(vnfd
)
88 for scaling_aspect
in scaling_aspects
:
89 scaling_group_record
= self
._get
_or
_create
_scaling
_group
(
90 nsr_id
, vnfr
["member-vnf-index-ref"], scaling_aspect
92 vdurs
= self
._get
_monitored
_vdurs
(
93 scaling_aspect
, vnfr
["vdur"]
95 for scaling_policy
in scaling_aspect
.get(
98 if scaling_policy
["scaling-type"] != "automatic":
100 scaling_policy_record
= (
101 self
._get
_or
_create
_scaling
_policy
(
102 nsr_id
, scaling_policy
, scaling_group_record
106 for scaling_criteria
in scaling_policy
[
109 scaling_criteria_record
= (
110 self
._get
_or
_create
_scaling
_criteria
(
113 scaling_policy_record
,
116 monitoring_param_ref
= scaling_criteria
.get(
117 "vnf-monitoring-param-ref"
119 vnf_monitoring_param
= all_vnfd_monitoring_params
[
124 vdu_id
= vdur
["vdu-id-ref"]
125 log
.debug("Creating alarm for vdur %s ", vdur
)
127 ScalingAlarmRepository
.get(
128 ScalingAlarm
.vdu_name
== vdur
["name"],
130 == scaling_criteria
["name"],
132 == scaling_policy
["name"],
133 ScalingGroup
.nsr_id
== nsr_id
,
141 "vdu %s already has an alarm configured",
145 except ScalingAlarm
.DoesNotExist
:
147 metric_name
= self
._get
_metric
_name
(
151 db_nsr
= self
.db_client
.get_nsr(nsr_id
)
153 if db_nsr
["_admin"].get("scaling-group"):
154 db_nsr_admin
= db_nsr
["_admin"][
160 ) in enumerate(db_nsr_admin
):
162 admin_scale_info
["name"]
163 == scaling_aspect
["name"]
165 nb_scale_op
= admin_scale_info
.get(
169 min_instance_count
= 1
170 for vdu_profile
in df
.get("vdu-profile", ()):
171 if vdu_profile
.get("id") == vdu_id
:
172 min_instance_count
= int(
174 "min-number-of-instances ", 1
178 if nb_scale_op
>= min_instance_count
:
180 await self
.mon_client
.create_alarm(
181 metric_name
=metric_name
,
183 vdu_name
=vdur
["name"],
184 vnf_member_index
=vnfr
[
185 "member-vnf-index-ref"
187 threshold
=scaling_criteria
[
190 operation
=scaling_criteria
[
191 "scale-in-relational-operation"
195 alarm
= ScalingAlarmRepository
.create(
196 alarm_uuid
=alarm_uuid
,
198 vnf_member_index
=vnfr
[
199 "member-vnf-index-ref"
201 vdu_name
=vdur
["name"],
202 scaling_criteria
=scaling_criteria_record
,
204 alarms_created
.append(alarm
)
205 alarm_uuid
= await self
.mon_client
.create_alarm(
206 metric_name
=metric_name
,
208 vdu_name
=vdur
["name"],
209 vnf_member_index
=vnfr
[
210 "member-vnf-index-ref"
212 threshold
=scaling_criteria
[
213 "scale-out-threshold"
215 operation
=scaling_criteria
[
216 "scale-out-relational-operation"
219 alarm
= ScalingAlarmRepository
.create(
220 alarm_uuid
=alarm_uuid
,
222 vnf_member_index
=vnfr
[
223 "member-vnf-index-ref"
225 vdu_name
=vdur
["name"],
226 scaling_criteria
=scaling_criteria_record
,
228 alarms_created
.append(alarm
)
230 except Exception as e
:
231 log
.exception("Error configuring scaling groups:")
233 if len(alarms_created
) > 0:
234 log
.info("Cleaning alarm resources in MON")
235 for alarm
in alarms_created
:
236 await self
.mon_client
.delete_alarm(
237 alarm
.scaling_criteria
.scaling_policy
.scaling_group
.nsr_id
,
238 alarm
.vnf_member_index
,
246 async def delete_scaling_groups(self
, nsr_id
: str):
247 log
.debug("Deleting scaling groups for network service %s", nsr_id
)
248 database
.db
.connect()
250 with database
.db
.atomic() as tx
:
252 for scaling_group
in ScalingGroupRepository
.list(
253 ScalingGroup
.nsr_id
== nsr_id
255 for scaling_policy
in scaling_group
.scaling_policies
:
256 for scaling_criteria
in scaling_policy
.scaling_criterias
:
257 for alarm
in scaling_criteria
.scaling_alarms
:
259 await self
.mon_client
.delete_alarm(
260 alarm
.scaling_criteria
.scaling_policy
.scaling_group
.nsr_id
,
261 alarm
.vnf_member_index
,
267 "Error deleting alarm in MON %s",
270 alarm
.delete_instance()
271 scaling_criteria
.delete_instance()
272 scaling_policy
.delete_instance()
273 scaling_group
.delete_instance()
275 except Exception as e
:
276 log
.exception("Error deleting scaling groups and alarms:")
282 async def delete_orphaned_alarms(self
, nsr_id
):
283 log
.info("Deleting orphaned scaling alarms for network service %s", nsr_id
)
284 database
.db
.connect()
286 with database
.db
.atomic() as tx
:
288 for scaling_group
in ScalingGroupRepository
.list(
289 ScalingGroup
.nsr_id
== nsr_id
291 for scaling_policy
in scaling_group
.scaling_policies
:
292 for scaling_criteria
in scaling_policy
.scaling_criterias
:
293 for alarm
in scaling_criteria
.scaling_alarms
:
295 self
.db_client
.get_vdur(
297 alarm
.vnf_member_index
,
302 "Deleting orphaned scaling alarm %s",
306 await self
.mon_client
.delete_alarm(
307 alarm
.scaling_criteria
.scaling_policy
.scaling_group
.nsr_id
,
308 alarm
.vnf_member_index
,
314 "Error deleting alarm in MON %s",
317 alarm
.delete_instance()
319 except Exception as e
:
320 log
.exception("Error deleting orphaned alarms:")
326 async def handle_alarm(self
, alarm_uuid
: str, status
: str):
327 await self
.update_alarm_status(alarm_uuid
, status
)
328 await self
.evaluate_policy(alarm_uuid
)
330 async def update_alarm_status(self
, alarm_uuid
: str, status
: str):
331 database
.db
.connect()
333 with database
.db
.atomic():
334 alarm
= ScalingAlarmRepository
.get(
335 ScalingAlarm
.alarm_uuid
== alarm_uuid
337 alarm
.last_status
= status
339 except ScalingAlarm
.DoesNotExist
:
341 "There is no autoscaling action configured for alarm %s.", alarm_uuid
346 async def evaluate_policy(self
, alarm_uuid
):
347 database
.db
.connect()
349 with database
.db
.atomic():
350 alarm
= ScalingAlarmRepository
.get(
351 ScalingAlarm
.alarm_uuid
== alarm_uuid
353 vnf_member_index
= alarm
.vnf_member_index
354 action
= alarm
.action
355 scaling_policy
= alarm
.scaling_criteria
.scaling_policy
356 if not scaling_policy
.enabled
:
358 if action
== "scale_in":
359 operation
= scaling_policy
.scale_in_operation
360 elif action
== "scale_out":
361 operation
= scaling_policy
.scale_out_operation
363 raise Exception("Unknown alarm action {}".format(alarm
.action
))
364 alarms
= ScalingAlarmRepository
.list(
365 ScalingAlarm
.scaling_criteria
== alarm
.scaling_criteria
,
366 ScalingAlarm
.action
== alarm
.action
,
367 ScalingAlarm
.vnf_member_index
== vnf_member_index
,
368 ScalingAlarm
.vdu_name
== alarm
.vdu_name
,
372 statuses
.append(alarm
.last_status
)
373 if (operation
== "AND" and set(statuses
) == {"alarm"}) or (
374 operation
== "OR" and "alarm" in statuses
376 delta
= datetime
.datetime
.now() - scaling_policy
.last_scale
377 if delta
.total_seconds() > scaling_policy
.cooldown_time
:
379 "Sending %s action message for ns: %s",
381 scaling_policy
.scaling_group
.nsr_id
,
383 await self
.lcm_client
.scale(
384 scaling_policy
.scaling_group
.nsr_id
,
385 scaling_policy
.scaling_group
.name
,
389 scaling_policy
.last_scale
= datetime
.datetime
.now()
390 scaling_policy
.save()
392 except ScalingAlarm
.DoesNotExist
:
394 "There is no autoscaling action configured for alarm %s.", alarm_uuid
399 def _get_all_vnfd_monitoring_params(self
, vnfd
):
400 all_monitoring_params
= {}
401 for ivld
in vnfd
.get("int-virtual-link-desc", ()):
402 for mp
in ivld
.get("monitoring-parameters", ()):
403 all_monitoring_params
[mp
.get("id")] = mp
405 for vdu
in vnfd
.get("vdu", ()):
406 for mp
in vdu
.get("monitoring-parameter", ()):
407 all_monitoring_params
[mp
.get("id")] = mp
409 for df
in vnfd
.get("df", ()):
410 for mp
in df
.get("monitoring-parameter", ()):
411 all_monitoring_params
[mp
.get("id")] = mp
413 return all_monitoring_params
415 def _get_or_create_scaling_group(
416 self
, nsr_id
: str, vnf_member_index
: str, scaling_aspect
: dict
419 scaling_group_record
= ScalingGroupRepository
.get(
420 ScalingGroup
.nsr_id
== nsr_id
,
421 ScalingGroup
.vnf_member_index
== vnf_member_index
,
422 ScalingGroup
.name
== scaling_aspect
["name"],
424 log
.debug("Found existing scaling group record in DB...")
425 except ScalingGroup
.DoesNotExist
:
426 log
.debug("Creating scaling group record in DB...")
427 scaling_group_record
= ScalingGroupRepository
.create(
429 vnf_member_index
=vnf_member_index
,
430 name
=scaling_aspect
["name"],
431 content
=json
.dumps(scaling_aspect
),
434 "Created scaling group record in DB : nsr_id=%s, vnf_member_index=%s, name=%s",
435 scaling_group_record
.nsr_id
,
436 scaling_group_record
.vnf_member_index
,
437 scaling_group_record
.name
,
439 return scaling_group_record
441 def _get_or_create_scaling_policy(
442 self
, nsr_id
: str, scaling_policy
: dict, scaling_group_record
: ScalingGroup
445 scaling_policy_record
= ScalingPolicyRepository
.get(
446 ScalingPolicy
.name
== scaling_policy
["name"],
447 ScalingGroup
.id == scaling_group_record
.id,
448 join_classes
=[ScalingGroup
],
450 log
.debug("Found existing scaling policy record in DB...")
451 except ScalingPolicy
.DoesNotExist
:
452 log
.debug("Creating scaling policy record in DB...")
453 scaling_policy_record
= ScalingPolicyRepository
.create(
455 name
=scaling_policy
["name"],
456 cooldown_time
=scaling_policy
["cooldown-time"],
457 scaling_group
=scaling_group_record
,
459 if "scale-in-operation-type" in scaling_policy
:
460 scaling_policy_record
.scale_in_operation
= scaling_policy
[
461 "scale-in-operation-type"
463 if "scale-out-operation-type" in scaling_policy
:
464 scaling_policy_record
.scale_out_operation
= scaling_policy
[
465 "scale-out-operation-type"
467 if "enabled" in scaling_policy
:
468 scaling_policy_record
.enabled
= scaling_policy
["enabled"]
469 scaling_policy_record
.save()
471 "Created scaling policy record in DB : name=%s, scaling_group.name=%s",
472 scaling_policy_record
.name
,
473 scaling_policy_record
.scaling_group
.name
,
475 return scaling_policy_record
477 def _get_or_create_scaling_criteria(
478 self
, nsr_id
: str, scaling_criteria
: dict, scaling_policy_record
: ScalingPolicy
481 scaling_criteria_record
= ScalingCriteriaRepository
.get(
482 ScalingPolicy
.id == scaling_policy_record
.id,
483 ScalingCriteria
.name
== scaling_criteria
["name"],
484 join_classes
=[ScalingPolicy
],
486 log
.debug("Found existing scaling criteria record in DB...")
487 except ScalingCriteria
.DoesNotExist
:
488 log
.debug("Creating scaling criteria record in DB...")
489 scaling_criteria_record
= ScalingCriteriaRepository
.create(
491 name
=scaling_criteria
["name"],
492 scaling_policy
=scaling_policy_record
,
495 "Created scaling criteria record in DB : name=%s, scaling_policy.name=%s",
496 scaling_criteria_record
.name
,
497 scaling_criteria_record
.scaling_policy
.name
,
499 return scaling_criteria_record
501 def _get_monitored_vdurs(self
, scaling_aspect
: dict, vdurs
):
502 all_monitored_vdus
= set()
503 for delta
in scaling_aspect
.get("aspect-delta-details", {}).get("deltas", ()):
504 for vdu_delta
in delta
.get("vdu-delta", ()):
505 all_monitored_vdus
.add(vdu_delta
.get("id"))
507 monitored_vdurs
= list(
508 filter(lambda vdur
: vdur
["vdu-id-ref"] in all_monitored_vdus
, vdurs
)
511 if not monitored_vdurs
:
513 "Scaling criteria is referring to a vnf-monitoring-param that does not "
514 "contain a reference to a vdu or vnf metric."
516 return monitored_vdurs
518 def _get_metric_name(self
, vnf_monitoring_param
: dict):
519 if "performance-metric" in vnf_monitoring_param
:
520 return vnf_monitoring_param
["performance-metric"]
522 "No metric name found for vnf_monitoring_param %s"
523 % vnf_monitoring_param
["id"]