openstack
/
ironic
Code Issues Proposed changes

Add notification documentation to install guide 

This adds documentation about notifications in ironic to the install
guide.

Related-Bug: #1526408
Change-Id: I29d924633209326d2b141049f8f43a3d552c9ff4
This commit is contained in:
Mario Villaplana 2016-11-09 19:43:24 +00:00
parent cb2971ba27
commit a9804c7ef6
2 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
install-guide/source/advanced.rst
View File

@ -10,3 +10,5 @@ Advanced features
.. include:: include/kernel-boot-parameters.rst
.. include:: include/trusted-boot.rst
.. include:: include/notifications.rst

16
install-guide/source/include/notifications.rst Normal file
View File

@ -0,0 +1,16 @@
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>`_.