Back to Argo Cd

Annotations and Labels used by Argo CD

docs/user-guide/annotations-and-labels.md

3.5.010.4 KB
Original Source

Annotations and Labels used by Argo CD

Annotations

Annotation keyTarget resource(es)Possible valuesDescription
argocd.argoproj.io/application-set-refreshApplicationSet"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-optionsanysee compare options docsConfigures how an app's current state is compared to its desired state.
argocd.argoproj.io/hookanysee hooks docsUsed to configure resource hooks.
argocd.argoproj.io/hook-delete-policyanysee sync waves docsUsed to set a resource hook's deletion policy.
argocd.argoproj.io/manifest-generate-pathsApplicationsee scaling docsUsed to avoid unnecessary Application refreshes, especially in mono-repos.
argocd.argoproj.io/managed-by-urlApplicationA valid http(s) URLSpecifies 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/refreshApplicationnormal, hardIndicates 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-reconcileApplication, 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-optionsanysee sync options docsProvides a variety of settings to determine how an Application's resources are synced.
argocd.argoproj.io/sync-waveanysee sync waves docs
argocd.argoproj.io/tracking-idanyanyUsed by Argo CD to track resources it manages. See resource tracking docs for details.
argocd.argoproj.io/ignore-default-linksany"true", falseDo not add autogenerated links to the ArgoCD UI from this resource. external URL docs for details.
argocd.argoproj.io/ignore-resource-updatesany"true", falseUsed by Argo CD to ignore resource updates. See reconcile docsreconcile_docs for details.
link.argocd.argoproj.io/{some link name}anyAn http(s) URLAdds a link to the Argo CD UI for the resource. See external URL docs for details.
notice.argocd.argoproj.io/contentApplicationPlain text (truncated at 500 chars)Enables a per-application notice banner on the details page and an icon on the application list/tile. See application notice docs.
notice.argocd.argoproj.io/severityApplicationinfo, warning, critical (default info)Selects the predefined banner/icon styling for the notice.
notice.argocd.argoproj.io/urlApplicationAn http(s) URLIf set, the notice banner text and icon link to this URL.
notice.argocd.argoproj.io/permanentApplication"true", "false" (default false)When true, the notice banner cannot be dismissed by users.
notice.argocd.argoproj.io/iconApplicationAn allowlisted FontAwesome class (e.g. fa-bell)Overrides the severity-derived default icon. Unknown values fall back to the severity default.
notice.argocd.argoproj.io/scopeApplicationbanner, icon, both (default both)Restricts where the notice is shown: details-page banner only, list/tile icon only, or both.
pref.argocd.argoproj.io/default-pod-sortApplicationsee UI customization docsSets the Application's default grouping mechanism.
pref.argocd.argoproj.io/default-viewApplicationsee UI customization docsSets the Application's default view mode (e.g. "tree" or "list")

Labels

Label keyTarget resource(es)Possible valuesDescription
argocd.argoproj.io/instanceApplicationanyRecommended tracking label to avoid conflicts with other tools which use app.kubernetes.io/instance.
argocd.argoproj.io/secret-typeSecretcluster, repository, repo-creds, scm-credsIdentifies 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.