From a9804c7ef691e5cd8f47b24780f6cf5357e099bd Mon Sep 17 00:00:00 2001 From: Mario Villaplana Date: Wed, 9 Nov 2016 19:43:24 +0000 Subject: [PATCH] Add notification documentation to install guide This adds documentation about notifications in ironic to the install guide. Related-Bug: #1526408 Change-Id: I29d924633209326d2b141049f8f43a3d552c9ff4 --- install-guide/source/advanced.rst | 2 ++ install-guide/source/include/notifications.rst | 16 ++++++++++++++++ 2 files changed, 18 insertions(+) create mode 100644 install-guide/source/include/notifications.rst diff --git a/install-guide/source/advanced.rst b/install-guide/source/advanced.rst index 809a2b25a0..9ddf4e7079 100644 --- a/install-guide/source/advanced.rst +++ b/install-guide/source/advanced.rst @@ -10,3 +10,5 @@ Advanced features .. include:: include/kernel-boot-parameters.rst .. include:: include/trusted-boot.rst + +.. include:: include/notifications.rst diff --git a/install-guide/source/include/notifications.rst b/install-guide/source/include/notifications.rst new file mode 100644 index 0000000000..0a14af5545 --- /dev/null +++ b/install-guide/source/include/notifications.rst @@ -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 +`_) 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 `_ 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 `_.