ironic/doc/source/admin/fast-track.rst
Dmitry Tantsur 4911477525 Document fast-track and the agent power interface
To prevent the administrator guide from growing too long, split
away advanced topics (i.e. stuff we don't expect most of admins
to read, use or understand).

Story: #2007771
Task: #40382
Change-Id: Ia3e3178692c96aaebdd4479e865a56fbe63c820a
2020-07-20 09:42:14 +02:00

51 lines
1.5 KiB
ReStructuredText

=====================
Fast-Track Deployment
=====================
*Fast track* is a mode of operation where the Bare Metal service keeps a
machine powered on with the agent running between provisioning operations.
It is first booted during in-band inspection or cleaning (whatever happens
first) and is only shut down before rebooting into the final instance.
Depending on the configuration, this mode can save several reboots and is
particularly useful for scenarios where nodes are enrolled, prepared and
provisioned within a short period of time.
.. warning::
Fast track deployment targets standalone use cases and is only tested with
the ``noop`` networking. The case where inspection, cleaning and
provisioning networks are different is not supported.
Enabling
========
Fast track is off by default and should be enabled in the configuration:
.. code-block:: ini
[deploy]
fast_track = true
Inspection
----------
If using :ref:`in-band inspection`, you need to tell ironic-inspector not to
power off nodes afterwards. Depending on the inspection mode (managed or
unmanaged), you need to configure two places. In ``ironic.conf``:
.. code-block:: ini
[inspector]
power_off = false
And in ``inspector.conf``:
.. code-block:: ini
[processing]
power_off = false
Finally, you need to update the :ironic-inspector-doc:`inspection PXE
configuration <install/index.html#configuration>` to include the
``ipa-api-url`` kernel parameter, pointing at the **ironic** endpoint, in
addition to the existing ``ipa-inspection-callback-url``.