summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorMark Goddard <mark@stackhpc.com>2019-12-09 16:45:53 +0000
committerDmitry Tantsur <dtantsur@protonmail.com>2020-07-08 11:09:53 +0200
commit2a6b5c14d5c45728fc63fc89b501beb74a64ca60 (patch)
treef055177242becc932789adfd66f5afe105b6a17d /doc
parentdeec7f4a926b7e032a44a0c56ac4016bf250ef54 (diff)
downloadironic-2a6b5c14d5c45728fc63fc89b501beb74a64ca60.tar.gz
Decompose the core deploy step of the direct deploy
This change decomposes the current deploy step of the direct deploy into multiple deploy steps: * deploy (priority 100) * write_image (priority 80) * prepare_instance_boot (priority 60) Note that this patch breaks backwards compatibility with 3rd party drivers that inherit AgentDeploy rather than the base agent class. Co-Authored-By: Dmitry Tantsur <dtantsur@protonmail.com> Change-Id: Ief586473aca0e22b74efe83ef70c354fd5df17bf Story: 2006963 Task: 37778
Diffstat (limited to 'doc')
-rw-r--r--doc/source/admin/node-deployment.rst29
1 files changed, 28 insertions, 1 deletions
diff --git a/doc/source/admin/node-deployment.rst b/doc/source/admin/node-deployment.rst
index 03dfbfec2..d535a4a75 100644
--- a/doc/source/admin/node-deployment.rst
+++ b/doc/source/admin/node-deployment.rst
@@ -68,7 +68,34 @@ 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.
-.. note:: Priorities 60 to 99 are currently reserved and should not be used.
+Direct deploy
+^^^^^^^^^^^^^
+
+The :ref:`direct-deploy` interface splits the ``deploy.deploy`` step into:
+
+
+``deploy.deploy`` (priority 100)
+ In this step the node is booted using a provisioning image.
+``deploy.write_image`` (priority 80)
+ A combination of an out-of-band and in-band step that downloads and writes
+ the image to the node. The step is executed asynchronously by the ramdisk.
+``deploy.prepare_instance_boot`` (priority 60)
+ In this step the boot device is configured and the bootloader is installed.
+
+Additional priority ranges can be used for custom deploy steps:
+
+81 to 99
+ In-band deploy steps to run before the image is written.
+61 to 79
+ In-band deploy steps to run after the image is written but before the
+ bootloader is installed.
+
+Other deploy interfaces
+^^^^^^^^^^^^^^^^^^^^^^^
+
+Priorities 60 to 99 are currently reserved and should not be used.
+
+.. TODO(dtantsur): update once iscsi and ansible are converted
Writing a Deploy Step
---------------------