openstack/cinder
Code Issues Proposed changes

Merge "Update docstrings for migration routines"

Browse Source
This commit is contained in:
Zuul 2024-08-08 18:13:56 +00:00 committed by Gerrit Code Review
commit 19d1499471
2 changed files with 111 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

72
cinder/interface/volume_driver.py
View File

@ -326,6 +326,32 @@ class VolumeDriverCore(base.CinderInterface):
:returns: Model updates.
"""
def before_volume_copy(self, context, src_vol, dest_vol, remote=None):
"""Driver-specific actions executed before copying a volume.
This method will be called before _copy_volume_data during volume
migration.
:param context: Context
:param src_volume: Source volume in the copy operation.
:param dest_volume: Destination volume in the copy operation.
:param remote: Whether the copy operation is local.
:returns: There is no return value for this method.
"""
def after_volume_copy(self, context, src_vol, dest_vol, remote=None):
"""Driver-specific actions executed after copying a volume.
This method will be called after _copy_volume_data during volume
migration.
:param context: Context
:param src_volume: Source volume in the copy operation.
:param dest_volume: Destination volume in the copy operation.
:param remote: Whether the copy operation is local.
:returns: There is no return value for this method.
"""
def extend_volume(self, volume, new_size):
"""Extend the size of a volume.
@ -336,6 +362,52 @@ class VolumeDriverCore(base.CinderInterface):
volume, the driver should report online_extend_support=False.
"""
def migrate_volume(self, context, volume, host):
"""Migrate the volume to the specified host.
:param context: Context
:param volume: A dictionary describing the volume to migrate
:param host: A dictionary describing the host to migrate to, where
host['host'] is its name, and host['capabilities'] is a
dictionary of its reported capabilities.
:returns: Tuple of (model_update, boolean) where the boolean specifies
whether the migration occurred.
"""
def update_migrated_volume(self, context, volume, new_volume,
original_volume_status):
"""Return model update for migrated volume.
Each driver implementing this method needs to be responsible for the
values of _name_id and provider_location. If None is returned or either
key is not set, it means the volume table does not need to change the
value(s) for the key(s).
The return format is {"_name_id": value, "provider_location": value}.
:param context: Context
:param volume: The original volume that was migrated to this backend
:param new_volume: The migration volume object that was created on
this backend as part of the migration process
:param original_volume_status: The status of the original volume
:returns: model_update to update DB with any needed changes
"""
def retype(self, context, volume, new_type, diff, host):
"""Change the type of a volume.
This operation occurs on the same backend and the return value
indicates whether it was successful. If migration is required
to satisfy a retype, that will be handled by the volume manager.
:param context: Context
:param volume: The volume to retype
:param new_type: The target type for the volume
:param diff: The differences between the two types
:param host: The host that contains this volume
:returns: Tuple of (boolean, model_update) where the boolean specifies
whether the retype occurred.
"""
def create_snapshot(self, snapshot):
"""Creates a snapshot.

67
cinder/volume/driver.py
View File

@ -952,18 +952,20 @@ class BaseVD(object, metaclass=abc.ABCMeta):
force=True, ignore_errors=True)
def before_volume_copy(self, context, src_vol, dest_vol, remote=None):
"""Driver-specific actions before copyvolume data.
"""Driver-specific actions executed before copying a volume.
This method will be called before _copy_volume_data during volume
migration
Refer to
:obj:`cinder.interface.volume_driver.VolumeDriverCore.before_volume_copy`
for additional information.
"""
pass
def after_volume_copy(self, context, src_vol, dest_vol, remote=None):
"""Driver-specific actions after copyvolume data.
"""Driver-specific actions executed after copying a volume.
This method will be called after _copy_volume_data during volume
migration
Refer to
:obj:`cinder.interface.volume_driver.VolumeDriverCore.after_volume_copy`
for additional information.
"""
pass
@ -1410,17 +1412,9 @@ class BaseVD(object, metaclass=abc.ABCMeta):
original_volume_status):
"""Return model update for migrated volume.
Each driver implementing this method needs to be responsible for the
values of _name_id and provider_location. If None is returned or either
key is not set, it means the volume table does not need to change the
value(s) for the key(s).
The return format is {"_name_id": value, "provider_location": value}.
:param volume: The original volume that was migrated to this backend
:param new_volume: The migration volume object that was created on
this backend as part of the migration process
:param original_volume_status: The status of the original volume
:returns: model_update to update DB with any needed changes
Refer to
:obj:`cinder.interface.volume_driver.VolumeDriverCore.update_migrated_volume`
for additional information.
"""
msg = _("The method update_migrated_volume is not implemented.")
raise NotImplementedError(msg)
@ -1430,6 +1424,12 @@ class BaseVD(object, metaclass=abc.ABCMeta):
pass
def retype(self, context, volume, new_type, diff, host):
"""Change the type of a volume.
Refer to
:obj:`cinder.interface.volume_driver.VolumeDriverCore.retype`
for additional information.
"""
return False, None
def create_cloned_volume(self, volume, src_vref):
@ -1545,10 +1545,14 @@ class BaseVD(object, metaclass=abc.ABCMeta):
return None, None
def migrate_volume(self, context, volume, host):
"""Migrate volume stub.
"""Migrate the volume to the specified host.
This is for drivers that don't implement an enhanced version
of this operation.
This is a stub for drivers that don't implement an enhanced
version of this operation.
Refer to
:obj:`cinder.interface.volume_driver.VolumeDriverCore.migrate_volume`
for additional information.
"""
return (False, None)
@ -2025,14 +2029,9 @@ class MigrateVD(object, metaclass=abc.ABCMeta):
def migrate_volume(self, context, volume, host):
"""Migrate the volume to the specified host.
Returns a boolean indicating whether the migration occurred, as well as
model_update.
:param context: Context
:param volume: A dictionary describing the volume to migrate
:param host: A dictionary describing the host to migrate to, where
host['host'] is its name, and host['capabilities'] is a
dictionary of its reported capabilities.
Refer to
:obj:`cinder.interface.volume_driver.VolumeDriverCore.migrate_volume`
for additional information.
"""
return (False, None)
@ -2315,6 +2314,12 @@ class VolumeDriver(ManageableVD, CloneableImageVD, ManageableSnapshotsVD,
"""Unmanage the specified snapshot from Cinder management."""
def retype(self, context, volume, new_type, diff, host):
"""Change the type of a volume.
Refer to
:obj:`cinder.interface.volume_driver.VolumeDriverCore.retype`
for additional information.
"""
return False, None
# ####### Interface methods for DataPath (Connector) ########
@ -2581,6 +2586,12 @@ class VolumeDriver(ManageableVD, CloneableImageVD, ManageableSnapshotsVD,
return None
def migrate_volume(self, context, volume, host):
"""Migrate the volume to the specified host.
Refer to
:obj:`cinder.interface.volume_driver.VolumeDriverCore.migrate_volume`
for additional information.
"""
return (False, None)
def accept_transfer(self, context, volume, new_user, new_project):