openstack
/
senlin
Code Issues Proposed changes

revise the event dispatcher document 

This patch revise the user document of event dispatcher
to clear how to configure it.

Change-Id: I33147e699620e89445713733e96e07b7fdbfeb3f
This commit is contained in:
ruijie 2017-10-19 16:47:49 +08:00
parent a6176569cf
commit a3c97805ea
1 changed files with 22 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
doc/source/user/events.rst
View File

@ -42,22 +42,23 @@ level value of the event:
serious problems encountered by the engine. The engine service may have
run into some bugs. User intervention is required to do a recovery.
Event Dispatcher Configuration
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Senlin provides an open architecture for event dispatching. Two of the
built-in dispatchers are ``database`` and ``message``. The ``database``
dispatcher dumps the events into database tables and it is enabled by default.
The ``message`` dispatcher converts the event objects into versioned event
built-in dispatchers are ``database`` and ``message``.
1. The ``database`` dispatcher dumps the events into database tables and it
is enabled by default.
2. The ``message`` dispatcher converts the event objects into versioned event
notifications and published on the global message queue. This dispatcher is
by default disabled. To enable it, you can add the following line to the
``[DEFAULT]`` section of the ``senlin.conf`` file and then restart the service
engine::
[default]
event_dispatchers = message
Note that the ``event_dispatchers`` field is ``MultiString``, you can enable
both the ``database`` and ``message`` dispatchers if needed by the following
configuration::
event_dispatchers = database, message
Based on your deployment settings, you have to add the following lines to
the ``senlin.conf`` file as well when using ``message`` dispatcher. This lines
set ``messaging`` as the default driver used by the ``oslo.messaging``
@ -66,6 +67,18 @@ package::
[oslo_messaging_notifications]
driver = messaging
With this configuration, the `database` dispatcher will be disabled, which
means you can only access to the events by the message queue.
3. The ``event_dispatchers`` field is ``MultiString``, you can enable
both the ``database`` and ``message`` dispatchers if needed by the following
configuration::
[default]
event_dispatchers = database, message
[oslo_messaging_notifications]
driver = messaging
Note that unprocessed event notifications which are not associated with a
TTL (time to live) value by default will remain queued at the message bus,
please make sure the Senlin event notifications will be subscribed and