summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMatt Riedemann <mriedem.os@gmail.com>2019-07-25 14:28:43 -0400
committerElod Illes <elod.illes@est.tech>2019-09-20 16:42:11 +0200
commit111d6a9b23d8c6b9bcce437039ff49536f0b5dd1 (patch)
treea6c037f8e0c0c2d44ee0f535ad45b50856ed79fa
parent100d34c54ecdfedf6fb40a2686e1aae1f54df97e (diff)
downloadpython-openstackclient-stein-em.tar.gz
Document 2.53 behavior for compute service list/deletestein-em3.18.1
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 (cherry picked from commit 1557afb554e908e097abd39081891ea78083e20e)
-rw-r--r--doc/source/cli/command-objects/compute-service.rst8
-rw-r--r--openstackclient/compute/v2/service.py11
2 files changed, 16 insertions, 3 deletions
diff --git a/doc/source/cli/command-objects/compute-service.rst b/doc/source/cli/command-objects/compute-service.rst
index ba624ea0..0977a0e8 100644
--- a/doc/source/cli/command-objects/compute-service.rst
+++ b/doc/source/cli/command-objects/compute-service.rst
@@ -18,13 +18,19 @@ Delete compute service(s)
.. _compute_service_delete-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
--------------------
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
diff --git a/openstackclient/compute/v2/service.py b/openstackclient/compute/v2/service.py
index b289a4f8..cefac39c 100644
--- a/openstackclient/compute/v2/service.py
+++ b/openstackclient/compute/v2/service.py
@@ -37,7 +37,10 @@ class DeleteService(command.Command):
"service",
metavar="<service>",
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
@@ -60,7 +63,11 @@ class DeleteService(command.Command):
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):
parser = super(ListService, self).get_parser(prog_name)