openstack/ironic
Code Issues Proposed changes

Update documentation to include servicing abort.

Browse Source 
Adds instructions on how to use abort verb to exit from service states.

Change-Id: Ibf654dc277eb5bc4c38ed1e804bbb6df42d43617
Signed-off-by: Jacob Anders <janders@redhat.com>
This commit is contained in:
Jacob Anders
2025-08-19 12:33:25 +10:00
parent 3e1d129241
commit e13142302d
2 changed files with 18 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
doc/source/admin/troubleshooting.rst
View File

@@ -580,10 +580,13 @@ to do this.
Stopping the operation Stopping the operation
---------------------- ----------------------
Cleaning, inspection and rescuing can be stopped while in ``clean wait``, Cleaning, inspection, servicing and rescuing can be stopped while in
``inspect wait`` and ``rescue wait`` states using the ``abort`` command. ``clean wait``, ``inspect wait``, ``service wait`` and ``rescue wait`` states
It will move the node to the corresponding failure state (``clean failed``, using the ``abort`` command. If the step running at the time has ``abortable``
``inspect failed`` or ``rescue failed``):: parameter set to ``True``, the abort will happen instantly, otherwise the
process will be aborted once the currently running step is finished.
The node will be moved to the corresponding failure state (``clean failed``,
``inspect failed``, ``service failed`` or ``rescue failed``)::
baremetal node abort <node> baremetal node abort <node>

11
doc/source/user/states.rst
View File

@@ -294,3 +294,14 @@ service failed
using the ``service`` verb. using the ``service`` verb.
* ``rescue`` (through ``rescuing``) by setting the node's provision state * ``rescue`` (through ``rescuing``) by setting the node's provision state
using the ``rescue`` verb. using the ``rescue`` verb.
* ``active`` by setting the node's provision state using the ``abort`` verb.
.. note::
Prior to attempting aborting a servicing operation on a node either in
``service wait`` or ``service failed`` state, the user must check the
remote console of the machine as a precaution and ensure there is no active
firmware update running on the node. Aborting service may result in a power
cycle operation which may interrupt the running update, causing
irreversible damage to the hardware.
Once it is confirmed no update operation is running, using ``abort`` verb
is not expected to cause any issues.