diff options
author | Dmitry Tantsur <dtantsur@protonmail.com> | 2020-09-03 15:20:20 +0200 |
---|---|---|
committer | Dmitry Tantsur <dtantsur@protonmail.com> | 2020-09-03 15:20:20 +0200 |
commit | 44cf63c23773615eb8f045b5f8e939238c010a6e (patch) | |
tree | feeaeaf37882ed0df4d6bc67b0c5a8f169ef0270 /doc/source | |
parent | 11aa5f66398c336699022566cb2d0d3cf7cdfcd1 (diff) | |
download | ironic-44cf63c23773615eb8f045b5f8e939238c010a6e.tar.gz |
Update deploy steps documentation
Mostly links to the recently added IPA docs on in-band steps.
Change-Id: Idb8d2ed94eca89bdf8204f5c9c66c4d5c0fa403b
Story: #2006963
Task: #37790
Diffstat (limited to 'doc/source')
-rw-r--r-- | doc/source/admin/deploy-steps.rst | 2 | ||||
-rw-r--r-- | doc/source/admin/drivers/ilo.rst | 2 | ||||
-rw-r--r-- | doc/source/admin/node-deployment.rst | 9 | ||||
-rw-r--r-- | doc/source/contributor/deploy-steps.rst | 6 |
4 files changed, 15 insertions, 4 deletions
diff --git a/doc/source/admin/deploy-steps.rst b/doc/source/admin/deploy-steps.rst index 1c02da9a7..fb3526365 100644 --- a/doc/source/admin/deploy-steps.rst +++ b/doc/source/admin/deploy-steps.rst @@ -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`. diff --git a/doc/source/admin/drivers/ilo.rst b/doc/source/admin/drivers/ilo.rst index 064318a5f..43026e8d9 100644 --- a/doc/source/admin/drivers/ilo.rst +++ b/doc/source/admin/drivers/ilo.rst @@ -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: diff --git a/doc/source/admin/node-deployment.rst b/doc/source/admin/node-deployment.rst index 3136685ed..b3f8bfe4f 100644 --- a/doc/source/admin/node-deployment.rst +++ b/doc/source/admin/node-deployment.rst @@ -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 --------------------- diff --git a/doc/source/contributor/deploy-steps.rst b/doc/source/contributor/deploy-steps.rst index a12b2867f..7fe5ce47e 100644 --- a/doc/source/contributor/deploy-steps.rst +++ b/doc/source/contributor/deploy-steps.rst @@ -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. |