ArgoCD

ArgoCD is a declarative, GitOps continuous delivery tool for Kubernetes.

Integrating Cortex with ArgoCD allows you to:

• Send information about ArgoCD syncs into Cortex

  • This data appears on entity detail pages.

• Use Cortex Workflows to automate ArgoCD syncs

• See deploy data for ArgoCD in Eng Intelligence

How to configure ArgoCD with Cortex

Step 1: Use ArgoCD notification webhooks

To send Cortex information about syncs in ArgoCD, use ArgoCD notification Webhooks to call the Cortex deploy REST endpoint.

Example config map

Here is an example of what a argocd-notifications-cm config map may look like:

apiVersion: v1
kind: ConfigMap
data:
  context: |
    argocdUrl: https://argo.company.com
  service.webhook.cortex-webhook: |
    url: https://api.getcortexapp.com
    headers:
    - name: Content-Type
      value: application/json
    - name: Accept
      value: application/json
    - name: Authorization
      value: Bearer $token 
    subscriptions: |
      - recipients:
        - cortex-webhook
        triggers:
        - on-sync-succeeded
  template.app-sync-succeeded: |
    webhook:
      cortex-webhook:
        method: POST
        path: /api/v1/catalog/{{.app.metadata.name}}/deploys 
        body: |
          { "customData": { "Sync Status": "{{.app.status.sync.status}}","Sync Details": "{{.context.argocdUrl}}/applications/{{.app.metadata.name}}?operation=true" },
            "environment": "{{.app.spec.destination.name}}",
            "sha": "{{.app.status.operationState.operation.sync.revision}}",
            "timestamp": "{{.app.status.operationState.finishedAt}}",
            "title": "Sync by ArgoCD",
            "type": "DEPLOY"
          }
  trigger.on-sync-succeeded: |
    - send:
      - app-sync-succeeded
      when: app.status.operationState.phase in ['Succeeded']
        

This example assumes your ArgoCD application's name matches the x-cortex-tag. In this case, each application in ArgoCD can subscribe to the same trigger.

If your application name doesn't match the x-cortex-tag, add a value/pair to the info section of the Application manifest. Then, instead of using .app.metadata.name in the url, use .app.spec.info[0].value.

Step 2: Subscribe application to webhooks

Next, subscribe your application to the webhook. You do this by adding a label annotation in the Application spec in the following format:

    notifications.argoproj.io/subscribe.<trigger-name>.<webhook-name>: ""

For example, if we want to subscribe an application to the example webhook above, the Application YAML may look like the following example:

apiVersion: argoproj.io/v1alpha1
kind: Application
metadata:
  annotations:
    notifications.argoproj.io/subscribe.on-sync-succeeded.cortex-webhook: ""
...  

Using the ArgoCD integration

View ArgoCD data on entity pages

After you configure the integration, you will see data about ArgoCD syncs in an entity's details page:

• On the entity overview, ArgoCD syncs will appear under the Latest events section.\

  
• In the entity's sidebar, click Events to see a full list of events for the entity, including sync events from ArgoCD.

• In the entity's sidebar, click CI/CD > Deploys to see data from the Cortex deploys API, including ArgoCD syncs.\

  

Automate ArgoCD events in Workflows

You can use a Workflow to automate ArgoCD syncs. See this docs page for more information.

See ArgoCD data in Eng Intelligence

Since the ArgoCD integration uses Cortex's deploys API endpoint, ArgoCD data is included in Eng Intelligence deploy metrics. Learn more about Eng Intelligence in the docs.

Troubleshooting and FAQ

What permissions does my API Key need?

The API key needs to be able to call the "Add deployment for entity" API endpoint, so ensure the Edit entities permission is enabled.

Ensure the Cortex API Key is encoded correctly

Make sure the encoded Cortex API Key does not contain an extra line. Use a tool like https://www.base64encode.org/ to ensure your encoded key does not contain an extra line.

Check the ArgoCD logs

The notification webhook is managed by the argocd-notifications-controller which will have a pod running in your ArgoCD namespace.

Assuming the ArgoCD is running in the argocd namepsace, run the following command to get the list of pods:

kubectl get pods -n argocd

This will return a list of pods similar to the ones listed below:

NAME                                                READY   STATUS    RESTARTS   AGE
argocd-application-controller-0                     1/1     Running   0          108d
argocd-applicationset-controller-69f96ccf5b-5jnpv   1/1     Running   0          108d
argocd-dex-server-5dff9c5998-j29zd                  1/1     Running   0          80d
argocd-notifications-controller-6cd988b564-sql55    1/1     Running   0          107d
argocd-redis-54c687db9d-kdxwj                       1/1     Running   0          80d
argocd-repo-server-6c6f8859c7-mrwll                 1/1     Running   0          108d
argocd-server-b77b48886-s2mtg                       1/1     Running   0          80d

In this example, the pod managing the webhook notifications is argocd-notifications-controller-6cd988b564-sql55. To get the logs, run the following command:

kubectl logs argocd-notifications-controller-6cd988b564-sql55 -n argocd

If your trigger was successful, you should seem something similar to this:

time="2023-07-19T02:41:13Z" level=info msg="Start processing" app=argocd/app-direct
time="2023-07-19T02:41:13Z" level=info msg="Trigger on-sync-succeeded result: []" app=argocd/app-direct
time="2023-07-19T02:41:13Z" level=info msg="Notification about condition 'on-sync-succeeded.[0].zxM90Et6k4Elb1-fHdjtDJq0xR0' already sent to ''" app=argocd/app-direct
time="2023-07-19T02:41:13Z" level=info msg="Processing completed" app=argocd/app-direct

Still need help?​

The following options are available to get assistance from the Cortex Customer Engineering team:

• Email: [email protected], or open a support ticket in the in app Resource Center

• Slack: Users with a connected Slack channel will have a workflow added to their account. From here, you can either @CortexTechnicalSupport or add a :ticket: reaction to a question in Slack, and the team will respond directly.

Don’t have a Slack channel? Talk with your Customer Success Manager.