Troubleshooting

Troubleshooting

The argocd-notifications binary includes a set of CLI commands that helps to configure the controller settings and troubleshoot issues.

Global flags

Following global flags are available for all sub-commands:

  • config-map - path to the file containing argocd-notifications-cm ConfigMap. If not specified then the command loads argocd-notification-cm ConfigMap using the local Kubernetes config file.
  • secret - path to the file containing argocd-notifications-secret ConfigMap. If not specified then the command loads argocd-notification-secret Secret using the local Kubernetes config file. Additionally, you can specify :empty value to use empty secret with no notification service settings.

Examples:

  • Get list of triggers configured in the local config map:
  1. argocd-notifications trigger get \
  2.   --config-map ./argocd-notifications-cm.yaml --secret :empty
  • Trigger notification using in-cluster config map and secret:
  1. argocd-notifications template notify \
  2.   app-sync-succeeded guestbook --recipient slack:argocd-notifications

Kustomize

If you are managing argocd-notifications config using Kustomize you can pipe whole kustomize build output into stdin using --config-map - flag:

  1. kustomize build ./argocd-notifications | \
  2.   argocd-notifications \
  3.   template notify app-sync-succeeded guestbook --recipient grafana:argocd \
  4.   --config-map -

How to get it

On your laptop

You can download argocd-notifications from the github release attachments.

The binary is available in argoprojlabs/argocd-notifications image. Use the docker run and volume mount to execute binary on any platform.

Example:

  1. docker run --rm -it -w /src -v $(pwd):/src \
  2.   argoprojlabs/argocd-notifications:<version> \
  3.   /app/argocd-notifications trigger get \
  4.   --config-map ./argocd-notifications-cm.yaml --secret :empty

In your cluster

SSH into the running argocd-notifications-controller pod and use kubectl exec command to validate in-cluster configuration.

Example

  1. kubectl exec -it argocd-notifications-controller-<pod-hash> \
  2.   /app/argocd-notifications trigger get

Commands

notifications template get

Prints information about configured templates

  1. notifications template get [flags]

Examples

  1. # prints all templates
  2. notifications template get
  3. # print YAML formatted app-sync-succeeded template definition
  4. notifications template get app-sync-succeeded -o=yaml

Options

  1.   -h, --help            help for get
  2.   -o, --output string   Output format. One of:json|yaml|wide|name (default "wide")

Options inherited from parent commands

  1.       --argocd-repo-server string       Argo CD repo server address (default "argocd-repo-server:8081")
  2.       --argocd-repo-server-plaintext    Use a plaintext client (non-TLS) to connect to repository server
  3.       --argocd-repo-server-strict-tls   Perform strict validation of TLS certificates when connecting to repo server
  4.       --as string                       Username to impersonate for the operation
  5.       --as-group stringArray            Group to impersonate for the operation, this flag can be repeated to specify multiple groups.
  6.       --as-uid string                   UID to impersonate for the operation
  7.       --certificate-authority string    Path to a cert file for the certificate authority
  8.       --client-certificate string       Path to a client certificate file for TLS
  9.       --client-key string               Path to a client key file for TLS
  10.       --cluster string                  The name of the kubeconfig cluster to use
  11.       --config-map string               argocd-notifications-cm.yaml file path
  12.       --context string                  The name of the kubeconfig context to use
  13.       --insecure-skip-tls-verify        If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
  14.       --kubeconfig string               Path to a kube config. Only required if out-of-cluster
  15.   -n, --namespace string                If present, the namespace scope for this CLI request
  16.       --password string                 Password for basic authentication to the API server
  17.       --request-timeout string          The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
  18.       --secret string                   argocd-notifications-secret.yaml file path. Use empty secret if provided value is ':empty'
  19.       --server string                   The address and port of the Kubernetes API server
  20.       --tls-server-name string          If provided, this name will be used to validate server certificate. If this is not provided, hostname used to contact the server is used.
  21.       --token string                    Bearer token for authentication to the API server
  22.       --user string                     The name of the kubeconfig user to use
  23.       --username string                 Username for basic authentication to the API server

