From a5101a413983c868c8dd865c6db42b5d87456d0e Mon Sep 17 00:00:00 2001
From: Stephen Finucane <sfinucan@redhat.com>
Date: Mon, 16 Nov 2020 11:15:32 +0000
Subject: [PATCH] trivial: Document removal of support for agents
We can't remove these commands for a long time, given OSC's intention to
support multiple releases of OpenStack, but we can at least indicate to
users that this thing might not work anymore.
Change-Id: I9093cc1197a0287984d83e2020fba100d0c958b3
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
---
openstackclient/compute/v2/agent.py | 28 ++++++++++++++++++++++++----
1 file changed, 24 insertions(+), 4 deletions(-)
diff --git a/openstackclient/compute/v2/agent.py b/openstackclient/compute/v2/agent.py
index 3feb99ec83..15fb0f9c36 100644
--- a/openstackclient/compute/v2/agent.py
+++ b/openstackclient/compute/v2/agent.py
@@ -28,7 +28,12 @@ LOG = logging.getLogger(__name__)
class CreateAgent(command.ShowOne):
- _description = _("Create compute agent")
+ """Create compute agent.
+
+ The compute agent functionality is hypervisor specific and is only
+ supported by the XenAPI hypervisor driver. It was removed from nova in the
+ 23.0.0 (Wallaby) release.
+ """
def get_parser(self, prog_name):
parser = super(CreateAgent, self).get_parser(prog_name)
@@ -80,7 +85,12 @@ class CreateAgent(command.ShowOne):
class DeleteAgent(command.Command):
- _description = _("Delete compute agent(s)")
+ """Delete compute agent(s).
+
+ The compute agent functionality is hypervisor specific and is only
+ supported by the XenAPI hypervisor driver. It was removed from nova in the
+ 23.0.0 (Wallaby) release.
+ """
def get_parser(self, prog_name):
parser = super(DeleteAgent, self).get_parser(prog_name)
@@ -111,7 +121,12 @@ class DeleteAgent(command.Command):
class ListAgent(command.Lister):
- _description = _("List compute agents")
+ """List compute agents.
+
+ The compute agent functionality is hypervisor specific and is only
+ supported by the XenAPI hypervisor driver. It was removed from nova in the
+ 23.0.0 (Wallaby) release.
+ """
def get_parser(self, prog_name):
parser = super(ListAgent, self).get_parser(prog_name)
@@ -141,7 +156,12 @@ class ListAgent(command.Lister):
class SetAgent(command.Command):
- _description = _("Set compute agent properties")
+ """Set compute agent properties.
+
+ The compute agent functionality is hypervisor specific and is only
+ supported by the XenAPI hypervisor driver. It was removed from nova in the
+ 23.0.0 (Wallaby) release.
+ """
def get_parser(self, prog_name):
parser = super(SetAgent, self).get_parser(prog_name)