Bootstrap FreeKB - ArgoCD - List Applications using the CLI
ArgoCD - List Applications using the CLI

Updated:   |  ArgoCD articles

This assumes:

The argocd app list command can then be used to list the app you have created.

~]$ argocd app list
NAME                            CLUSTER                                     NAMESPACE         PROJECT  STATUS     HEALTH    SYNCPOLICY  CONDITIONS                REPO                                                     PATH       TARGET
openshift-gitops/my-app         https://kubernetes.default.svc              my-project        default  OutOfSync  Healthy   Manual      SharedResourceWarning(5)  https://github.com/my_project/my_repo.git  python
openshift-gitops/hello-world    https://api.dev.openshift.example.com:6443  default           default                       Manual      <none>                    https://github.com/my_project/my_repo.git  python
openshift-gitops/bad-app        https://kubernetes.default.svc              openshift-gitops  default  OutOfSync  Degraded  Manual      <none>                    https://github.com/my_project/my_repo.git  resources

 

Or on the Kubernetes or OpenShift cluster that ArgoCD is in the kubectl (Kubernetes) or oc (OpenShift) exec command can be used to run the argocd cluster list command in the ArgoCD server pod. It is noteworthy that by default the argocd login command will create the hidden .config file in the root directory of the operating system /.config and only root has permission to create files in the root directory of the operating system thus the --config /home/argocd/.config option is used so that the hidden .config file is create in our users home directory.

~]$ SERVER_POD=$(oc get pod --namespace openshift-gitops --selector=app.kubernetes.io/name=openshift-gitops-server --output custom-columns=POD:.metadata.name --no-headers)
~]$ ADMIN_PASSWD=$(oc get secret openshift-gitops-cluster --namespace openshift-gitops --output jsonpath='{.data.admin\.password}' | base64 --decode)
~]$ URL=$(oc get routes --namespace openshift-gitops --selector=app.kubernetes.io/name=openshift-gitops-server --output jsonpath="{.items[*].spec.host}")

~]$ oc exec $SERVER_POD --namespace openshift-gitops -- /bin/bash -c "argocd login --username admin --password $ADMIN_PASSWD $URL:443 --insecure --grpc-web --config /home/argocd/.config; argocd app list --server $URL:443 --insecure --grpc-web --config /home/argocd/.config"
'admin:login' logged in successfully
NAME                            CLUSTER                                     NAMESPACE         PROJECT  STATUS     HEALTH    SYNCPOLICY  CONDITIONS                REPO                                                     PATH       TARGET
openshift-gitops/my-app         https://kubernetes.default.svc              my-project        default  OutOfSync  Healthy   Manual      SharedResourceWarning(5)  https://github.com/my_project/my_repo.git  python
openshift-gitops/hello-world    https://api.dev.openshift.example.com:6443  default           default                       Manual      <none>                    https://github.com/my_project/my_repo.git  python
openshift-gitops/bad-app        https://kubernetes.default.svc              openshift-gitops  default  OutOfSync  Degraded  Manual      <none>                    https://github.com/my_project/my_repo.git  resources

 

The kubectl (Kubernetes) or oc (OpenShift) login command to log into the Kubernetes or OpenShift cluster that ArgoCD is running in and then use the auth can-i command can be used to determine if you have permission to list an ArgoCD application.

~]$ oc login -u john.doe api.dev.openshift.example.com:6443

~]$ oc auth can-i list applications.argoproj.io
yes

 

Assuming you have permission to list an application the kubectl (Kubernetes) or oc (OpenShift) get applications.argoproj.io command can be used to list the ArgoCD applications.

~]$ oc get applications.argoproj.io --namespace <the namespace argocd is in, usually argocd or openshift-gitops>
NAME                               SYNC STATUS   HEALTH STATUS
my-app                             Synced        Healthy
hello-world
bad-app                            OutOfSync     Degraded

 

The argocd app get command can be used to display more details.

