From 7856406cf32c48de827662862b63f808f6c4bc92 Mon Sep 17 00:00:00 2001 From: Dmitry Tantsur Date: Mon, 30 Sep 2024 14:09:04 +0200 Subject: [PATCH] User guide: expand the detached annotation page Mention the operationalStatus field - this is the only way to know that detachment was successful. Also explain how to re-attach. Remove the paragraph that explains the detachment the 2nd time. Signed-off-by: Dmitry Tantsur --- docs/user-guide/src/bmo/detached_annotation.md | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) diff --git a/docs/user-guide/src/bmo/detached_annotation.md b/docs/user-guide/src/bmo/detached_annotation.md index cc968084..4f889dee 100644 --- a/docs/user-guide/src/bmo/detached_annotation.md +++ b/docs/user-guide/src/bmo/detached_annotation.md @@ -11,6 +11,15 @@ By applying the annotation before removing the BareMetalHost from the old cluste The next step is then to recreate it in the new cluster without triggering a new inspection. See the [status annotation page](./status_annotation.md) for how to do this. +The detached annotation is also useful if you want to move the host under +control of a different management system without fully removing it from +BareMetal Operator. Particularly, detaching a host stops Ironic from trying to +enforce its power state as per the `online` field. + +For more details, please see the [design proposal](https://github.com/metal3-io/metal3-docs/blob/main/design/baremetal-operator/detached-annotation.md). + +## How to detach + The annotation key is `baremetalhost.metal3.io/detached` and the value can be anything (it is ignored). Here is an example: @@ -31,9 +40,9 @@ spec: ... ``` -Why is this annotation needed? +Now wait for the `operationalStatus` field to become `detached`. -- It provides a way to move BareMetalHosts between clusters (essentially deleting them in the old cluster and recreating them in the new) without going through deprovisioning, inspection and provisioning. -- It allows deleting the BareMetalHost object without triggering deprovisioning. This can be used to hand over management of the host to a different system without disruption. +## How to attach again -For more details, please see the [design proposal](https://github.com/metal3-io/metal3-docs/blob/main/design/baremetal-operator/detached-annotation.md). +If you want to attach a previously detached host, remove the annotation and +wait for the `operationalStatus` field to become `OK`.