ironic/install-guide/source/include/notifications.rst
Mario Villaplana a9804c7ef6 Add notification documentation to install guide
This adds documentation about notifications in ironic to the install
guide.

Related-Bug: #1526408
Change-Id: I29d924633209326d2b141049f8f43a3d552c9ff4
2016-11-21 20:18:31 +00:00

17 lines
855 B
ReStructuredText

Notifications
-------------
The Bare Metal service supports the emission of notifications, which are
messages sent on a message broker (like RabbitMQ or anything else supported by
the `oslo messaging library
<http://docs.openstack.org/developer/oslo.messaging/notifier.html>`_) that
indicate various events which occur, such as when a node changes power states.
These can be consumed by an external service reading from the message bus. For
example, `Searchlight <https://wiki.openstack.org/wiki/Searchlight>`_ is an
OpenStack service that uses notifications to index (and make searchable)
resources from the Bare Metal service.
Notifications are disabled by default. For a complete list of available
notifications and instructions for how to enable them, see the `deploy
guide <http://docs.openstack.org/developer/ironic/deploy/notifications.html>`_.