openstack/python-openstackclient
Code Issues Proposed changes

Document 2.53 behavior for compute service list/delete

Browse Source 
With compute API microversion 2.53, nova-compute services
can only be deleted with the ID as a UUID to uniquely identify
the service in a multi-cell deployment. This documents that for
the "compute service delete <service>" argument. The description
of the "compute service list" command is also updated to mention
that the ID can be retrieved as a UUID using 2.53 or greater.

Change-Id: If7d4a27c0aaef588bcd77dd9edddec1e535fbf31
Story: 2005349
Task: 30302
This commit is contained in:
Matt Riedemann 2019-07-25 14:28:43 -04:00
parent 4bd53dc109
commit 1557afb554
2 changed files with 16 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/source/cli/command-objects/compute-service.rst
View File

@ -18,13 +18,19 @@ Delete compute service(s)
.. _compute_service_delete-service: .. _compute_service_delete-service:
.. describe:: <service> .. describe:: <service>
Compute service(s) to delete (ID only) 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 compute service list
-------------------- --------------------
List compute services 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 .. program:: compute service list
.. code:: bash .. code:: bash

11
openstackclient/compute/v2/service.py
View File

@ -37,7 +37,10 @@ class DeleteService(command.Command):
"service", "service",
metavar="<service>", metavar="<service>",
nargs='+', nargs='+',
help=_("Compute service(s) to delete (ID only)") help=_("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.")
) )
return parser return parser
@ -60,7 +63,11 @@ class DeleteService(command.Command):
class ListService(command.Lister): class ListService(command.Lister):
_description = _("List compute services") _description = _("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.")
def get_parser(self, prog_name): def get_parser(self, prog_name):
parser = super(ListService, self).get_parser(prog_name) parser = super(ListService, self).get_parser(prog_name)