aboutsummaryrefslogtreecommitdiffstats
path: root/apps/placement/optimizers/conductor/translation.py
blob: d3617555b5f620b9a2a62ef3099af4ed3d861888 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
# -------------------------------------------------------------------------
#   Copyright (c) 2015-2017 AT&T Intellectual Property
#
#   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
#
#       http://www.apache.org/licenses/LICENSE-2.0
#
#   Unless required by applicable law or agreed to in writing, software
#   distributed under the License is distributed on an "AS IS" BASIS,
#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
#   See the License for the specific language governing permissions and
#   limitations under the License.
#
# -------------------------------------------------------------------------
#
import copy
import json
import yaml
import re

from osdf.utils.data_conversion import text_to_symbol
from osdf.utils.programming_utils import dot_notation

policy_config_mapping = yaml.safe_load(open('config/has_config.yaml')).get('policy_config_mapping')


def get_opt_query_data(req_json, policies):
    """
    Fetch service and order specific details from the requestParameters field of a request.
    :param req_json: a request file
    :param policies: A set of policies
    :return: A dictionary with service and order-specific attributes.
    """
    req_param_dict = {}
    if 'requestParameters' in req_json["placementInfo"]:
        req_params = req_json["placementInfo"]["requestParameters"]
        for policy in policies:
            for queryProp in policy['content']['queryProperties']:
                attr_val = queryProp['value'] if 'value' in queryProp and queryProp['value'] != "" \
                    else dot_notation(req_params, queryProp['attribute_location'])
                if attr_val is not None:
                    req_param_dict.update({queryProp['attribute']: attr_val})
    return req_param_dict


def gen_optimization_policy(vnf_list, optimization_policy):
    """Generate optimization policy details to pass to Conductor
    :param vnf_list: List of vnf's to used in placement request
    :param optimization_policy: optimization objective policy information provided in the incoming request
    :return: List of optimization objective policies in a format required by Conductor
    """
    optimization_policy_list = []
    for policy in optimization_policy:
        content = policy['content']
        parameter_list = []
        parameters = ["cloud_version", "hpa_score"]

        for attr in content['objectiveParameter']['parameterAttributes']:
            parameter = attr['parameter'] if attr['parameter'] in parameters else attr['parameter']+"_between"
            vnfs = get_matching_vnfs(attr['resources'], vnf_list)
            for vnf in vnfs:
                value = [vnf] if attr['parameter'] in parameters else [attr['customerLocationInfo'], vnf]
                parameter_list.append({
                    attr['operator']: [attr['weight'], {parameter: value}]
                })

        optimization_policy_list.append({
                content['objective']: {content['objectiveParameter']['operator']: parameter_list }
        })
    return optimization_policy_list


def get_matching_vnfs(resources, vnf_list, match_type="intersection"):
    """Get a list of matching VNFs from the list of resources
    :param resources:
    :param vnf_list: List of vnfs to used in placement request
    :param match_type: "intersection" or "all" or "any" (any => send all_vnfs if there is any intersection)
    :return: List of matching VNFs
    """
    resources_lcase = [x.lower() for x in resources]
    if match_type == "all":  # don't bother with any comparisons
        return resources if set(resources_lcase) <= set(vnf_list) else None
    common_vnfs = set(vnf_list) & set(resources_lcase)
    common_resources = [x for x in resources if x.lower() in common_vnfs]
    if match_type == "intersection":  # specifically requested intersection
        return list(common_resources)
    return resources if common_vnfs else None  # "any" match => all resources to be returned


def gen_policy_instance(vnf_list, resource_policy, match_type="intersection", rtype=None):
    """Generate a list of policies
    :param vnf_list: List of vnf's to used in placement request
    :param resource_policy: policy for this specific resource
    :param match_type: How to match the vnf_names with the vnf_list (intersection or "any")
             intersection => return intersection; "any" implies return all vnf_names if intersection is not null
    :param rtype: resource type (e.g. resourceRegionProperty or resourceInstanceProperty)
             None => no controller information added to the policy specification to Conductor
    :return: resource policy list in a format required by Conductor
    """
    resource_policy_list = []
    related_policies = []
    for policy in resource_policy:
        pc = policy['content']
        demands = get_matching_vnfs(pc['resources'], vnf_list, match_type=match_type)
        resource = {pc['identity']: {'type': pc['policyType'], 'demands': demands}}

        if rtype:
            resource[pc['identity']]['properties'] = {'controller': pc[rtype]['controller'],
                                                      'request': json.loads(pc[rtype]['request'])}
        if demands and len(demands) != 0:
            resource_policy_list.append(resource)
            related_policies.append(policy)
    return resource_policy_list, related_policies


