1 # -------------------------------------------------------------------------
2 # Copyright (c) 2015-2017 AT&T Intellectual Property
4 # Licensed under the Apache License, Version 2.0 (the "License");
5 # you may not use this file except in compliance with the License.
6 # You may obtain a copy of the License at
8 # http://www.apache.org/licenses/LICENSE-2.0
10 # Unless required by applicable law or agreed to in writing, software
11 # distributed under the License is distributed on an "AS IS" BASIS,
12 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 # See the License for the specific language governing permissions and
14 # limitations under the License.
16 # -------------------------------------------------------------------------
22 from osdf.utils.data_conversion import text_to_symbol
23 from osdf.utils.programming_utils import dot_notation
25 policy_config_mapping = yaml.load(open('config/has_config.yaml')).get('policy_config_mapping')
28 def get_opt_query_data(req_json, policies):
30 Fetch service and order specific details from the requestParameters field of a request.
31 :param req_json: a request file
32 :param policies: A set of policies
33 :return: A dictionary with service and order-specific attributes.
36 if 'requestParameters' in req_json["placementInfo"]:
37 req_params = req_json["placementInfo"]["requestParameters"]
38 for policy in policies:
39 for queryProp in policy['content']['queryProperties']:
40 attr_val = queryProp['value'] if 'value' in queryProp and queryProp['value'] != "" \
41 else dot_notation(req_params, queryProp['attribute_location'])
42 if attr_val is not None:
43 req_param_dict.update({queryProp['attribute']: attr_val})
47 def gen_optimization_policy(vnf_list, optimization_policy):
48 """Generate optimization policy details to pass to Conductor
49 :param vnf_list: List of vnf's to used in placement request
50 :param optimization_policy: optimization objective policy information provided in the incoming request
51 :return: List of optimization objective policies in a format required by Conductor
53 optimization_policy_list = []
54 for policy in optimization_policy:
55 content = policy['content']
57 parameters = ["cloud_version", "hpa_score"]
59 for attr in content['objectiveParameter']['parameterAttributes']:
60 parameter = attr['parameter'] if attr['parameter'] in parameters else attr['parameter']+"_between"
61 vnfs = get_matching_vnfs(attr['resources'], vnf_list)
63 value = [vnf] if attr['parameter'] in parameters else [attr['customerLocationInfo'], vnf]
64 parameter_list.append({
65 attr['operator']: [attr['weight'], {parameter: value}]
68 optimization_policy_list.append({
69 content['objective']: {content['objectiveParameter']['operator']: parameter_list }
71 return optimization_policy_list
74 def get_matching_vnfs(resources, vnf_list, match_type="intersection"):
75 """Get a list of matching VNFs from the list of resources
77 :param vnf_list: List of vnfs to used in placement request
78 :param match_type: "intersection" or "all" or "any" (any => send all_vnfs if there is any intersection)
79 :return: List of matching VNFs
81 resources_lcase = [x.lower() for x in resources]
82 if match_type == "all": # don't bother with any comparisons
83 return resources if set(resources_lcase) <= set(vnf_list) else None
84 common_vnfs = set(vnf_list) & set(resources_lcase)
85 common_resources = [x for x in resources if x.lower() in common_vnfs]
86 if match_type == "intersection": # specifically requested intersection
87 return list(common_resources)
88 return resources if common_vnfs else None # "any" match => all resources to be returned
91 def gen_policy_instance(vnf_list, resource_policy, match_type="intersection", rtype=None):
92 """Generate a list of policies
93 :param vnf_list: List of vnf's to used in placement request
94 :param resource_policy: policy for this specific resource
95 :param match_type: How to match the vnf_names with the vnf_list (intersection or "any")
96 intersection => return intersection; "any" implies return all vnf_names if intersection is not null
97 :param rtype: resource type (e.g. resourceRegionProperty or resourceInstanceProperty)
98 None => no controller information added to the policy specification to Conductor
99 :return: resource policy list in a format required by Conductor
101 resource_policy_list = []
102 related_policies = []
103 for policy in resource_policy:
104 pc = policy['content']
105 demands = get_matching_vnfs(pc['resources'], vnf_list, match_type=match_type)
106 resource = {pc['identity']: {'type': pc['policyType'], 'demands': demands}}
109 resource[pc['identity']]['properties'] = {'controller': pc[rtype]['controller'],
110 'request': json.loads(pc[rtype]['request'])}
111 if demands and len(demands) != 0:
112 resource_policy_list.append(resource)
113 related_policies.append(policy)
114 return resource_policy_list, related_policies
117 def gen_resource_instance_policy(vnf_list, resource_instance_policy):
118 """Get policies governing resource instances in order to populate the Conductor API call"""
119 cur_policies, _ = gen_policy_instance(vnf_list, resource_instance_policy, rtype='resourceInstanceProperty')
123 def gen_resource_region_policy(vnf_list, resource_region_policy):
124 """Get policies governing resource region in order to populate the Conductor API call"""
125 cur_policies, _ = gen_policy_instance(vnf_list, resource_region_policy, rtype='resourceRegionProperty')
129 def gen_inventory_group_policy(vnf_list, inventory_group_policy):
130 """Get policies governing inventory group in order to populate the Conductor API call"""
131 cur_policies, _ = gen_policy_instance(vnf_list, inventory_group_policy, rtype=None)
135 def gen_reservation_policy(vnf_list, reservation_policy):
136 """Get policies governing resource instances in order to populate the Conductor API call"""
137 cur_policies, _ = gen_policy_instance(vnf_list, reservation_policy, rtype='instanceReservationProperty')
141 def gen_distance_to_location_policy(vnf_list, distance_to_location_policy):
142 """Get policies governing distance-to-location for VNFs in order to populate the Conductor API call"""
143 cur_policies, related_policies = gen_policy_instance(vnf_list, distance_to_location_policy, rtype=None)
144 for p_new, p_main in zip(cur_policies, related_policies): # add additional fields to each policy
145 properties = p_main['content']['distanceProperties']
146 pcp_d = properties['distance']
147 p_new[p_main['content']['identity']]['properties'] = {
148 'distance': pcp_d['operator'] + " " + pcp_d['value'].lower() + " " + pcp_d['unit'].lower(),
149 'location': properties['locationInfo']
154 def gen_attribute_policy(vnf_list, attribute_policy):
155 """Get policies governing attributes of VNFs in order to populate the Conductor API call"""
156 cur_policies, related_policies = gen_policy_instance(vnf_list, attribute_policy, rtype=None)
157 for p_new, p_main in zip(cur_policies, related_policies): # add additional fields to each policy
158 properties = p_main['content']['cloudAttributeProperty']
159 attribute_mapping = policy_config_mapping['attributes'] # wanted attributes and mapping
160 p_new[p_main['content']['identity']]['properties'] = {
161 'evaluate': dict((k, properties.get(attribute_mapping.get(k))) for k in attribute_mapping.keys())
163 return cur_policies # cur_policies gets updated in place...
166 def gen_zone_policy(vnf_list, zone_policy):
167 """Get zone policies in order to populate the Conductor API call"""
168 cur_policies, related_policies = gen_policy_instance(vnf_list, zone_policy, match_type="all", rtype=None)
169 for p_new, p_main in zip(cur_policies, related_policies): # add additional fields to each policy
170 pmz = p_main['content']['affinityProperty']
171 p_new[p_main['content']['identity']]['properties'] = {'category': pmz['category'], 'qualifier': pmz['qualifier']}
175 def gen_capacity_policy(vnf_list, capacity_policy):
176 """Get zone policies in order to populate the Conductor API call"""
177 cur_policies, related_policies = gen_policy_instance(vnf_list, capacity_policy, rtype=None)
178 for p_new, p_main in zip(cur_policies, related_policies): # add additional fields to each policy
179 pmz = p_main['content']['capacityProperty']
180 p_new[p_main['content']['identity']]['properties'] = \
181 {"controller": pmz['controller'], 'request': json.loads(pmz['request'])}
185 def gen_hpa_policy(vnf_list, hpa_policy):
186 """Get zone policies in order to populate the Conductor API call"""
187 cur_policies, related_policies = gen_policy_instance(vnf_list, hpa_policy, rtype=None)
188 for p_new, p_main in zip(cur_policies, related_policies): # add additional fields to each policy
189 p_new[p_main['content']['identity']]['properties'] = {'evaluate': p_main['content']['flavorFeatures']}
193 def get_augmented_policy_attributes(policy_property, demand):
194 """Get policy attributes and augment them using policy_config_mapping and demand information"""
195 attributes = copy.copy(policy_property['attributes'])
196 remapping = policy_config_mapping['remapping']
197 extra = dict((x, demand['resourceModelInfo'][remapping[x]]) for x in attributes if x in remapping)
198 attributes.update(extra)
202 def get_candidates_demands(demand):
203 """Get demands related to candidates; e.g. excluded/required"""
205 for k, v in policy_config_mapping['candidates'].items():
208 res[v] = [{'inventory_type': x['identifierType'], 'candidate_id': x['identifiers']} for x in demand[k]]
212 def get_policy_properties(demand, policies):
213 """Get policy_properties for cases where there is a match with the demand"""
214 for policy in policies:
215 policy_demands = set([x.lower() for x in policy['content'].get('resources', [])])
216 if demand['resourceModuleName'].lower() not in policy_demands:
217 continue # no match for this policy
218 for policy_property in policy['content']['vnfProperties']:
219 yield policy_property
222 def get_demand_properties(demand, policies):
223 """Get list demand properties objects (named tuples) from policy"""
224 demand_properties = []
225 for policy_property in get_policy_properties(demand, policies):
226 prop = dict(inventory_provider=policy_property['inventoryProvider'],
227 inventory_type=policy_property['inventoryType'],
228 service_type=demand['serviceResourceId'],
229 service_resource_id=demand['serviceResourceId'])
230 prop['attributes'] = dict()
231 prop['attributes'].update({'global-customer-id': policy_property['customerId']}
232 if policy_property['customerId'] else {})
233 prop['attributes'].update({'model-invariant-id': demand['resourceModelInfo']['modelInvariantId']}
234 if demand['resourceModelInfo']['modelInvariantId'] else {})
235 prop['attributes'].update({'model-version-id': demand['resourceModelInfo']['modelVersionId']}
236 if demand['resourceModelInfo']['modelVersionId'] else {})
237 prop['attributes'].update({'equipment-role': policy_property['equipmentRole']}
238 if policy_property['equipmentRole'] else {})
239 prop.update(get_candidates_demands(demand))
240 demand_properties.append(prop)
241 return demand_properties
244 def gen_demands(req_json, vnf_policies):
245 """Generate list of demands based on request and VNF policies
246 :param req_json: Request object from the client (e.g. MSO)
247 :param vnf_policies: Policies associated with demand resources (e.g. from grouped_policies['vnfPolicy'])
248 :return: list of demand parameters to populate the Conductor API call
250 demand_dictionary = {}
251 for demand in req_json['placementInfo']['placementDemands']:
252 prop = get_demand_properties(demand, vnf_policies)
254 demand_dictionary.update({demand['resourceModuleName']: prop})
255 return demand_dictionary