109415c26d
This modification adds support for volume type encryption to python-cinderclient, supporting two Cinder API extensions. The first support set provides accessors to python-cinderclient for retrieving volume encryption metadata from Cinder. These changes provide other services (e.g., Nova) access to encryption metadata (e.g., encryption key UUIDs). See the volume encryption key API extension in Cinder for more information. The second support set creates a new python-cinderclient resource manager, along with matching shell commands, that provides creation and accessor operations for encryption type information. These operations allow users and services to define encryption information (e.g., cipher, key size, encryption provider) for a pre-existing volume type. See the volume type encryption API extension in Cinder for more information. blueprint encrypt-cinder-volumes Change-Id: Id4b2425d699678eb1997863362ddb9bf5ba6f033
346 lines
12 KiB
Python
346 lines
12 KiB
Python
# Copyright 2013 OpenStack LLC.
|
|
# All Rights Reserved.
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License"); you may
|
|
# not use this file except in compliance with the License. You may obtain
|
|
# a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
# License for the specific language governing permissions and limitations
|
|
# under the License.
|
|
|
|
"""Volume interface (v2 extension)."""
|
|
|
|
import six
|
|
try:
|
|
from urllib import urlencode
|
|
except ImportError:
|
|
from urllib.parse import urlencode
|
|
|
|
from cinderclient import base
|
|
|
|
|
|
class Volume(base.Resource):
|
|
"""A volume is an extra block level storage to the OpenStack instances."""
|
|
def __repr__(self):
|
|
return "<Volume: %s>" % self.id
|
|
|
|
def delete(self):
|
|
"""Delete this volume."""
|
|
self.manager.delete(self)
|
|
|
|
def update(self, **kwargs):
|
|
"""Update the name or description for this volume."""
|
|
self.manager.update(self, **kwargs)
|
|
|
|
def attach(self, instance_uuid, mountpoint):
|
|
"""Set attachment metadata.
|
|
|
|
:param instance_uuid: uuid of the attaching instance.
|
|
:param mountpoint: mountpoint on the attaching instance.
|
|
"""
|
|
return self.manager.attach(self, instance_uuid, mountpoint)
|
|
|
|
def detach(self):
|
|
"""Clear attachment metadata."""
|
|
return self.manager.detach(self)
|
|
|
|
def reserve(self, volume):
|
|
"""Reserve this volume."""
|
|
return self.manager.reserve(self)
|
|
|
|
def unreserve(self, volume):
|
|
"""Unreserve this volume."""
|
|
return self.manager.unreserve(self)
|
|
|
|
def begin_detaching(self, volume):
|
|
"""Begin detaching volume."""
|
|
return self.manager.begin_detaching(self)
|
|
|
|
def roll_detaching(self, volume):
|
|
"""Roll detaching volume."""
|
|
return self.manager.roll_detaching(self)
|
|
|
|
def initialize_connection(self, volume, connector):
|
|
"""Initialize a volume connection.
|
|
|
|
:param connector: connector dict from nova.
|
|
"""
|
|
return self.manager.initialize_connection(self, connector)
|
|
|
|
def terminate_connection(self, volume, connector):
|
|
"""Terminate a volume connection.
|
|
|
|
:param connector: connector dict from nova.
|
|
"""
|
|
return self.manager.terminate_connection(self, connector)
|
|
|
|
def set_metadata(self, volume, metadata):
|
|
"""Set or Append metadata to a volume.
|
|
|
|
:param type : The :class: `Volume` to set metadata on
|
|
:param metadata: A dict of key/value pairs to set
|
|
"""
|
|
return self.manager.set_metadata(self, metadata)
|
|
|
|
def upload_to_image(self, force, image_name, container_format,
|
|
disk_format):
|
|
"""Upload a volume to image service as an image."""
|
|
return self.manager.upload_to_image(self, force, image_name,
|
|
container_format, disk_format)
|
|
|
|
def force_delete(self):
|
|
"""Delete the specified volume ignoring its current state.
|
|
|
|
:param volume: The UUID of the volume to force-delete.
|
|
"""
|
|
self.manager.force_delete(self)
|
|
|
|
def reset_state(self, state):
|
|
"""Update the volume with the provided state."""
|
|
self.manager.reset_state(self, state)
|
|
|
|
def extend(self, volume, new_size):
|
|
"""Extend the size of the specified volume.
|
|
:param volume: The UUID of the volume to extend
|
|
:param new_size: The desired size to extend volume to.
|
|
"""
|
|
|
|
self.manager.extend(self, volume, new_size)
|
|
|
|
|
|
class VolumeManager(base.ManagerWithFind):
|
|
"""Manage :class:`Volume` resources."""
|
|
resource_class = Volume
|
|
|
|
def create(self, size, snapshot_id=None, source_volid=None,
|
|
name=None, description=None,
|
|
volume_type=None, user_id=None,
|
|
project_id=None, availability_zone=None,
|
|
metadata=None, imageRef=None, scheduler_hints=None):
|
|
"""Create a volume.
|
|
|
|
:param size: Size of volume in GB
|
|
:param snapshot_id: ID of the snapshot
|
|
:param name: Name of the volume
|
|
:param description: Description of the volume
|
|
:param volume_type: Type of volume
|
|
:param user_id: User id derived from context
|
|
:param project_id: Project id derived from context
|
|
:param availability_zone: Availability Zone to use
|
|
:param metadata: Optional metadata to set on volume creation
|
|
:param imageRef: reference to an image stored in glance
|
|
:param source_volid: ID of source volume to clone from
|
|
:param scheduler_hints: (optional extension) arbitrary key-value pairs
|
|
specified by the client to help boot an instance
|
|
:rtype: :class:`Volume`
|
|
"""
|
|
|
|
if metadata is None:
|
|
volume_metadata = {}
|
|
else:
|
|
volume_metadata = metadata
|
|
|
|
body = {'volume': {'size': size,
|
|
'snapshot_id': snapshot_id,
|
|
'name': name,
|
|
'description': description,
|
|
'volume_type': volume_type,
|
|
'user_id': user_id,
|
|
'project_id': project_id,
|
|
'availability_zone': availability_zone,
|
|
'status': "creating",
|
|
'attach_status': "detached",
|
|
'metadata': volume_metadata,
|
|
'imageRef': imageRef,
|
|
'source_volid': source_volid,
|
|
'scheduler_hints': scheduler_hints,
|
|
}}
|
|
return self._create('/volumes', body, 'volume')
|
|
|
|
def get(self, volume_id):
|
|
"""Get a volume.
|
|
|
|
:param volume_id: The ID of the volume to delete.
|
|
:rtype: :class:`Volume`
|
|
"""
|
|
return self._get("/volumes/%s" % volume_id, "volume")
|
|
|
|
def list(self, detailed=True, search_opts=None):
|
|
"""Get a list of all volumes.
|
|
|
|
:rtype: list of :class:`Volume`
|
|
"""
|
|
if search_opts is None:
|
|
search_opts = {}
|
|
|
|
qparams = {}
|
|
|
|
for opt, val in six.iteritems(search_opts):
|
|
if val:
|
|
qparams[opt] = val
|
|
|
|
query_string = "?%s" % urlencode(qparams) if qparams else ""
|
|
|
|
detail = ""
|
|
if detailed:
|
|
detail = "/detail"
|
|
|
|
return self._list("/volumes%s%s" % (detail, query_string),
|
|
"volumes")
|
|
|
|
def delete(self, volume):
|
|
"""Delete a volume.
|
|
|
|
:param volume: The :class:`Volume` to delete.
|
|
"""
|
|
self._delete("/volumes/%s" % base.getid(volume))
|
|
|
|
def update(self, volume, **kwargs):
|
|
"""Update the name or description for a volume.
|
|
|
|
:param volume: The :class:`Volume` to delete.
|
|
"""
|
|
if not kwargs:
|
|
return
|
|
|
|
body = {"volume": kwargs}
|
|
|
|
self._update("/volumes/%s" % base.getid(volume), body)
|
|
|
|
def _action(self, action, volume, info=None, **kwargs):
|
|
"""Perform a volume "action."
|
|
"""
|
|
body = {action: info}
|
|
self.run_hooks('modify_body_for_action', body, **kwargs)
|
|
url = '/volumes/%s/action' % base.getid(volume)
|
|
return self.api.client.post(url, body=body)
|
|
|
|
def attach(self, volume, instance_uuid, mountpoint):
|
|
"""Set attachment metadata.
|
|
|
|
:param volume: The :class:`Volume` (or its ID)
|
|
you would like to attach.
|
|
:param instance_uuid: uuid of the attaching instance.
|
|
:param mountpoint: mountpoint on the attaching instance.
|
|
"""
|
|
return self._action('os-attach',
|
|
volume,
|
|
{'instance_uuid': instance_uuid,
|
|
'mountpoint': mountpoint})
|
|
|
|
def detach(self, volume):
|
|
"""Clear attachment metadata.
|
|
|
|
:param volume: The :class:`Volume` (or its ID)
|
|
you would like to detach.
|
|
"""
|
|
return self._action('os-detach', volume)
|
|
|
|
def reserve(self, volume):
|
|
"""Reserve this volume.
|
|
|
|
:param volume: The :class:`Volume` (or its ID)
|
|
you would like to reserve.
|
|
"""
|
|
return self._action('os-reserve', volume)
|
|
|
|
def unreserve(self, volume):
|
|
"""Unreserve this volume.
|
|
|
|
:param volume: The :class:`Volume` (or its ID)
|
|
you would like to unreserve.
|
|
"""
|
|
return self._action('os-unreserve', volume)
|
|
|
|
def begin_detaching(self, volume):
|
|
"""Begin detaching this volume.
|
|
|
|
:param volume: The :class:`Volume` (or its ID)
|
|
you would like to detach.
|
|
"""
|
|
return self._action('os-begin_detaching', volume)
|
|
|
|
def roll_detaching(self, volume):
|
|
"""Roll detaching this volume.
|
|
|
|
:param volume: The :class:`Volume` (or its ID)
|
|
you would like to roll detaching.
|
|
"""
|
|
return self._action('os-roll_detaching', volume)
|
|
|
|
def initialize_connection(self, volume, connector):
|
|
"""Initialize a volume connection.
|
|
|
|
:param volume: The :class:`Volume` (or its ID).
|
|
:param connector: connector dict from nova.
|
|
"""
|
|
return self._action('os-initialize_connection', volume,
|
|
{'connector': connector})[1]['connection_info']
|
|
|
|
def terminate_connection(self, volume, connector):
|
|
"""Terminate a volume connection.
|
|
|
|
:param volume: The :class:`Volume` (or its ID).
|
|
:param connector: connector dict from nova.
|
|
"""
|
|
self._action('os-terminate_connection', volume,
|
|
{'connector': connector})
|
|
|
|
def set_metadata(self, volume, metadata):
|
|
"""Update/Set a volumes metadata.
|
|
|
|
:param volume: The :class:`Volume`.
|
|
:param metadata: A list of keys to be set.
|
|
"""
|
|
body = {'metadata': metadata}
|
|
return self._create("/volumes/%s/metadata" % base.getid(volume),
|
|
body, "metadata")
|
|
|
|
def delete_metadata(self, volume, keys):
|
|
"""Delete specified keys from volumes metadata.
|
|
|
|
:param volume: The :class:`Volume`.
|
|
:param metadata: A list of keys to be removed.
|
|
"""
|
|
for k in keys:
|
|
self._delete("/volumes/%s/metadata/%s" % (base.getid(volume), k))
|
|
|
|
def upload_to_image(self, volume, force, image_name, container_format,
|
|
disk_format):
|
|
"""Upload volume to image service as image.
|
|
|
|
:param volume: The :class:`Volume` to upload.
|
|
"""
|
|
return self._action('os-volume_upload_image',
|
|
volume,
|
|
{'force': force,
|
|
'image_name': image_name,
|
|
'container_format': container_format,
|
|
'disk_format': disk_format})
|
|
|
|
def force_delete(self, volume):
|
|
return self._action('os-force_delete', base.getid(volume))
|
|
|
|
def reset_state(self, volume, state):
|
|
"""Update the provided volume with the provided state."""
|
|
return self._action('os-reset_status', volume, {'status': state})
|
|
|
|
def extend(self, volume, new_size):
|
|
return self._action('os-extend',
|
|
base.getid(volume),
|
|
{'new_size': new_size})
|
|
|
|
def get_encryption_metadata(self, volume_id):
|
|
"""
|
|
Retrieve the encryption metadata from the desired volume.
|
|
|
|
:param volume_id: the id of the volume to query
|
|
:return: a dictionary of volume encryption metadata
|
|
"""
|
|
return self._get("/volumes/%s/encryption" % volume_id)._info
|