mirror of
https://github.com/argoproj/argo-cd.git
synced 2026-02-20 01:28:45 +01:00
Signed-off-by: Drew Bailey <drew.bailey@airbnb.com> Co-authored-by: Drew Bailey <drew.bailey@airbnb.com>
8.2 KiB
8.2 KiB
Annotations and Labels used by Argo CD
Annotations
| Annotation key | Target resource(es) | Possible values | Description |
|---|---|---|---|
| argocd.argoproj.io/application-set-refresh | ApplicationSet | "true" |
Added when an ApplicationSet is requested to be refreshed by a webhook. The ApplicationSet controller will remove this annotation at the end of reconciliation. |
| argocd.argoproj.io/compare-options | any | see compare options docs | Configures how an app's current state is compared to its desired state. |
| argocd.argoproj.io/hook | any | see resource hooks docs | Used to configure resource hooks. |
| argocd.argoproj.io/hook-delete-policy | any | see sync waves docs | Used to set a resource hook's deletion policy. |
| argocd.argoproj.io/manifest-generate-paths | Application | see scaling docs | Used to avoid unnecessary Application refreshes, especially in mono-repos. |
| argocd.argoproj.io/managed-by-url | Application | A valid http(s) URL | Specifies the URL of the Argo CD instance managing the application. Used to correctly link to applications managed by a different Argo CD instance. See managed-by-url docs for details. |
| argocd.argoproj.io/refresh | Application | normal, hard |
Indicates that app needs to be refreshed. Removed by application controller after app is refreshed. Value "hard" means manifest cache and target cluster state cache should be invalidated before refresh. |
| argocd.argoproj.io/skip-reconcile | Application, Cluster Secret | "true" |
On an Application, skips reconciliation for that app. On a cluster secret, skips reconciliation for all apps targeting that cluster. See skip reconcile docs. |
| argocd.argoproj.io/sync-options | any | see sync options docs | Provides a variety of settings to determine how an Application's resources are synced. |
| argocd.argoproj.io/sync-wave | any | see sync waves docs | |
| argocd.argoproj.io/tracking-id | any | any | Used by Argo CD to track resources it manages. See resource tracking docs for details. |
| argocd.argoproj.io/ignore-default-links | any | "true", false |
Do not add autogenerated links to the ArgoCD UI from this resource. external URL docs for details. |
| argocd.argoproj.io/ignore-resource-updates | any | "true", false |
Used by Argo CD to ignore resource updates. See reconcile docsreconcile_docs for details. |
| link.argocd.argoproj.io/{some link name} | any | An http(s) URL | Adds a link to the Argo CD UI for the resource. See external URL docs for details. |
| pref.argocd.argoproj.io/default-pod-sort | Application | see UI customization docs | Sets the Application's default grouping mechanism. |
| pref.argocd.argoproj.io/default-view | Application | see UI customization docs | Sets the Application's default view mode (e.g. "tree" or "list") |
Labels
| Label key | Target resource(es) | Possible values | Description |
|---|---|---|---|
| argocd.argoproj.io/instance | Application | any | Recommended tracking label to avoid conflicts with other tools which use app.kubernetes.io/instance. |
| argocd.argoproj.io/secret-type | Secret | cluster, repository, repo-creds, scm-creds |
Identifies certain types of Secrets used by Argo CD. See the Declarative Setup docs for details about the first three, and AppSet-in-any-namespace docs for the last one. |