feat: Enhance ArgoCD CLI: Dynamic Repo Server Retrieval with --core and --refresh Flags #17613

Mangaal · 2024-03-25T14:15:21Z

Description

When using the ArgoCD CLI client with the --core and --refresh flags, it's essential to provide the repo-server-name argument for the default ArgoCD instance deployed with operators. However, in some cases, users might forget to specify this argument, leading to errors.

Current Behavior:
Running the command argocd app list --core or argocd admin app get-reconcile-results --refresh text.txt without providing the repo-server-name flag results in a default value of argocd-repo-server. This default value is not valid for ArgoCD installations with an operator. The actual repo server name is derived from the ArgoCD CR name, such as example-argocd-repo-server if the CR name is example-argocd. Consequently, an error occurs due to the mismatch between the default and actual repo server name.

How to Reproduce the Issue:
To reproduce the issue:

1. Install ArgoCD with an operator.
2. Configure the ArgoCD CustomResource (CR) name, e.g., example-argocd.
3. kubectl config set-context --current --namespace <some-namespace-where-argocd-is-deployed>
4. Execute the `argocd app list --core` command without specifying the repo-server-name flag.

You will encounter the following issue:

FATA[0000] cannot find pod with selector: [app.kubernetes.io/name=argocd-repo-server] - use the --{component}-name flag in this command or set the environmental variable (Refer to https://argo-cd.readthedocs.io/en/stable/user-guide/environment-variables), to change the Argo CD component name in the CLI

Fix:

This pull request enhances the ArgoCD CLI by dynamically fetching the correct repo server name instead of relying solely on a default value. It queries the ArgoCD component services with the label app.kubernetes.io/component=repo-server and updates the repo server name accordingly. If the service query fails, it falls back to the default value. This ensures compatibility with ArgoCD installations using operators and improves overall reliability.

Additionally, this pull request addresses a bug documented in issue #17602

Output after fix:

Checklist:

Signed-off-by: Mangaal <angommeeteimangaal@gmail.com>

…rver labels , if the label exist construct label selector PortForward Signed-off-by: Mangaal <angommeeteimangaal@gmail.com>

Signed-off-by: Mangaal <angommeeteimangaal@gmail.com>

anandf · 2024-03-25T17:29:53Z

cmd/argocd/commands/headless/headless.go

-		repoServerPodLabelSelector := common.LabelKeyAppName + "=" + c.repoServerName
+		repoServerName := c.repoServerName
+		repoServererviceLabelSelector := common.LabelKeyComponentRepoServer + "=" + common.LabelValueComponentRepoServer
+		repoServerServices, err := c.kubeClientset.CoreV1().Services(c.namespace).List(context.Background(), v1.ListOptions{LabelSelector: repoServererviceLabelSelector})


Instead of deriving the argocd instance name from the services, can we not apply the label app.kubernetes.io/component=repo-server to the spec.template.metadata section of the repo server deployment and then use this label to get the right repo server.
https://github.com/argoproj/argo-cd/blob/f87897c53c6f04426953f5d3ca781d3240186a60/manifests/base/repo-server/argocd-repo-server-deployment.yaml#L16C9-L16C51

Hi @anandf, I will update the implementation and add the labels "app.kubernetes.io/component=repo-server" to repo-server replica pods in the manifest

Switching to app.kubernetes.io/component=repo-server component based label might cause confusion when customer provides argument --repo-server-name with the name of the argocd instance argocd-repo-server. So let's keep the logic of deriving the argocd repo server name from the service name.

jannfis

Just a nit regarding the PR's title: Can you please try to find a shorter, more concise title that denotes what actually has been fixed or improved? :)

…cd-cli-core-flag

…o-cd into argocd-cli-core-flag

…mpty ClusterSharding{} Signed-off-by: Mangaal <angommeeteimangaal@gmail.com>

Signed-off-by: Mangaal <angommeeteimangaal@gmail.com>

…o-cd into argocd-cli-core-flag

anandf · 2024-03-27T14:07:15Z

controller/cache/cache.go

@@ -437,7 +437,7 @@ func (c *liveStateCache) getCluster(server string) (clustercache.ClusterCache, e
 		return nil, fmt.Errorf("error getting cluster: %w", err)
 	}

-	if !c.canHandleCluster(cluster) {
+	if !c.canHandleCluster(cluster) && c.clusterSharding == nil {


I think the nil check should come first isn't it ?

Hi @anandf, I have updated the code to handle nil ptr dereference separately

…o-cd into argocd-cli-core-flag

Signed-off-by: Mangaal <angommeeteimangaal@gmail.com>

anandf

LGTM

ishitasequeira · 2024-03-28T12:04:38Z

cmd/argocd/commands/admin/app.go

 				if repoServerAddress == "" {
 					printLine("Repo server is not provided, trying to port-forward to argocd-repo-server pod.")
 					overrides := clientcmd.ConfigOverrides{}
-					repoServerPodLabelSelector := common.LabelKeyAppName + "=" + clientOpts.RepoServerName
+					repoServerName := clientOpts.RepoServerName
+					repoServererviceLabelSelector := common.LabelKeyComponentRepoServer + "=" + common.LabelValueComponentRepoServer


nit: repoServerServiceLabelSelector

Thanks, @ishitasequeira, Updating the same.

ishitasequeira

@Mangaal Just 1 nit. Rest looks good to me!!

…o-cd into argocd-cli-core-flag

Signed-off-by: Mangaal <angommeeteimangaal@gmail.com>

…nd --refresh Flags (argoproj#17613) * add const key value for ComponentRepoServer Signed-off-by: Mangaal <angommeeteimangaal@gmail.com> * update NewRepoServerClient() to look for service with ComponentRepoServer labels , if the label exist construct label selector PortForward Signed-off-by: Mangaal <angommeeteimangaal@gmail.com> * add comment for the new constants Signed-off-by: Mangaal <angommeeteimangaal@gmail.com> * instead of passing nil which leads to nil ptr referance error, pass empty ClusterSharding{} Signed-off-by: Mangaal <angommeeteimangaal@gmail.com> * check for operator install repo server name Signed-off-by: Mangaal <angommeeteimangaal@gmail.com> * handle empty nil ptr dereference error Signed-off-by: Mangaal <angommeeteimangaal@gmail.com> * handle nil prt dereference Signed-off-by: Mangaal <angommeeteimangaal@gmail.com> * typo correction Signed-off-by: Mangaal <angommeeteimangaal@gmail.com> * run clidocsgen Signed-off-by: Mangaal <angommeeteimangaal@gmail.com> --------- Signed-off-by: Mangaal <angommeeteimangaal@gmail.com>

Mangaal added 3 commits March 25, 2024 15:56

add const key value for ComponentRepoServer

87bc574

Signed-off-by: Mangaal <angommeeteimangaal@gmail.com>

update NewRepoServerClient() to look for service with ComponentRepoSe…

4987796

…rver labels , if the label exist construct label selector PortForward Signed-off-by: Mangaal <angommeeteimangaal@gmail.com>

add comment for the new constants

29b0e7a

Signed-off-by: Mangaal <angommeeteimangaal@gmail.com>

Mangaal requested a review from a team as a code owner March 25, 2024 14:15

anandf reviewed Mar 25, 2024

View reviewed changes

jannfis reviewed Mar 25, 2024

View reviewed changes

Merge branch 'master' of https://github.com/Mangaal/argo-cd into argo…

3b060b4

…cd-cli-core-flag

Mangaal changed the title ~~feat: ArgoCD CLI client in core mode requires repo-server-name arg for default ArgoCD instance for ArgoCD deployed with operators~~ feat: ArgoCD CLI client in core mode requires repo-server-name arg Mar 26, 2024

Mangaal changed the title ~~feat: ArgoCD CLI client in core mode requires repo-server-name arg~~ feat: ArgoCD CLI client in core mode requires repo-server-name flag Mar 26, 2024

Mangaal force-pushed the argocd-cli-core-flag branch from 439f521 to 3b060b4 Compare March 26, 2024 13:19

Mangaal and others added 6 commits March 26, 2024 18:50

Merge branch 'master' into argocd-cli-core-flag

5319368

Merge branch 'argocd-cli-core-flag' of https://github.com/Mangaal/arg…

f67255d

…o-cd into argocd-cli-core-flag

Merge branch 'master' into argocd-cli-core-flag

69713b1

instead of passing nil which leads to nil ptr referance error, pass e…

ec4b22a

…mpty ClusterSharding{} Signed-off-by: Mangaal <angommeeteimangaal@gmail.com>

check for operator install repo server name

dde9a3e

Signed-off-by: Mangaal <angommeeteimangaal@gmail.com>

handle empty nil ptr dereference error

eb41e7c

Signed-off-by: Mangaal <angommeeteimangaal@gmail.com>

Mangaal changed the title ~~feat: ArgoCD CLI client in core mode requires repo-server-name flag~~ feat: Enhance ArgoCD CLI: Dynamic Repo Server Retrieval with --core and --refresh Flags Mar 27, 2024

Merge branch 'argocd-cli-core-flag' of https://github.com/Mangaal/arg…

22e28e2

…o-cd into argocd-cli-core-flag

Mangaal mentioned this pull request Mar 27, 2024

Panic Error with 'dist/argocd admin app get-reconcile-results' Command Using --refresh Flag #17602

Open

anandf reviewed Mar 27, 2024

View reviewed changes

Mangaal and others added 4 commits March 27, 2024 20:32

Merge branch 'master' into argocd-cli-core-flag

2610292

Merge branch 'master' into argocd-cli-core-flag

6049c22

Merge branch 'argocd-cli-core-flag' of https://github.com/Mangaal/arg…

4c30993

…o-cd into argocd-cli-core-flag

handle nil prt dereference

58a7e28

Signed-off-by: Mangaal <angommeeteimangaal@gmail.com>

anandf approved these changes Mar 28, 2024

View reviewed changes

ishitasequeira reviewed Mar 28, 2024

View reviewed changes

Mangaal and others added 3 commits March 28, 2024 20:09

Merge branch 'master' into argocd-cli-core-flag

4b1ccee

Merge branch 'argocd-cli-core-flag' of https://github.com/Mangaal/arg…

fdba5b1

…o-cd into argocd-cli-core-flag

typo correction

d051cab

Signed-off-by: Mangaal <angommeeteimangaal@gmail.com>

run clidocsgen

39e5371

Signed-off-by: Mangaal <angommeeteimangaal@gmail.com>

Mangaal requested a review from a team as a code owner March 29, 2024 05:22

ishitasequeira approved these changes Mar 29, 2024

View reviewed changes

ishitasequeira merged commit 766a6da into argoproj:master Mar 29, 2024
27 checks passed

mikutas mentioned this pull request Mar 30, 2024

fix: Check changes to generated code job #17662

Closed

14 tasks

ishitasequeira mentioned this pull request Apr 1, 2024

feat: changes git client to resolve semantic versioning tags #17566

Merged

14 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Enhance ArgoCD CLI: Dynamic Repo Server Retrieval with --core and --refresh Flags #17613

feat: Enhance ArgoCD CLI: Dynamic Repo Server Retrieval with --core and --refresh Flags #17613

Mangaal commented Mar 25, 2024 •

edited

Loading

anandf Mar 25, 2024

Mangaal Mar 26, 2024

anandf Mar 26, 2024

jannfis left a comment

anandf Mar 27, 2024

Mangaal Mar 28, 2024

anandf left a comment

ishitasequeira Mar 28, 2024

Mangaal Mar 28, 2024

ishitasequeira left a comment

feat: Enhance ArgoCD CLI: Dynamic Repo Server Retrieval with --core and --refresh Flags #17613

feat: Enhance ArgoCD CLI: Dynamic Repo Server Retrieval with --core and --refresh Flags #17613

Conversation

Mangaal commented Mar 25, 2024 • edited Loading

Description

Fix:

anandf Mar 25, 2024

Choose a reason for hiding this comment

Mangaal Mar 26, 2024

Choose a reason for hiding this comment

anandf Mar 26, 2024

Choose a reason for hiding this comment

jannfis left a comment

Choose a reason for hiding this comment

anandf Mar 27, 2024

Choose a reason for hiding this comment

Mangaal Mar 28, 2024

Choose a reason for hiding this comment

anandf left a comment

Choose a reason for hiding this comment

ishitasequeira Mar 28, 2024

Choose a reason for hiding this comment

Mangaal Mar 28, 2024

Choose a reason for hiding this comment

ishitasequeira left a comment

Choose a reason for hiding this comment

Mangaal commented Mar 25, 2024 •

edited

Loading