diff options
| author | Eric Fried <openstack@fried.cc> | 2019-11-04 16:02:31 -0600 |
|---|---|---|
| committer | Eric Fried <openstack@fried.cc> | 2019-11-05 07:09:05 -0600 |
| commit | c6266b5ab22b911ae7e0ca5077d0c04a23dabca9 (patch) | |
| tree | 8e2f4ff670b4b272184ecc877cd9838b5ad4873b /doc/source/cli/command-objects/flavor.rst | |
| parent | da56b8f4cf15cc5a77249b680dd0c4d05137be9a (diff) | |
| download | python-openstackclient-c6266b5ab22b911ae7e0ca5077d0c04a23dabca9.tar.gz | |
compute: autogenerate docs
$namespace = openstack.compute.v2
The subcommand documents for $namespace were hardcoded and thus prone to
drift over time. This commit removes the hardcoded content and uses the
autoprogram-cliff directive to generate them automatically from the
subcommand configuration classes.
Many of these were already being generated. Some were missing a few
sub-subcommands, so those are added.
Change-Id: I1aa4b2655bafd2f6a5d83b658742f65d180eb128
Diffstat (limited to 'doc/source/cli/command-objects/flavor.rst')
| -rw-r--r-- | doc/source/cli/command-objects/flavor.rst | 228 |
1 files changed, 2 insertions, 226 deletions
diff --git a/doc/source/cli/command-objects/flavor.rst b/doc/source/cli/command-objects/flavor.rst index f22463b7..ee09b3ac 100644 --- a/doc/source/cli/command-objects/flavor.rst +++ b/doc/source/cli/command-objects/flavor.rst @@ -4,229 +4,5 @@ flavor Compute v2 -flavor create -------------- - -Create new flavor - -.. program:: flavor create -.. code:: bash - - openstack 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] - [--property <key=value> [...] ] - [--project <project>] - [--project-domain <project-domain>] - [--description <description>] - <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-mb> - - Additional swap space size in MB (default 0M) - -.. option:: --vcpus <num-cpu> - - Number of vcpus (default 1) - -.. option:: --rxtx-factor <factor> - - RX/TX factor (default 1.0) - -.. option:: --public - - Flavor is available to other projects (default) - -.. option:: --private - - Flavor is not available to other projects - -.. option:: --property <key=value> - - Property to add for this flavor (repeat option to set multiple properties) - -.. option:: --project <project> - - Allow <project> to access private flavor (name or ID) - (Must be used with :option:`--private` option) - -.. option:: --project-domain <project-domain> - - Domain the project belongs to (name or ID). - This can be used in case collisions between project names exist. - -.. option:: --description <description> - - Description to add for this flavor. Only available starting with - ``--os-compute-api-version 2.55``. - -.. _flavor_create-flavor-name: -.. describe:: <flavor-name> - - New flavor name - -flavor delete -------------- - -Delete flavor(s) - -.. program:: flavor delete -.. code:: bash - - openstack flavor delete - <flavor> [<flavor> ...] - -.. _flavor_delete-flavor: -.. describe:: <flavor> - - Flavor(s) to delete (name or ID) - -flavor list ------------ - -List flavors - -.. program:: flavor list -.. code:: bash - - openstack flavor list - [--public | --private | --all] - [--long] - [--marker <flavor-id>] - [--limit <num-flavors>] - -.. option:: --public - - List only public flavors (default) - -.. option:: --private - - List only private flavors - -.. option:: --all - - List all flavors, whether public or private - -.. option:: --long - - List additional fields in output - -.. option:: --marker <flavor-id> - - The last flavor ID of the previous page - -.. option:: --limit <num-flavors> - - Maximum number of flavors to display - -flavor set ----------- - -Set flavor properties - -.. program:: flavor set -.. code:: bash - - openstack flavor set - [--no-property] - [--property <key=value> [...] ] - [--project <project>] - [--project-domain <project-domain>] - [--description <description>] - <flavor> - -.. option:: --property <key=value> - - Property to add or modify for this flavor (repeat option to set multiple properties) - -.. option:: --project <project> - - Set flavor access to project (name or ID) (admin only) - -.. option:: --project-domain <project-domain> - - Domain the project belongs to (name or ID). - This can be used in case collisions between project names exist. - -.. option:: --no-property - - Remove all properties from this flavor (specify both --no-property and --property - to remove the current properties before setting new properties.) - -.. option:: --description <description> - - Description to set for this flavor. Only available starting with - ``--os-compute-api-version 2.55``. - -.. describe:: <flavor> - - Flavor to modify (name or ID) - -flavor show ------------ - -Display flavor details - -.. program:: flavor show -.. code:: bash - - openstack flavor show - <flavor> - -.. _flavor_show-flavor: -.. describe:: <flavor> - - Flavor to display (name or ID) - -flavor unset ------------- - -Unset flavor properties - -.. program:: flavor unset -.. code:: bash - - openstack flavor unset - [--property <key> [...] ] - [--project <project>] - [--project-domain <project-domain>] - <flavor> - -.. option:: --property <key> - - Property to remove from flavor (repeat option to remove multiple properties) - -.. option:: --project <project> - - Remove flavor access from project (name or ID) (admin only) - -.. option:: --project-domain <project-domain> - - Domain the project belongs to (name or ID). - This can be used in case collisions between project names exist. - -.. describe:: <flavor> - - Flavor to modify (name or ID) +.. autoprogram-cliff:: openstack.compute.v2 + :command: flavor * |
