Commit 6dfdba09 authored by Guillermo Gomez's avatar Guillermo Gomez
Browse files

initial commit with latest version found in

\ No newline at end of file
FROM python:slim
COPY requirements.txt ./
RUN pip install -r requirements.txt
ADD prom_lib ./prom_lib
RUN mkdir -p /etc/volume
CMD [ "python", "" ]
\ No newline at end of file
Apache License
Version 2.0, January 2004
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
implied, including, without limitation, any warranties or conditions
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
See the License for the specific language governing permissions and
limitations under the License.
# OSM-AI-Agent
AI-Agent container for OSM helm chart
from base64 import b64decode
import json
import logging
import os
import requests
from pymongo import MongoClient, DESCENDING
from prom_lib.prometheus_client import PrometheusClient
import datetime
from importlib import import_module
import uuid
logger = logging.getLogger("AI-Agent v8")
stream_handler = logging.StreamHandler()
formatter = logging.Formatter('%(asctime)s %(name)s %(levelname)s: %(message)s')
stream_formatter = logging.Formatter('%(asctime)s %(name)s %(levelname)s: %(message)s')
def get_prometheus_data(ns_id, query, step=120, days=2):
Prometheus data requester
:param ns_id: network service instance id
:param query: prometheus query
:param step: time between probe and probe (in seconds)
:param days: interval of data (current datetime - days, current datetime)
:return: Prometheus data: List of tuples [(value of metric, timestamp), ...]
client = PrometheusClient('http://prometheus:9090')
ts_data = client.range_query(query, ns_id, step=step, days=days)
timeseries = ts_data['result'][0]['values']
return timeseries
def get_ns_info():
Network service data requester using MongoDB as datasource
:return: Network Service Data with the following structure:
'member-vnf-index-ref': <string>,
'nsi_id': <string>,
'vdu-data': <list>,
'ns_name': <string>,
'vnfs': <list>,
'project_id': <string>,
'scaling-group-descriptor': <string>
client = MongoClient('mongo', 27017)
osm = client['osm']
values = {}
vnf = os.environ.get('vnf-id')
vnf_data = osm['vnfrs'].find_one({'_id': vnf})
values['member-vnf-index-ref'] = vnf_data['member-vnf-index-ref']
values['nsi_id'] = vnf_data['nsr-id-ref']
vduData = []
for vdu in vnf_data.get('vdur'):
{'vdu-id-ref': vdu.get('vdu-id-ref'), 'ip-address': vdu.get('ip-address'), 'name': vdu.get('name')})
values['vdu-data'] = vduData
ns_data = list(osm['nsrs'].find({'_id': values['nsi_id']}))[0]
values['ns_name'] = ns_data.get('name')
values['vnfs'] = ns_data.get('constituent-vnfr-ref', [])
values['project_id'] = ns_data.get('_admin').get('projects_write', [None])[0]
scaling = osm['vnfds'].find_one({'_id': vnf_data['vnfd-id']}).get('scaling-group-descriptor', [{}])[0].get('name')
values['scaling-group-descriptor'] = scaling
return values
def scale_ns(nsi_id, project_id, scaling_group, vnf_index, scale="SCALE_OUT"):
Scale in/out trigger for NS.
:param nsi_id: Network Service instance identification
:param project_id: OSM Project identification
:param scaling_group: Scaling group action (Specified in the VNF descriptor)
:param vnf_index: Virtual Network Function index (Specified in the VNF descriptor)
:param scale: Scale action 2 possibilities: 'SCALE_OUT' Or 'SCALE_IN'
:return: Scaling action response
token = update_token(project_id)
headers = {'Authorization': token, 'accept': 'application/json'}
url = 'https://nbi:9999/osm/nslcm/v1/ns_instances/{}/scale'.format(nsi_id)
scale_data = {
"scaleType": "SCALE_VNF",
"timeout_ns_scale": 1,
"scaleVnfData": {
"scaleVnfType": scale,
"scaleByStepData": {
"scaling-group-descriptor": scaling_group,
"scaling-policy": "string",
"member-vnf-index": vnf_index
response =, data=str(scale_data), verify=False, headers=headers)
return response.text
def update_token(project_id):
NBI Token generator to provide authorization access
:param project_id: OSM Project identification
:return: token to perform requests in an authorized way
client = MongoClient('mongo', 27017)['osm']['tokens']
token = os.environ.get('NBI-Token', uuid.uuid4())
date = datetime.datetime.utcnow().timestamp()
token_data = client.find_one({'project_id': project_id}, sort=[('expires', DESCENDING)])
token_data['_id'] = token
token_data['id'] = token
token_data['issued_at'] = date
token_data['expires'] = date + 5
client.delete_one({'id': token})
except Exception as e:
token = "Bearer " + token
return token
def delete_token(token):
Remove used token for scaling actions to be deleted
:param token: token used
:return: None
token = token.split('Bearer ')[-1]
client = MongoClient('mongo', 27017)['osm']['tokens']
client.delete_one({'id': token})
def url_composer(url, port=None):
URL composer
:param url: URL to compose
:param port: optional port to compose
:return: composed URL
if url[0] != 'h':
url = 'http://{}'.format(url)
if port:
url = url + ':' + str(port)
return url
def get_metrics(prediction, values):
Metrics requester in evaluation phase
:param prediction: prediction object defined in the helm chart values
:param values: values obtained by the function get_ns_info
:return: metrics
data = []
url = prediction['monitoring'].get('url')
prom_query = prediction['monitoring'].get('prometheusQuery')
if url:
url = prediction['monitoring']['url']
if url == 'vnf':
url = values['vdu-data']['ip-address']
port = prediction['monitoring']['port']
url = url_composer(url, port)
data = requests.get(url).text
elif prom_query:
stepsTime = prediction['monitoring'].get('stepsTime') * 60
dataWindowTime = prediction['monitoring'].get('dataWindowTime') / 1440
data = get_prometheus_data(values['nsi_id'], prom_query, step=stepsTime, days=dataWindowTime)'Metrics requested')
return data
def ai_evaluation(prediction, ai_url, data):
AI evaluation asking the AI Server and being evaluated by the threshold defined in the helm chart
:param prediction: prediction object defined in the helm chart values
:param ai_url: AI URL defined in the helm chart
:param data: metrics data
:return: True for scaling, False for not scaling
url = ai_url.format(prediction['model'])
forecast_data =, data=data).json()'prediction requested: {}'.format(forecast_data))
threshold = prediction['threshold']
with open('', 'w') as out_file:
evaluation_function = getattr(import_module('aux_functions'), threshold['function_name'])"importing evaluation function")
return evaluation_function(forecast_data)
def evaluate_v1(config, values):
Evaluation function V1
:param config: configuration object defined in the helm chart values
:param values: values obtained by the function get_ns_info
:return: None
if config['AIServer']['type'] == 'tensorflow':
ai_url = os.path.join(config['AIServer']['url'], config['AIServer']['version'], 'models') + '/{}:predict'
ai_url = config['AIServer']['url']
ai_url = url_composer(ai_url)"AI URL : {}".format(ai_url))
for prediction in config['predictions']:
if prediction['active']:'Prediction to perform: {}'.format(prediction))
data = get_metrics(prediction, values)
evaluation = ai_evaluation(prediction, ai_url, data)
if evaluation and (len(values['vdu-data']) == 1):"SCALING OUT")
scale_ns(values['nsi_id'], values['project_id'], values['scaling-group-descriptor'],
elif not evaluation and len(values['vdu-data']) > 1:"SCALING IN")
scale_ns(values['nsi_id'], values['project_id'], values['scaling-group-descriptor'],
values['member-vnf-index-ref'], scale="SCALE_IN")
if __name__ == '__main__':'AI Agent V1.0')
config = os.environ.get('config')
if config:
config = b64decode(config)
config = json.loads(config)'Config:\n{}'.format(config))
else:'No config available')
values = get_ns_info()'Values:\n{}'.format(values))
evaluate_v1(config, values)
import requests
from datetime import datetime, timedelta
import time
class PrometheusClient:
apibase = "/api/v1/"
def __init__(self, prometheus_url="http://localhost:9090"):
self.apibase = "/api/v1/"
self.prometheus_url = prometheus_url if prometheus_url[-1:] != '/' else prometheus_url[:-1]
def range_query(self, metric, instance=None, start=None, end=None, step=60, params=None, days=1):
Returns a PrometheusData object loaded with results from a query_range call
:param instance: instance to query
:param days: Number of days to query
:param metric: string of the metric query
:param start: an epoch time for the earliest data point in the range -- default is 24 hours ago
:param end: an epoch time for the latest data point in the range -- default is the current time
:param step: the step size
:param params: additional params to send to the API
:return: PrometheusData
if params is None:
params = {}
params['query'] = metric
params['instance'] = instance
params['step'] = step
if start is None:
start = self._time_to_epoch(( - timedelta(days=days)))
if end is None:
end = self._time_to_epoch(
params['start'] = start
params['end'] = end
response = self._fetch('query_range', params)
data = self._extract_data(response)
return data
def _time_to_epoch(t):
A simple utility to turn a datetime object into a timestamp
:param t: datetime object
:return: integer
return int(time.mktime(t.timetuple()))
def _fetch(self, resource, params=None):
if params is None:
params = {}
full_url = self.prometheus_url + self.apibase + resource
res = requests.get(full_url, params)
return res.json()
def _extract_data(jsondata):
if jsondata['status'] != 'success':
data = []
data = jsondata['data']
return data
def _handle_results(data):
results = data
return results
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment