Skip to content

Latest commit

 

History

History
43 lines (28 loc) · 1.97 KB

README.md

File metadata and controls

43 lines (28 loc) · 1.97 KB

Rocketchat callback plugin for Ansible

Example output

This callback plugin is based on the work of Deepak Kothandan, which has been published on GitHub

Installation

Copy the plugin (rocketchat.py) into your callback_plugins folder and configure at least the webhook.

Make sure that the python module prettytable is installed on your ansible host, otherwise the callback plugin will fail with an warning.

The plugin can be configured via ansible.cfg (section callback_rocketchat) or environment variables:

ini key env var required default description
webhook_url ROCKETCHAT_WEBHOOK_URL YES Rocketchat Webhook URL
username ROCKETCHAT_USERNAME no ansible Username to post as
channel ROCKETCHAT_CHANNEL no (configured in webhook) Rocketchat room to post in. The default (empty) will use the default configured in the webhook.
icon_url ROCKETCHAT_ICON_URL no - URL to image which should be used for user avatar
icon_emoji ROCKETCHAT_ICON_emoji no - Rocketchat emoji which should be used for user avatar
validate_certs ROCKETCHAT_VALIDATE_CERTS no true Validate the TLS certificate of the Rocketchat server. (For HTTPS URLs)

Example configuration:

[callback_rocketchat]
username = Ansible
channel = #yoloops
icon_emoji = :superhero:
webhook_url = https://rocket.example.com/yourrocketchatwebhooktoken

FAQ

I have the prettytable plugins installed, but I still get the warning

This is probably happens, because you have installed the module with pip. Pip installs it into /usr/local/lib/<PYTHONVERSION>/site-packages instead of /usr/lib/<PYTHONVERSION>/site-packages, which is included in ansibles python library path.

If you're using CentOS you can use the RPM package:

$ dnf install python3-prettytable.noarch