Skip to content

Commit

Permalink
Merge pull request #473 from dtantsur/detached
Browse files Browse the repository at this point in the history
User guide: expand the detached annotation page
  • Loading branch information
metal3-io-bot authored Oct 8, 2024
2 parents 120c873 + 7856406 commit 75ecc05
Showing 1 changed file with 13 additions and 4 deletions.
17 changes: 13 additions & 4 deletions docs/user-guide/src/bmo/detached_annotation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand All @@ -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`.

0 comments on commit 75ecc05

Please sign in to comment.