Command docs: flavor

Change-Id: Ie85ff7706ef08b70ab8ba99533465d90904cf393
This commit is contained in:
Dean Troyer 2014-12-31 12:09:50 -06:00
parent e62ea50f7d
commit 0720c78199
3 changed files with 125 additions and 13 deletions

View File

@ -0,0 +1,105 @@
======
flavor
======
flavor create
-------------
Create new flavor
.. program:: flavor create
.. code:: bash
os flavor create
[--id <id>]
[--ram <size-mb>]
[--disk <size-gb>]
[--ephemeral-disk <size-gb>]
[--swap <size-mb>]
[--vcpus <num-cpu>]
[--rxtx-factor <factor>]
[--public | --private]
<flavor-name>
.. option:: --id <id>
Unique flavor ID; 'auto' creates a UUID (default: auto)
.. option:: --ram <size-mb>
Memory size in MB (default 256M)
.. option:: --disk <size-gb>
Disk size in GB (default 0G)
.. option:: --ephemeral-disk <size-gb>
Ephemeral disk size in GB (default 0G)
.. option:: --swap <size-gb>
Swap space size in GB (default 0G)
.. option:: --vcpus <num-cpu>
Number of vcpus (default 1)
.. option:: --rxtx-factor <factor>
RX/TX factor (default 1)
.. option:: --public
Flavor is available to other projects (default)
.. option:: --private
Flavor is not available to other projects
.. _flavor_create-flavor-name:
.. describe:: <flavor-name>
New flavor name
flavor delete
-------------
Delete a flavor
.. program:: flavor delete
.. code:: bash
os flavor delete
<flavor>
.. _flavor_delete-flavor:
.. describe:: <flavor>
Flavor to delete (name or ID)
flavor list
-----------
List flavors
.. program:: flavor list
.. code:: bash
os flavor list
flavor show
-----------
Display flavor details
.. program:: flavor show
.. code:: bash
os flavor show
<flavor>
.. _flavor_show-flavor:
.. describe:: <flavor>
Flavor to display (name or ID)

View File

@ -82,7 +82,7 @@ referring to both Compute and Volume quotas.
* ``domain``: Identity - a grouping of projects
* ``endpoint``: (**Identity**) the base URL used to contact a specific service
* ``extension``: (**Compute**, **Identity**, **Volume**) OpenStack server API extensions
* ``flavor``: Compute - pre-defined configurations of servers: ram, root disk, etc
* ``flavor``: (**Compute**) pre-defined server configurations: ram, root disk, etc
* ``group``: Identity - a grouping of users
* ``host``: Compute - the physical computer running a hypervisor
* ``hypervisor``: Compute - the virtual machine manager

View File

@ -34,64 +34,71 @@ class CreateFlavor(show.ShowOne):
parser = super(CreateFlavor, self).get_parser(prog_name)
parser.add_argument(
"name",
metavar="<name>",
metavar="<flavor-name>",
help="New flavor name",
)
parser.add_argument(
"--id",
metavar="<id>",
default='auto',
help="Unique flavor ID; 'auto' will create a UUID "
"(default: auto)")
help="Unique flavor ID; 'auto' creates a UUID "
"(default: auto)",
)
parser.add_argument(
"--ram",
type=int,
metavar="<size-mb>",
default=256,
help="Memory size in MB (default 256M)")
help="Memory size in MB (default 256M)",
)
parser.add_argument(
"--disk",
type=int,
metavar="<size-gb>",
default=0,
help="Disk size in GB (default 0G)")
help="Disk size in GB (default 0G)",
)
parser.add_argument(
"--ephemeral",
type=int,
metavar="<size-gb>",
default=0,
help="Ephemeral disk size in GB (default 0G)",
default=0)
)
parser.add_argument(
"--swap",
type=int,
metavar="<size-gb>",
default=0,
help="Swap space size in GB (default 0G)",
default=0)
)
parser.add_argument(
"--vcpus",
type=int,
metavar="<vcpus>",
default=1,
help="Number of vcpus (default 1)")
help="Number of vcpus (default 1)",
)
parser.add_argument(
"--rxtx-factor",
type=int,
metavar="<factor>",
default=1,
help="RX/TX factor (default 1)",
default=1)
)
public_group = parser.add_mutually_exclusive_group()
public_group.add_argument(
"--public",
dest="public",
action="store_true",
default=True,
help="Flavor is accessible to other projects (default)",
help="Flavor is available to other projects (default)",
)
public_group.add_argument(
"--private",
dest="public",
action="store_false",
help="Flavor is inaccessible to other projects",
help="Flavor is not available to other projects",
)
return parser
@ -168,7 +175,7 @@ class ListFlavor(lister.Lister):
class ShowFlavor(show.ShowOne):
"""Show flavor details"""
"""Display flavor details"""
log = logging.getLogger(__name__ + ".ShowFlavor")