cc8dd55264
Implements support for the volume backup api added to cinder in https://review.openstack.org/19468. This is a resubmit of the expired change https://review.openstack.org/25299 with the following changes: * Added unit tests for backups (v1 and v2) * Changed references in backup code to display_name and display_description to name and description respectively * Removed links from backup-show output * Added object_count to _translate_backup_keys * Removed unneccesary items from _translate_backup_keys * Fixed backups docstrings including removing references to swift. Adds backup-create, backup-delete, backup-list, backup-restore and backup-show to both the v1 and v2 clients, since the volume backup extension is available via both APIs. Change-Id: I197384f1c2fd2af641d207a5f4dba0dfbc5c681a
83 lines
3.0 KiB
Python
83 lines
3.0 KiB
Python
from cinderclient import client
|
|
from cinderclient.v2 import limits
|
|
from cinderclient.v2 import quota_classes
|
|
from cinderclient.v2 import quotas
|
|
from cinderclient.v2 import volumes
|
|
from cinderclient.v2 import volume_snapshots
|
|
from cinderclient.v2 import volume_types
|
|
from cinderclient.v2 import volume_backups
|
|
from cinderclient.v2 import volume_backups_restore
|
|
|
|
|
|
class Client(object):
|
|
"""Top-level object to access the OpenStack Volume API.
|
|
|
|
Create an instance with your creds::
|
|
|
|
>>> client = Client(USERNAME, PASSWORD, PROJECT_ID, AUTH_URL)
|
|
|
|
Then call methods on its managers::
|
|
|
|
>>> client.volumes.list()
|
|
...
|
|
"""
|
|
|
|
def __init__(self, username, api_key, project_id=None, auth_url='',
|
|
insecure=False, timeout=None, tenant_id=None,
|
|
proxy_tenant_id=None, proxy_token=None, region_name=None,
|
|
endpoint_type='publicURL', extensions=None,
|
|
service_type='volume', service_name=None,
|
|
volume_service_name=None, retries=None,
|
|
http_log_debug=False,
|
|
cacert=None):
|
|
# FIXME(comstud): Rename the api_key argument above when we
|
|
# know it's not being used as keyword argument
|
|
password = api_key
|
|
self.limits = limits.LimitsManager(self)
|
|
|
|
# extensions
|
|
self.volumes = volumes.VolumeManager(self)
|
|
self.volume_snapshots = volume_snapshots.SnapshotManager(self)
|
|
self.volume_types = volume_types.VolumeTypeManager(self)
|
|
self.quota_classes = quota_classes.QuotaClassSetManager(self)
|
|
self.quotas = quotas.QuotaSetManager(self)
|
|
self.backups = volume_backups.VolumeBackupManager(self)
|
|
self.restores = volume_backups_restore.VolumeBackupRestoreManager(self)
|
|
|
|
# Add in any extensions...
|
|
if extensions:
|
|
for extension in extensions:
|
|
if extension.manager_class:
|
|
setattr(self, extension.name,
|
|
extension.manager_class(self))
|
|
|
|
self.client = client.HTTPClient(
|
|
username,
|
|
password,
|
|
project_id,
|
|
auth_url,
|
|
insecure=insecure,
|
|
timeout=timeout,
|
|
tenant_id=tenant_id,
|
|
proxy_token=proxy_token,
|
|
proxy_tenant_id=proxy_tenant_id,
|
|
region_name=region_name,
|
|
endpoint_type=endpoint_type,
|
|
service_type=service_type,
|
|
service_name=service_name,
|
|
volume_service_name=volume_service_name,
|
|
retries=retries,
|
|
http_log_debug=http_log_debug,
|
|
cacert=cacert)
|
|
|
|
def authenticate(self):
|
|
"""Authenticate against the server.
|
|
|
|
Normally this is called automatically when you first access the API,
|
|
but you can call this method to force authentication right now.
|
|
|
|
Returns on success; raises :exc:`exceptions.Unauthorized` if the
|
|
credentials are wrong.
|
|
"""
|
|
self.client.authenticate()
|