[docs] Update manual clean and verify steps
This updates admin documentation for the Redfish-based manual clean step `set_bmc_clock` and automated `verify_bmc_clock`. - Updates the cleaning.rst with an example of using `set_bmc_clock`. - Adds a section to the steps.rst for the `verify_bmc_clock`. - Explains how to enable the verify step using the `enable_verify_bmc_clock` config option under `[redfish]`. Change-Id: Ied7fa289178510ccb0ceaa790fe8d89ed7e481b6 Signed-off-by: Queensly Kyerewaa Acheampongmaa <qacheampong@gmail.com>
This commit is contained in:
@@ -360,6 +360,21 @@ In the above example, the node's RAID interface would configure hardware
|
|||||||
RAID without non-root volumes, and then all devices would be erased
|
RAID without non-root volumes, and then all devices would be erased
|
||||||
(in that order).
|
(in that order).
|
||||||
|
|
||||||
|
An example is setting the BMC clock using the Redfish management interface::
|
||||||
|
|
||||||
|
{
|
||||||
|
"target": "clean",
|
||||||
|
"clean_steps": [{
|
||||||
|
"interface": "management",
|
||||||
|
"step": "set_bmc_clock",
|
||||||
|
"args": {"datetime": "2025-07-22T12:34:56+00:00"}
|
||||||
|
}]
|
||||||
|
}
|
||||||
|
|
||||||
|
This step requires the node to use the ``redfish`` management interface
|
||||||
|
and that the Redfish service exposes the ``DateTime`` and ``DateTimeLocalOffset``
|
||||||
|
fields under the Manager Resource.
|
||||||
|
|
||||||
Alternatively, you can specify a runbook instead of clean_steps::
|
Alternatively, you can specify a runbook instead of clean_steps::
|
||||||
|
|
||||||
{
|
{
|
||||||
|
@@ -127,3 +127,52 @@ existing known state of the system.
|
|||||||
the ``has_dedicated_power_supply`` option is set for the child node.
|
the ``has_dedicated_power_supply`` option is set for the child node.
|
||||||
This pattern of behavior prevents parent nodes from being automatically
|
This pattern of behavior prevents parent nodes from being automatically
|
||||||
powered back on should a child node be left online.
|
powered back on should a child node be left online.
|
||||||
|
|
||||||
|
BMC Clock Verification Step (Verify Phase)
|
||||||
|
===========================================
|
||||||
|
|
||||||
|
The Redfish management interface includes a verify step called
|
||||||
|
``verify_bmc_clock`` which automatically checks and sets the BMC
|
||||||
|
clock during node registration.
|
||||||
|
|
||||||
|
This step compares the system time on the conductor with the BMC's
|
||||||
|
time reported via Redfish. If the clock differs by more than one
|
||||||
|
second, Ironic updates the BMC's clock to match the conductor's UTC time.
|
||||||
|
|
||||||
|
This step runs automatically if enabled and the node
|
||||||
|
supports the Redfish interface.
|
||||||
|
|
||||||
|
How to Enable
|
||||||
|
---------------
|
||||||
|
The feature is controlled by the following configuration option
|
||||||
|
in `` ironic.conf``:
|
||||||
|
|
||||||
|
.. code-block:: ini
|
||||||
|
|
||||||
|
[redfish]
|
||||||
|
enable_verify_bmc_clock = true
|
||||||
|
|
||||||
|
By default, this option is set to ``false``. To enable it, set it to ``true`` and
|
||||||
|
restart the ``ironic conductor``.
|
||||||
|
|
||||||
|
When It Runs
|
||||||
|
---------------
|
||||||
|
|
||||||
|
``verify_bmc_clock`` step is triggered during the automated verify step of the
|
||||||
|
node registration, before inspection and deployment.
|
||||||
|
|
||||||
|
Note:
|
||||||
|
|
||||||
|
- If the BMC does not support setting the clock via Redfish,
|
||||||
|
the step will fail.
|
||||||
|
|
||||||
|
- If the time cannot be synchronized within 1 second, the step will
|
||||||
|
raise a ``NodeVerifyFailure``.
|
||||||
|
|
||||||
|
- If the configuration option is disabled, the step is skipped.
|
||||||
|
|
||||||
|
- ``verify_bmc_clock`` is defined with a priority of 1 and
|
||||||
|
is not interruptible.
|
||||||
|
|
||||||
|
- This is different from the manual ``clean`` step ``set_bmc_clock``
|
||||||
|
which allows explicit datatime setting through the API.
|
||||||
|
Reference in New Issue
Block a user