lcm/lcm/nf/biz/scale_vnf.py

   1 # Copyright (C) 2018 Verizon. All Rights Reserved.
   2 #
   3 # Licensed under the Apache License, Version 2.0 (the "License");
   4 # you may not use this file except in compliance with the License.
   5 # You may obtain a copy of the License at
   6 #
   7 #       http://www.apache.org/licenses/LICENSE-2.0
   8 #
   9 # Unless required by applicable law or agreed to in writing, software
  10 # distributed under the License is distributed on an "AS IS" BASIS,
  11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12 # See the License for the specific language governing permissions and
  13 # limitations under the License.
  14 import json
  15 import logging
  16 import uuid
  17 import traceback
  18 from threading import Thread
  19
  20 from lcm.nf.biz import common
  21 from lcm.nf.biz.grant_vnf import grant_resource
  22 from lcm.nf.const import VNF_STATUS, GRANT_TYPE, CHANGE_TYPE
  23 from lcm.nf.const import RESOURCE_MAP, OPERATION_STATE_TYPE
  24 from lcm.nf.const import INSTANTIATION_STATE
  25 from lcm.nf.const import OPERATION_TYPE
  26 from lcm.nf.const import OPERATION_TASK
  27 from lcm.pub.database.models import NfInstModel
  28 from lcm.pub.database.models import VNFCInstModel, PortInstModel
  29 from lcm.pub.database.models import VmInstModel
  30 from lcm.pub.exceptions import NFLCMException
  31 from lcm.pub.utils.notificationsutil import NotificationsUtil, prepare_notification
  32 from lcm.pub.utils.values import ignore_case_get
  33 from lcm.pub.utils.jobutil import JobUtil
  34 from lcm.pub.utils.timeutil import now_time
  35 from lcm.pub.vimapi import adaptor
  36 from .operate_vnf_lcm_op_occ import VnfLcmOpOcc
  37
  38 logger = logging.getLogger(__name__)
  39
  40 DEFAULT_STEPS = 1
  41
  42
  43 class ScaleVnf(Thread):
  44     def __init__(self, data, nf_inst_id, job_id):
  45         super(ScaleVnf, self).__init__()
  46         self.data = data
  47         self.nf_inst_id = nf_inst_id
  48         self.job_id = job_id
  49         self.vnf_insts = NfInstModel.objects.filter(nfinstid=self.nf_inst_id)
  50         self.lcm_op_occ = VnfLcmOpOcc(
  51             vnf_inst_id=nf_inst_id,
  52             lcm_op_id=job_id,
  53             operation=OPERATION_TYPE.SCALE,
  54             task=OPERATION_TASK.SCALE
  55         )
  56
  57     def run(self):
  58         try:
  59             self.scale_pre()
  60             self.lcm_op_occ.notify_lcm(OPERATION_STATE_TYPE.STARTING)
  61             JobUtil.add_job_status(self.job_id,
  62                                    50,
  63                                    "Start to apply grant.")
  64             self.apply_grant()
  65             self.lcm_op_occ.notify_lcm(OPERATION_STATE_TYPE.PROCESSING)
  66             JobUtil.add_job_status(self.job_id,
  67                                    75,
  68                                    "Start to scale Vnf.")
  69             self.do_operation()
  70             self.send_notification()
  71             JobUtil.add_job_status(self.job_id,
  72                                    100,
  73                                    "Scale Vnf success.")
  74             self.vnf_insts.update(status=INSTANTIATION_STATE.INSTANTIATED,
  75                                   lastuptime=now_time())
  76         except NFLCMException as e:
  77             logger.error(e.message)
  78             self.vnf_scale_failed_handle(e.message)
  79         except Exception as e:
  80             logger.error(e.message)
  81             logger.error(traceback.format_exc())
  82             self.vnf_scale_failed_handle(e.message)
  83
  84     def scale_pre(self):
  85         self.scale_type = self.data.get("type")
  86         self.aspect_id = self.data.get("aspectId")
  87         self.number_of_steps = int(self.data.get("numberOfSteps", DEFAULT_STEPS))
  88         self.additional_params = self.data.get("additionalParams", {})
  89         self.is_scale_in = (self.scale_type == GRANT_TYPE.SCALE_IN)
  90         self.vnfd_info = json.loads(self.vnf_insts[0].vnfd_model)
  91         self.step_delta = self.get_scale_step_delta()
  92         self.target_vdu, self.step_inst_num = self.get_vdu_scale_aspect_deltas()
  93         self.scale_inst_num = self.number_of_steps * self.step_inst_num
  94         self.min_instance_num, self.max_instance_num = self.get_instance_range()
  95         self.check_if_can_scale()
  96         self.scale_out_resource = {}
  97
  98     def apply_grant(self):
  99         logger.debug("Start scale apply grant")
 100         vdus = ignore_case_get(self.vnfd_info, "vdus")
 101         scale_vdus = [vdu for vdu in vdus if vdu["vdu_id"] == self.target_vdu]
 102         scale_vdus = scale_vdus * self.scale_inst_num
 103         grant_result = grant_resource(data=self.data,
 104                                       nf_inst_id=self.nf_inst_id,
 105                                       job_id=self.job_id,
 106                                       grant_type=self.scale_type,
 107                                       vdus=scale_vdus)
 108         logger.debug("Scale Grant result: %s", grant_result)
 109         self.set_location(grant_result)
 110
 111     def do_operation(self):
 112         logger.debug("Start %s VNF resource", self.scale_type)
 113         logger.debug('VnfdInfo = %s' % self.vnfd_info)
 114
 115         if self.is_scale_in:
 116             self.affected_vnfcs = []
 117             self.scale_in_resource = self.get_scale_in_resource(self.affected_vnfcs)
 118             adaptor.delete_vim_res(self.scale_in_resource, self.do_notify_del_vim_res)
 119         else:
 120             self.scale_out_resource = {
 121                 'volumn': [],
 122                 'network': [],
 123                 'subnet': [],
 124                 'port': [],
 125                 'flavor': [],
 126                 'vm': []
 127             }
 128             self.vnfd_info["volume_storages"] = []
 129             self.vnfd_info["vls"] = []
 130             self.vnfd_info["cps"] = self.vnfd_info["cps"] * self.scale_inst_num
 131             for cp in self.vnfd_info["cps"]:
 132                 # TODO: how to set name for scale_out cp
 133                 cp["properties"]["name"] = cp["cp_id"] + str(uuid.uuid4())
 134                 cp_inst = PortInstModel.objects.filter(name__startswith=cp["cp_id"]).first()
 135                 if cp_inst:
 136                     cp["networkId"] = cp_inst.networkid
 137                     cp["subnetId"] = cp_inst.subnetworkid
 138                 else:
 139                     raise NFLCMException("CP(%s) does not exist" % cp["cp_id"])
 140             self.vnfd_info["vdus"] = self.vnfd_info["vdus"] * self.scale_inst_num
 141             for vdu in self.vnfd_info["vdus"]:
 142                 # TODO: how to set name for scale_out vdu
 143                 vdu["properties"]["name"] = vdu["properties"]["name"] + str(uuid.uuid4())
 144
 145             vim_cache = json.loads(self.vnf_insts[0].vimInfo)
 146             res_cache = json.loads(self.vnf_insts[0].resInfo)
 147             adaptor.create_vim_res(self.vnfd_info,
 148                                    self.do_notify_create_vim_res,
 149                                    vim_cache=vim_cache,
 150                                    res_cache=res_cache)
 151             self.vnf_insts.update(vimInfo=json.dumps(vim_cache),
 152                                   resInfo=json.dumps(res_cache))
 153         logger.debug("%s VNF resource finish", self.scale_type)
 154
 155     def send_notification(self):
 156         data = prepare_notification(nfinstid=self.nf_inst_id,
 157                                     jobid=self.job_id,
 158                                     operation=OPERATION_TYPE.SCALE,
 159                                     operation_state=OPERATION_STATE_TYPE.COMPLETED)
 160
 161         # TODO: need set changedExtConnectivity for data
 162         if self.is_scale_in:
 163             data["affectedVnfcs"] = self.affected_vnfcs
 164         else:
 165             for vm in self.scale_out_resource["vm"]:
 166                 self.set_affected_vnfcs(data["affectedVnfcs"], vm["res_id"])
 167
 168         logger.debug('Notify request data = %s' % data)
 169         NotificationsUtil().send_notification(data)
 170
 171     def rollback_operation(self):
 172         if self.is_scale_in:
 173             # SCALE_IN operaion does not support rollback
 174             return
 175         adaptor.delete_vim_res(self.scale_out_resource, self.do_notify_del_vim_res)
 176
 177     def set_location(self, grant_result):
 178         vim_connections = ignore_case_get(grant_result, "vimConnections")
 179         access_info = ignore_case_get(vim_connections[0], "accessInfo")
 180         tenant = ignore_case_get(access_info, "tenant")
 181         vimid = ignore_case_get(vim_connections[0], "vimId")
 182
 183         for resource_type in ['vdus', 'vls', 'cps', 'volume_storages']:
 184             for resource in ignore_case_get(self.vnfd_info, resource_type):
 185                 if "location_info" not in resource["properties"]:
 186                     resource["properties"]["location_info"] = {}
 187                 resource["properties"]["location_info"]["vimid"] = vimid
 188                 resource["properties"]["location_info"]["tenant"] = tenant
 189
 190     def do_notify_create_vim_res(self, res_type, ret):
 191         logger.debug('Scaling out [%s] resource' % res_type)
 192         resource_save_method = getattr(common, res_type + '_save')
 193         resource_save_method(self.job_id, self.nf_inst_id, ret)
 194         self.scale_out_resource[res_type].append(self.gen_del_resource(ret))
 195
 196     def do_notify_del_vim_res(self, res_type, res_id):
 197         logger.debug('Scaling in [%s] resource, resourceid [%s]', res_type, res_id)
 198         resource_type = RESOURCE_MAP.keys()[RESOURCE_MAP.values().index(res_type)]
 199         resource_table = globals().get(resource_type + 'InstModel')
 200         resource_table.objects.filter(instid=self.nf_inst_id, resourceid=res_id).delete()
 201         if res_type == "vm":
 202             VNFCInstModel.objects.filter(instid=self.nf_inst_id, vmid=res_id).delete()
 203
 204     def get_scale_in_resource(self, affected_vnfcs):
 205         scale_in_resource = {
 206             'volumn': [],
 207             'network': [],
 208             'subnet': [],
 209             'port': [],
 210             'flavor': [],
 211             'vm': []
 212         }
 213         scale_in_vms = VmInstModel.objects.filter(instid=self.nf_inst_id)
 214         vms_count = scale_in_vms.count()
 215         for index in range(self.scale_inst_num):
 216             vm_index = vms_count - index - 1
 217             scale_in_resource["vm"].append(self.gen_del_resource(scale_in_vms[vm_index]))
 218             self.set_affected_vnfcs(affected_vnfcs, scale_in_vms[vm_index].resourceid)
 219         return scale_in_resource
 220
 221     def gen_del_resource(self, res):
 222         is_dict = isinstance(res, dict)
 223         return {
 224             "vim_id": res["vimId"] if is_dict else res.vimid,
 225             "tenant_id": res["tenantId"] if is_dict else res.tenant,
 226             "res_id": res["id"] if is_dict else res.resourceid,
 227             "is_predefined": res["returnCode"] if is_dict else res.is_predefined
 228         }
 229
 230     def get_scale_step_delta(self):
 231         for policy in self.vnfd_info.get("policies", []):
 232             if policy.get("type") != "tosca.policies.nfv.ScalingAspects":
 233                 continue
 234             aspects = policy["properties"]["aspects"]
 235             if self.aspect_id in aspects:
 236                 return aspects.get(self.aspect_id).get("step_deltas")[0]
 237         raise NFLCMException("Aspect(%s) does not exist" % self.aspect_id)
 238
 239     def get_vdu_scale_aspect_deltas(self):
 240         for policy in self.vnfd_info.get("policies", []):
 241             if policy.get("type") != "tosca.policies.nfv.VduScalingAspectDeltas":
 242                 continue
 243             target = policy.get("targets")[0]
 244             deltas = policy["properties"]["deltas"]
 245             if self.step_delta in deltas:
 246                 num = int(deltas.get(self.step_delta).get("number_of_instances"))
 247                 return target, num
 248         raise NFLCMException("Aspect step delta(%s) does not exist" % self.step_delta)
 249
 250     def get_instance_range(self):
 251         for vdu in self.vnfd_info["vdus"]:
 252             if vdu["vdu_id"] == self.target_vdu:
 253                 vdu_profile = vdu["properties"]["vdu_profile"]
 254                 min_inst_num = int(vdu_profile["min_number_of_instances"])
 255                 max_inst_num = int(vdu_profile["max_number_of_instances"])
 256                 return min_inst_num, max_inst_num
 257         raise NFLCMException("VDU(%s) does not exist" % self.target_vdu)
 258
 259     def check_if_can_scale(self):
 260         cur_inst_num = VNFCInstModel.objects.filter(instid=self.nf_inst_id).count()
 261         if self.is_scale_in:
 262             if cur_inst_num - self.scale_inst_num < self.min_instance_num:
 263                 msg = "VNF(%s) cannot be scaled: less than min instance."
 264                 raise NFLCMException(msg % self.nf_inst_id)
 265         else:
 266             if cur_inst_num + self.scale_inst_num > self.max_instance_num:
 267                 msg = "VNF(%s) cannot be scaled: max instance exceeded."
 268                 raise NFLCMException(msg % self.nf_inst_id)
 269
 270     def set_affected_vnfcs(self, affected_vnfcs, vm_id):
 271         chgtype = CHANGE_TYPE.REMOVED if self.is_scale_in else CHANGE_TYPE.ADDED
 272         vnfcs = VNFCInstModel.objects.filter(instid=self.nf_inst_id, vmid=vm_id)
 273         vm = VmInstModel.objects.filter(instid=self.nf_inst_id, resourceid=vm_id)
 274         vm_resource = {}
 275         if vm:
 276             vm_resource = {
 277                 'vimConnectionId': vm[0].vimid,
 278                 'resourceId': vm[0].resourceid,
 279                 'vimLevelResourceType': 'vm'
 280             }
 281         if vnfcs:
 282             affected_vnfcs.append({
 283                 'id': vnfcs[0].vnfcinstanceid,
 284                 'vduId': vnfcs[0].vduid,
 285                 'changeType': chgtype,
 286                 'computeResource': vm_resource
 287             })
 288
 289     def vnf_scale_failed_handle(self, error_msg):
 290         logger.error('VNF scaling failed, detail message: %s', error_msg)
 291         self.vnf_insts.update(status=VNF_STATUS.FAILED,
 292                               lastuptime=now_time())
 293         self.lcm_op_occ.notify_lcm(OPERATION_STATE_TYPE.FAILED, error_msg)
 294         JobUtil.add_job_status(self.job_id, 255, error_msg)