From 9599ffe65d9dcd4b3aa780d346eccd1e760890bf Mon Sep 17 00:00:00 2001 From: Doug Hellmann Date: Tue, 13 Jun 2017 15:55:33 -0400 Subject: reorganize existing documentation according to the new standard layout Move existing content around based on the doc-migration specification. Replace :doc: markup with :ref: to have sphinx keep track of where the files move and generate valid hyperlinks. Add a few toctrees and index pages for the new directories. Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454 Change-Id: I253ee8f89d3ec40e39310c18bb87ed1d3d5de330 Signed-off-by: Doug Hellmann --- doc/source/cli/command-objects/flavor.rst | 220 ++++++++++++++++++++++++++++++ 1 file changed, 220 insertions(+) create mode 100644 doc/source/cli/command-objects/flavor.rst (limited to 'doc/source/cli/command-objects/flavor.rst') diff --git a/doc/source/cli/command-objects/flavor.rst b/doc/source/cli/command-objects/flavor.rst new file mode 100644 index 00000000..6feb4498 --- /dev/null +++ b/doc/source/cli/command-objects/flavor.rst @@ -0,0 +1,220 @@ +====== +flavor +====== + +Compute v2 + +flavor create +------------- + +Create new flavor + +.. program:: flavor create +.. code:: bash + + openstack flavor create + [--id ] + [--ram ] + [--disk ] + [--ephemeral-disk ] + [--swap ] + [--vcpus ] + [--rxtx-factor ] + [--public | --private] + [--property [...] ] + [--project ] + [--project-domain ] + + +.. option:: --id + + Unique flavor ID; 'auto' creates a UUID (default: auto) + +.. option:: --ram + + Memory size in MB (default 256M) + +.. option:: --disk + + Disk size in GB (default 0G) + +.. option:: --ephemeral-disk + + Ephemeral disk size in GB (default 0G) + +.. option:: --swap + + Swap space size in MB (default 0M) + +.. option:: --vcpus + + Number of vcpus (default 1) + +.. option:: --rxtx-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 + + Property to add for this flavor (repeat option to set multiple properties) + +.. option:: --project + + Allow to access private flavor (name or ID) + (Must be used with :option:`--private` option) + +.. option:: --project-domain + + Domain the project belongs to (name or ID). + This can be used in case collisions between project names exist. + +.. _flavor_create-flavor-name: +.. describe:: + + New flavor name + +flavor delete +------------- + +Delete flavor(s) + +.. program:: flavor delete +.. code:: bash + + openstack flavor delete + [ ...] + +.. _flavor_delete-flavor: +.. describe:: + + Flavor(s) to delete (name or ID) + +flavor list +----------- + +List flavors + +.. program:: flavor list +.. code:: bash + + openstack flavor list + [--public | --private | --all] + [--long] + [--marker ] + [--limit ] + +.. 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 + + The last flavor ID of the previous page + +.. option:: --limit + + Maximum number of flavors to display + +flavor set +---------- + +Set flavor properties + +.. program:: flavor set +.. code:: bash + + openstack flavor set + [--no-property] + [--property [...] ] + [--project ] + [--project-domain ] + + +.. option:: --property + + Property to add or modify for this flavor (repeat option to set multiple properties) + +.. option:: --project + + Set flavor access to project (name or ID) (admin only) + +.. option:: --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.) + +.. describe:: + + Flavor to modify (name or ID) + +flavor show +----------- + +Display flavor details + +.. program:: flavor show +.. code:: bash + + openstack flavor show + + +.. _flavor_show-flavor: +.. describe:: + + Flavor to display (name or ID) + +flavor unset +------------ + +Unset flavor properties + +.. program:: flavor unset +.. code:: bash + + openstack flavor unset + [--property [...] ] + [--project ] + [--project-domain ] + + +.. option:: --property + + Property to remove from flavor (repeat option to remove multiple properties) + +.. option:: --project + + Remove flavor access from project (name or ID) (admin only) + +.. option:: --project-domain + + Domain the project belongs to (name or ID). + This can be used in case collisions between project names exist. + +.. describe:: + + Flavor to modify (name or ID) -- cgit v1.2.1