Merge "trivial: add missing exception to agent code path docstrings"

This commit is contained in:
Zuul 2025-05-16 04:30:12 +00:00 committed by Gerrit Code Review
commit f05c75a766
2 changed files with 5 additions and 0 deletions

View File

@ -545,6 +545,7 @@ class HeartbeatMixin(object):
LOG.exception('Asynchronous exception for node %(node)s: %(err)s',
{'node': task.node.uuid, 'err': last_error})
# Do not call the error handler is the node is already DEPLOYFAIL
# or DEPLOYWAIT
if node.provision_state in (states.DEPLOYING, states.DEPLOYWAIT):
deploy_utils.set_failed_state(
task, last_error, collect_logs=self.collect_deploy_logs)

View File

@ -183,6 +183,8 @@ class AgentClient(object):
:raises: AgentAPIError when agent failed to execute specified command.
:raises: AgentInProgress when the command fails to execute as the agent
is presently executing the prior command.
:raises: AgentConnectionFailed when connectivity has failed and there
is no prior command to determine the status of.
:returns: A dict containing command result from agent, see
get_commands_status for a sample.
"""
@ -577,6 +579,8 @@ class AgentClient(object):
:raises: IronicException when failed to issue the request or there was
a malformed response from the agent.
:raises: AgentAPIError when agent failed to execute specified command.
:raises: AgentConnectionFailed when an a transient connection failure
breaks the connection while the request is being processed.
:returns: A dict containing command response from agent.
See :func:`get_commands_status` for a command result sample.
The value of key command_result is in the form of: