rwcal/plugins/vala/rwcal_openstack/rift/rwcal/openstack/utils/compute.py

   1 #!/usr/bin/python
   2
   3 #
   4 #   Copyright 2017 RIFT.IO Inc
   5 #
   6 #   Licensed under the Apache License, Version 2.0 (the "License");
   7 #   you may not use this file except in compliance with the License.
   8 #   You may obtain a copy of the License at
   9 #
  10 #       http://www.apache.org/licenses/LICENSE-2.0
  11 #
  12 #   Unless required by applicable law or agreed to in writing, software
  13 #   distributed under the License is distributed on an "AS IS" BASIS,
  14 #   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15 #   See the License for the specific language governing permissions and
  16 #   limitations under the License.
  17 #
  18 import uuid
  19 import gi
  20 gi.require_version('RwcalYang', '1.0')
  21 from gi.repository import RwcalYang
  22
  23
  24 class ImageValidateError(Exception):
  25     pass
  26
  27 class VolumeValidateError(Exception):
  28     pass
  29
  30 class AffinityGroupError(Exception):
  31     pass
  32
  33
  34 class ComputeUtils(object):
  35     """
  36     Utility class for compute operations
  37     """
  38     epa_types = ['vm_flavor',
  39                  'guest_epa',
  40                  'host_epa',
  41                  'host_aggregate',
  42                  'hypervisor_epa',
  43                  'vswitch_epa']
  44     def __init__(self, driver):
  45         """
  46         Constructor for class
  47         Arguments:
  48            driver: object of OpenstackDriver()
  49         """
  50         self._driver = driver
  51         self.log = driver.log
  52
  53     @property
  54     def driver(self):
  55         return self._driver
  56
  57     def search_vdu_flavor(self, vdu_params):
  58         """
  59         Function to search a matching flavor for VDU instantiation
  60         from already existing flavors
  61
  62         Arguments:
  63           vdu_params: Protobuf GI object RwcalYang.VDUInitParams()
  64
  65         Returns:
  66            flavor_id(string): Flavor id for VDU instantiation
  67            None if no flavor could be found
  68         """
  69         kwargs = { 'vcpus': vdu_params.vm_flavor.vcpu_count,
  70                    'ram'  : vdu_params.vm_flavor.memory_mb,
  71                    'disk' : vdu_params.vm_flavor.storage_gb,}
  72
  73         flavors = self.driver.nova_flavor_find(**kwargs)
  74         flavor_list = list()
  75         for flv in flavors:
  76             flavor_list.append(self.driver.utils.flavor.parse_flavor_info(flv))
  77
  78         flavor_id = self.driver.utils.flavor.match_resource_flavor(vdu_params, flavor_list)
  79         return flavor_id
  80
  81     def select_vdu_flavor(self, vdu_params):
  82         """
  83         This function attempts to find a pre-existing flavor matching required
  84         parameters for VDU instantiation. If no such flavor is found, a new one
  85         is created.
  86
  87         Arguments:
  88           vdu_params: Protobuf GI object RwcalYang.VDUInitParams()
  89
  90         Returns:
  91            flavor_id(string): Flavor id for VDU instantiation
  92         """
  93         flavor_id = self.search_vdu_flavor(vdu_params)
  94         if flavor_id is not None:
  95             self.log.info("Found flavor with id: %s matching requirements for VDU: %s",
  96                           flavor_id, vdu_params.name)
  97             return flavor_id
  98
  99         flavor = RwcalYang.FlavorInfoItem()
 100         flavor.name = str(uuid.uuid4())
 101
 102         epa_dict = { k: v for k, v in vdu_params.as_dict().items()
 103                      if k in ComputeUtils.epa_types }
 104
 105         flavor.from_dict(epa_dict)
 106
 107         flavor_id = self.driver.nova_flavor_create(name      = flavor.name,
 108                                                    ram       = flavor.vm_flavor.memory_mb,
 109                                                    vcpus     = flavor.vm_flavor.vcpu_count,
 110                                                    disk      = flavor.vm_flavor.storage_gb,
 111                                                    epa_specs = self.driver.utils.flavor.get_extra_specs(flavor))
 112         return flavor_id
 113
 114     def make_vdu_flavor_args(self, vdu_params):
 115         """
 116         Creates flavor related arguments for VDU operation
 117         Arguments:
 118           vdu_params: Protobuf GI object RwcalYang.VDUInitParams()
 119
 120         Returns:
 121            A dictionary {'flavor_id': <flavor-id>}
 122         """
 123         return {'flavor_id': self.select_vdu_flavor(vdu_params)}
 124
 125
 126     def make_vdu_image_args(self, vdu_params):
 127         """
 128         Creates image related arguments for VDU operation
 129         Arguments:
 130           vdu_params: Protobuf GI object RwcalYang.VDUInitParams()
 131
 132         Returns:
 133            A dictionary {'image_id': <image-id>}
 134
 135         """
 136         kwargs = dict()
 137         if vdu_params.has_field('image_name'):
 138             kwargs['image_id'] = self.resolve_image_n_validate(vdu_params.image_name,
 139                                                                vdu_params.image_checksum)
 140         elif vdu_params.has_field('image_id'):
 141             kwargs['image_id'] = vdu_params.image_id
 142
 143         return kwargs
 144
 145     def resolve_image_n_validate(self, image_name, checksum = None):
 146         """
 147         Resolve the image_name to image-object by matching image_name and checksum
 148
 149         Arguments:
 150           image_name (string): Name of image
 151           checksums  (string): Checksum associated with image
 152
 153         Raises ImageValidateError in case of Errors
 154         """
 155         image_info = [ i for i in self.driver._glance_image_list if i['name'] == image_name]
 156
 157         if not image_info:
 158             self.log.error("No image with name: %s found", image_name)
 159             raise ImageValidateError("No image with name %s found" %(image_name))
 160
 161         for image in image_info:
 162             if 'status' not in image or image['status'] != 'active':
 163                 self.log.error("Image %s not in active state. Current state: %s",
 164                                image_name, image['status'])
 165                 raise ImageValidateError("Image with name %s found in incorrect (%s) state"
 166                                          %(image_name, image['status']))
 167             if not checksum or checksum == image['checksum']:
 168                 break
 169         else:
 170             self.log.info("No image found with matching name: %s and checksum: %s",
 171                           image_name, checksum)
 172             raise ImageValidateError("No image found with matching name: %s and checksum: %s"
 173                                      %(image_name, checksum))
 174         return image['id']
 175
 176     def make_vdu_volume_args(self, volume, vdu_params):
 177         """
 178         Arguments:
 179            volume:   Protobuf GI object RwcalYang.VDUInitParams_Volumes()
 180            vdu_params: Protobuf GI object RwcalYang.VDUInitParams()
 181
 182         Returns:
 183            A dictionary required to create volume for VDU
 184
 185         Raises VolumeValidateError in case of Errors
 186         """
 187         kwargs = dict()
 188
 189         if volume.has_field('volume_ref'):
 190             self.log.error("Unsupported option <Volume Reference> found for volume: %s", volume.name)
 191             raise VolumeValidateError("Unsupported option <Volume Reference> found for volume: %s"
 192                                       %(volume.name))
 193
 194         kwargs['boot_index'] = volume.boot_priority
 195         if volume.has_field("image"):
 196             # Support image->volume
 197             kwargs['source_type'] = "image"
 198             kwargs['uuid'] = self.resolve_image_n_validate(volume.image, volume.image_checksum)
 199         else:
 200             # Support blank->volume
 201             kwargs['source_type'] = "blank"
 202         kwargs['device_name'] = volume.name
 203         kwargs['destination_type'] = "volume"
 204         kwargs['volume_size'] = volume.size
 205         kwargs['delete_on_termination'] = True
 206
 207         if volume.has_field('device_type'):
 208             if volume.device_type in ['cdrom', 'disk']:
 209                 kwargs['device_type'] = volume.device_type
 210             else:
 211                 self.log.error("Unsupported device_type <%s> found for volume: %s",
 212                                volume.device_type, volume.name)
 213                 raise VolumeValidateError("Unsupported device_type <%s> found for volume: %s"
 214                                           %(volume.device_type, volume.name))
 215         else:
 216             self.log.error("Mandatory field <device_type> not specified for volume: %s",
 217                            volume.name)
 218             raise VolumeValidateError("Mandatory field <device_type> not specified for volume: %s"
 219                                       %(volume.name))
 220
 221         if volume.has_field('device_bus'):
 222             if volume.device_bus in ['ide', 'virtio', 'scsi']:
 223                 kwargs['disk_bus'] = volume.device_bus
 224             else:
 225                 self.log.error("Unsupported device_bus <%s> found for volume: %s",
 226                                volume.device_bus, volume.name)
 227                 raise VolumeValidateError("Unsupported device_bus <%s> found for volume: %s"
 228                                           %(volume.device_bus, volume.name))
 229         else:
 230             self.log.error("Mandatory field <device_bus> not specified for volume: %s",
 231                            volume.name)
 232             raise VolumeValidateError("Mandatory field <device_bus> not specified for volume: %s"
 233                                       %(volume.name))
 234
 235         return kwargs
 236
 237     def make_vdu_storage_args(self, vdu_params):
 238         """
 239         Creates volume related arguments for VDU operation
 240
 241         Arguments:
 242           vdu_params: Protobuf GI object RwcalYang.VDUInitParams()
 243
 244         Returns:
 245            A dictionary required for volumes creation for VDU instantiation
 246         """
 247         kwargs = dict()
 248         if vdu_params.has_field('volumes'):
 249             kwargs['block_device_mapping_v2'] = list()
 250             # Ignore top-level image
 251             kwargs['image_id']  = ""
 252             for volume in vdu_params.volumes:
 253                 kwargs['block_device_mapping_v2'].append(self.make_vdu_volume_args(volume, vdu_params))
 254         return kwargs
 255
 256     def make_vdu_network_args(self, vdu_params):
 257         """
 258         Creates VDU network related arguments for VDU operation
 259         Arguments:
 260           vdu_params: Protobuf GI object RwcalYang.VDUInitParams()
 261
 262         Returns:
 263            A dictionary {'port_list' : [ports], 'network_list': [networks]}
 264
 265         """
 266         kwargs = dict()
 267         kwargs['port_list'], kwargs['network_list'] = self.driver.utils.network.setup_vdu_networking(vdu_params)
 268         return kwargs
 269
 270
 271     def make_vdu_boot_config_args(self, vdu_params):
 272         """
 273         Creates VDU boot config related arguments for VDU operation
 274         Arguments:
 275           vdu_params: Protobuf GI object RwcalYang.VDUInitParams()
 276
 277         Returns:
 278           A dictionary {
 279                          'userdata'    :  <cloud-init> ,
 280                          'config_drive':  True/False,
 281                          'files'       :  [ file name ],
 282                          'metadata'    :  <metadata string>
 283         }
 284         """
 285         kwargs = dict()
 286         if vdu_params.has_field('vdu_init') and vdu_params.vdu_init.has_field('userdata'):
 287             kwargs['userdata'] = vdu_params.vdu_init.userdata
 288         else:
 289             kwargs['userdata'] = ''
 290
 291         if not vdu_params.has_field('supplemental_boot_data'):
 292             return kwargs
 293
 294         if vdu_params.supplemental_boot_data.has_field('config_file'):
 295             files = dict()
 296             for cf in vdu_params.supplemental_boot_data.config_file:
 297                 files[cf.dest] = cf.source
 298             kwargs['files'] = files
 299
 300         if vdu_params.supplemental_boot_data.has_field('boot_data_drive'):
 301             kwargs['config_drive'] = vdu_params.supplemental_boot_data.boot_data_drive
 302         else:
 303             kwargs['config_drive'] = False
 304
 305         if vdu_params.supplemental_boot_data.has_field('custom_meta_data'):
 306             metadata = dict()
 307             for cm in vdu_params.supplemental_boot_data.custom_meta_data:
 308                 metadata[cm] = cm.value
 309             kwargs['metadata'] = metadata
 310
 311         return kwargs
 312
 313     def _select_affinity_group(self, group_name):
 314         """
 315         Selects the affinity group based on name and return its id
 316         Arguments:
 317           group_name (string): Name of the Affinity/Anti-Affinity group
 318         Returns:
 319           Id of the matching group
 320
 321         Raises exception AffinityGroupError if no matching group is found
 322         """
 323         groups = [g['id'] for g in self.driver._nova_affinity_group if g['name'] == group_name]
 324         if not groups:
 325             self.log.error("No affinity/anti-affinity group with name: %s found", group_name)
 326             raise AffinityGroupError("No affinity/anti-affinity group with name: %s found" %(group_name))
 327         return groups[0]
 328
 329
 330     def make_vdu_server_placement_args(self, vdu_params):
 331         """
 332         Function to create kwargs required for nova server placement
 333
 334         Arguments:
 335           vdu_params: Protobuf GI object RwcalYang.VDUInitParams()
 336
 337         Returns:
 338          A dictionary { 'availability_zone' : < Zone >, 'scheduler_hints': <group-id> }
 339
 340         """
 341         kwargs = dict()
 342
 343         if vdu_params.has_field('availability_zone') \
 344            and vdu_params.availability_zone.has_field('name'):
 345             kwargs['availability_zone']  = vdu_params.availability_zone
 346
 347         if vdu_params.has_field('server_group'):
 348             kwargs['scheduler_hints'] = {
 349                 'group': self._select_affinity_group(vdu_params.server_group)
 350             }
 351         return kwargs
 352
 353     def make_vdu_server_security_args(self, vdu_params, account):
 354         """
 355         Function to create kwargs required for nova security group
 356
 357         Arguments:
 358           vdu_params: Protobuf GI object RwcalYang.VDUInitParams()
 359           account: Protobuf GI object RwcalYang.CloudAccount()
 360
 361         Returns:
 362           A dictionary {'security_groups' : < group > }
 363         """
 364         kwargs = dict()
 365         if account.openstack.security_groups:
 366             kwargs['security_groups'] = account.openstack.security_groups
 367         return kwargs
 368
 369
 370     def make_vdu_create_args(self, vdu_params, account):
 371         """
 372         Function to create kwargs required for nova_server_create API
 373
 374         Arguments:
 375           vdu_params: Protobuf GI object RwcalYang.VDUInitParams()
 376           account: Protobuf GI object RwcalYang.CloudAccount()
 377
 378         Returns:
 379           A kwargs dictionary for VDU create operation
 380         """
 381         kwargs = dict()
 382
 383         kwargs['name'] = vdu_params.name
 384
 385         kwargs.update(self.make_vdu_flavor_args(vdu_params))
 386         kwargs.update(self.make_vdu_storage_args(vdu_params))
 387         kwargs.update(self.make_vdu_image_args(vdu_params))
 388         kwargs.update(self.make_vdu_network_args(vdu_params))
 389         kwargs.update(self.make_vdu_boot_config_args(vdu_params))
 390         kwargs.update(self.make_vdu_server_placement_args(vdu_params))
 391         kwargs.update(self.make_vdu_server_security_args(vdu_params, account))
 392         return kwargs
 393
 394
 395     def _parse_vdu_mgmt_address_info(self, vm_info):
 396         """
 397         Get management_ip and public_ip for VDU
 398
 399         Arguments:
 400           vm_info : A dictionary object return by novaclient library listing VM attributes
 401
 402         Returns:
 403           A tuple of mgmt_ip (string) and public_ip (string)
 404         """
 405         mgmt_ip = None
 406         public_ip = None
 407         if 'addresses' in vm_info:
 408             for network_name, network_info in vm_info['addresses'].items():
 409                 if network_info and network_name == self.driver.mgmt_network:
 410                     for interface in network_info:
 411                         if 'OS-EXT-IPS:type' in interface:
 412                             if interface['OS-EXT-IPS:type'] == 'fixed':
 413                                 mgmt_ip = interface['addr']
 414                             elif interface['OS-EXT-IPS:type'] == 'floating':
 415                                 public_ip = interface['addr']
 416         return (mgmt_ip, public_ip)
 417
 418     def get_vdu_epa_info(self, vm_info):
 419         """
 420         Get flavor information (including EPA) for VDU
 421
 422         Arguments:
 423           vm_info : A dictionary returned by novaclient library listing VM attributes
 424         Returns:
 425           flavor_info: A dictionary object returned by novaclient library listing flavor attributes
 426         """
 427         if 'flavor' in vm_info and 'id' in vm_info['flavor']:
 428             try:
 429                 flavor_info = self.driver.nova_flavor_get(vm_info['flavor']['id'])
 430                 return flavor_info
 431             except Exception as e:
 432                 self.log.exception("Exception %s occured during get-flavor", str(e))
 433         return dict()
 434
 435     def _parse_vdu_cp_info(self, vdu_id):
 436         """
 437         Get connection point information for VDU identified by vdu_id
 438         Arguments:
 439         vdu_id (string) : VDU Id (vm_info['id'])
 440         Returns:
 441         A List of object RwcalYang.VDUInfoParams_ConnectionPoints()
 442
 443         """
 444         cp_list = []
 445         # Fill the port information
 446         port_list = self.driver.neutron_port_list(**{'device_id': vdu_id})
 447         for port in port_list:
 448             cp_info = self.driver.utils.network._parse_cp(port)
 449             cp = RwcalYang.VDUInfoParams_ConnectionPoints()
 450             cp.from_dict(cp_info.as_dict())
 451             cp_list.append(cp)
 452         return cp_list
 453
 454     def _parse_vdu_state_info(self, vm_info):
 455         """
 456         Get VDU state information
 457
 458         Arguments:
 459           vm_info : A dictionary returned by novaclient library listing VM attributes
 460
 461         Returns:
 462           state (string): State of the VDU
 463         """
 464         if 'status' in vm_info:
 465             if vm_info['status'] == 'ACTIVE':
 466                 vdu_state = 'active'
 467             elif vm_info['status'] == 'ERROR':
 468                 vdu_state = 'failed'
 469             else:
 470                 vdu_state = 'inactive'
 471         else:
 472             vdu_state = 'unknown'
 473         return vdu_state
 474
 475     def _parse_vdu_server_group_info(self, vm_info):
 476         """
 477         Get VDU server group information
 478         Arguments:
 479           vm_info : A dictionary returned by novaclient library listing VM attributes
 480
 481         Returns:
 482           server_group_name (string): Name of the server group to which VM belongs, else empty string
 483
 484         """
 485         server_group = [ v['name']
 486                          for v in self.driver.nova_server_group_list()
 487                          if vm_info['id'] in v['members'] ]
 488         if server_group:
 489             return server_group[0]
 490         else:
 491             return str()
 492
 493     def _parse_vdu_volume_info(self, vm_info):
 494         """
 495         Get VDU server group information
 496         Arguments:
 497           vm_info : A dictionary returned by novaclient library listing VM attributes
 498
 499         Returns:
 500           List of RwcalYang.VDUInfoParams_Volumes()
 501         """
 502         volumes = list()
 503
 504         try:
 505             volume_list = self.driver.nova_volume_list(vm_info['id'])
 506         except Exception as e:
 507             self.log.exception("Exception %s occured during nova-volume-list", str(e))
 508             return volumes
 509
 510         for v in volume_list:
 511             volume = RwcalYang.VDUInfoParams_Volumes()
 512             try:
 513                 volume.name = (v['device']).split('/')[2]
 514                 volume.volume_id = v['volumeId']
 515                 details = self.driver.cinder_volume_get(volume.volume_id)
 516                 for k, v in details.metadata.items():
 517                     vd = volume.custom_meta_data.add()
 518                     vd.name = k
 519                     vd.value = v
 520             except Exception as e:
 521                 self.log.exception("Exception %s occured during volume list parsing", str(e))
 522                 continue
 523             else:
 524                 volumes.append(volume)
 525         return volumes
 526
 527     def _parse_vdu_console_url(self, vm_info):
 528         """
 529         Get VDU console URL
 530         Arguments:
 531           vm_info : A dictionary returned by novaclient library listing VM attributes
 532
 533         Returns:
 534           console_url(string): Console URL for VM
 535         """
 536         console_url = None
 537         if self._parse_vdu_state_info(vm_info) == 'active':
 538             try:
 539                 serv_console_url = self.driver.nova_server_console(vm_info['id'])
 540                 if 'console' in serv_console_url:
 541                     console_url = serv_console_url['console']['url']
 542                 else:
 543                     self.log.error("Error fetching console url. This could be an Openstack issue. Console : " + str(serv_console_url))
 544
 545
 546             except Exception as e:
 547                 self.log.exception("Exception %s occured during volume list parsing", str(e))
 548         return console_url
 549
 550     def parse_cloud_vdu_info(self, vm_info):
 551         """
 552         Parse vm_info dictionary (return by python-client) and put values in GI object for VDU
 553
 554         Arguments:
 555            vm_info : A dictionary object return by novaclient library listing VM attributes
 556
 557         Returns:
 558            Protobuf GI Object of type RwcalYang.VDUInfoParams()
 559         """
 560         vdu = RwcalYang.VDUInfoParams()
 561         vdu.name = vm_info['name']
 562         vdu.vdu_id = vm_info['id']
 563         vdu.cloud_type  = 'openstack'
 564
 565         if 'config_drive' in vm_info:
 566             vdu.supplemental_boot_data.boot_data_drive = vm_info['config_drive']
 567
 568         if 'image' in vm_info and 'id' in vm_info['image']:
 569             vdu.image_id = vm_info['image']['id']
 570
 571         if 'availability_zone' in vm_info:
 572             vdu.availability_zone = vm_info['availability_zone']
 573
 574         vdu.state = self._parse_vdu_state_info(vm_info)
 575         management_ip,public_ip = self._parse_vdu_mgmt_address_info(vm_info)
 576
 577         if management_ip:
 578             vdu.management_ip = management_ip
 579
 580         if public_ip:
 581             vdu.public_ip = public_ip
 582
 583         if 'flavor' in vm_info and 'id' in vm_info['flavor']:
 584             vdu.flavor_id = vm_info['flavor']['id']
 585             flavor_info = self.get_vdu_epa_info(vm_info)
 586             vm_flavor = self.driver.utils.flavor.parse_vm_flavor_epa_info(flavor_info)
 587             guest_epa = self.driver.utils.flavor.parse_guest_epa_info(flavor_info)
 588             host_epa = self.driver.utils.flavor.parse_host_epa_info(flavor_info)
 589             host_aggregates = self.driver.utils.flavor.parse_host_aggregate_epa_info(flavor_info)
 590
 591             vdu.vm_flavor.from_dict(vm_flavor.as_dict())
 592             vdu.guest_epa.from_dict(guest_epa.as_dict())
 593             vdu.host_epa.from_dict(host_epa.as_dict())
 594             for aggr in host_aggregates:
 595                 ha = vdu.host_aggregate.add()
 596                 ha.from_dict(aggr.as_dict())
 597
 598         cp_list = self._parse_vdu_cp_info(vdu.vdu_id)
 599         for cp in cp_list:
 600             vdu.connection_points.append(cp)
 601
 602         vdu.server_group.name = self._parse_vdu_server_group_info(vm_info)
 603
 604         for v in self._parse_vdu_volume_info(vm_info):
 605             vdu.volumes.append(v)
 606
 607         vdu.console_url = self._parse_vdu_console_url(vm_info)
 608         return vdu
 609
 610
 611     def perform_vdu_network_cleanup(self, vdu_id):
 612         """
 613         This function cleans up networking resources related to VDU
 614         Arguments:
 615            vdu_id(string): VDU id
 616         Returns:
 617            None
 618         """
 619         ### Get list of floating_ips associated with this instance and delete them
 620         floating_ips = [ f for f in self.driver.nova_floating_ip_list() if f.instance_id == vdu_id ]
 621         for f in floating_ips:
 622             self.driver.nova_floating_ip_delete(f)
 623
 624         ### Get list of port on VM and delete them.
 625         port_list = self.driver.neutron_port_list(**{'device_id': vdu_id})
 626
 627         for port in port_list:
 628             if ((port['device_owner'] == 'compute:None') or (port['device_owner'] == '')):
 629                 self.driver.neutron_port_delete(port['id'])
 630