Files
kamaji/docs/content/guides/pausing.md
Dario Tranchitella e366dc3959 feat: pausing reconciliation of controlled objects (#874)
* feat: pausing reconciliation of controlled objects

Objects such as TenantControlPlane and Secret can be annotated with
kamaji.clastix.io/paused to prevent controllers from processing them.

This will stop reconciling objects for debugging or other purposes.
Annotation value is irrelevant, just the key presence is evaluated.

Signed-off-by: Dario Tranchitella <dario@tranchitella.eu>

* docs: pausing reconciliation of controlled objects

Signed-off-by: Dario Tranchitella <dario@tranchitella.eu>

* chore(logs): typo for deleted resources

Signed-off-by: Dario Tranchitella <dario@tranchitella.eu>

---------

Signed-off-by: Dario Tranchitella <dario@tranchitella.eu>
2025-07-16 10:44:48 +02:00

1.4 KiB

Pausing Reconciliations

Kamaji follows the Kubernetes Operator pattern, which includes implementing a reconciliation loop. This loop continuously reacts to events such as creation, updates, and deletions of resources.

To temporarily disable reconciliation for a resource, you can use the following annotation:

kamaji.clastix.io/paused

!!! info "Annotation value" The annotation key is sufficient on its own: no value is required. Its mere presence disables controller reconciliations.

Pausing TenantControlPlane reconciliations

When you add the kamaji.clastix.io/paused annotation to a TenantControlPlane object, Kamaji will halt all reconciliation processes for that object.

This affects all controllers, including:

  • The primary controller responsible for provisioning resources in the management cluster
  • Secondary (soot) controllers responsible for bootstrapping the control plane, deploying addons, and managing any additional resources handled by Kamaji.

Pausing Secret rotation

Kamaji automatically generates and manages several Secret resources, such as:

  • x509 certificates
  • kubeconfig credentials

These secrets are automatically rotated by Kamaji's built-in Certificate Lifecycle feature.

To temporarily disable secret rotation for these resources, apply the kamaji.clastix.io/paused annotation to the corresponding object.