From ccd3d15f8f74d0562e891b932b31cc0396940bae Mon Sep 17 00:00:00 2001 From: Theo Barber-Bany Date: Thu, 26 Sep 2024 15:35:27 +0100 Subject: [PATCH] Update InfraCluster contract to include Pausing rule --- .../book/src/developer/providers/contracts/infra-cluster.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/book/src/developer/providers/contracts/infra-cluster.md b/docs/book/src/developer/providers/contracts/infra-cluster.md index 0908e1e33e87..d6cfb4ffc8fc 100644 --- a/docs/book/src/developer/providers/contracts/infra-cluster.md +++ b/docs/book/src/developer/providers/contracts/infra-cluster.md @@ -335,6 +335,12 @@ the implication of this choice which are described both in the document above an +### 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