Clarify --migration-type migration value as cold migration

This is a follow up to a review discussion [1] where the
"migration" value for the --migration-type option is for
a cold migration. This change just updates docs and help
strings.

An alternative is changing "migration" as a valid value to
"cold-migration" (or accept both) and under the covers treat
"cold-migration" as "migration" for the actual API call.

[1] https://review.opendev.org/#/c/675117/3/novaclient/v2/shell.py@5430

Related to blueprint more-migration-list-filters

Change-Id: I6baa6af8731252e3c4976db06f0ca9cdfcb5e2f1
This commit is contained in:
Matt Riedemann 2019-08-26 11:26:18 -04:00
parent a19253f857
commit 96dcf13f46
3 changed files with 9 additions and 6 deletions

View File

@ -2593,6 +2593,9 @@ To see the list of evacuation operations *from* a compute service host:
* evacuation
* live-migration
* migration
.. note:: This is a cold migration.
* resize
``--source-compute <source_compute>``

View File

@ -61,7 +61,7 @@ class MigrationManager(base.ManagerWithFind):
:param status: filter migrations by status (optional).
:param instance_uuid: filter migrations by instance uuid (optional).
:param migration_type: Filter migrations by type. Valid values are:
evacuation, live-migration, migration, resize
evacuation, live-migration, migration (cold), resize
:param source_compute: Filter migrations by source compute host name.
"""
return self._list_base(host=host, status=status,
@ -89,7 +89,7 @@ class MigrationManager(base.ManagerWithFind):
to a certain point of time. The provided time should be an ISO 8061
formatted time. e.g. 2016-03-04T06:27:59Z . (optional).
:param migration_type: Filter migrations by type. Valid values are:
evacuation, live-migration, migration, resize
evacuation, live-migration, migration (cold), resize
:param source_compute: Filter migrations by source compute host name.
"""
return self._list_base(host=host, status=status,
@ -122,7 +122,7 @@ class MigrationManager(base.ManagerWithFind):
equal to a certain point of time. The provided time should be an ISO
8061 formatted time. e.g. 2016-03-05T06:27:59Z . (optional).
:param migration_type: Filter migrations by type. Valid values are:
evacuation, live-migration, migration, resize
evacuation, live-migration, migration (cold), resize
:param source_compute: Filter migrations by source compute host name.
"""
return self._list_base(host=host, status=status,

View File

@ -5427,7 +5427,7 @@ def _print_migrations(cs, migrations):
dest='migration_type',
metavar='<migration_type>',
help=_('Filter migrations by type. Valid values are: evacuation, '
'live-migration, migration, resize'))
'live-migration, migration (cold), resize'))
@utils.arg(
'--source-compute',
dest='source_compute',
@ -5463,7 +5463,7 @@ def do_migration_list(cs, args):
dest='migration_type',
metavar='<migration_type>',
help=_('Filter migrations by type. Valid values are: evacuation, '
'live-migration, migration, resize'))
'live-migration, migration (cold), resize'))
@utils.arg(
'--source-compute',
dest='source_compute',
@ -5535,7 +5535,7 @@ def do_migration_list(cs, args):
dest='migration_type',
metavar='<migration_type>',
help=_('Filter migrations by type. Valid values are: evacuation, '
'live-migration, migration, resize'))
'live-migration, migration (cold), resize'))
@utils.arg(
'--source-compute',
dest='source_compute',