osdf/optimizers/placementopt/conductor/api_builder.py

   1 # -------------------------------------------------------------------------
   2 #   Copyright (c) 2015-2017 AT&T Intellectual Property
   3 #
   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
   7 #
   8 #       http://www.apache.org/licenses/LICENSE-2.0
   9 #
  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.
  15 #
  16 # -------------------------------------------------------------------------
  17 #
  18
  19 import json
  20
  21 from jinja2 import Template
  22
  23 import osdf.optimizers.placementopt.conductor.translation as tr
  24 from osdf.adapters.policy.utils import group_policies_gen
  25 from osdf.utils.programming_utils import list_flatten
  26
  27
  28 def _build_parameters(group_policies, request_json):
  29     """
  30     Function prepares parameters section for has request
  31     :param group_policies: filtered policies
  32     :param request_json: parameter data received from a client
  33     :return:
  34     """
  35     initial_params = tr.get_opt_query_data(request_json, group_policies['request_param_query'])
  36     params = dict()
  37     params.update({"REQUIRED_MEM": initial_params.pop("requiredMemory", "")})
  38     params.update({"REQUIRED_DISK": initial_params.pop("requiredDisk", "")})
  39     params.update({"customer_lat": initial_params.pop("customerLatitude", 0.0)})
  40     params.update({"customer_long": initial_params.pop("customerLongitude", 0.0)})
  41     params.update({"service_name": request_json['serviceInfo']['serviceName']})
  42     params.update({"service_id": request_json['serviceInfo']['serviceInstanceId']})
  43
  44     for key, val in initial_params.items():
  45         if val and val != "":
  46             params.update({key: val})
  47
  48     return params
  49
  50
  51 def conductor_api_builder(request_json, flat_policies: list, local_config,
  52                           template="osdf/templates/conductor_interface.json"):
  53     """Build an OSDF southbound API call for HAS-Conductor/Placement optimization
  54     :param request_json: parameter data received from a client
  55     :param flat_policies: policy data received from the policy platform (flat policies)
  56     :param template: template to generate southbound API call to conductor
  57     :param local_config: local configuration file with pointers for the service specific information
  58     :param prov_status: provStatus retrieved from Subscriber policy
  59     :return: json to be sent to Conductor/placement optimization
  60     """
  61     templ = Template(open(template).read())
  62     gp = group_policies_gen(flat_policies, local_config)
  63     demand_vnf_name_list = []
  64
  65     for placementDemand in request_json['placementInfo']['placementDemands']:
  66         demand_vnf_name_list.append(placementDemand['resourceModuleName'].lower())
  67     demand_list = tr.gen_demands(request_json, gp['vnfPolicy'])
  68     attribute_policy_list = tr.gen_attribute_policy(demand_vnf_name_list, gp['attribute'])
  69     distance_to_location_policy_list = tr.gen_distance_to_location_policy(
  70         demand_vnf_name_list, gp['distance_to_location'])
  71     inventory_policy_list = tr.gen_inventory_group_policy(demand_vnf_name_list, gp['inventory_group'])
  72     resource_instance_policy_list = tr.gen_resource_instance_policy(
  73         demand_vnf_name_list, gp['instance_fit'])
  74     resource_region_policy_list = tr.gen_resource_region_policy(demand_vnf_name_list, gp['region_fit'])
  75     zone_policy_list = tr.gen_zone_policy(demand_vnf_name_list, gp['zone'])
  76     optimization_policy_list = tr.gen_optimization_policy(demand_vnf_name_list, gp['placement_optimization'])
  77     reservation_policy_list = tr.gen_reservation_policy(demand_vnf_name_list, gp['instance_reservation'])
  78     capacity_policy_list = tr.gen_capacity_policy(demand_vnf_name_list, gp['vim_fit'])
  79     hpa_policy_list = tr.gen_hpa_policy(demand_vnf_name_list, gp['hpa'])
  80     req_params_dict = _build_parameters(gp, request_json)
  81     conductor_policies = [attribute_policy_list, distance_to_location_policy_list, inventory_policy_list,
  82                           resource_instance_policy_list, resource_region_policy_list, zone_policy_list,
  83                           reservation_policy_list, capacity_policy_list, hpa_policy_list]
  84     filtered_policies = [x for x in conductor_policies if len(x) > 0]
  85     policy_groups = list_flatten(filtered_policies)
  86     req_info = request_json['requestInfo']
  87     request_type = req_info.get('requestType', None)
  88     rendered_req = templ.render(
  89         requestType=request_type,
  90         demand_list=demand_list,
  91         policy_groups=policy_groups,
  92         optimization_policies=optimization_policy_list,
  93         name=req_info['requestId'],
  94         timeout=req_info['timeout'],
  95         limit=req_info['numSolutions'],
  96         request_params=req_params_dict,
  97         json=json)
  98     json_payload = json.dumps(json.loads(rendered_req))  # need this because template's JSON is ugly!
  99     return json_payload