openstack/ironic
Code Issues Proposed changes

Document the custom-agent deploy interface

Browse Source 
Follow-up to commit e85a36fe36db166e3f37212aa8261ac72e34e66a.

Change-Id: I8f1909523f2e8c314bd7e6f62ac29a90d7585abd
This commit is contained in:
Dmitry Tantsur 2021-05-05 16:05:47 +02:00
parent 270792377d
commit 53d06a797c
2 changed files with 20 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
doc/source/admin/interfaces/deploy.rst
View File

@ -133,3 +133,16 @@ Ramdisk deploy
The ramdisk interface is intended to provide a mechanism to "deploy" an
instance where the item to be deployed is in reality a ramdisk. It is
documented separately, see :doc:`/admin/ramdisk-boot`.
.. _custom-agent-deploy:
Custom agent deploy
===================
The ``custom-agent`` deploy interface is designed for operators who want to
completely orchestrate writing the instance image using
:ironic-python-agent-doc:`in-band deploy steps from a custom agent image
<admin/hardware_managers.html>`. If you use this deploy interface, you are
responsible to provide all necessary deploy steps with priorities between
61 and 99 (see :ref:`node-deployment-core-steps` for information on
priorities).

7
doc/source/admin/node-deployment.rst
View File

@ -116,6 +116,13 @@ An example by passing a JSON string:
Format of JSON for deploy steps argument is described in `Deploy step format`_
section.
Excluding the default steps
---------------------------
Starting with the Xena release, you can use the new :ref:`custom-agent-deploy`
interface to exclude the default step ``write_image`` and skip bootloader
installation in the ``prepare_instance_boot`` step.
Writing a Deploy Step
---------------------