Skip to content

Grafana

To be able to create Grafana annotation with argocd-notifications you have to create an API Key inside your Grafana.

sample

Available parameters :

  • apiURL - the server url, e.g. https://grafana.example.com
  • apiKey - the API key for the serviceaccount
  • insecureSkipVerify - optional bool, true or false
  • maxIdleConns - optional, maximum number of idle (keep-alive) connections across all hosts.
  • maxIdleConnsPerHost - optional, maximum number of idle (keep-alive) connections per host.
  • maxConnsPerHost - optional, maximum total connections per host.

  • idleConnTimeout - optional, maximum amount of time an idle (keep-alive) connection will remain open before closing.

  • Login to your Grafana instance as admin

  • On the left menu, go to Configuration / API Keys
  • Click "Add API Key"
  • Fill the Key with name ArgoCD Notification, role Editor and Time to Live 10y (for example)
  • Click on Add button
  • Store apiKey in argocd-notifications-secret Secret and Copy your API Key and define it in argocd-notifications-cm ConfigMap
apiVersion: v1
kind: ConfigMap
metadata:
  name: argocd-notifications-cm
data:
  service.grafana: |
    apiUrl: https://grafana.example.com/api
    apiKey: $grafana-api-key

apiVersion: v1
kind: Secret
metadata:
  name: <secret-name>
stringData:
  grafana-api-key: api-key
  1. Create a template in argo-notifications-cm Configmap This will be used to pass the (required) text of the annocation to Grafana (or re-use an existing one) As there is no specific template for Grafana, you must use the generic message:
apiVersion: v1
kind: ConfigMap
metadata:
  name: argocd-notifications-cm
data:
  templates:
    template.app-deployed: |
      messsage: Application {{.app.metadata.name}} is now running new version of deployments manifests.
  1. Create subscription for your Grafana integration
apiVersion: argoproj.io/v1alpha1
kind: Application
metadata:
  annotations:
    notifications.argoproj.io/subscribe.<trigger-name>.grafana: tag1|tag2 # list of tags separated with |
  1. Change the annotations settings 8