External-Mirrors/awx
2
0
Fork 0
mirror of https://github.com/ansible/awx.git synced 2026-01-11 01:57:35 -03:30
Code Issues Packages Projects Releases Wiki Activity

Add mattermost to notification_system docs

Browse Source
This commit is contained in:
Nicholas O. Wilburn 2017-09-09 22:25:18 -07:00
parent f347caf825
commit 29451cf88c
1 changed files with 21 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
docs/notification_system.md
View File

@ -35,6 +35,7 @@ The currently defined Notification Types are:
* Email
* Slack
* Hipchat
* Mattermost
* Pagerduty
* Twilio
* IRC
@ -99,6 +100,26 @@ Hipchat allows you to create a team with limited users and message history for f
https://www.hipchat.com/server
## Mattermost
The mattermost notification integration uses Incoming Webhooks. These must be enabled in the System Console of Mattermost. If the user wishes to allow Ansible Tower notifications to modify the Icon URL and username of the notification then they must enabled these options as well.
* `url`: The incoming webhook URL that was configured in Mattermost. Notifications will use this URL to POST.
* `username`: Optional. The username to display for the notification.
* `channel`: Optional. Override the channel to display the notification in. Mattermost incoming webhooks are tied to a channel by default, so if left blank then this will use the incoming webhook channel. Note, if the channel does not exist then the notification will error out.
* `icon_url`: Optional. A URL pointing to an icon to use for the notification.
### Testing considerations
* Make sure all options behave as expected
* Test that all notification options are obeyed
* Test formatting and appearance. Mattermost will use the minimal version of the notification.
### Test Service
* Utilize an existing Mattermost installation or use their docker container here: `docker run --name mattermost-preview -d --publish 8065:8065 mattermost/mattermost-preview`
* Turn on Incoming Webhooks and optionally allow Integrations to override usernames and icons in the System Console.
## Pagerduty
Pager duty is a fairly straightforward integration. The user will create an API Key in the pagerduty system (this will be the token that is given to Tower) and then create a "Service" which will provide an "Integration Key" that will be given to Tower also. The other options of note are: