opendev/system-config
Code Issues Proposed changes

Merge "Add firehose documentation for notifications"

Browse Source
This commit is contained in:
Jenkins 2017-08-02 18:16:08 +00:00 committed by Gerrit Code Review
commit b0a2efbcfb
1 changed files with 17 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
doc/source/firehose.rst
View File

@ -298,6 +298,23 @@ Or with ruby:
puts message
end
Example Use Cases
=================
Event Notifications
-------------------
A common use case for the event bus is to get a notification when an event
occurs. There is an open source tool, `mqttwarn`_ that makes setting this up
off the firehose (or any other mqtt broker) very straightforward.
.. _mqttwarn: https://github.com/jpmens/mqttwarn
You can use mqttwarn to setup custom notifications to a large number of tools
and services. (both local and remote). You can read the full docs on how to
configure and use mqttwarn at https://github.com/jpmens/mqttwarn/wiki and
https://github.com/jpmens/mqttwarn/blob/master/README.md
IMAP and MX
===========