diff options
| author | Dmitry Tantsur <dtantsur@protonmail.com> | 2021-01-07 17:46:20 +0100 |
|---|---|---|
| committer | Dmitry Tantsur <dtantsur@protonmail.com> | 2021-03-16 16:08:46 +0100 |
| commit | 30a85bd0cecc395a83790e637368ce4476cdf7f9 (patch) | |
| tree | 88217c10787304245bdf0ac3a00de90d22513d00 /api-ref | |
| parent | f152ad370df8bf16e6d4d9ccab8be9a258dc57cf (diff) | |
| download | ironic-30a85bd0cecc395a83790e637368ce4476cdf7f9.tar.gz | |
API to force manual cleaning without booting IPA
Adds a new argument disable_ramdisk to the manual cleaning API.
Only steps that are marked with requires_ramdisk=False can be
run in this mode. Cleaning prepare/tear down is not done.
Some steps (like redfish BIOS) currently require IPA to detect
a successful reboot. They are not marked with requires_ramdisk
just yet.
Change-Id: Icacac871603bd48536188813647bc669c574de2a
Story: #2008491
Task: #41540
Diffstat (limited to 'api-ref')
| -rw-r--r-- | api-ref/source/baremetal-api-v1-node-management.inc | 5 | ||||
| -rw-r--r-- | api-ref/source/parameters.yaml | 8 |
2 files changed, 13 insertions, 0 deletions
diff --git a/api-ref/source/baremetal-api-v1-node-management.inc b/api-ref/source/baremetal-api-v1-node-management.inc index cae2c0689..0d543a669 100644 --- a/api-ref/source/baremetal-api-v1-node-management.inc +++ b/api-ref/source/baremetal-api-v1-node-management.inc @@ -363,6 +363,10 @@ detailed documentation of the Ironic State Machine is available ``deploy_steps`` can be provided when settings the node's provision target state to ``active`` or ``rebuild``. +.. versionadded:: 1.70 + ``disable_ramdisk`` can be provided to avoid booting the ramdisk during + manual cleaning. + Normal response code: 202 Error codes: @@ -382,6 +386,7 @@ Request - clean_steps: clean_steps - deploy_steps: deploy_steps - rescue_password: rescue_password + - disable_ramdisk: disable_ramdisk **Example request to deploy a Node, using a configdrive served via local webserver:** diff --git a/api-ref/source/parameters.yaml b/api-ref/source/parameters.yaml index 62d3f2ec4..2db02f853 100644 --- a/api-ref/source/parameters.yaml +++ b/api-ref/source/parameters.yaml @@ -780,6 +780,14 @@ description: in: body required: true type: string +disable_ramdisk: + description: | + If set to ``true``, the ironic-python-agent ramdisk will not be booted for + cleaning. Only clean steps explicitly marked as not requiring ramdisk can + be executed in this mode. Only allowed for manual cleaning. + in: body + required: false + type: boolean driver_info: description: | All the metadata required by the driver to manage this Node. List of fields |