Elgato_dark/argo-cd
1
0
Fork 0
mirror of https://github.com/argoproj/argo-cd synced 2026-04-21 08:57:17 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 14

docs: clarify prune ordering for sync waves (#27352)

Browse source 
Signed-off-by: Revital Barletz <Revital.barletz@octopus.com>
This commit is contained in:
Revital Barletz 2026-04-15 13:22:43 +03:00 committed by GitHub
parent 67de02b1c4
commit bfc332d871
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 6 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
docs/user-guide/sync-waves.md
View file

@ -32,9 +32,11 @@ Here is a graphical overview of the sync process:
You can use this simple lifecycle method in various scenarios. For example you can run an essential check as a PreSync hook. If it fails then the whole sync operation will stop preventing the deployment from taking place. In a similar manner you can run smoke tests as PostSync hooks. If they succeed you know that your application has passed the validation. If they fail then the whole deployment will be marked as failed and Argo CD can then notify you in order to take further actions.
Hooks at the SyncFail phase can be used for cleanup actions and other housekeeping tasks. Note that if they themselves fail, Argo CD will not do anything special (other than marking the whole operation as failed).
Hooks do not run during a selective sync operation. During the SyncFail phase, hooks can be used for cleanup and other housekeeping tasks. If a SyncFail hook itself fails, Argo CD does not take any additional action beyond marking the overall operation as failed.
Note that hooks do not run during a selective sync operation.
During pruning, the wave order is reversed from the creation order. Resources in higher waves are pruned first.
If pruning any resource in a wave fails, the operation is marked as failed, and resources in lower waves are not processed.
This ensures that dependent resources are deleted in the correct order.
## Hook lifecycle and cleanup
@ -57,7 +59,6 @@ When Helm hook annotations are mapped onto Argo CD hooks, delete-policy evaluati
### PreDelete Hooks
PreDelete hooks execute before an Application and its resources are deleted. They run only during Application deletion (e.g., `kubectl delete application` or `argocd app delete`), not during normal sync operations, even when pruning is enabled.
**Behavior:**
1. When an Application is deleted, Argo CD checks for PreDelete hooks defined in the Application's manifests
@ -109,6 +110,8 @@ When a sync operation takes place, Argo CD will:
There is currently a delay between each sync wave in order to give other controllers a chance to react to the spec change that was just applied. This also prevents Argo CD from assessing resource health too quickly (against the stale object), causing hooks to fire prematurely. The current delay between each sync wave is 2 seconds and can be configured via the environment variable ARGOCD_SYNC_WAVE_DELAY.
## Combining Sync waves and hooks
While you can use sync waves on their own, for maximum flexibility you can combine them with hooks. This way you can use sync phases for coarse grained ordering and sync waves for defining the exact order of a resource within an individual phase.