openstack/python-openstackclient
Code Issues Proposed changes

Merge "volume: Deprecate '--retype-policy' in favor of '--migration-policy'"

Browse Source
This commit is contained in:
Zuul 2024-04-08 12:36:54 +00:00 committed by Gerrit Code Review
commit 9467b404c7
2 changed files with 33 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
openstackclient/volume/v2/volume.py
View File

@ -720,6 +720,12 @@ class SetVolume(command.Command):
'--retype-policy',
metavar='<retype-policy>',
choices=['never', 'on-demand'],
help=argparse.SUPPRESS,
)
parser.add_argument(
'--migration-policy',
metavar='<migration-policy>',
choices=['never', 'on-demand'],
help=_(
'Migration policy while re-typing volume '
'("never" or "on-demand", default is "never" ) '
@ -755,6 +761,15 @@ class SetVolume(command.Command):
volume = utils.find_resource(volume_client.volumes, parsed_args.volume)
result = 0
if parsed_args.retype_policy:
msg = _(
"The '--retype-policy' option has been deprecated in favor "
"of '--migration-policy' option. The '--retype-policy' option "
"will be removed in a future release. Please use "
"'--migration-policy' instead."
)
self.log.warning(msg)
if parsed_args.size:
try:
if parsed_args.size <= volume.size:
@ -848,11 +863,12 @@ class SetVolume(command.Command):
e,
)
result += 1
policy = parsed_args.migration_policy or parsed_args.retype_policy
if parsed_args.type:
# get the migration policy
migration_policy = 'never'
if parsed_args.retype_policy:
migration_policy = parsed_args.retype_policy
if policy:
migration_policy = policy
try:
# find the volume type
volume_type = utils.find_resource(
@ -865,12 +881,14 @@ class SetVolume(command.Command):
except Exception as e:
LOG.error(_("Failed to set volume type: %s"), e)
result += 1
elif parsed_args.retype_policy:
# If the "--retype-policy" is specified without "--type"
elif policy:
# If the "--migration-policy" is specified without "--type"
LOG.warning(
_(
"'--retype-policy' option will not work "
"without '--type' option"
_("'%s' option will not work without '--type' option")
% (
'--migration-policy'
if parsed_args.migration_policy
else '--retype-policy'
)
)

8
releasenotes/notes/rename-volume-set-retype-policy-6bacb7dd92f1ad82.yaml Normal file
View File

@ -0,0 +1,8 @@
---
upgrade:
- |
The ``volume set --retype-policy`` parameter has been renamed to
``--migration-policy`` to better convey the correct meaning of the options
usage. The migration policy determines whether we are going to perform the
migration in the retype opearation or not and is not related to the actual
retype which just changes the volume type of the volume.