def gen_resource_instance_policy(vnf_list, resource_instance_policy):
    """Get policies governing resource instances in order to populate the Conductor API call"""
    cur_policies, _ = gen_policy_instance(vnf_list, resource_instance_policy, rtype='resourceInstanceProperty')
    return cur_policies


def gen_resource_region_policy(vnf_list, resource_region_policy):
    """Get policies governing resource region in order to populate the Conductor API call"""
    cur_policies, _ = gen_policy_instance(vnf_list, resource_region_policy, rtype='resourceRegionProperty')
    return cur_policies


def gen_inventory_group_policy(vnf_list, inventory_group_policy):
    """Get policies governing inventory group in order to populate the Conductor API call"""
    cur_policies, _ = gen_policy_instance(vnf_list, inventory_group_policy, rtype=None)
    return cur_policies


def gen_reservation_policy(vnf_list, reservation_policy):
    """Get policies governing resource instances in order to populate the Conductor API call"""
    cur_policies, _ = gen_policy_instance(vnf_list, reservation_policy, rtype='instanceReservationProperty')
    return cur_policies


def gen_distance_to_location_policy(vnf_list, distance_to_location_policy):
    """Get policies governing distance-to-location for VNFs in order to populate the Conductor API call"""
    cur_policies, related_policies = gen_policy_instance(vnf_list, distance_to_location_policy, rtype=None)
    for p_new, p_main in zip(cur_policies, related_policies):  # add additional fields to each policy
        properties = p_main['content']['distanceProperties']
        pcp_d = properties['distance']
        p_new[p_main['content']['identity']]['properties'] = {
            'distance': pcp_d['operator'] + " " + pcp_d['value'].lower() + " " + pcp_d['unit'].lower(),
            'location': properties['locationInfo']
        }
    return cur_policies


def gen_attribute_policy(vnf_list, attribute_policy):
    """Get policies governing attributes of VNFs in order to populate the Conductor API call"""
    cur_policies, related_policies = gen_policy_instance(vnf_list, attribute_policy, rtype=None)
    for p_new, p_main in zip(cur_policies, related_policies):  # add additional fields to each policy
        properties = p_main['content']['cloudAttributeProperty']
        attribute_mapping = policy_config_mapping['attributes']  # wanted attributes and mapping
        p_new[p_main['content']['identity']]['properties'] = {
            'evaluate': dict((k, properties.get(attribute_mapping.get(k))) for k in attribute_mapping.keys())
        }
    return cur_policies  # cur_policies gets updated in place...


def gen_zone_policy(vnf_list, zone_policy):
    """Get zone policies in order to populate the Conductor API call"""
    cur_policies, related_policies = gen_policy_instance(vnf_list, zone_policy, match_type="all", rtype=None)
    for p_new, p_main in zip(cur_policies, related_policies):  # add additional fields to each policy
        pmz = p_main['content']['affinityProperty']
        p_new[p_main['content']['identity']]['properties'] = {'category': pmz['category'], 'qualifier': pmz['qualifier']}
    return cur_policies


def gen_capacity_policy(vnf_list, capacity_policy):
    """Get zone policies in order to populate the Conductor API call"""
    cur_policies, related_policies = gen_policy_instance(vnf_list, capacity_policy, rtype=None)
    for p_new, p_main in zip(cur_policies, related_policies):  # add additional fields to each policy
        pmz = p_main['content']['capacityProperty']
        p_new[p_main['content']['identity']]['properties'] = \
            {"controller": pmz['controller'], 'request': json.loads(pmz['request'])}
    return cur_policies


