Notifications

Envoyer un e-mail ou un message sur un canal quand un job se termine ou qu’il lui arrive quelque chose

Les notifications d’un formulaire indiquent qui est informé de ses jobs, et quand :

  • Qui : recipients, des adresses e-mail, et channels, les noms de canaux de notification (mail, Slack, Microsoft Teams, Telegram, un webhook). Au moins l’un des deux est obligatoire.
  • Quand : onStatus, quand un job se termine (success, failed, aborted, warning ou any), et onEvent, quand il arrive quelque chose à un job (launch, relaunch, delete, approve, reject ou any).
notifications:
  recipients:
    - ops@example.com
  channels:
    - ops-teams
  onStatus:
    - failed
  onEvent:
    - approve
    - reject

When you want to send a notification on job-event: an email, and a message to notification channels (Connections > Notifications: Slack, Microsoft Teams, Telegram, a webhook)

Email Templates
Notification emails use HTML templates located in server/templates/email/:

  • approval.html - Approval request notifications
  • jobstatus.html - Job outcome notifications (success, failed, aborted, warning)
  • jobevent.html - Job lifecycle event notifications (launch, relaunch, delete, approve, reject)

    These templates can be customized by replacing them with your own versions.
    In Docker or Kubernetes deployments, mount your custom templates to /app/dist/templates/email/ to override the defaults.
    Example Docker mount: -v /path/to/custom/templates:/app/dist/templates/email/
    A mount at the former location, /app/dist/src/templates/, keeps working and takes precedence.

Attributs

Les attributs de l’objet notifications :

Attribut Commentaires
recipients
array

Recipients
email address

A list of email addresses who need to receive a notification.
recipients or channels, or both, is needed.
channels
array

Channels
the name of a notification channel

The notification channels of Connections > Notifications the notification goes to: Slack, Microsoft Teams, Telegram, a webhook. They get a short message (the form, the job, what happened) with a link to the job.
A mail channel in this list sends the notification mail to the recipients through that server instead of the active one.
A name that is not there is said in the log and skipped. (Added in 7.0.0)
onStatus
array

Jobstatus event

A list of jobstatus events you want to send a notification on. Use any, if you always want a notification.
At least one of onStatus or onEvent must be specified for notifications to be sent.

Choix :
  • any
  • success
  • failed
  • aborted
  • warning
onEvent
array

Job trigger events

A list of job lifecycle events (triggers) you want to send a notification on.
Unlike onStatus which notifies on job outcomes, onEvent notifies on user actions and job lifecycle events.
Use any to be notified of all job events.

Choix :
  • any
  • launch
  • relaunch
  • delete
  • approve
  • reject

Exemples

Exemples de notifications, en YAML :

1) Send a notification on failed

La définition, en YAML :

notifications:
  recipients:
    - info@ansibleguy.com
  onStatus:
    - failed

2) Send notifications on job events (launch, relaunch, approve, reject)

La définition, en YAML :

notifications:
  recipients:
    - admin@ansibleguy.com
    - auditor@ansibleguy.com
  onEvent:
    - launch
    - relaunch
    - approve
    - reject

3) Send notifications on all events

La définition, en YAML :

notifications:
  recipients:
    - admin@ansibleguy.com
  onStatus:
    - any
  onEvent:
    - launch
    - relaunch
    - delete
    - approve
    - reject