openstack/python-openstackclient
Code Issues Proposed changes

Merge "trivial: Cleanup docs for 'server rebuild'"

Browse Source
This commit is contained in:
Zuul 2020-12-05 21:27:53 +00:00 committed by Gerrit Code Review
commit fe98069c20
1 changed files with 52 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

81
openstackclient/compute/v2/server.py
View File

@ -2440,47 +2440,57 @@ class RebuildServer(command.ShowOne):
parser.add_argument( parser.add_argument(
'--image', '--image',
metavar='<image>', metavar='<image>',
help=_('Recreate server from the specified image (name or ID).' help=_(
' Defaults to the currently used one.'), 'Recreate server from the specified image (name or ID).'
'Defaults to the currently used one.'
),
) )
parser.add_argument( parser.add_argument(
'--password', '--password',
metavar='<password>', metavar='<password>',
help=_("Set the password on the rebuilt instance"), help=_('Set a password on the rebuilt server'),
) )
parser.add_argument( parser.add_argument(
'--property', '--property',
metavar='<key=value>', metavar='<key=value>',
action=parseractions.KeyValueAction, action=parseractions.KeyValueAction,
help=_('Set a property on the rebuilt instance ' help=_(
'(repeat option to set multiple values)'), 'Set a new property on the rebuilt server '
'(repeat option to set multiple values)'
),
) )
parser.add_argument( parser.add_argument(
'--description', '--description',
metavar='<description>', metavar='<description>',
help=_('New description for the server (supported by ' help=_(
'--os-compute-api-version 2.19 or above'), 'Set a new description on the rebuilt server '
) '(supported by --os-compute-api-version 2.19 or above)'
parser.add_argument( ),
'--wait',
action='store_true',
help=_('Wait for rebuild to complete'),
) )
key_group = parser.add_mutually_exclusive_group() key_group = parser.add_mutually_exclusive_group()
key_group.add_argument( key_group.add_argument(
'--key-name', '--key-name',
metavar='<key-name>', metavar='<key-name>',
help=_("Set the key name of key pair on the rebuilt instance." help=_(
" Cannot be specified with the '--key-unset' option." 'Set the key name of key pair on the rebuilt server. '
" (Supported by API versions '2.54' - '2.latest')"), 'Cannot be specified with the --key-unset option. '
'(supported by --os-compute-api-version 2.54 or above)'
),
) )
key_group.add_argument( key_group.add_argument(
'--key-unset', '--key-unset',
action='store_true', action='store_true',
default=False, default=False,
help=_("Unset the key name of key pair on the rebuilt instance." help=_(
" Cannot be specified with the '--key-name' option." 'Unset the key name of key pair on the rebuilt server. '
" (Supported by API versions '2.54' - '2.latest')"), 'Cannot be specified with the --key-name option. '
'(supported by --os-compute-api-version 2.54 or above)'
),
)
parser.add_argument(
'--wait',
action='store_true',
help=_('Wait for rebuild to complete'),
) )
return parser return parser
@ -2506,24 +2516,38 @@ class RebuildServer(command.ShowOne):
image = image_client.get_image(image_id) image = image_client.get_image(image_id)
kwargs = {} kwargs = {}
if parsed_args.property: if parsed_args.property:
kwargs['meta'] = parsed_args.property kwargs['meta'] = parsed_args.property
if parsed_args.description: if parsed_args.description:
if server.api_version < api_versions.APIVersion("2.19"): if server.api_version < api_versions.APIVersion("2.19"):
msg = _("Description is not supported for " msg = _(
"--os-compute-api-version less than 2.19") '--os-compute-api-version 2.19 or greater is required to '
'support the --description option'
)
raise exceptions.CommandError(msg) raise exceptions.CommandError(msg)
kwargs['description'] = parsed_args.description kwargs['description'] = parsed_args.description
if parsed_args.key_name or parsed_args.key_unset: if parsed_args.key_name:
if compute_client.api_version < api_versions.APIVersion('2.54'): if compute_client.api_version < api_versions.APIVersion('2.54'):
msg = _('--os-compute-api-version 2.54 or later is required') msg = _(
'--os-compute-api-version 2.54 or greater is required to '
'support the --key-name option'
)
raise exceptions.CommandError(msg) raise exceptions.CommandError(msg)
if parsed_args.key_unset:
kwargs['key_name'] = None
if parsed_args.key_name:
kwargs['key_name'] = parsed_args.key_name kwargs['key_name'] = parsed_args.key_name
elif parsed_args.key_unset:
if compute_client.api_version < api_versions.APIVersion('2.54'):
msg = _(
'--os-compute-api-version 2.54 or greater is required to '
'support the --no-key-name option'
)
raise exceptions.CommandError(msg)
kwargs['key_name'] = None
server = server.rebuild(image, parsed_args.password, **kwargs) server = server.rebuild(image, parsed_args.password, **kwargs)
if parsed_args.wait: if parsed_args.wait:
@ -2534,13 +2558,12 @@ class RebuildServer(command.ShowOne):
): ):
self.app.stdout.write(_('Complete\n')) self.app.stdout.write(_('Complete\n'))
else: else:
LOG.error(_('Error rebuilding server: %s'), LOG.error(_('Error rebuilding server: %s'), server.id)
server.id)
self.app.stdout.write(_('Error rebuilding server\n')) self.app.stdout.write(_('Error rebuilding server\n'))
raise SystemExit raise SystemExit
details = _prep_server_detail(compute_client, image_client, server, details = _prep_server_detail(
refresh=False) compute_client, image_client, server, refresh=False)
return zip(*sorted(details.items())) return zip(*sorted(details.items()))