def gen_hpa_policy(vnf_list, hpa_policy):
    """Get zone policies in order to populate the Conductor API call"""
    cur_policies, related_policies = gen_policy_instance(vnf_list, hpa_policy, rtype=None)
    for p_new, p_main in zip(cur_policies, related_policies):  # add additional fields to each policy
        p_new[p_main['content']['identity']]['properties'] = {'evaluate': p_main['content']['flavorFeatures']}
    return cur_policies


def get_augmented_policy_attributes(policy_property, demand):
    """Get policy attributes and augment them using policy_config_mapping and demand information"""
    attributes = copy.copy(policy_property['attributes'])
    remapping = policy_config_mapping['remapping']
    extra = dict((x, demand['resourceModelInfo'][remapping[x]]) for x in attributes if x in remapping)
    attributes.update(extra)
    return attributes


def get_candidates_demands(demand):
    """Get demands related to candidates; e.g. excluded/required"""
    res = {}
    for k, v in policy_config_mapping['candidates'].items():
        if k not in demand:
            continue
        res[v] = [{'inventory_type': x['identifierType'], 'candidate_id': x['identifiers']} for x in demand[k]]
    return res


def get_policy_properties(demand, policies):
    """Get policy_properties for cases where there is a match with the demand"""
    for policy in policies:
        policy_demands = set([x.lower() for x in policy['content'].get('resources', [])])
        if demand['resourceModuleName'].lower() not in policy_demands:
            continue  # no match for this policy
        for policy_property in policy['content']['vnfProperties']:
            yield policy_property


def get_demand_properties(demand, policies):
    """Get list demand properties objects (named tuples) from policy"""
    demand_properties = []
    for policy_property in get_policy_properties(demand, policies):
        prop = dict(inventory_provider=policy_property['inventoryProvider'],
                    inventory_type=policy_property['inventoryType'],
                    service_type=demand['serviceResourceId'],
                    service_resource_id=demand['serviceResourceId'])

        prop.update({'unique': policy_property['unique']} if 'unique' in policy_property and
                                                             policy_property['unique'] else {})
        prop['attributes'] = dict()
        prop['attributes'].update({'global-customer-id': policy_property['customerId']}
                                  if policy_property['customerId'] else {})
        prop['attributes'].update({'model-invariant-id': demand['resourceModelInfo']['modelInvariantId']}
                                  if demand['resourceModelInfo']['modelInvariantId'] else {})
        prop['attributes'].update({'model-version-id': demand['resourceModelInfo']['modelVersionId']}
                                  if demand['resourceModelInfo']['modelVersionId'] else {})
        prop['attributes'].update({'equipment-role': policy_property['equipmentRole']}
                                  if policy_property['equipmentRole'] else {})

        if policy_property.get('attributes'):
            for attr_key, attr_val in policy_property['attributes'].items():
                update_converted_attribute(attr_key, attr_val, prop)

        prop.update(get_candidates_demands(demand))
        demand_properties.append(prop)
    return demand_properties


def update_converted_attribute(attr_key, attr_val, properties):
    """
    Updates dictonary of attributes with one specified in the arguments.
    Automatically translates key namr from camelCase to hyphens
    :param attr_key: key of the attribute
    :param attr_val: value of the attribute
    :param properties: dictionary with attributes to update
    :return:
    """
    if attr_val:
        remapping = policy_config_mapping['attributes']
        if remapping.get(attr_key):
            key_value = remapping.get(attr_key)
        else:
            key_value = re.sub('(.)([A-Z][a-z]+)', r'\1-\2', attr_key)
            key_value = re.sub('([a-z0-9])([A-Z])', r'\1-\2', key_value).lower()
        properties['attributes'].update({key_value: attr_val})


def gen_demands(req_json, vnf_policies):
    """Generate list of demands based on request and VNF policies
    :param req_json: Request object from the client (e.g. MSO)
    :param vnf_policies: Policies associated with demand resources (e.g. from grouped_policies['vnfPolicy'])
    :return: list of demand parameters to populate the Conductor API call
    """
    demand_dictionary = {}
    for demand in req_json['placementInfo']['placementDemands']:
        prop = get_demand_properties(demand, vnf_policies)
        if len(prop) > 0:
            demand_dictionary.update({demand['resourceModuleName']: prop})
    return demand_dictionary