vitrage/doc/source/contributor/vitrage-use-cases.rst
Ifat Afek 5d40367bef Doc Migration: move the developer guide documents under the "contributor" folder
Changed files:
- index.rst
- contributor/index.rst
- installation-and-configuration - split to devstack-installation.rst and configuration.rst

Change-Id: I4683a213e2a530d2088c4f232b9c2508fc25ba68
2017-07-27 07:05:18 +00:00

97 lines
2.9 KiB
ReStructuredText

=================
Vitrage Use Cases
=================
Add Nova Instance
-----------------
.. image:: ./images/add_nova_instance_flow.png
:width: 100%
:align: center
#. Nova datasource Driver queries all Nova instances, or gets a message bus
notification about a new Nova instance
#. Nova datasource Driver sends corresponding events to the Entity Queue
#. The Entity Processor polls the Entity Queue and gets the new Nova Instance
event
#. The Entity Processor passes the event to the Nova Instance Transformer,
which returns a Vertex with the instance data, with an edge to the host
Vertex in the graph
#. The Entity Processor adds the new vertex and edge to the Graph
.. image:: ./images/add_nova_instance_graph.png
:width: 100%
:align: center
Add Aodh Alarm
--------------
.. image:: ./images/add_aodh_alarm_flow.png
:width: 100%
:align: center
#. Aodh Driver queries all Aodh alarms
#. Aodh Driver sends corresponding events to the Entity Queue
#. The Entity Processor polls the Entity Queue and gets the Aodh Alarm event,
for example threshold alarm on Instance-1 CPU
#. The Entity Processor passes the event to the Aodh Alarm Transformer, which
returns a Vertex with the alarm data, with an edge to the instance Vertex
#. The Entity Processor adds the new vertex and edge to the Graph
.. image:: ./images/add_aodh_alarm_graph.png
:width: 100%
:align: center
Nagios Alarm Causes Deduced Alarm
---------------------------------
.. image:: ./images/nagios_causes_deduced_flow.png
:width: 100%
:align: center
5. (steps 1-4) Nagios datasource driver pushes a nagios alarm on a switch to
the Entity Queue, which is converted by Nagios Transformer to a vertex and
inserted to the Graph
6. The Evaluator is notified about a new Vertex (Nagios switch alarm) that was
added to the graph
7. The Evaluator performs its calculations and deduces that alarms should be
triggered on every instance on every host attached to this switch
8. The Evaluator pushes alarms to the Entity Queue
9. The graph is updated with these new alarms
10. The graph writes to the message bus that new alarms were created
11. Aodh Notifier creates new alarm definitions in Aodh, and sets their states
to "alarm"
.. image:: ./images/nagios_causes_deduced_graph.png
:width: 100%
:align: center
Create RCA Insights
-------------------
.. image:: ./images/rca_flow.png
:width: 100%
:align: center
#. The Evaluator is notified of a new alarm *Alarm-X*.
#. The Evaluator evaluates the templates and the Graph, and decides that there
is a root cause relation between *Alarm-X* and *Alarm-Y*. It adds a "causes"
edge to the Graph
.. image:: ./images/rca_graph.png
:width: 100%
:align: center
Note that in future versions the graph with RCA information may become more
complex, for example:
.. image:: ./images/complex_rca_graph.png
:width: 100%
:align: center