Skip to content

Commit

Permalink
Address comments
Browse files Browse the repository at this point in the history
  • Loading branch information
fabriziopandini committed Sep 26, 2024
1 parent 50b0de4 commit 868ccf0
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions docs/book/src/developer/providers/contracts/infra-machine.md
Original file line number Diff line number Diff line change
Expand Up @@ -223,22 +223,22 @@ In case you are developing an infrastructure provider which has a notion of fail
placed in, the InfraMachine resource MUST comply to the value that exists in the `spec.failureDomain` field of the Machine
(in other words, the InfraMachine MUST be placed in the failure domain specified at Machine level).

Please note, that for allowing transition from the failure domain model in use before CAPI 1.3.0,
Cluster API still supports a _deprecated_ reverse process, where the InfraMachine is authoritative WRT to
to the failure domain placement (instead of the the Machine).
Please note, that for allowing a transparent transition from when there was no failure domain support in Cluster API
and InfraMachine was authoritative WRT to failure domain placement (before CAPI v1.3.0),
Cluster API still supports a _deprecated_ reverse process for failure domain management.

In the _deprecated_ reverse process, the the failure domain where the machine is actually placed is defined in the InfraMachine's
In the _deprecated_ reverse process, the the failure domain where the machine should be placed is defined in the InfraMachine's
`spec.failureDomain` field; the value of this field is then surfaced on the corresponding field at Machine level.

<aside class="note warning">

<h1>Heads up! this will change with the v1beta2 contract</h1>

In order to avoid the confusion of the two-way contract that exists for historical reasons, Machine's controller
will stop reading InfraMachine's `spec.failureDomain` from machines.
Machine's controller will stop supporting the _deprecated_ reverse process; the InfraMachine's `spec.failureDomain`,
if still present, will be ignored.

However, InfraMachine will be allowed to surface the failure domain where the machine is actually placed in by
implementing a new, optional `status.failureDomain`; this info will then surface at Machine level in a
implementing a new, optional `status.failureDomain`; this info, if present, will then surface at Machine level in a
new corresponding field (also in status).

```go
Expand Down

0 comments on commit 868ccf0

Please sign in to comment.