4 # Copyright 2016 RIFT.IO Inc
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
10 # http://www.apache.org/licenses/LICENSE-2.0
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.
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
31 import keystoneclient
.exceptions
as KeystoneExceptions
32 import neutronclient
.common
.exceptions
as NeutronException
35 class ValidationError(Exception):
39 class DriverUtilities(object):
41 Class with utility method
43 def __init__(self
, driver
):
45 Constructor of DriverUtilities class
47 driver: Object of OpenstackDriver
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
)
56 return self
.flavor_utils
60 return self
.compute_utils
64 return self
.network_utils
68 return self
.image_utils
71 class OpenstackDriver(object):
73 Driver for openstack nova, neutron, glance, keystone, swift, cinder services
75 def __init__(self
, logger
= None, **kwargs
):
77 OpenstackDriver Driver constructor
79 logger: (instance of logging.Logger)
80 kwargs: A dictionary of
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
96 self
.log
= logging
.getLogger('rwcal.openstack.driver')
97 self
.log
.setLevel(logging
.DEBUG
)
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,)
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
112 discover
= ks_drv
.KeystoneVersionDiscover(kwargs
['auth_url'], logger
= self
.log
)
113 (major
, minor
) = discover
.get_version()
115 self
.sess_drv
= sess_drv
.SessionDriver(auth_method
= 'password',
116 version
= str(major
),
117 cert_validate
= cert_validate
,
121 self
.ks_drv
= ks_drv
.KeystoneDriver(str(major
),
125 self
.nova_drv
= nv_drv
.NovaDriver(self
.sess_drv
,
126 region_name
= region
,
129 self
.neutron_drv
= nt_drv
.NeutronDriver(self
.sess_drv
,
130 region_name
= region
,
133 self
.glance_drv
= gl_drv
.GlanceDriver(self
.sess_drv
,
134 region_name
= region
,
138 self
.cinder_drv
= ci_drv
.CinderDriver(self
.sess_drv
,
139 region_name
= region
,
142 self
.cinder_drv
= None
144 self
.ceilo_drv
= ce_drv
.CeilometerDriver(self
.sess_drv
,
145 region_name
= region
,
148 self
.utils
= DriverUtilities(self
)
150 self
._mgmt
_network
= mgmt_network
152 self
._cache
= dict(neutron
= dict(),
156 self
.build_resource_cache()
159 def nova_cache(self
):
160 return self
._cache
['nova']
163 def neutron_cache(self
):
164 return self
._cache
['neutron']
167 def glance_cache(self
):
168 return self
._cache
['glance']
171 def cinder_cache(self
):
172 return self
._cache
['cinder']
174 def build_resource_cache(self
):
176 self
.build_network_resource_cache()
179 self
.build_nova_resource_cache()
180 self
.build_cinder_resource_cache()
181 self
.build_glance_resource_cache()
183 def _cache_populate(self
, method
, datatype
, *args
, **kwargs
):
185 rsp
= method(*args
, **kwargs
)
186 except Exception as e
:
187 self
.log
.exception("Exception %s occured during execution of %s",
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
,
197 return self
.nova_cache
['security_groups']
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
,
203 return self
.nova_cache
['affinity_groups']
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
,
209 return self
.neutron_cache
['security_groups']
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
,
215 return self
.neutron_cache
['subnet_pool']
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
,
222 **{'network_name': self
._mgmt
_network
})
224 self
.neutron_cache
['mgmt_net'] = network_list
['id']
226 msg
= "Could not find management network %s" % self
._mgmt
_network
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
,
236 return self
.glance_cache
['images']
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
,
242 return self
.cinder_cache
['volumes']
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
()
250 def build_network_resource_cache(self
):
251 self
.log
.info("Building network resource cache")
253 self
._get
_neutron
_mgmt
_network
()
256 self
._build
_neutron
_security
_group
_list
()
257 self
._build
_neutron
_subnet
_prefix
_list
()
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
()
264 def build_glance_resource_cache(self
):
265 self
.log
.info("Building glance resource cache")
266 self
._build
_glance
_image
_list
()
270 def _nova_affinity_group(self
):
271 if 'affinity_groups' in self
.nova_cache
:
272 return self
.nova_cache
['affinity_groups']
274 return self
._build
_nova
_affinity
_group
_list
()
277 def _nova_security_groups(self
):
278 if 'security_groups' in self
.nova_cache
:
279 return self
.nova_cache
['security_groups']
281 return self
._build
_nova
_security
_group
_list
()
284 def mgmt_network(self
):
285 return self
._mgmt
_network
288 def _mgmt_network_id(self
):
289 if 'mgmt_net' in self
.neutron_cache
:
290 return self
.neutron_cache
['mgmt_net']
295 def _neutron_security_groups(self
):
296 if 'security_groups' in self
.neutron_cache
:
297 return self
.neutron_cache
['security_groups']
299 return self
._build
_neutron
_security
_group
_list
()
302 def _neutron_subnet_prefix_pool(self
):
303 if 'subnet_pool' in self
.neutron_cache
:
304 return self
.neutron_cache
['subnet_pool']
306 return self
._build
_neutron
_subnet
_prefix
_list
()
309 def _glance_image_list(self
):
310 if 'images' in self
.glance_cache
:
311 return self
.glance_cache
['images']
313 return self
._build
_glance
_image
_list
()
316 def _cinder_volume_list(self
):
317 if 'volumes' in self
.cinder_cache
:
318 return self
.cinder_cache
['volumes']
320 return self
._build
_cinder
_volume
_list
()
322 def validate_account_creds(self
):
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
))
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
)
352 def glance_image_upload(self
, image_id
, fd
):
353 self
.glance_drv
.image_upload(image_id
, fd
)
355 def glance_image_add_location(self
, image_id
, location
):
356 self
.glance_drv
.image_add_location(image_id
, location
)
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
)
361 def glance_image_delete(self
, image_id
):
362 self
.glance_drv
.image_delete(image_id
)
364 def glance_image_list(self
):
365 return self
.glance_drv
.image_list()
367 def glance_image_get(self
, image_id
):
368 return self
.glance_drv
.image_get(image_id
)
370 def nova_flavor_list(self
):
371 return self
.nova_drv
.flavor_list()
373 def nova_flavor_find(self
, **kwargs
):
374 return self
.nova_drv
.flavor_find(**kwargs
)
376 def nova_flavor_create(self
, name
, ram
, vcpus
, disk
, epa_specs
= dict()):
377 return self
.nova_drv
.flavor_create(name
,
381 extra_specs
= epa_specs
)
383 def nova_flavor_delete(self
, flavor_id
):
384 self
.nova_drv
.flavor_delete(flavor_id
)
386 def nova_flavor_get(self
, flavor_id
):
387 return self
.nova_drv
.flavor_get(flavor_id
)
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
)
394 def nova_server_add_port(self
, server_id
, port_id
):
395 self
.nova_drv
.server_add_port(server_id
, port_id
)
397 def nova_server_delete_port(self
, server_id
, port_id
):
398 self
.nova_drv
.server_delete_port(server_id
, port_id
)
400 def nova_server_start(self
, server_id
):
401 self
.nova_drv
.server_start(server_id
)
403 def nova_server_stop(self
, server_id
):
404 self
.nova_drv
.server_stop(server_id
)
406 def nova_server_delete(self
, server_id
):
407 self
.nova_drv
.server_delete(server_id
)
409 def nova_server_reboot(self
, server_id
):
410 self
.nova_drv
.server_reboot(server_id
, reboot_type
='HARD')
412 def nova_server_rebuild(self
, server_id
, image_id
):
413 self
.nova_drv
.server_rebuild(server_id
, image_id
)
415 def nova_floating_ip_list(self
):
416 return self
.nova_drv
.floating_ip_list()
418 def nova_floating_ip_create(self
, pool
= None):
419 return self
.nova_drv
.floating_ip_create(pool
)
421 def nova_floating_ip_delete(self
, floating_ip
):
422 self
.nova_drv
.floating_ip_delete(floating_ip
)
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
)
427 def nova_floating_ip_release(self
, server_id
, floating_ip
):
428 self
.nova_drv
.floating_ip_release(server_id
, floating_ip
)
430 def nova_server_list(self
):
431 return self
.nova_drv
.server_list()
433 def nova_server_get(self
, server_id
):
434 return self
.nova_drv
.server_get(server_id
)
436 def nova_server_console(self
, server_id
):
437 return self
.nova_drv
.server_console(server_id
)
439 def nova_server_group_list(self
):
440 return self
.nova_drv
.group_list()
442 def nova_volume_list(self
, server_id
):
443 return self
.nova_drv
.volume_list(server_id
)
445 def neutron_extensions_list(self
):
446 return self
.neutron_drv
.extensions_list()
448 def neutron_network_list(self
):
449 return self
.neutron_drv
.network_list()
451 def neutron_network_get(self
, network_id
):
452 return self
.neutron_drv
.network_get(network_id
=network_id
)
454 def neutron_network_create(self
, **kwargs
):
455 return self
.neutron_drv
.network_create(**kwargs
)
457 def neutron_network_delete(self
, network_id
):
458 self
.neutron_drv
.network_delete(network_id
)
460 def neutron_subnet_list(self
):
461 return self
.neutron_drv
.subnet_list(**{})
463 def neutron_subnet_get(self
, subnet_id
):
464 return self
.neutron_drv
.subnet_get(subnet_id
)
466 def neutron_subnet_create(self
, **kwargs
):
467 return self
.neutron_drv
.subnet_create(**kwargs
)
469 def netruon_subnet_delete(self
, subnet_id
):
470 self
.neutron_drv
.subnet_delete(subnet_id
)
472 def neutron_subnetpool_list(self
):
473 return self
.neutron_drv
.subnetpool_list()
475 def netruon_subnetpool_by_name(self
, pool_name
):
476 pool_list
= self
.neutron_drv
.subnetpool_list(**{'name': pool_name
})
482 def neutron_port_list(self
, **kwargs
):
483 return self
.neutron_drv
.port_list(**kwargs
)
485 def neutron_port_get(self
, port_id
):
486 return self
.neutron_drv
.port_get(port_id
)
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
)
494 def neutron_multi_port_create(self
, ports
):
495 return self
.neutron_drv
.port_create(ports
)
497 def neutron_security_group_list(self
):
498 return self
.neutron_drv
.security_group_list(**{})
500 def neutron_security_group_by_name(self
, group_name
):
501 group_list
= self
.neutron_drv
.security_group_list(**{'name': group_name
})
507 def neutron_port_delete(self
, port_id
):
508 self
.neutron_drv
.port_delete(port_id
)
510 def ceilo_meter_endpoint(self
):
511 return self
.ceilo_drv
.endpoint
513 def ceilo_meter_list(self
):
514 return self
.ceilo_drv
.meters
516 def ceilo_nfvi_metrics(self
, vim_id
):
517 """Returns a dict of NFVI metrics for a given VM
520 vim_id - the VIM ID of the VM to retrieve the metrics for
523 A dict of NFVI metrics
526 return self
.ceilo_drv
.nfvi_metrics(vim_id
)
528 def ceilo_alarm_list(self
):
529 """Returns a list of ceilometer alarms"""
530 return self
.ceilo_drv
.client
.alarms
.list()
532 def ceilo_alarm_create(self
,
545 """Create a new Alarm
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
557 period - the duration (seconds) over which to evaluate the
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
573 kwargs - an arbitrary dict of keyword arguments that are
574 passed to the ceilometer client
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
581 return self
.ceilo_drv
.client
.alarms
.create(name
=name
,
584 comparison_operator
=operation
,
587 evaluation_periods
=evaluations
,
589 repeat_actions
=repeat
,
591 ok_actions
=ok_actions
,
592 alarm_actions
=alarm_actions
,
593 insufficient_data_actions
=insufficient_data_actions
,
596 def ceilo_alarm_update(self
, alarm_id
, **kwargs
):
597 """Updates an existing alarm
600 alarm_id - the identifier of the alarm to update
601 kwargs - a dict of the alarm attributes to update
604 return self
.ceilo_drv
.client
.alarms
.update(alarm_id
, **kwargs
)
606 def ceilo_alarm_delete(self
, alarm_id
):
607 self
.ceilo_drv
.client
.alarms
.delete(alarm_id
)
609 def cinder_volume_list(self
):
610 return self
.cinder_drv
.volume_list()
612 def cinder_volume_get(self
, vol_id
):
613 return self
.cinder_drv
.volume_get(vol_id
)
615 def cinder_volume_set_metadata(self
, volumeid
, metadata
):
616 return self
.cinder_drv
.volume_set_metadata(volumeid
, metadata
)
618 def cinder_volume_delete_metadata(self
, volumeid
, metadata
):
619 return self
.cinder_drv
.volume_delete_metadata(volumeid
, metadata
)