Skip Application Reconcile¶
This is an experimental, alpha-quality feature. The primary use case is to provide integration with third party projects. This feature may be removed in future releases or modified in backwards-incompatible ways.
Argo CD allows users to stop an Application from reconciling.
The skip reconcile option is configured with the
argocd.argoproj.io/skip-reconcile: "true" annotation.
When the Application is configured to skip reconcile,
all processing is stopped for the Application.
During the period of time when the Application is not processing,
status field will not be updated.
If an Application is newly created with the skip reconcile annotation,
then the Application
status field will not be present.
To resume the reconciliation or processing of the Application,
remove the annotation or set the value to
See the below example for enabling an Application to skip reconcile:
metadata: annotations: argocd.argoproj.io/skip-reconcile: "true"
See the below example for an Application that is newly created with the skip reconcile enabled:
apiVersion: argoproj.io/v1alpha1 kind: Application metadata: annotations: argocd.argoproj.io/skip-reconcile: "true" name: guestbook namespace: argocd spec: destination: namespace: guestbook server: https://kubernetes.default.svc project: default source: path: guestbook repoURL: https://github.com/argoproj/argocd-example-apps.git targetRevision: HEAD
status field is not present.
Primary Use Case¶
The skip reconcile option is intended to be used with third party projects that wishes to make updates to the Application status without having the changes being overwritten by the Application controller. An example of this usage is the Open Cluster Management (OCM) project using pull-integration controller. In the example, the hub cluster Application is not meant to be reconciled by the Argo CD Application controller. Instead, the OCM pull-integration controller will populate the primary/hub cluster Application status using the collected Application status from the remote/spoke/managed cluster.
Alternative Use Cases¶
There are other alternative use cases for this skip reconcile option. It's important to note that this is an experimental, alpha-quality feature and the following use cases are generally not recommended.
- Ease of debugging when the Application reconcile is skipped.
- Orphan resources without deleting the Application might provide a safer way to migrate applications.
- ApplicationSet can generate dry-run like Applications that don't reconcile automatically.
- Pause and resume Applications reconcile during a disaster recovery process.
- Provide another alternative approval flow by not allowing an Application to start reconciling right away.