From c6266b5ab22b911ae7e0ca5077d0c04a23dabca9 Mon Sep 17 00:00:00 2001 From: Eric Fried Date: Mon, 4 Nov 2019 16:02:31 -0600 Subject: [PATCH] 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 --- doc/source/cli/command-objects/aggregate.rst | 179 +------------- .../cli/command-objects/compute-agent.rst | 98 +------- .../cli/command-objects/compute-service.rst | 93 +------ .../cli/command-objects/console-log.rst | 21 +- .../cli/command-objects/console-url.rst | 42 +--- doc/source/cli/command-objects/flavor.rst | 228 +----------------- doc/source/cli/command-objects/host.rst | 66 +---- .../cli/command-objects/hypervisor-stats.rst | 12 +- doc/source/cli/command-objects/hypervisor.rst | 39 +-- doc/source/cli/command-objects/keypair.rst | 71 +----- doc/source/cli/command-objects/server.rst | 4 +- doc/source/cli/command-objects/usage.rst | 49 +--- setup.cfg | 2 +- 13 files changed, 29 insertions(+), 875 deletions(-) diff --git a/doc/source/cli/command-objects/aggregate.rst b/doc/source/cli/command-objects/aggregate.rst index 2029a6c8c..0f62ce8f4 100644 --- a/doc/source/cli/command-objects/aggregate.rst +++ b/doc/source/cli/command-objects/aggregate.rst @@ -7,180 +7,5 @@ criteria. Compute v2 -aggregate add host ------------------- - -Add host to aggregate - -.. program:: aggregate add host -.. code:: bash - - openstack aggregate add host - - - -.. _aggregate_add_host-aggregate: -.. describe:: - - Aggregate (name or ID) - -.. _aggregate_add_host-host: -.. describe:: - - Host to add to :ref:`\ ` - -aggregate create ----------------- - -Create a new aggregate - -.. program:: aggregate create -.. code:: bash - - openstack aggregate create - [--zone ] - [--property [...] ] - - -.. option:: --zone - - Availability zone name - -.. option:: --property - - Property to add to this aggregate (repeat option to set multiple properties) - -.. _aggregate_create-name: -.. describe:: - - New aggregate name - -aggregate delete ----------------- - -Delete existing aggregate(s) - -.. program:: aggregate delete -.. code:: bash - - openstack aggregate delete - [ ...] - -.. _aggregate_delete-aggregate: -.. describe:: - - Aggregate(s) to delete (name or ID) - -aggregate list --------------- - -List all aggregates - -.. program:: aggregate list -.. code:: bash - - openstack aggregate list - [--long] - -.. option:: --long - - List additional fields in output - -aggregate remove host ---------------------- - -Remove host from aggregate - -.. program:: aggregate remove host -.. code:: bash - - openstack aggregate remove host - - - -.. _aggregate_remove_host-aggregate: -.. describe:: - - Aggregate (name or ID) - -.. _aggregate_remove_host-host: -.. describe:: - - Host to remove from :ref:`\ ` - -aggregate set -------------- - -Set aggregate properties - -.. program:: aggregate set -.. code:: bash - - openstack aggregate set - [--name ] - [--zone ] - [--property [...] ] - [--no-property] - - -.. option:: --name - - Set aggregate name - -.. option:: --zone - - Set availability zone name - -.. option:: --property - - Property to set on :ref:`\ ` - (repeat option to set multiple properties) - -.. option:: --no-property - - Remove all properties from :ref:`\ ` - (specify both :option:`--property` and :option:`--no-property` to - overwrite the current properties) - -.. _aggregate_set-aggregate: -.. describe:: - - Aggregate to modify (name or ID) - -aggregate show --------------- - -Display aggregate details - -.. program:: aggregate show -.. code:: bash - - openstack aggregate show - - -.. _aggregate_show-aggregate: -.. describe:: - - Aggregate to display (name or ID) - -aggregate unset ---------------- - -Unset aggregate properties - -.. program:: aggregate unset -.. code-block:: bash - - openstack aggregate unset - [--property [...] ] - - -.. option:: --property - - Property to remove from :ref:`\ ` - (repeat option to remove multiple properties) - -.. _aggregate_unset-aggregate: -.. describe:: - - Aggregate to modify (name or ID) +.. autoprogram-cliff:: openstack.compute.v2 + :command: aggregate * diff --git a/doc/source/cli/command-objects/compute-agent.rst b/doc/source/cli/command-objects/compute-agent.rst index e8317b482..89d749287 100644 --- a/doc/source/cli/command-objects/compute-agent.rst +++ b/doc/source/cli/command-objects/compute-agent.rst @@ -4,99 +4,5 @@ compute agent Compute v2 -compute agent create --------------------- - -Create compute agent - -.. program:: compute agent create -.. code:: bash - - openstack compute agent create - - - -.. _compute_agent-create: -.. describe:: - - Type of OS - -.. describe:: - - Type of architecture - -.. describe:: - - Version - -.. describe:: - - URL - -.. describe:: - - MD5 hash - -.. describe:: - - Type of hypervisor - -compute agent delete --------------------- - -Delete compute agent(s) - -.. program:: compute agent delete -.. code:: bash - - openstack compute agent delete [ ...] - -.. _compute_agent-delete: -.. describe:: - - ID of agent(s) to delete - -compute agent list ------------------- - -List compute agents - -.. program:: compute agent list -.. code:: bash - - openstack compute agent list [--hypervisor ] - -.. option:: --hypervisor - - Type of hypervisor - -compute agent set ------------------ - -Set compute agent properties - -.. program:: agent set -.. code:: bash - - openstack compute agent set - [--agent-version ] - [--url ] - - -.. _compute_agent-set: -.. option:: --agent-version - - Version of the agent - -.. option:: --url - - URL of the agent - -.. option:: --md5hash - - MD5 hash of the agent - -.. describe:: - - Agent to modify (ID only) +.. autoprogram-cliff:: openstack.compute.v2 + :command: compute agent * diff --git a/doc/source/cli/command-objects/compute-service.rst b/doc/source/cli/command-objects/compute-service.rst index a76a9c26b..ac54786e5 100644 --- a/doc/source/cli/command-objects/compute-service.rst +++ b/doc/source/cli/command-objects/compute-service.rst @@ -4,94 +4,5 @@ compute service Compute v2 -compute service delete ----------------------- - -Delete compute service(s) - -.. program:: compute service delete -.. code:: bash - - openstack compute service delete - [ ...] - -.. _compute_service_delete-service: -.. describe:: - - Compute service(s) to delete (ID only). If using - ``--os-compute-api-version`` 2.53 or greater, the ID is a UUID which can - be retrieved by listing compute services using the same 2.53+ microversion. - -compute service list --------------------- - -List compute services - -Using ``--os-compute-api-version`` 2.53 or greater will return the ID as a -UUID value which can be used to uniquely identify the service in a multi-cell -deployment. - -.. program:: compute service list -.. code:: bash - - openstack compute service list - [--host ] - [--service ] - [--long] - -.. option:: --host - - List services on specified host (name only) - -.. option:: --service - - List only specified service binaries (name only). For example, - ``nova-compute``, ``nova-conductor``, etc. - -.. option:: --long - - List additional fields in output - -compute service set -------------------- - -Set compute service properties - -.. program:: compute service set -.. code:: bash - - openstack compute service set - [--enable | --disable] - [--disable-reason ] - [--up | --down] - - -.. option:: --enable - - Enable service - -.. option:: --disable - - Disable service - -.. option:: --disable-reason - - Reason for disabling the service (in quotes). Should be used with :option:`--disable` option. - -.. option:: --up - - Force up service. Requires ``--os-compute-api-version`` 2.11 or greater. - -.. option:: --down - - Force down service. . Requires ``--os-compute-api-version`` 2.11 or - greater. - -.. _compute_service_set-host: -.. describe:: - - Name of host - -.. describe:: - - Name of service (Binary name), for example ``nova-compute`` +.. autoprogram-cliff:: openstack.compute.v2 + :command: compute service * diff --git a/doc/source/cli/command-objects/console-log.rst b/doc/source/cli/command-objects/console-log.rst index bcb23e700..46ef370d8 100644 --- a/doc/source/cli/command-objects/console-log.rst +++ b/doc/source/cli/command-objects/console-log.rst @@ -6,22 +6,5 @@ Server console text dump Compute v2 -console log show ----------------- - -Show server's console output - -.. program:: console log show -.. code:: bash - - openstack console log show - [--lines ] - - -.. option:: --lines - - Number of lines to display from the end of the log (default=all) - -.. describe:: - - Server to show log console log (name or ID) +.. autoprogram-cliff:: openstack.compute.v2 + :command: console log * diff --git a/doc/source/cli/command-objects/console-url.rst b/doc/source/cli/command-objects/console-url.rst index 8a5807b6a..001ccc56c 100644 --- a/doc/source/cli/command-objects/console-url.rst +++ b/doc/source/cli/command-objects/console-url.rst @@ -6,43 +6,5 @@ Server remote console URL Compute v2 -console url show ----------------- - -Show server's remote console URL - -.. program:: console url show -.. code:: bash - - openstack console url show - [--novnc | --xvpvnc | --spice] - [--rdp | --serial | --mks] - - -.. option:: --novnc - - Show noVNC console URL (default) - -.. option:: --xvpvnc - - Show xvpvnc console URL - -.. option:: --spice - - Show SPICE console URL - -.. option:: --rdp - - Show RDP console URL - -.. option:: --serial - - Show serial console URL - -.. option:: --mks - - Show WebMKS console URL - -.. describe:: - - Server to show URL (name or ID) +.. autoprogram-cliff:: openstack.compute.v2 + :command: console url * diff --git a/doc/source/cli/command-objects/flavor.rst b/doc/source/cli/command-objects/flavor.rst index f22463b78..ee09b3ace 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 ] - [--ram ] - [--disk ] - [--ephemeral-disk ] - [--swap ] - [--vcpus ] - [--rxtx-factor ] - [--public | --private] - [--property [...] ] - [--project ] - [--project-domain ] - [--description ] - - -.. 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 - - Additional 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. - -.. option:: --description - - Description to add for this flavor. Only available starting with - ``--os-compute-api-version 2.55``. - -.. _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 ] - [--description ] - - -.. 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.) - -.. option:: --description - - Description to set for this flavor. Only available starting with - ``--os-compute-api-version 2.55``. - -.. 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) +.. autoprogram-cliff:: openstack.compute.v2 + :command: flavor * diff --git a/doc/source/cli/command-objects/host.rst b/doc/source/cli/command-objects/host.rst index cbf343982..acd5a287f 100644 --- a/doc/source/cli/command-objects/host.rst +++ b/doc/source/cli/command-objects/host.rst @@ -6,67 +6,5 @@ Compute v2 The physical computer running a hypervisor. -host list ---------- - -List hosts - -.. program:: host list -.. code:: bash - - openstack host list - [--zone ] - -.. option:: --zone - - Only return hosts in the availability zone - -host set --------- - -Set host properties - -.. program:: host set -.. code:: bash - - openstack host set - [--enable | --disable] - [--enable-maintenance | --disable-maintenance] - - -.. _host-set: -.. option:: --enable - - Enable the host - -.. option:: --disable - - Disable the host - -.. _maintenance-set: -.. option:: --enable-maintenance - - Enable maintenance mode for the host - -.. option:: --disable-maintenance - - Disable maintenance mode for the host - -.. describe:: - - Host to modify (name only) - -host show ---------- - -Display host details - -.. program:: host show -.. code:: bash - - openstack host show - - -.. describe:: - - Name of host +.. autoprogram-cliff:: openstack.compute.v2 + :command: host * diff --git a/doc/source/cli/command-objects/hypervisor-stats.rst b/doc/source/cli/command-objects/hypervisor-stats.rst index 89faf135f..1f5768f29 100644 --- a/doc/source/cli/command-objects/hypervisor-stats.rst +++ b/doc/source/cli/command-objects/hypervisor-stats.rst @@ -4,13 +4,5 @@ hypervisor stats Compute v2 -hypervisor stats show ---------------------- - -Display hypervisor stats details - -.. program:: hypervisor stats show -.. code:: bash - - openstack hypervisor stats show - +.. autoprogram-cliff:: openstack.compute.v2 + :command: hypervisor stats * diff --git a/doc/source/cli/command-objects/hypervisor.rst b/doc/source/cli/command-objects/hypervisor.rst index 9db384a24..9ae82bf12 100644 --- a/doc/source/cli/command-objects/hypervisor.rst +++ b/doc/source/cli/command-objects/hypervisor.rst @@ -4,38 +4,11 @@ hypervisor Compute v2 -hypervisor list ---------------- +.. NOTE(efried): have to list these out one by one; 'hypervisor *' pulls in + ... stats. -List hypervisors +.. autoprogram-cliff:: openstack.compute.v2 + :command: hypervisor list -.. program:: hypervisor list -.. code:: bash - - openstack hypervisor list - [--matching ] - [--long] - -.. option:: --matching - - Filter hypervisors using substring - -.. option:: --long - - List additional fields in output - -hypervisor show ---------------- - -Display hypervisor details - -.. program:: hypervisor show -.. code:: bash - - openstack hypervisor show - - -.. _hypervisor_show-flavor: -.. describe:: - - Hypervisor to display (name or ID) +.. autoprogram-cliff:: openstack.compute.v2 + :command: hypervisor show diff --git a/doc/source/cli/command-objects/keypair.rst b/doc/source/cli/command-objects/keypair.rst index a539f0a20..f8bce3756 100644 --- a/doc/source/cli/command-objects/keypair.rst +++ b/doc/source/cli/command-objects/keypair.rst @@ -9,72 +9,5 @@ command. Compute v2 -keypair create --------------- - -Create new public or private key for server ssh access - -.. program:: keypair create -.. code:: bash - - openstack keypair create - [--public-key | --private-key ] - - -.. option:: --public-key - - Filename for public key to add. If not used, creates a private key. - -.. option:: --private-key - - Filename for private key to save. If not used, print private key in - console. - -.. describe:: - - New public or private key name - -keypair delete --------------- - -Delete public or private key(s) - -.. program:: keypair delete -.. code:: bash - - openstack keypair delete - [ ...] - -.. describe:: - - Name of key(s) to delete (name only) - -keypair list ------------- - -List key fingerprints - -.. program:: keypair list -.. code:: bash - - openstack keypair list - -keypair show ------------- - -Display key details - -.. program:: keypair show -.. code:: bash - - openstack keypair show - [--public-key] - - -.. option:: --public-key - - Show only bare public key paired with the generated key - -.. describe:: - - Public or private key to display (name only) +.. autoprogram-cliff:: openstack.compute.v2 + :command: keypair * diff --git a/doc/source/cli/command-objects/server.rst b/doc/source/cli/command-objects/server.rst index a7fef2578..89eb4e371 100644 --- a/doc/source/cli/command-objects/server.rst +++ b/doc/source/cli/command-objects/server.rst @@ -23,7 +23,7 @@ Compute v2 :command: server lock .. autoprogram-cliff:: openstack.compute.v2 - :command: server migrate + :command: server migrate* .. autoprogram-cliff:: openstack.compute.v2 :command: server pause @@ -41,7 +41,7 @@ Compute v2 :command: server rescue .. autoprogram-cliff:: openstack.compute.v2 - :command: server resize + :command: server resize* .. autoprogram-cliff:: openstack.compute.v2 :command: server restore diff --git a/doc/source/cli/command-objects/usage.rst b/doc/source/cli/command-objects/usage.rst index bb13176cc..c2bcde061 100644 --- a/doc/source/cli/command-objects/usage.rst +++ b/doc/source/cli/command-objects/usage.rst @@ -4,50 +4,5 @@ usage Compute v2 -usage list ----------- - -List resource usage per project - -Compute API v2.40+ returns all matching entities rather than being -limited to the API server configured maximum (``CONF.api.max_limit``). - -.. program:: usage list -.. code:: bash - - openstack usage list - [--start ] - [--end ] - -.. option:: --start - - Usage range start date, ex 2012-01-20 (default: 4 weeks ago) - -.. option:: --end - - Usage range end date, ex 2012-01-20 (default: tomorrow) - -usage show ----------- - -Show resource usage for a single project - -.. program:: usage show -.. code:: bash - - openstack usage show - [--project ] - [--start ] - [--end ] - -.. option:: --project - - Name or ID of project to show usage for - -.. option:: --start - - Usage range start date, ex 2012-01-20 (default: 4 weeks ago) - -.. option:: --end - - Usage range end date, ex 2012-01-20 (default: tomorrow) +.. autoprogram-cliff:: openstack.compute.v2 + :command: usage * diff --git a/setup.cfg b/setup.cfg index d2bee32e0..2d6422787 100644 --- a/setup.cfg +++ b/setup.cfg @@ -102,6 +102,7 @@ openstack.compute.v2 = server_add_volume = openstackclient.compute.v2.server:AddServerVolume server_create = openstackclient.compute.v2.server:CreateServer server_delete = openstackclient.compute.v2.server:DeleteServer + server_dump_create = openstackclient.compute.v2.server:CreateServerDump server_list = openstackclient.compute.v2.server:ListServer server_lock = openstackclient.compute.v2.server:LockServer server_migrate = openstackclient.compute.v2.server:MigrateServer @@ -129,7 +130,6 @@ openstack.compute.v2 = server_start = openstackclient.compute.v2.server:StartServer server_stop = openstackclient.compute.v2.server:StopServer server_suspend = openstackclient.compute.v2.server:SuspendServer - server_dump_create = openstackclient.compute.v2.server:CreateServerDump server_unlock = openstackclient.compute.v2.server:UnlockServer server_unpause = openstackclient.compute.v2.server:UnpauseServer server_unrescue = openstackclient.compute.v2.server:UnrescueServer