notifications template notify

Generates notification using the specified template and send it to specified recipients

  1. notifications template notify NAME RESOURCE_NAME [flags]

Examples

  1. # Trigger notification using in-cluster config map and secret
  2. notifications template notify app-sync-succeeded guestbook --recipient slack:my-slack-channel
  4. # Render notification render generated notification in console
  5. notifications template notify app-sync-succeeded guestbook

Options

  1.   -h, --help                    help for notify
  2.       --recipient stringArray   List of recipients (default [console:stdout])

Options inherited from parent commands

  1.       --argocd-repo-server string       Argo CD repo server address (default "argocd-repo-server:8081")
  2.       --argocd-repo-server-plaintext    Use a plaintext client (non-TLS) to connect to repository server
  3.       --argocd-repo-server-strict-tls   Perform strict validation of TLS certificates when connecting to repo server
  4.       --as string                       Username to impersonate for the operation
  5.       --as-group stringArray            Group to impersonate for the operation, this flag can be repeated to specify multiple groups.
  6.       --as-uid string                   UID to impersonate for the operation
  7.       --certificate-authority string    Path to a cert file for the certificate authority
  8.       --client-certificate string       Path to a client certificate file for TLS
  9.       --client-key string               Path to a client key file for TLS
  10.       --cluster string                  The name of the kubeconfig cluster to use
  11.       --config-map string               argocd-notifications-cm.yaml file path
  12.       --context string                  The name of the kubeconfig context to use
  13.       --insecure-skip-tls-verify        If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
  14.       --kubeconfig string               Path to a kube config. Only required if out-of-cluster
  15.   -n, --namespace string                If present, the namespace scope for this CLI request
  16.       --password string                 Password for basic authentication to the API server
  17.       --request-timeout string          The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
  18.       --secret string                   argocd-notifications-secret.yaml file path. Use empty secret if provided value is ':empty'
  19.       --server string                   The address and port of the Kubernetes API server
  20.       --tls-server-name string          If provided, this name will be used to validate server certificate. If this is not provided, hostname used to contact the server is used.
  21.       --token string                    Bearer token for authentication to the API server
  22.       --user string                     The name of the kubeconfig user to use
  23.       --username string                 Username for basic authentication to the API server

notifications trigger get

Prints information about configured triggers

  1. notifications trigger get [flags]

Examples

  1. # prints all triggers
  2. notifications trigger get
  3. # print YAML formatted on-sync-failed trigger definition
  4. notifications trigger get on-sync-failed -o=yaml

Options

  1.   -h, --help            help for get
  2.   -o, --output string   Output format. One of:json|yaml|wide|name (default "wide")

Options inherited from parent commands

  1.       --argocd-repo-server string       Argo CD repo server address (default "argocd-repo-server:8081")
  2.       --argocd-repo-server-plaintext    Use a plaintext client (non-TLS) to connect to repository server
  3.       --argocd-repo-server-strict-tls   Perform strict validation of TLS certificates when connecting to repo server
  4.       --as string                       Username to impersonate for the operation
  5.       --as-group stringArray            Group to impersonate for the operation, this flag can be repeated to specify multiple groups.
  6.       --as-uid string                   UID to impersonate for the operation
  7.       --certificate-authority string    Path to a cert file for the certificate authority
  8.       --client-certificate string       Path to a client certificate file for TLS
  9.       --client-key string               Path to a client key file for TLS
  10.       --cluster string                  The name of the kubeconfig cluster to use
  11.       --config-map string               argocd-notifications-cm.yaml file path
  12.       --context string                  The name of the kubeconfig context to use
  13.       --insecure-skip-tls-verify        If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
  14.       --kubeconfig string               Path to a kube config. Only required if out-of-cluster
  15.   -n, --namespace string                If present, the namespace scope for this CLI request
  16.       --password string                 Password for basic authentication to the API server
  17.       --request-timeout string          The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
  18.       --secret string                   argocd-notifications-secret.yaml file path. Use empty secret if provided value is ':empty'
  19.       --server string                   The address and port of the Kubernetes API server
  20.       --tls-server-name string          If provided, this name will be used to validate server certificate. If this is not provided, hostname used to contact the server is used.
  21.       --token string                    Bearer token for authentication to the API server
  22.       --user string                     The name of the kubeconfig user to use
  23.       --username string                 Username for basic authentication to the API server

