Skip to content

Commit

Permalink
Update InfraCluster contract to include Pausing rule
Browse files Browse the repository at this point in the history
  • Loading branch information
theobarberbany committed Oct 1, 2024
1 parent 404084f commit ccd3d15
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions docs/book/src/developer/providers/contracts/infra-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -335,6 +335,12 @@ the implication of this choice which are described both in the document above an

</aside>

### InfraCluster: Pausing

Providers SHOULD implement the pause behaviour for every object with a reconciliation loop. This is done by checking if `spec.paused` is set, or for the paused annotation: `cluster.x-k8s.io/paused`.

If implementing the pause behavior, providers SHOULD surface the paused status of an object using the Paused condition: `Status.Conditions[Paused]`.

### InfraCluster: terminal failures

Each InfraCluster SHOULD report when Cluster's enter in a state that cannot be recovered (terminal failure) by
Expand Down

0 comments on commit ccd3d15

Please sign in to comment.