Question:
I am using Ansible to deploy a Django website into my servers (production, staging, etc), and I would like to get a notification (via slack in this case) if and only if any task fails.
I can only figure out how to do it if a specified task fails (so I guess I could add a handler to all tasks), but intuition tells me there has to be an easier and more elegant option.
Basically what I am thinking of is:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 |
--- - hosts: "{{hosts_to_deploy}}" - tasks: [...] - name: notify slack of deploy failure local_action: module: slack token: "{{slack_token}}" msg: "Deploy failed on {{inventory_hostname}}" when: # any task failed |
I have been diving into the Ansible documentation, specially in the error handling section, and answers here at SO, but I’m struggling to find an answer to my question. So any help will be much appreciated.
Answer:
I don’t think a handler is a solution, because a handler will only be notified if the task reports a changed state. On a failed state the handler will not be notified.
Also, handlers by default will not be fired if the playbook failed. But that can be changed. For that you will need to set this in your ansible.cfg:
|
1 2 |
force_handlers = True |
But yes, there are better options available.
If you use Ansible 2 you can use the new blocks feature. Blocks group tasks together and have a rescue section which will be only triggered if any of the tasks have failed.
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 |
tasks: - block: - here - go - all - your - tasks rescue: - name: notify slack of deploy failure local_action: module: slack token: "{{slack_token}}" msg: "Deploy failed on {{inventory_hostname}}" |
Another option and especially interesting if you’re using Ansible 1.x might be callback plugins. As the name suggests with these kind of plugins you can write callbacks which can be fired on various events.
Again, if you’re using Ansible 2 you’re lucky, because there already is a slack callback plugin available: https://github.com/ansible/ansible/blob/devel/lib/ansible/plugins/callback/slack.py
To use this plugin you need to enable it in your ansible.cfg:
|
1 2 |
callback_whitelist = slack |
And define some environment variables on your system for configuration:
|
1 2 3 4 5 6 7 |
This plugin makes use of the following environment variables: SLACK_WEBHOOK_URL (required): Slack Webhook URL SLACK_CHANNEL (optional): Slack room to post in. Default: #ansible SLACK_USERNAME (optional): Username to post as. Default: ansible SLACK_INVOCATION (optional): Show command line invocation details. Default: False |
That plugin might need some modifications to fit your needs. If that’s the case copy the source and store it relative to your playbook as callback_plugins/custom_slack.py and then enable it in your ansible.cfg:
|
1 2 |
callback_whitelist = custom_slack |
If you use Ansible 1.x you’ll have to see how you can convert it. The API is different, examples for the old API can be found here: https://github.com/ansible/ansible/tree/v1.9.4-1/plugins/callbacks