diff options
author | Mark Goddard <mark@stackhpc.com> | 2019-12-09 16:45:53 +0000 |
---|---|---|
committer | Dmitry Tantsur <dtantsur@protonmail.com> | 2020-07-13 11:36:00 +0200 |
commit | 63f6adf68ee76295a6ce8157362548ad10af8473 (patch) | |
tree | 443014360bbc580e1cc127d6a566cf86164c8f87 /doc | |
parent | 2a6b5c14d5c45728fc63fc89b501beb74a64ca60 (diff) | |
download | ironic-63f6adf68ee76295a6ce8157362548ad10af8473.tar.gz |
Decompose the core deploy step on iscsi and ansible deploy
Following the decomposition of the core step on the 'direct' deploy
interface, this change decomposed the iscsi and ansible deploy.
Co-Authored-By: Dmitry Tantsur <dtantsur@protonmail.com>
Change-Id: I537c6f6cf66c80b67b9045ea0618b02b7b93d36c
Story: #2006963
Task: #40152
Diffstat (limited to 'doc')
-rw-r--r-- | doc/source/admin/node-deployment.rst | 49 |
1 files changed, 18 insertions, 31 deletions
diff --git a/doc/source/admin/node-deployment.rst b/doc/source/admin/node-deployment.rst index d535a4a75..3136685ed 100644 --- a/doc/source/admin/node-deployment.rst +++ b/doc/source/admin/node-deployment.rst @@ -47,8 +47,10 @@ All deploy interfaces based on ironic-python-agent (i.e. ``direct``, ``iscsi`` and ``ansible`` and any derivatives) expose the following deploy steps: ``deploy.deploy`` (priority 100) - In this step the node is booted using a provisioning image, and the user - image is written to the node's disk. + In this step the node is booted using a provisioning image. +``deploy.write_image`` (priority 80) + An out-of-band (``iscsi``, ``ansible``) or in-band (``direct``) step that + downloads and writes the image to the node. ``deploy.tear_down_agent`` (priority 40) In this step the provisioning image is shut down. ``deploy.switch_to_tenant_network`` (priority 30) @@ -57,45 +59,30 @@ and ``ansible`` and any derivatives) expose the following deploy steps: ``deploy.boot_instance`` (priority 20) In this step the node is booted into the user image. -Accordingly, the following priority ranges can be used for custom deploy steps: - -> 100 - Out-of-band steps to run before deployment. -41 to 59 - In-band steps to run after the image is written the bootloader is installed. -21 to 39 - Out-of-band steps to run after the provisioning image is shut down. -1 to 19 - Any steps that are run when the user instance is already running. - -Direct deploy -^^^^^^^^^^^^^ - -The :ref:`direct-deploy` interface splits the ``deploy.deploy`` step into: +Additionally, the ``iscsi`` and ``direct`` deploy interfaces have: - -``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: + .. note:: + For the ``ansible`` deploy interface these steps are done in + ``deploy.write_image``. + +Accordingly, the following priority ranges can be used for custom deploy steps: +> 100 + Out-of-band steps to run before deployment. 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 +41 to 59 + In-band steps to run after the image is written the bootloader is installed. +21 to 39 + Out-of-band steps to run after the provisioning image is shut down. +1 to 19 + Any steps that are run when the user instance is already running. Writing a Deploy Step --------------------- |