openstack/python-openstackclient
Code Issues Proposed changes

Update container format choices

Browse Source 
The choices for valid container formats is out of date in the
image v1 and v2 help text.  This patch adds 'ova' and 'docker'
and does some minor refactoring to align the container_format
option with the disk_format option.

Change-Id: Icdea5fab801abd651baf45cf96c920c7df79f11b
Closes-bug: #1658138
This commit is contained in:
Brian Rosmaita 2017-01-20 23:15:12 +00:00 committed by Steve Martinelli
parent 64c509cf76
commit 80c62021c8
3 changed files with 24 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/source/command-objects/image.rst
View File

@ -76,7 +76,8 @@ Create/upload an image
.. option:: --container-format <container-format> .. option:: --container-format <container-format>
Image container format (default: bare) Image container format. The supported options are: ami, ari, aki,
bare, docker, ova, ovf. The default format is: bare
.. option:: --disk-format <disk-format> .. option:: --disk-format <disk-format>
@ -342,7 +343,8 @@ Set image properties
.. option:: --container-format <container-format> .. option:: --container-format <container-format>
Image container format (default: bare) Image container format. The supported options are: ami, ari, aki,
bare, docker, ova, ovf.
.. option:: --disk-format <disk-format> .. option:: --disk-format <disk-format>

16
openstackclient/image/v1/image.py
View File

@ -36,6 +36,7 @@ from openstackclient.api import utils as api_utils
from openstackclient.i18n import _ from openstackclient.i18n import _
CONTAINER_CHOICES = ["ami", "ari", "aki", "bare", "docker", "ova", "ovf"]
DEFAULT_CONTAINER_FORMAT = 'bare' DEFAULT_CONTAINER_FORMAT = 'bare'
DEFAULT_DISK_FORMAT = 'raw' DEFAULT_DISK_FORMAT = 'raw'
DISK_CHOICES = ["ami", "ari", "aki", "vhd", "vmdk", "raw", "qcow2", "vhdx", DISK_CHOICES = ["ami", "ari", "aki", "vhd", "vmdk", "raw", "qcow2", "vhdx",
@ -84,8 +85,12 @@ class CreateImage(command.ShowOne):
"--container-format", "--container-format",
default=DEFAULT_CONTAINER_FORMAT, default=DEFAULT_CONTAINER_FORMAT,
metavar="<container-format>", metavar="<container-format>",
help=_("Image container format " choices=CONTAINER_CHOICES,
"(default: %s)") % DEFAULT_CONTAINER_FORMAT, help=(_("Image container format. "
"The supported options are: %(option_list)s. "
"The default format is: %(default_opt)s") %
{'option_list': ', '.join(CONTAINER_CHOICES),
'default_opt': DEFAULT_CONTAINER_FORMAT})
) )
parser.add_argument( parser.add_argument(
"--disk-format", "--disk-format",
@ -498,13 +503,12 @@ class SetImage(command.Command):
type=int, type=int,
help=_("Minimum RAM size needed to boot image, in megabytes"), help=_("Minimum RAM size needed to boot image, in megabytes"),
) )
container_choices = ["ami", "ari", "aki", "bare", "ovf"]
parser.add_argument( parser.add_argument(
"--container-format", "--container-format",
metavar="<container-format>", metavar="<container-format>",
help=_("Container format of image. Acceptable formats: %s") % choices=CONTAINER_CHOICES,
container_choices, help=_("Image container format. The supported options are: %s") %
choices=container_choices ', '.join(CONTAINER_CHOICES)
) )
parser.add_argument( parser.add_argument(
"--disk-format", "--disk-format",

14
openstackclient/image/v2/image.py
View File

@ -30,6 +30,7 @@ from openstackclient.i18n import _
from openstackclient.identity import common from openstackclient.identity import common
CONTAINER_CHOICES = ["ami", "ari", "aki", "bare", "docker", "ova", "ovf"]
DEFAULT_CONTAINER_FORMAT = 'bare' DEFAULT_CONTAINER_FORMAT = 'bare'
DEFAULT_DISK_FORMAT = 'raw' DEFAULT_DISK_FORMAT = 'raw'
DISK_CHOICES = ["ami", "ari", "aki", "vhd", "vmdk", "raw", "qcow2", "vhdx", DISK_CHOICES = ["ami", "ari", "aki", "vhd", "vmdk", "raw", "qcow2", "vhdx",
@ -135,9 +136,13 @@ class CreateImage(command.ShowOne):
parser.add_argument( parser.add_argument(
"--container-format", "--container-format",
default=DEFAULT_CONTAINER_FORMAT, default=DEFAULT_CONTAINER_FORMAT,
choices=CONTAINER_CHOICES,
metavar="<container-format>", metavar="<container-format>",
help=_("Image container format " help=(_("Image container format. "
"(default: %s)") % DEFAULT_CONTAINER_FORMAT, "The supported options are: %(option_list)s. "
"The default format is: %(default_opt)s") %
{'option_list': ', '.join(CONTAINER_CHOICES),
'default_opt': DEFAULT_CONTAINER_FORMAT})
) )
parser.add_argument( parser.add_argument(
"--disk-format", "--disk-format",
@ -659,8 +664,9 @@ class SetImage(command.Command):
parser.add_argument( parser.add_argument(
"--container-format", "--container-format",
metavar="<container-format>", metavar="<container-format>",
help=_("Image container format " choices=CONTAINER_CHOICES,
"(default: %s)") % DEFAULT_CONTAINER_FORMAT, help=_("Image container format. The supported options are: %s") %
', '.join(CONTAINER_CHOICES)
) )
parser.add_argument( parser.add_argument(
"--disk-format", "--disk-format",