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
31 from osm_policy_module
.common
.common_db_client
import CommonDbClient
32 from osm_policy_module
.common
.lcm_client
import LcmClient
33 from osm_policy_module
.common
.mon_client
import MonClient
34 from osm_policy_module
.core
import database
35 from osm_policy_module
.core
.config
import Config
36 from osm_policy_module
.core
.database
import (
41 ScalingAlarmRepository
,
42 ScalingGroupRepository
,
43 ScalingPolicyRepository
,
44 ScalingCriteriaRepository
,
46 from osm_policy_module
.core
.exceptions
import VdurNotFound
48 log
= logging
.getLogger(__name__
)
51 class AutoscalingService
:
52 def __init__(self
, config
: Config
):
54 self
.db_client
= CommonDbClient(config
)
55 self
.mon_client
= MonClient(config
)
56 self
.lcm_client
= LcmClient(config
)
58 async def configure_scaling_groups(self
, nsr_id
: str, vnf_member_index
=None):
60 Configures scaling groups for a network service. Creates records in DB. Creates alarms in MON.
61 :param nsr_id: Network service record id
65 "Configuring scaling groups for network service with nsr_id: %s", nsr_id
70 with database
.db
.atomic() as tx
:
72 if vnf_member_index
is None:
73 vnfrs
= self
.db_client
.get_vnfrs(nsr_id
)
76 vnfr
= self
.db_client
.get_vnfr(nsr_id
, vnf_member_index
)
78 # vnfrs = self.db_client.get_vnfrs(nsr_id)
80 log
.debug("Processing vnfr: %s", vnfr
)
81 vnfd
= self
.db_client
.get_vnfd(vnfr
["vnfd-id"])
82 # TODO: Change for multiple DF support
83 df
= vnfd
.get("df", [{}])[0]
84 if "scaling-aspect" not in df
:
85 log
.debug("No scaling aspect present in vnfd")
87 # TODO: Change for multiple instantiation levels support
88 scaling_aspects
= df
["scaling-aspect"]
89 all_vnfd_monitoring_params
= (
90 self
._get
_all
_vnfd
_monitoring
_params
(vnfd
)
92 for scaling_aspect
in scaling_aspects
:
93 scaling_group_record
= self
._get
_or
_create
_scaling
_group
(
94 nsr_id
, vnfr
["member-vnf-index-ref"], scaling_aspect
96 vdurs
= self
._get
_monitored
_vdurs
(
97 scaling_aspect
, vnfr
["vdur"]
99 for scaling_policy
in scaling_aspect
.get(
102 if scaling_policy
["scaling-type"] != "automatic":
104 scaling_policy_record
= (
105 self
._get
_or
_create
_scaling
_policy
(
106 nsr_id
, scaling_policy
, scaling_group_record
110 for scaling_criteria
in scaling_policy
[
113 scaling_criteria_record
= (
114 self
._get
_or
_create
_scaling
_criteria
(
117 scaling_policy_record
,
120 monitoring_param_ref
= scaling_criteria
.get(
121 "vnf-monitoring-param-ref"
123 vnf_monitoring_param
= all_vnfd_monitoring_params
[
128 vdu_id
= vdur
["vdu-id-ref"]
129 log
.debug("Creating alarm for vdur %s ", vdur
)
131 ScalingAlarmRepository
.get(
132 ScalingAlarm
.vdu_name
== vdur
["name"],
134 == scaling_criteria
["name"],
136 == scaling_policy
["name"],
137 ScalingGroup
.nsr_id
== nsr_id
,
145 "vdu %s already has an alarm configured",
149 except ScalingAlarm
.DoesNotExist
:
151 metric_name
= self
._get
_metric
_name
(
155 db_nsr
= self
.db_client
.get_nsr(nsr_id
)
157 if db_nsr
["_admin"].get("scaling-group"):
158 db_nsr_admin
= db_nsr
["_admin"][
164 ) in enumerate(db_nsr_admin
):
166 admin_scale_info
["name"]
167 == scaling_aspect
["name"]
169 nb_scale_op
= admin_scale_info
.get(
173 min_instance_count
= 1
174 for vdu_profile
in df
.get("vdu-profile", ()):
175 if vdu_profile
.get("id") == vdu_id
:
176 min_instance_count
= int(
178 "min-number-of-instances ", 1
182 if nb_scale_op
>= min_instance_count
:
184 await self
.mon_client
.create_alarm(
185 metric_name
=metric_name
,
187 vdu_name
=vdur
["name"],
188 vnf_member_index
=vnfr
[
189 "member-vnf-index-ref"
191 threshold
=scaling_criteria
[
194 operation
=scaling_criteria
[
195 "scale-in-relational-operation"
200 alarm
= ScalingAlarmRepository
.create(
201 alarm_uuid
=alarm_uuid
,
203 vnf_member_index
=vnfr
[
204 "member-vnf-index-ref"
206 vdu_name
=vdur
["name"],
207 scaling_criteria
=scaling_criteria_record
,
209 alarms_created
.append(alarm
)
210 alarm_uuid
= await self
.mon_client
.create_alarm(
211 metric_name
=metric_name
,
213 vdu_name
=vdur
["name"],
214 vnf_member_index
=vnfr
[
215 "member-vnf-index-ref"
217 threshold
=scaling_criteria
[
218 "scale-out-threshold"
220 operation
=scaling_criteria
[
221 "scale-out-relational-operation"
225 alarm
= ScalingAlarmRepository
.create(
226 alarm_uuid
=alarm_uuid
,
228 vnf_member_index
=vnfr
[
229 "member-vnf-index-ref"
231 vdu_name
=vdur
["name"],
232 scaling_criteria
=scaling_criteria_record
,
234 alarms_created
.append(alarm
)
236 except Exception as e
:
237 log
.exception("Error configuring scaling groups:")
239 if len(alarms_created
) > 0:
240 log
.info("Cleaning alarm resources in MON")
241 for alarm
in alarms_created
:
242 await self
.mon_client
.delete_alarm(
243 alarm
.scaling_criteria
.scaling_policy
.scaling_group
.nsr_id
,
244 alarm
.vnf_member_index
,
252 async def delete_scaling_groups(self
, nsr_id
: str, vnf_member_index
=None):
253 log
.debug("Deleting scaling groups for network service %s", nsr_id
)
254 database
.db
.connect()
256 with database
.db
.atomic() as tx
:
258 if vnf_member_index
is None:
259 scale_conditions
= ScalingGroup
.nsr_id
== nsr_id
262 ScalingGroup
.nsr_id
== nsr_id
,
263 ScalingGroup
.vnf_member_index
== vnf_member_index
,
265 scale_conditions
= functools
.reduce(operator
.and_
, query_list
)
266 for scaling_group
in ScalingGroupRepository
.list(scale_conditions
):
267 for scaling_policy
in scaling_group
.scaling_policies
:
268 for scaling_criteria
in scaling_policy
.scaling_criterias
:
269 for alarm
in scaling_criteria
.scaling_alarms
:
271 await self
.mon_client
.delete_alarm(
272 alarm
.scaling_criteria
.scaling_policy
.scaling_group
.nsr_id
,
273 alarm
.vnf_member_index
,
279 "Error deleting alarm in MON %s",
282 alarm
.delete_instance()
283 scaling_criteria
.delete_instance()
284 scaling_policy
.delete_instance()
285 scaling_group
.delete_instance()
287 except Exception as e
:
288 log
.exception("Error deleting scaling groups and alarms:")
294 async def delete_orphaned_alarms(self
, nsr_id
):
295 log
.info("Deleting orphaned scaling alarms for network service %s", nsr_id
)
296 database
.db
.connect()
298 with database
.db
.atomic() as tx
:
300 for scaling_group
in ScalingGroupRepository
.list(
301 ScalingGroup
.nsr_id
== nsr_id
303 for scaling_policy
in scaling_group
.scaling_policies
:
304 for scaling_criteria
in scaling_policy
.scaling_criterias
:
305 for alarm
in scaling_criteria
.scaling_alarms
:
307 self
.db_client
.get_vdur(
309 alarm
.vnf_member_index
,
314 "Deleting orphaned scaling alarm %s",
318 await self
.mon_client
.delete_alarm(
319 alarm
.scaling_criteria
.scaling_policy
.scaling_group
.nsr_id
,
320 alarm
.vnf_member_index
,
326 "Error deleting alarm in MON %s",
329 alarm
.delete_instance()
331 except Exception as e
:
332 log
.exception("Error deleting orphaned alarms:")
338 async def handle_alarm(self
, alarm_uuid
: str, status
: str):
339 await self
.update_alarm_status(alarm_uuid
, status
)
340 await self
.evaluate_policy(alarm_uuid
)
342 async def update_alarm_status(self
, alarm_uuid
: str, status
: str):
343 database
.db
.connect()
345 with database
.db
.atomic():
346 alarm
= ScalingAlarmRepository
.get(
347 ScalingAlarm
.alarm_uuid
== alarm_uuid
349 alarm
.last_status
= status
351 except ScalingAlarm
.DoesNotExist
:
353 "There is no autoscaling action configured for alarm %s.", alarm_uuid
358 async def evaluate_policy(self
, alarm_uuid
):
359 database
.db
.connect()
361 if self
.conf
.get("autoscale", "enabled") == "True":
362 with database
.db
.atomic():
363 alarm
= ScalingAlarmRepository
.get(
364 ScalingAlarm
.alarm_uuid
== alarm_uuid
366 vnf_member_index
= alarm
.vnf_member_index
367 action
= alarm
.action
368 scaling_policy
= alarm
.scaling_criteria
.scaling_policy
369 if not scaling_policy
.enabled
:
371 if action
== "scale_in":
372 operation
= scaling_policy
.scale_in_operation
373 elif action
== "scale_out":
374 operation
= scaling_policy
.scale_out_operation
376 raise Exception("Unknown alarm action {}".format(alarm
.action
))
377 alarms
= ScalingAlarmRepository
.list(
378 ScalingAlarm
.scaling_criteria
== alarm
.scaling_criteria
,
379 ScalingAlarm
.action
== alarm
.action
,
380 ScalingAlarm
.vnf_member_index
== vnf_member_index
,
381 ScalingAlarm
.vdu_name
== alarm
.vdu_name
,
385 statuses
.append(alarm
.last_status
)
386 if (operation
== "AND" and set(statuses
) == {"alarm"}) or (
387 operation
== "OR" and "alarm" in statuses
389 delta
= datetime
.datetime
.now() - scaling_policy
.last_scale
390 if delta
.total_seconds() > scaling_policy
.cooldown_time
:
392 "Sending %s action message for ns: %s",
394 scaling_policy
.scaling_group
.nsr_id
,
396 await self
.lcm_client
.scale(
397 scaling_policy
.scaling_group
.nsr_id
,
398 scaling_policy
.scaling_group
.name
,
402 scaling_policy
.last_scale
= datetime
.datetime
.now()
403 scaling_policy
.save()
405 except ScalingAlarm
.DoesNotExist
:
407 "There is no autoscaling action configured for alarm %s.", alarm_uuid
412 def _get_all_vnfd_monitoring_params(self
, vnfd
):
413 all_monitoring_params
= {}
414 for ivld
in vnfd
.get("int-virtual-link-desc", ()):
415 for mp
in ivld
.get("monitoring-parameters", ()):
416 all_monitoring_params
[mp
.get("id")] = mp
418 for vdu
in vnfd
.get("vdu", ()):
419 for mp
in vdu
.get("monitoring-parameter", ()):
420 all_monitoring_params
[mp
.get("id")] = mp
422 for df
in vnfd
.get("df", ()):
423 for mp
in df
.get("monitoring-parameter", ()):
424 all_monitoring_params
[mp
.get("id")] = mp
426 return all_monitoring_params
428 def _get_or_create_scaling_group(
429 self
, nsr_id
: str, vnf_member_index
: str, scaling_aspect
: dict
432 scaling_group_record
= ScalingGroupRepository
.get(
433 ScalingGroup
.nsr_id
== nsr_id
,
434 ScalingGroup
.vnf_member_index
== vnf_member_index
,
435 ScalingGroup
.name
== scaling_aspect
["name"],
437 log
.debug("Found existing scaling group record in DB...")
438 except ScalingGroup
.DoesNotExist
:
439 log
.debug("Creating scaling group record in DB...")
440 scaling_group_record
= ScalingGroupRepository
.create(
442 vnf_member_index
=vnf_member_index
,
443 name
=scaling_aspect
["name"],
444 content
=json
.dumps(scaling_aspect
),
447 "Created scaling group record in DB : nsr_id=%s, vnf_member_index=%s, name=%s",
448 scaling_group_record
.nsr_id
,
449 scaling_group_record
.vnf_member_index
,
450 scaling_group_record
.name
,
452 return scaling_group_record
454 def _get_or_create_scaling_policy(
455 self
, nsr_id
: str, scaling_policy
: dict, scaling_group_record
: ScalingGroup
458 scaling_policy_record
= ScalingPolicyRepository
.get(
459 ScalingPolicy
.name
== scaling_policy
["name"],
460 ScalingGroup
.id == scaling_group_record
.id,
461 join_classes
=[ScalingGroup
],
463 log
.debug("Found existing scaling policy record in DB...")
464 except ScalingPolicy
.DoesNotExist
:
465 log
.debug("Creating scaling policy record in DB...")
466 scaling_policy_record
= ScalingPolicyRepository
.create(
468 name
=scaling_policy
["name"],
469 cooldown_time
=scaling_policy
["cooldown-time"],
470 scaling_group
=scaling_group_record
,
472 if "scale-in-operation-type" in scaling_policy
:
473 scaling_policy_record
.scale_in_operation
= scaling_policy
[
474 "scale-in-operation-type"
476 if "scale-out-operation-type" in scaling_policy
:
477 scaling_policy_record
.scale_out_operation
= scaling_policy
[
478 "scale-out-operation-type"
480 if "enabled" in scaling_policy
:
481 scaling_policy_record
.enabled
= scaling_policy
["enabled"]
482 scaling_policy_record
.save()
484 "Created scaling policy record in DB : name=%s, scaling_group.name=%s",
485 scaling_policy_record
.name
,
486 scaling_policy_record
.scaling_group
.name
,
488 return scaling_policy_record
490 def _get_or_create_scaling_criteria(
491 self
, nsr_id
: str, scaling_criteria
: dict, scaling_policy_record
: ScalingPolicy
494 scaling_criteria_record
= ScalingCriteriaRepository
.get(
495 ScalingPolicy
.id == scaling_policy_record
.id,
496 ScalingCriteria
.name
== scaling_criteria
["name"],
497 join_classes
=[ScalingPolicy
],
499 log
.debug("Found existing scaling criteria record in DB...")
500 except ScalingCriteria
.DoesNotExist
:
501 log
.debug("Creating scaling criteria record in DB...")
502 scaling_criteria_record
= ScalingCriteriaRepository
.create(
504 name
=scaling_criteria
["name"],
505 scaling_policy
=scaling_policy_record
,
508 "Created scaling criteria record in DB : name=%s, scaling_policy.name=%s",
509 scaling_criteria_record
.name
,
510 scaling_criteria_record
.scaling_policy
.name
,
512 return scaling_criteria_record
514 def _get_monitored_vdurs(self
, scaling_aspect
: dict, vdurs
):
515 all_monitored_vdus
= set()
516 for delta
in scaling_aspect
.get("aspect-delta-details", {}).get("deltas", ()):
517 for vdu_delta
in delta
.get("vdu-delta", ()):
518 all_monitored_vdus
.add(vdu_delta
.get("id"))
520 monitored_vdurs
= list(
521 filter(lambda vdur
: vdur
["vdu-id-ref"] in all_monitored_vdus
, vdurs
)
524 if not monitored_vdurs
:
526 "Scaling criteria is referring to a vnf-monitoring-param that does not "
527 "contain a reference to a vdu or vnf metric."
529 return monitored_vdurs
531 def _get_metric_name(self
, vnf_monitoring_param
: dict):
532 if "performance-metric" in vnf_monitoring_param
:
533 return vnf_monitoring_param
["performance-metric"]
535 "No metric name found for vnf_monitoring_param %s"
536 % vnf_monitoring_param
["id"]