Skip to main content
Version: 3.0.0

How to: Pause / Resume a Composition

Reconciliation can be paused for a specific Composition resource. This is useful for maintenance windows, debugging, or when you want to temporarily prevent Krateo from applying changes to a service.

Concepts: Composition ยท CDC


1. Immediate Pause (Controller-only)โ€‹

To stop the Krateo controller from watching a composition immediately:

kubectl annotate composition <name> krateo.io/paused="true" --overwrite

Effect: The CDC will stop reconciling this specific instance. Any changes made to the Composition resource or the cluster state will be ignored.


2. Graceful Pause (Full Stack)โ€‹

If your Helm chart is configured to support graceful pausing, you can pause the entire application stack (including resources managed by other providers):

kubectl annotate composition <name> krateo.io/gracefully-paused="true" --overwrite

Effect: The CDC performs one final helm upgrade to inject global.gracefullyPaused: true into the chart values, then stops reconciliation.


3. Resume Reconciliationโ€‹

To resume normal operations, remove the annotation:

# To resume from an immediate pause
kubectl annotate composition <name> krateo.io/paused-

# To resume from a graceful pause
kubectl annotate composition <name> krateo.io/gracefully-paused-

Technical Detailsโ€‹

To use this feature, your Helm chart must be updated to support it. See the Values Injection & Pausing documentation for the required chart changes.


Next stepsโ€‹