notifications trigger run

Evaluates specified trigger condition and prints the result

  1. notifications trigger run NAME RESOURCE_NAME [flags]

Examples

  1. # Execute trigger configured in 'argocd-notification-cm' ConfigMap
  2. notifications trigger run on-sync-status-unknown ./sample-app.yaml
  4. # Execute trigger using my-config-map.yaml instead of 'argocd-notifications-cm' ConfigMap
  5. notifications trigger run on-sync-status-unknown ./sample-app.yaml \
  6.     --config-map ./my-config-map.yaml

Options

  1.   -h, --help   help for run

Options inherited from parent commands

  1.       --argocd-repo-server string       Argo CD repo server address (default "argocd-repo-server:8081")
  2.       --argocd-repo-server-plaintext    Use a plaintext client (non-TLS) to connect to repository server
  3.       --argocd-repo-server-strict-tls   Perform strict validation of TLS certificates when connecting to repo server
  4.       --as string                       Username to impersonate for the operation
  5.       --as-group stringArray            Group to impersonate for the operation, this flag can be repeated to specify multiple groups.
  6.       --as-uid string                   UID to impersonate for the operation
  7.       --certificate-authority string    Path to a cert file for the certificate authority
  8.       --client-certificate string       Path to a client certificate file for TLS
  9.       --client-key string               Path to a client key file for TLS
  10.       --cluster string                  The name of the kubeconfig cluster to use
  11.       --config-map string               argocd-notifications-cm.yaml file path
  12.       --context string                  The name of the kubeconfig context to use
  13.       --insecure-skip-tls-verify        If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
  14.       --kubeconfig string               Path to a kube config. Only required if out-of-cluster
  15.   -n, --namespace string                If present, the namespace scope for this CLI request
  16.       --password string                 Password for basic authentication to the API server
  17.       --request-timeout string          The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
  18.       --secret string                   argocd-notifications-secret.yaml file path. Use empty secret if provided value is ':empty'
  19.       --server string                   The address and port of the Kubernetes API server
  20.       --tls-server-name string          If provided, this name will be used to validate server certificate. If this is not provided, hostname used to contact the server is used.
  21.       --token string                    Bearer token for authentication to the API server
  22.       --user string                     The name of the kubeconfig user to use
  23.       --username string                 Username for basic authentication to the API server

Errors

Failed to parse new settings

error converting YAML to JSON

YAML syntax is incorrect.

incorrect:

  1. apiVersion: v1
  2. kind: ConfigMap
  3. metadata:
  4.   name: argocd-notifications-cm
  5. data:
  6.   service.slack: |
  7.     token: $slack-token
  8.     icon: :rocket:

correct:

  1. apiVersion: v1
  2. kind: ConfigMap
  3. metadata:
  4.   name: argocd-notifications-cm
  5. data:
  6.   service.slack: |
  7.     token: $slack-token
  8.     icon: ":rocket:"

service type ‘xxxx’ is not supported

You need to check your argocd-notifications controller version. For instance, the teams integration is to support v1.1.0 and more.

Failed to notify recipient

notification service ‘xxxx’ is not supported”

You have not defined xxxx in argocd-notifications-cm or to fail to parse settings.