Skip to content

Commit

Permalink
Update InfraCluster contract to include Paused condition
Browse files Browse the repository at this point in the history
  • Loading branch information
theobarberbany committed Sep 27, 2024
1 parent 404084f commit adfa182
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/book/src/developer/providers/contracts/infra-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -308,6 +308,8 @@ If a condition with type `Ready` exist, such condition will be mirrored in Clust
Please note that the `Ready` condition is expected to surface the status of the InfraCluster during its own entire lifecycle,
including initial provisioning, the final deletion process, and the period in between these two moments.

Provider implementers SHOULD implement `Status.Conditions[Paused]` to report if the cluster is paused. It should check if 'spec.paused' is set on the cluster, and for the paused annotation. Implementing this condition is currently optional, but we may revisit this in the future.

See [Cluster API condition proposal] for more context.

<aside class="note warning">
Expand Down

0 comments on commit adfa182

Please sign in to comment.