From 1557afb554e908e097abd39081891ea78083e20e Mon Sep 17 00:00:00 2001 From: Matt Riedemann Date: Thu, 25 Jul 2019 14:28:43 -0400 Subject: [PATCH] Document 2.53 behavior for compute service list/delete 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 " 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 --- doc/source/cli/command-objects/compute-service.rst | 8 +++++++- openstackclient/compute/v2/service.py | 11 +++++++++-- 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 45e781e298..a76a9c26b9 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:: - 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 80c0be7ecb..625c0fad3a 100644 --- a/openstackclient/compute/v2/service.py +++ b/openstackclient/compute/v2/service.py @@ -37,7 +37,10 @@ class DeleteService(command.Command): "service", metavar="", 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)