argoproj / argo-cd

Declarative Continuous Deployment for Kubernetes
https://argo-cd.readthedocs.io
Apache License 2.0
16.71k stars 5.06k forks source link

Updating the documentation sections pertaining to the defaut resource tracking label #16072

Open PonchonB opened 8 months ago

PonchonB commented 8 months ago

Summary

Hello there, thank you very much for the hard work on developing and maintaining the project. The documentation is very clear and easy to navigate. It greatly helped us setting up ArgoCD in our workflows.

On the subject of resource tracking, it looks like there are some inconsistencies between the Helm value file and the default behavior explained in the resource tracking and Helm sections. The two doc sections state that ArgoCD uses the app.kubernetes.io/instance label to track the Kubernetes resources that each application should manage, however in the chart default value file it looks like the default tracking label (application.instanceLabelKey value) is argocd.argoproj.io/instance. Am I missing something?

Proposal

Update the two pages in the documentation to reflect the default behavior: ArgoCD uses argocd.argoproj.io/instance label and not the app.kubernetes.io/instance label to track the Kubernetes resources managed by each application. I'll gladly make the change myself. I wasn't sure if I had to create an enhancement proposal for such a small documentation update.

RafaelBroseghini commented 1 month ago

Argo does use app.kubernetes.io/instance by default as the tracking label. It uses argocd.argoproj.io/instance by default when installed via Helm but not plain manifests for example.