openstack/ironic
Code Issues Proposed changes

Update deploy steps documentation

Browse Source 
Mostly links to the recently added IPA docs on in-band steps.

Change-Id: Idb8d2ed94eca89bdf8204f5c9c66c4d5c0fa403b
Story: #2006963
Task: #37790
This commit is contained in:
Dmitry Tantsur 2020-09-03 15:20:20 +02:00
parent 11aa5f6639
commit 44cf63c237
4 changed files with 15 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/source/admin/deploy-steps.rst
View File

@ -2,4 +2,4 @@
Deploy Steps
============
The deploy steps section has moved to :ref:`node-deployment-deploy-steps`.
The deploy steps section has moved to :doc:`node-deployment`.

2
doc/source/admin/drivers/ilo.rst
View File

@ -736,7 +736,7 @@ For more information on node manual cleaning, see :ref:`manual_cleaning`
Node Deployment Customization
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The hardware type ``ilo`` and ``ilo5`` supports customization of node
deployment via deploy templates, see :ref:`node-deployment-deploy-steps`
deployment via deploy templates, see :doc:`/admin/node-deployment`.
The supported deploy steps are:

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

@ -5,8 +5,6 @@ Node Deployment
.. contents::
:depth: 2
.. _node-deployment-deploy-steps:
Overview
========
@ -84,6 +82,13 @@ Accordingly, the following priority ranges can be used for custom deploy steps:
1 to 19
Any steps that are run when the user instance is already running.
In-band steps
-------------
More deploy steps can be provided by the ramdisk, see
:ironic-python-agent-doc:`IPA hardware managers documentation
<admin/hardware_managers.html>` for a listing.
Writing a Deploy Step
---------------------

6
doc/source/contributor/deploy-steps.rst
View File

@ -60,3 +60,9 @@ The above command outputs the ``driver_internal_info`` as following::
Similarly, clean steps can be implemented using the ``clean_step``
decorator.
In-band deploy steps (deploy steps that are run inside the ramdisk) have to be
implemented in a custom :ironic-python-agent-doc:`IPA hardware manager
<contributor/hardware_managers.html#custom-hardwaremanagers-and-deploying>`.
All in-band deploy steps must have priorities between 41 and 99, see
:ref:`node-deployment-core-steps` for details.