Skip to content

Commit a5101a4

Browse files
committed
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>
1 parent 24edeb2 commit a5101a4

1 file changed

Lines changed: 24 additions & 4 deletions

File tree

openstackclient/compute/v2/agent.py

Lines changed: 24 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,12 @@
2828

2929

3030
class CreateAgent(command.ShowOne):
31-
_description = _("Create compute agent")
31+
"""Create compute agent.
32+
33+
The compute agent functionality is hypervisor specific and is only
34+
supported by the XenAPI hypervisor driver. It was removed from nova in the
35+
23.0.0 (Wallaby) release.
36+
"""
3237

3338
def get_parser(self, prog_name):
3439
parser = super(CreateAgent, self).get_parser(prog_name)
@@ -80,7 +85,12 @@ def take_action(self, parsed_args):
8085

8186

8287
class DeleteAgent(command.Command):
83-
_description = _("Delete compute agent(s)")
88+
"""Delete compute agent(s).
89+
90+
The compute agent functionality is hypervisor specific and is only
91+
supported by the XenAPI hypervisor driver. It was removed from nova in the
92+
23.0.0 (Wallaby) release.
93+
"""
8494

8595
def get_parser(self, prog_name):
8696
parser = super(DeleteAgent, self).get_parser(prog_name)
@@ -111,7 +121,12 @@ def take_action(self, parsed_args):
111121

112122

113123
class ListAgent(command.Lister):
114-
_description = _("List compute agents")
124+
"""List compute agents.
125+
126+
The compute agent functionality is hypervisor specific and is only
127+
supported by the XenAPI hypervisor driver. It was removed from nova in the
128+
23.0.0 (Wallaby) release.
129+
"""
115130

116131
def get_parser(self, prog_name):
117132
parser = super(ListAgent, self).get_parser(prog_name)
@@ -141,7 +156,12 @@ def take_action(self, parsed_args):
141156

142157

143158
class SetAgent(command.Command):
144-
_description = _("Set compute agent properties")
159+
"""Set compute agent properties.
160+
161+
The compute agent functionality is hypervisor specific and is only
162+
supported by the XenAPI hypervisor driver. It was removed from nova in the
163+
23.0.0 (Wallaby) release.
164+
"""
145165

146166
def get_parser(self, prog_name):
147167
parser = super(SetAgent, self).get_parser(prog_name)

0 commit comments

Comments
 (0)