rwcal/plugins/vala/rwcal_openstack/rift/rwcal/openstack/openstack_drv.py

   1 #!/usr/bin/python
   2
   3 #
   4 #   Copyright 2016 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
  19 import logging
  20
  21 from . import session as sess_drv
  22 from . import keystone as ks_drv
  23 from . import nova as nv_drv
  24 from . import neutron as nt_drv
  25 from . import glance as gl_drv
  26 from . import ceilometer as ce_drv
  27 from . import cinder as ci_drv
  28 from . import utils as drv_utils
  29
  30 # Exceptions
  31 import keystoneclient.exceptions as KeystoneExceptions
  32 import neutronclient.common.exceptions as NeutronException
  33
  34
  35 class ValidationError(Exception):
  36     pass
  37
  38
  39 class DriverUtilities(object):
  40     """
  41     Class with utility method
  42     """
  43     def __init__(self, driver):
  44         """
  45         Constructor of DriverUtilities class
  46         Arguments:
  47           driver: Object of OpenstackDriver
  48         """
  49         self.flavor_utils = drv_utils.FlavorUtils(driver)
  50         self.network_utils = drv_utils.NetworkUtils(driver)
  51         self.image_utils = drv_utils.ImageUtils(driver)
  52         self.compute_utils = drv_utils.ComputeUtils(driver)
  53
  54     @property
  55     def flavor(self):
  56         return self.flavor_utils
  57
  58     @property
  59     def compute(self):
  60         return self.compute_utils
  61
  62     @property
  63     def network(self):
  64         return self.network_utils
  65
  66     @property
  67     def image(self):
  68         return self.image_utils
  69
  70
  71 class OpenstackDriver(object):
  72     """
  73     Driver for openstack nova, neutron, glance, keystone, swift, cinder services
  74     """
  75     def __init__(self, logger = None, **kwargs):
  76         """
  77         OpenstackDriver Driver constructor
  78         Arguments:
  79            logger: (instance of logging.Logger)
  80            kwargs:  A dictionary of
  81             {
  82               username (string)                   : Username for project/tenant.
  83               password (string)                   : Password
  84               auth_url (string)                   : Keystone Authentication URL.
  85               project  (string)                   : Openstack project name
  86               mgmt_network(string, optional)      : Management network name. Each VM created with this cloud-account will
  87                                                     have a default interface into management network.
  88               cert_validate (boolean, optional)   : In case of SSL/TLS connection if certificate validation is required or not.
  89               user_domain                         : Domain name for user
  90               project_domain                      : Domain name for project
  91               region                              : Region name
  92             }
  93         """
  94
  95         if logger is None:
  96             self.log = logging.getLogger('rwcal.openstack.driver')
  97             self.log.setLevel(logging.DEBUG)
  98         else:
  99             self.log = logger
 100
 101         args =  dict(auth_url            = kwargs['auth_url'],
 102                      username            = kwargs['username'],
 103                      password            = kwargs['password'],
 104                      project_name        = kwargs['project'],
 105                      project_domain_name = kwargs['project_domain'] if 'project_domain' in kwargs else None,
 106                      user_domain_name    = kwargs['user_domain'] if 'user_domain' in kwargs else None,)
 107
 108         cert_validate = kwargs['cert_validate'] if 'cert_validate' in kwargs else False
 109         region = kwargs['region_name'] if 'region_name' in kwargs else False
 110         mgmt_network = kwargs['mgmt_network'] if 'mgmt_network' in kwargs else None
 111
 112         discover = ks_drv.KeystoneVersionDiscover(kwargs['auth_url'], logger = self.log)
 113         (major, minor) = discover.get_version()
 114
 115         self.sess_drv = sess_drv.SessionDriver(auth_method = 'password',
 116                                                version = str(major),
 117                                                cert_validate = cert_validate,
 118                                                logger = self.log,
 119                                                **args)
 120
 121         self.ks_drv = ks_drv.KeystoneDriver(str(major),
 122                                             self.sess_drv,
 123                                             logger = self.log)
 124
 125         self.nova_drv = nv_drv.NovaDriver(self.sess_drv,
 126                                           region_name = region,
 127                                           logger = self.log)
 128
 129         self.neutron_drv = nt_drv.NeutronDriver(self.sess_drv,
 130                                                 region_name = region,
 131                                                 logger = self.log)
 132
 133         self.glance_drv = gl_drv.GlanceDriver(self.sess_drv,
 134                                               region_name = region,
 135                                               logger = self.log)
 136
 137         try:
 138            self.cinder_drv = ci_drv.CinderDriver(self.sess_drv,
 139                                               region_name = region,
 140                                               logger = self.log)
 141         except Exception:
 142            self.cinder_drv = None
 143
 144         self.ceilo_drv = ce_drv.CeilometerDriver(self.sess_drv,
 145                                                  region_name = region,
 146                                                  logger = self.log)
 147
 148         self.utils = DriverUtilities(self)
 149
 150         self._mgmt_network = mgmt_network
 151
 152         self._cache = dict(neutron = dict(),
 153                            nova = dict(),
 154                            cinder = dict(),
 155                            glance = dict())
 156         self.build_resource_cache()
 157
 158     @property
 159     def nova_cache(self):
 160         return self._cache['nova']
 161
 162     @property
 163     def neutron_cache(self):
 164         return self._cache['neutron']
 165
 166     @property
 167     def glance_cache(self):
 168         return self._cache['glance']
 169
 170     @property
 171     def cinder_cache(self):
 172         return self._cache['cinder']
 173
 174     def build_resource_cache(self):
 175         try:
 176             self.build_network_resource_cache()
 177         except KeyError:
 178             raise
 179         self.build_nova_resource_cache()
 180         self.build_cinder_resource_cache()
 181         self.build_glance_resource_cache()
 182
 183     def _cache_populate(self, method, datatype, *args, **kwargs):
 184         try:
 185             rsp = method(*args, **kwargs)
 186         except Exception as e:
 187             self.log.exception("Exception %s occured during execution of %s",
 188                                str(e), method)
 189             return datatype
 190         else:
 191             return rsp
 192
 193     def _build_nova_security_group_list(self):
 194         self.log.info("Building Nova security group cache")
 195         self.nova_cache['security_groups'] = self._cache_populate(self.nova_drv.security_group_list,
 196                                                                   list())
 197         return self.nova_cache['security_groups']
 198
 199     def _build_nova_affinity_group_list(self):
 200         self.log.info("Building Nova affinity/anti-affinity group cache")
 201         self.nova_cache['affinity_groups'] = self._cache_populate(self.nova_server_group_list,
 202                                                                   list())
 203         return self.nova_cache['affinity_groups']
 204
 205     def _build_neutron_security_group_list(self):
 206         self.log.info("Discovering neutron security group")
 207         self.neutron_cache['security_groups'] = self._cache_populate(self.neutron_security_group_list,
 208                                                                      list())
 209         return self.neutron_cache['security_groups']
 210
 211     def _build_neutron_subnet_prefix_list(self):
 212         self.log.info("Discovering subnet prefix pools")
 213         self.neutron_cache['subnet_pool'] = self._cache_populate(self.neutron_subnetpool_list,
 214                                                                  list())
 215         return self.neutron_cache['subnet_pool']
 216
 217     def _get_neutron_mgmt_network(self):
 218         if self._mgmt_network:
 219             self.log.info("Discovering management network %s", self._mgmt_network)
 220             network_list = self._cache_populate(self.neutron_drv.network_get,
 221                                                 None,
 222                                                 **{'network_name': self._mgmt_network})
 223             if network_list:
 224                 self.neutron_cache['mgmt_net'] = network_list['id']
 225             else:
 226                 msg = "Could not find management network %s" % self._mgmt_network
 227                 self.log.error(msg)
 228                 raise KeyError(msg)
 229
 230
 231     def _build_glance_image_list(self):
 232         self.log.info("Discovering images")
 233         self.glance_cache['images'] = self._cache_populate(self.glance_image_list,
 234                                                            list())
 235
 236         return self.glance_cache['images']
 237
 238     def _build_cinder_volume_list(self):
 239         self.log.info("Discovering volumes")
 240         self.cinder_cache['volumes'] = self._cache_populate(self.cinder_volume_list,
 241                                                            list())
 242         return self.cinder_cache['volumes']
 243
 244     def build_nova_resource_cache(self):
 245         self.log.info("Building nova resource cache")
 246         self._build_nova_security_group_list()
 247         self._build_nova_affinity_group_list()
 248
 249
 250     def build_network_resource_cache(self):
 251         self.log.info("Building network resource cache")
 252         try:
 253             self._get_neutron_mgmt_network()
 254         except KeyError:
 255             raise
 256         self._build_neutron_security_group_list()
 257         self._build_neutron_subnet_prefix_list()
 258
 259     def build_cinder_resource_cache(self):
 260         self.log.info("Building cinder resource cache")
 261         if self.cinder_drv is not None:
 262             self._build_cinder_volume_list()
 263
 264     def build_glance_resource_cache(self):
 265         self.log.info("Building glance resource cache")
 266         self._build_glance_image_list()
 267
 268
 269     @property
 270     def _nova_affinity_group(self):
 271         if 'affinity_groups' in self.nova_cache:
 272             return self.nova_cache['affinity_groups']
 273         else:
 274             return self._build_nova_affinity_group_list()
 275
 276     @property
 277     def _nova_security_groups(self):
 278         if 'security_groups' in self.nova_cache:
 279             return self.nova_cache['security_groups']
 280         else:
 281             return self._build_nova_security_group_list()
 282
 283     @property
 284     def mgmt_network(self):
 285         return self._mgmt_network
 286
 287     @property
 288     def _mgmt_network_id(self):
 289         if 'mgmt_net' in self.neutron_cache:
 290             return self.neutron_cache['mgmt_net']
 291         else:
 292             return list()
 293
 294     @property
 295     def _neutron_security_groups(self):
 296         if 'security_groups' in self.neutron_cache:
 297             return self.neutron_cache['security_groups']
 298         else:
 299             return self._build_neutron_security_group_list()
 300
 301     @property
 302     def _neutron_subnet_prefix_pool(self):
 303         if 'subnet_pool' in self.neutron_cache:
 304             return self.neutron_cache['subnet_pool']
 305         else:
 306             return self._build_neutron_subnet_prefix_list()
 307
 308     @property
 309     def _glance_image_list(self):
 310         if 'images' in self.glance_cache:
 311             return self.glance_cache['images']
 312         else:
 313             return self._build_glance_image_list()
 314
 315     @property
 316     def _cinder_volume_list(self):
 317         if 'volumes' in self.cinder_cache:
 318             return self.cinder_cache['volumes']
 319         else:
 320             return self._build_cinder_volume_list()
 321
 322     def validate_account_creds(self):
 323         try:
 324             self.sess_drv.invalidate_auth_token()
 325             self.sess_drv.auth_token
 326             self.build_resource_cache()
 327         except KeystoneExceptions.Unauthorized as e:
 328             self.log.error("Invalid credentials ")
 329             raise ValidationError("Invalid Credentials: "+ str(e))
 330         except KeystoneExceptions.AuthorizationFailure as e:
 331             self.log.error("Unable to authenticate or validate the existing credentials. Exception: %s", str(e))
 332             raise ValidationError("Invalid Credentials: "+ str(e))
 333         except NeutronException.NotFound as e:
 334             self.log.error("Given management network could not be found for Openstack account ")
 335             raise ValidationError("Neutron network not found "+ str(e))
 336         except Exception as e:
 337             self.log.error("Could not connect to Openstack. Exception: %s", str(e))
 338             raise ValidationError("Connection Error: "+ str(e))
 339
 340
 341     def glance_image_create(self, **kwargs):
 342         if 'disk_format' not in kwargs:
 343             kwargs['disk_format'] = 'qcow2'
 344         if 'container_format' not in kwargs:
 345             kwargs['container_format'] = 'bare'
 346         if 'min_disk' not in kwargs:
 347             kwargs['min_disk'] = 0
 348         if 'min_ram' not in kwargs:
 349             kwargs['min_ram'] = 0
 350         return self.glance_drv.image_create(**kwargs)
 351
 352     def glance_image_upload(self, image_id, fd):
 353         self.glance_drv.image_upload(image_id, fd)
 354
 355     def glance_image_add_location(self, image_id, location):
 356         self.glance_drv.image_add_location(image_id, location)
 357
 358     def glance_image_update(self, image_id, remove_props = None, **kwargs):
 359         self.glance_drv.image_update(image_id, remove_props=remove_props, **kwargs)
 360
 361     def glance_image_delete(self, image_id):
 362         self.glance_drv.image_delete(image_id)
 363
 364     def glance_image_list(self):
 365         return self.glance_drv.image_list()
 366
 367     def glance_image_get(self, image_id):
 368         return self.glance_drv.image_get(image_id)
 369
 370     def nova_flavor_list(self):
 371         return self.nova_drv.flavor_list()
 372
 373     def nova_flavor_find(self, **kwargs):
 374         return self.nova_drv.flavor_find(**kwargs)
 375
 376     def nova_flavor_create(self, name, ram, vcpus, disk, epa_specs = dict()):
 377         return self.nova_drv.flavor_create(name,
 378                                            ram         = ram,
 379                                            vcpu        = vcpus,
 380                                            disk        = disk,
 381                                            extra_specs = epa_specs)
 382
 383     def nova_flavor_delete(self, flavor_id):
 384         self.nova_drv.flavor_delete(flavor_id)
 385
 386     def nova_flavor_get(self, flavor_id):
 387         return self.nova_drv.flavor_get(flavor_id)
 388
 389     def nova_server_create(self, **kwargs):
 390         if 'security_groups' not in kwargs:
 391             kwargs['security_groups'] = [s['name'] for s in self._nova_security_groups]
 392         return self.nova_drv.server_create(**kwargs)
 393
 394     def nova_server_add_port(self, server_id, port_id):
 395         self.nova_drv.server_add_port(server_id, port_id)
 396
 397     def nova_server_delete_port(self, server_id, port_id):
 398         self.nova_drv.server_delete_port(server_id, port_id)
 399
 400     def nova_server_start(self, server_id):
 401         self.nova_drv.server_start(server_id)
 402
 403     def nova_server_stop(self, server_id):
 404         self.nova_drv.server_stop(server_id)
 405
 406     def nova_server_delete(self, server_id):
 407         self.nova_drv.server_delete(server_id)
 408
 409     def nova_server_reboot(self, server_id):
 410         self.nova_drv.server_reboot(server_id, reboot_type='HARD')
 411
 412     def nova_server_rebuild(self, server_id, image_id):
 413         self.nova_drv.server_rebuild(server_id, image_id)
 414
 415     def nova_floating_ip_list(self):
 416         return self.nova_drv.floating_ip_list()
 417
 418     def nova_floating_ip_create(self, pool = None):
 419         return self.nova_drv.floating_ip_create(pool)
 420
 421     def nova_floating_ip_delete(self, floating_ip):
 422         self.nova_drv.floating_ip_delete(floating_ip)
 423
 424     def nova_floating_ip_assign(self, server_id, floating_ip, fixed_ip):
 425         self.nova_drv.floating_ip_assign(server_id, floating_ip, fixed_ip)
 426
 427     def nova_floating_ip_release(self, server_id, floating_ip):
 428         self.nova_drv.floating_ip_release(server_id, floating_ip)
 429
 430     def nova_server_list(self):
 431         return self.nova_drv.server_list()
 432
 433     def nova_server_get(self, server_id):
 434         return self.nova_drv.server_get(server_id)
 435
 436     def nova_server_console(self, server_id):
 437         return self.nova_drv.server_console(server_id)
 438
 439     def nova_server_group_list(self):
 440         return self.nova_drv.group_list()
 441
 442     def nova_volume_list(self, server_id):
 443         return self.nova_drv.volume_list(server_id)
 444
 445     def neutron_extensions_list(self):
 446         return self.neutron_drv.extensions_list()
 447
 448     def neutron_network_list(self):
 449         return self.neutron_drv.network_list()
 450
 451     def neutron_network_get(self, network_id):
 452         return self.neutron_drv.network_get(network_id=network_id)
 453
 454     def neutron_network_create(self, **kwargs):
 455         return self.neutron_drv.network_create(**kwargs)
 456
 457     def neutron_network_delete(self, network_id):
 458         self.neutron_drv.network_delete(network_id)
 459
 460     def neutron_subnet_list(self):
 461         return self.neutron_drv.subnet_list(**{})
 462
 463     def neutron_subnet_get(self, subnet_id):
 464         return self.neutron_drv.subnet_get(subnet_id)
 465
 466     def neutron_subnet_create(self, **kwargs):
 467         return self.neutron_drv.subnet_create(**kwargs)
 468
 469     def netruon_subnet_delete(self, subnet_id):
 470         self.neutron_drv.subnet_delete(subnet_id)
 471
 472     def neutron_subnetpool_list(self):
 473         return self.neutron_drv.subnetpool_list()
 474
 475     def netruon_subnetpool_by_name(self, pool_name):
 476         pool_list = self.neutron_drv.subnetpool_list(**{'name': pool_name})
 477         if pool_list:
 478             return pool_list[0]
 479         else:
 480             return None
 481
 482     def neutron_port_list(self, **kwargs):
 483         return self.neutron_drv.port_list(**kwargs)
 484
 485     def neutron_port_get(self, port_id):
 486         return self.neutron_drv.port_get(port_id)
 487
 488     def neutron_port_create(self, **kwargs):
 489         port_id =  self.neutron_drv.port_create([kwargs])[0]
 490         if 'vm_id' in kwargs:
 491             self.nova_server_add_port(kwargs['vm_id'], port_id)
 492         return port_id
 493
 494     def neutron_multi_port_create(self, ports):
 495         return self.neutron_drv.port_create(ports)
 496
 497     def neutron_security_group_list(self):
 498         return self.neutron_drv.security_group_list(**{})
 499
 500     def neutron_security_group_by_name(self, group_name):
 501         group_list = self.neutron_drv.security_group_list(**{'name': group_name})
 502         if group_list:
 503             return group_list[0]
 504         else:
 505             return None
 506
 507     def neutron_port_delete(self, port_id):
 508         self.neutron_drv.port_delete(port_id)
 509
 510     def ceilo_meter_endpoint(self):
 511         return self.ceilo_drv.endpoint
 512
 513     def ceilo_meter_list(self):
 514         return self.ceilo_drv.meters
 515
 516     def ceilo_nfvi_metrics(self, vim_id):
 517         """Returns a dict of NFVI metrics for a given VM
 518
 519         Arguments:
 520             vim_id - the VIM ID of the VM to retrieve the metrics for
 521
 522         Returns:
 523             A dict of NFVI metrics
 524
 525         """
 526         return self.ceilo_drv.nfvi_metrics(vim_id)
 527
 528     def ceilo_alarm_list(self):
 529         """Returns a list of ceilometer alarms"""
 530         return self.ceilo_drv.client.alarms.list()
 531
 532     def ceilo_alarm_create(self,
 533                            name,
 534                            meter,
 535                            statistic,
 536                            operation,
 537                            threshold,
 538                            period,
 539                            evaluations,
 540                            severity='low',
 541                            repeat=True,
 542                            enabled=True,
 543                            actions=None,
 544                            **kwargs):
 545         """Create a new Alarm
 546
 547         Arguments:
 548             name        - the name of the alarm
 549             meter       - the name of the meter to measure
 550             statistic   - the type of statistic used to trigger the alarm
 551                           ('avg', 'min', 'max', 'count', 'sum')
 552             operation   - the relational operator that, combined with the
 553                           threshold value, determines  when the alarm is
 554                           triggered ('lt', 'le', 'eq', 'ge', 'gt')
 555             threshold   - the value of the statistic that will trigger the
 556                           alarm
 557             period      - the duration (seconds) over which to evaluate the
 558                           specified statistic
 559             evaluations - the number of samples of the meter statistic to
 560                           collect when evaluating the threshold
 561             severity    - a measure of the urgency or importance of the alarm
 562                           ('low', 'moderate', 'critical')
 563             repeat      - a flag that indicates whether the alarm should be
 564                           triggered once (False) or repeatedly while the alarm
 565                           condition is true (True)
 566             enabled     - a flag that indicates whether the alarm is enabled
 567                           (True) or disabled (False)
 568             actions     - a dict specifying the URLs for webhooks. The dict can
 569                           have up to 3 keys: 'insufficient_data', 'alarm',
 570                           'ok'. Each key is associated with a list of URLs to
 571                           webhooks that will be invoked when one of the 3
 572                           actions is taken.
 573             kwargs      - an arbitrary dict of keyword arguments that are
 574                           passed to the ceilometer client
 575
 576         """
 577         ok_actions = actions.get('ok') if actions is not None else None
 578         alarm_actions = actions.get('alarm') if actions is not None else None
 579         insufficient_data_actions = actions.get('insufficient_data') if actions is not None else None
 580
 581         return self.ceilo_drv.client.alarms.create(name=name,
 582                                                    meter_name=meter,
 583                                                    statistic=statistic,
 584                                                    comparison_operator=operation,
 585                                                    threshold=threshold,
 586                                                    period=period,
 587                                                    evaluation_periods=evaluations,
 588                                                    severity=severity,
 589                                                    repeat_actions=repeat,
 590                                                    enabled=enabled,
 591                                                    ok_actions=ok_actions,
 592                                                    alarm_actions=alarm_actions,
 593                                                    insufficient_data_actions=insufficient_data_actions,
 594                                                    **kwargs)
 595
 596     def ceilo_alarm_update(self, alarm_id, **kwargs):
 597         """Updates an existing alarm
 598
 599         Arguments:
 600             alarm_id - the identifier of the alarm to update
 601             kwargs   - a dict of the alarm attributes to update
 602
 603         """
 604         return self.ceilo_drv.client.alarms.update(alarm_id, **kwargs)
 605
 606     def ceilo_alarm_delete(self, alarm_id):
 607         self.ceilo_drv.client.alarms.delete(alarm_id)
 608
 609     def cinder_volume_list(self):
 610         return self.cinder_drv.volume_list()
 611
 612     def cinder_volume_get(self, vol_id):
 613         return self.cinder_drv.volume_get(vol_id)
 614
 615     def cinder_volume_set_metadata(self, volumeid, metadata):
 616         return self.cinder_drv.volume_set_metadata(volumeid, metadata)
 617
 618     def cinder_volume_delete_metadata(self, volumeid, metadata):
 619         return self.cinder_drv.volume_delete_metadata(volumeid, metadata)
 620
 621
 622