Documentation

Change-Id: I15c7ec3f3d60417ccfea2f1ab3d7308ba83db148

devstack/README.rst

@@ -2,18 +2,20 @@
 Enabling Vitrage in DevStack
 ============================
 
-1. Download DevStack::
+1. Download DevStack:
 
     git clone https://git.openstack.org/openstack-dev/devstack.git
     cd devstack
 
-2. Add this repo as an external repository in ``local.conf`` file::
+2. Add this repo as an external repository in ``local.conf`` file:
 
     [[local|localrc]]
     enable_plugin vitrage https://git.openstack.org/openstack/vitrage
 
 3. Add this to add notification from nova to vitrage
 
+::
+
    [[post-config|$NOVA_CONF]]
    [DEFAULT]
    notification_topics = notifications,vitrage_notifications
@@ -22,6 +24,8 @@ Enabling Vitrage in DevStack
 4. Add this to add notification from neutron to vitrage
    (make sure neutron is enabled in devstack)
 
+::
+
    [[post-config|$NEUTRON_CONF]]
    [DEFAULT]
    notification_topics = notifications,vitrage_notifications
@@ -29,6 +33,8 @@ Enabling Vitrage in DevStack
 
 5. Add this to add notification from cinder to vitrage
 
+::
+
    [[post-config|$CINDER_CONF]]
    [DEFAULT]
    notification_topics = notifications,vitrage_notifications

doc/source/notifier-aodh-plugin.rst

@@ -14,27 +14,40 @@ Design
 
 ::
 
-  +------------------+          +--------+
+ +----------+  +-----------+   +------+         +--------+
-  |      Vitrage     |          | Message|       +------------------+
+ | Vitrage  |  | DataSource|   |Graph |         | Message|       +------------------+
-  |    Evaluator     ---------->|  Bus   --------> Vitrage Notifier |
+ | Evaluator|->| Queue     |-->|      |-------->|  Bus   |------>| Vitrage Notifier |
-  +------------------+          |        |       +------------------+
+ +----------+  +-----------+   +------+         |        |       +------------------+
-                                |        |          |        |   |
+                                                |        |          |        |   |
-                                |        |      +---|------+ |   |
+                                                |        |      +----------+ |   |
-                                |        |      | Aodh     |-|-+ |
+                                                |        |      | Aodh     |---+ |
-                                |        |      | notifier |   |-|--+
+                                                |        |      | notifier |   |----+
-                                |        |   +--| plugin   |   |    |
+                                                |        |   +--| plugin   |   |    |
-                                |        |   |  +----------+   |    |
+                                                |        |   |  +----------+   |    |
-                                +--------+   |     +-----------+    |
+                                                +--------+   |     +-----------+    |
-                                             |         +------------+
+                                                             |         +------------+
-  +------------------+                       |
+                  +------------------+                       |
-  |   Aodh           <-----------------------+
+                  |   Aodh           |<----------------------+
-  +------------------+
+                  +------------------+
 
 ...
 
-Evaluator bus notifications
+DeducedAlarmNotifier class will be subscribed to entity graph notifications. Whenever a vitrage deduced alarm is added to the graph it will post a message to the message bus.
----------------------------
+The processor will hold an instance of the DeducedAlarmNotifier class and will subscribe this instance to entity graph notifications.
-Vitrage Evaluator will use the **vitrage.evaluator** message bus topic, and will post messages as follows:
+
+The VitrageNotifier is a new service that listens to the bus for internal vitrage notifications, then can call all the relevant notifier plugins.
+
+1. Deduced Alarm created by the Evaluator
+2. Graph vertex added/updated
+3. DeducedAlarmNotifier write to message bus
+4. VitrageNotifierService receives the event and calls all plugins
+5. Aodh plugin - using the ceilometer client, creates an event in aodh (with some metadata params in the query)
+
+Deduced Alarms bus notifications
+--------------------------------
+
+Vitrage Evaluator will create a deduced alarm, sending it to the data source queue
+Vitrage Evaluator will use the **vitrage.graph** message bus topic, and will post messages as follows:
 
  - message of type **vitrage.deduce_alarm.activate** :
 
@@ -62,6 +75,22 @@ Handle vitrage.deduce_alarm.activate:
 -------------------------------------
 Create an event alarm with the specified severity, where the alarm name is vitrage_alarm_name+resource_id so to be unique
 
+ - Message does not contain aodh alarm id:
+
+   * plugin will **create** a new aodh alarm
+   * alarm type - event
+   * alarm status - alarm
+   * query contain resource_id, vitrage_id fields
+
+ - Message contains aodh alarm id
+
+   * plugin will **update** the aodh alarm status to alarm
+
 Handle vitrage.deduce_alarm.deactivate:
 ---------------------------------------
 delete an event alarm with the specified id
+
+   * message will contain the aodh alarm id - plugin will **update** the alarm status to ok
+   * name - is the alarm name in vitrage
+   * severity - is the alarm severity
+   * affected_resource_id - is the openstack id of the resource on which the alarm was raised