~]$ argocd app get openshift-gitops/my-app
Name:               openshift-gitops/my-app
Project:            default
Server:             https://kubernetes.default.svc
Namespace:          my-project
URL:                https://openshift-gitops-server-openshift-gitops.apps.openshift.example.com/applications/my-app
Source:
- Repo:             https://github.com/my_project/my_repo.git
  Target:
  Path:             python
SyncWindow:         Sync Allowed
Sync Policy:        Manual
Sync Status:        OutOfSync from  (dbc57d6)
Health Status:      Missing

GROUP  KIND        NAMESPACE  NAME    STATUS     HEALTH   HOOK  MESSAGE
apps   Deployment  my-project python  OutOfSync  Missing

 

The --output json flag can be used to display output as JSON instead of YAML.

~]$ argocd app get openshift-gitops/my-app --output json
{
  "metadata": {
    "name": "my-app",
    "namespace": "openshift-gitops",
    "uid": "e6d7b10c-74f0-4c2a-b4b2-6d82a8b987ca",
    "resourceVersion": "405164309",
    "generation": 2,
    "creationTimestamp": "2024-12-20T02:34:18Z",
    "managedFields": [
      {
        "manager": "argocd-application-controller",
        "operation": "Update",
        "apiVersion": "argoproj.io/v1alpha1",
        "time": "2024-12-20T02:34:18Z",
        "fieldsType": "FieldsV1",
        "fieldsV1": {
          "f:status": {
            "f:controllerNamespace": {},
            "f:health": {
              "f:status": {}
            },
            "f:reconciledAt": {},
            "f:resources": {},
            "f:sourceType": {},
            "f:sync": {
              "f:comparedTo": {
                "f:destination": {
                  "f:namespace": {},
                  "f:server": {}
                },
                "f:source": {
                  "f:path": {},
                  "f:repoURL": {}
                }
              },
              "f:revision": {},
              "f:status": {}
            }
          }
        }
      },
      {
        "manager": "argocd-server",
        "operation": "Update",
        "apiVersion": "argoproj.io/v1alpha1",
        "time": "2024-12-20T02:34:18Z",
        "fieldsType": "FieldsV1",
        "fieldsV1": {
          "f:spec": {
            ".": {},
            "f:destination": {
              ".": {},
              "f:namespace": {},
              "f:server": {}
            },
            "f:project": {},
            "f:source": {
              ".": {},
              "f:path": {},
              "f:repoURL": {}
            }
          },
          "f:status": {
            ".": {},
            "f:health": {},
            "f:summary": {},
            "f:sync": {
              ".": {},
              "f:comparedTo": {
                ".": {},
                "f:destination": {},
                "f:source": {}
              }
            }
          }
        }
      }
    ]
  },
  "spec": {
    "source": {
      "repoURL": "https://github.com/my_project/my_repo.git",
      "path": "python"
    },
    "destination": {
      "server": "https://kubernetes.default.svc",
      "namespace": "my-project"
    },
    "project": "default"
  },
  "status": {
    "resources": [
      {
        "group": "apps",
        "version": "v1",
        "kind": "Deployment",
        "namespace": "my-project",
        "name": "python",
        "status": "OutOfSync",
        "health": {
          "status": "Missing"
        }
      }
    ],
    "sync": {
      "status": "OutOfSync",
      "comparedTo": {
        "source": {
          "repoURL": "https://github.com/my_project/my_repo.git",
          "path": "python"
        },
        "destination": {
          "server": "https://kubernetes.default.svc",
          "namespace": "my-project"
        }
      },
      "revision": "dbc57d62045ddae6c68f925b7cb3f6a1f621bd81"
    },
    "health": {
      "status": "Missing"
    },
    "reconciledAt": "2024-12-20T02:34:18Z",
    "sourceType": "Directory",
    "summary": {},
    "controllerNamespace": "openshift-gitops"
  }
}

 




Did you find this article helpful?

If so, consider buying me a coffee over at Buy Me A Coffee



Comments


Add a Comment


Please enter b4f59f in the box below so that we can be sure you are a human.