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"
196 alarm
= ScalingAlarmRepository
.create(
197 alarm_uuid
=alarm_uuid
,
199 vnf_member_index
=vnfr
[
200 "member-vnf-index-ref"
202 vdu_name
=vdur
["name"],
203 scaling_criteria
=scaling_criteria_record
,
205 alarms_created
.append(alarm
)
206 alarm_uuid
= await self
.mon_client
.create_alarm(
207 metric_name
=metric_name
,
209 vdu_name
=vdur
["name"],
210 vnf_member_index
=vnfr
[
211 "member-vnf-index-ref"
213 threshold
=scaling_criteria
[
214 "scale-out-threshold"
216 operation
=scaling_criteria
[
217 "scale-out-relational-operation"
221 alarm
= ScalingAlarmRepository
.create(
222 alarm_uuid
=alarm_uuid
,
224 vnf_member_index
=vnfr
[
225 "member-vnf-index-ref"
227 vdu_name
=vdur
["name"],
228 scaling_criteria
=scaling_criteria_record
,
230 alarms_created
.append(alarm
)
232 except Exception as e
:
233 log
.exception("Error configuring scaling groups:")
235 if len(alarms_created
) > 0:
236 log
.info("Cleaning alarm resources in MON")
237 for alarm
in alarms_created
:
238 await self
.mon_client
.delete_alarm(
239 alarm
.scaling_criteria
.scaling_policy
.scaling_group
.nsr_id
,
240 alarm
.vnf_member_index
,
248 async def delete_scaling_groups(self
, nsr_id
: str):
249 log
.debug("Deleting scaling groups for network service %s", nsr_id
)
250 database
.db
.connect()
252 with database
.db
.atomic() as tx
:
254 for scaling_group
in ScalingGroupRepository
.list(
255 ScalingGroup
.nsr_id
== nsr_id
257 for scaling_policy
in scaling_group
.scaling_policies
:
258 for scaling_criteria
in scaling_policy
.scaling_criterias
:
259 for alarm
in scaling_criteria
.scaling_alarms
:
261 await self
.mon_client
.delete_alarm(
262 alarm
.scaling_criteria
.scaling_policy
.scaling_group
.nsr_id
,
263 alarm
.vnf_member_index
,
269 "Error deleting alarm in MON %s",
272 alarm
.delete_instance()
273 scaling_criteria
.delete_instance()
274 scaling_policy
.delete_instance()
275 scaling_group
.delete_instance()
277 except Exception as e
:
278 log
.exception("Error deleting scaling groups and alarms:")
284 async def delete_orphaned_alarms(self
, nsr_id
):
285 log
.info("Deleting orphaned scaling alarms for network service %s", nsr_id
)
286 database
.db
.connect()
288 with database
.db
.atomic() as tx
:
290 for scaling_group
in ScalingGroupRepository
.list(
291 ScalingGroup
.nsr_id
== nsr_id
293 for scaling_policy
in scaling_group
.scaling_policies
:
294 for scaling_criteria
in scaling_policy
.scaling_criterias
:
295 for alarm
in scaling_criteria
.scaling_alarms
:
297 self
.db_client
.get_vdur(
299 alarm
.vnf_member_index
,
304 "Deleting orphaned scaling alarm %s",
308 await self
.mon_client
.delete_alarm(
309 alarm
.scaling_criteria
.scaling_policy
.scaling_group
.nsr_id
,
310 alarm
.vnf_member_index
,
316 "Error deleting alarm in MON %s",
319 alarm
.delete_instance()
321 except Exception as e
:
322 log
.exception("Error deleting orphaned alarms:")
328 async def handle_alarm(self
, alarm_uuid
: str, status
: str):
329 await self
.update_alarm_status(alarm_uuid
, status
)
330 await self
.evaluate_policy(alarm_uuid
)
332 async def update_alarm_status(self
, alarm_uuid
: str, status
: str):
333 database
.db
.connect()
335 with database
.db
.atomic():
336 alarm
= ScalingAlarmRepository
.get(
337 ScalingAlarm
.alarm_uuid
== alarm_uuid
339 alarm
.last_status
= status
341 except ScalingAlarm
.DoesNotExist
:
343 "There is no autoscaling action configured for alarm %s.", alarm_uuid
348 async def evaluate_policy(self
, alarm_uuid
):
349 database
.db
.connect()
351 with database
.db
.atomic():
352 alarm
= ScalingAlarmRepository
.get(
353 ScalingAlarm
.alarm_uuid
== alarm_uuid
355 vnf_member_index
= alarm
.vnf_member_index
356 action
= alarm
.action
357 scaling_policy
= alarm
.scaling_criteria
.scaling_policy
358 if not scaling_policy
.enabled
:
360 if action
== "scale_in":
361 operation
= scaling_policy
.scale_in_operation
362 elif action
== "scale_out":
363 operation
= scaling_policy
.scale_out_operation
365 raise Exception("Unknown alarm action {}".format(alarm
.action
))
366 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
,
374 statuses
.append(alarm
.last_status
)
375 if (operation
== "AND" and set(statuses
) == {"alarm"}) or (
376 operation
== "OR" and "alarm" in statuses
378 delta
= datetime
.datetime
.now() - scaling_policy
.last_scale
379 if delta
.total_seconds() > scaling_policy
.cooldown_time
:
381 "Sending %s action message for ns: %s",
383 scaling_policy
.scaling_group
.nsr_id
,
385 await self
.lcm_client
.scale(
386 scaling_policy
.scaling_group
.nsr_id
,
387 scaling_policy
.scaling_group
.name
,
391 scaling_policy
.last_scale
= datetime
.datetime
.now()
392 scaling_policy
.save()
394 except ScalingAlarm
.DoesNotExist
:
396 "There is no autoscaling action configured for alarm %s.", alarm_uuid
401 def _get_all_vnfd_monitoring_params(self
, vnfd
):
402 all_monitoring_params
= {}
403 for ivld
in vnfd
.get("int-virtual-link-desc", ()):
404 for mp
in ivld
.get("monitoring-parameters", ()):
405 all_monitoring_params
[mp
.get("id")] = mp
407 for vdu
in vnfd
.get("vdu", ()):
408 for mp
in vdu
.get("monitoring-parameter", ()):
409 all_monitoring_params
[mp
.get("id")] = mp
411 for df
in vnfd
.get("df", ()):
412 for mp
in df
.get("monitoring-parameter", ()):
413 all_monitoring_params
[mp
.get("id")] = mp
415 return all_monitoring_params
417 def _get_or_create_scaling_group(
418 self
, nsr_id
: str, vnf_member_index
: str, scaling_aspect
: dict
421 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"],
426 log
.debug("Found existing scaling group record in DB...")
427 except ScalingGroup
.DoesNotExist
:
428 log
.debug("Creating scaling group record in DB...")
429 scaling_group_record
= ScalingGroupRepository
.create(
431 vnf_member_index
=vnf_member_index
,
432 name
=scaling_aspect
["name"],
433 content
=json
.dumps(scaling_aspect
),
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
,
441 return scaling_group_record
443 def _get_or_create_scaling_policy(
444 self
, nsr_id
: str, scaling_policy
: dict, scaling_group_record
: ScalingGroup
447 scaling_policy_record
= ScalingPolicyRepository
.get(
448 ScalingPolicy
.name
== scaling_policy
["name"],
449 ScalingGroup
.id == scaling_group_record
.id,
450 join_classes
=[ScalingGroup
],
452 log
.debug("Found existing scaling policy record in DB...")
453 except ScalingPolicy
.DoesNotExist
:
454 log
.debug("Creating scaling policy record in DB...")
455 scaling_policy_record
= ScalingPolicyRepository
.create(
457 name
=scaling_policy
["name"],
458 cooldown_time
=scaling_policy
["cooldown-time"],
459 scaling_group
=scaling_group_record
,
461 if "scale-in-operation-type" in scaling_policy
:
462 scaling_policy_record
.scale_in_operation
= scaling_policy
[
463 "scale-in-operation-type"
465 if "scale-out-operation-type" in scaling_policy
:
466 scaling_policy_record
.scale_out_operation
= scaling_policy
[
467 "scale-out-operation-type"
469 if "enabled" in scaling_policy
:
470 scaling_policy_record
.enabled
= scaling_policy
["enabled"]
471 scaling_policy_record
.save()
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
,
477 return scaling_policy_record
479 def _get_or_create_scaling_criteria(
480 self
, nsr_id
: str, scaling_criteria
: dict, scaling_policy_record
: ScalingPolicy
483 scaling_criteria_record
= ScalingCriteriaRepository
.get(
484 ScalingPolicy
.id == scaling_policy_record
.id,
485 ScalingCriteria
.name
== scaling_criteria
["name"],
486 join_classes
=[ScalingPolicy
],
488 log
.debug("Found existing scaling criteria record in DB...")
489 except ScalingCriteria
.DoesNotExist
:
490 log
.debug("Creating scaling criteria record in DB...")
491 scaling_criteria_record
= ScalingCriteriaRepository
.create(
493 name
=scaling_criteria
["name"],
494 scaling_policy
=scaling_policy_record
,
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
,
501 return scaling_criteria_record
503 def _get_monitored_vdurs(self
, scaling_aspect
: dict, vdurs
):
504 all_monitored_vdus
= set()
505 for delta
in scaling_aspect
.get("aspect-delta-details", {}).get("deltas", ()):
506 for vdu_delta
in delta
.get("vdu-delta", ()):
507 all_monitored_vdus
.add(vdu_delta
.get("id"))
509 monitored_vdurs
= list(
510 filter(lambda vdur
: vdur
["vdu-id-ref"] in all_monitored_vdus
, vdurs
)
513 if not monitored_vdurs
:
515 "Scaling criteria is referring to a vnf-monitoring-param that does not "
516 "contain a reference to a vdu or vnf metric."
518 return monitored_vdurs
520 def _get_metric_name(self
, vnf_monitoring_param
: dict):
521 if "performance-metric" in vnf_monitoring_param
:
522 return vnf_monitoring_param
["performance-metric"]
524 "No metric name found for vnf_monitoring_param %s"
525 % vnf_monitoring_param
["id"]