openstack/vitrage
Code Issues Proposed changes

Updated Vitrage documentation and architecture diagram

Browse Source 
Change-Id: If710046523d42cf904bf09254bfab9cb41fe03bf
Implements: blueprint support-inspector-sb-api
This commit is contained in:
Ifat Afek 2017-01-16 17:30:37 +00:00
parent b1a2827140
commit 180d557eb1
2 changed files with 32 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
doc/source/images/vitrage_graph_architecture.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 77 KiB

After

Width:  |  Height:  |  Size: 116 KiB

33
doc/source/index.rst
View File

@ -6,7 +6,10 @@
Welcome to Vitrage documentation! Welcome to Vitrage documentation!
================================= =================================
Vitrage is the OpenStack RCA (Root Cause Analysis) service for organizing, analyzing and expanding OpenStack alarms & events, yielding insights regarding the root cause of problems and deducing their existence before they are directly detected. Vitrage is the OpenStack RCA (Root Cause Analysis) service for organizing,
analyzing and expanding OpenStack alarms & events, yielding insights regarding
the root cause of problems and deducing their existence before they are
directly detected.
High Level Functionality High Level Functionality
@ -20,6 +23,34 @@ High Level Functionality
* Horizon plugin for the above features * Horizon plugin for the above features
High Level Architecture
-----------------------
.. image:: ./images/vitrage_graph_architecture.png
:width: 100%
:align: center
**Vitrage Data Sources** are responsible for importing information from
different sources, regarding the state of the system. This includes information
regarding resources (physical, virtual, and applications) and alarms.
The information is then processed into the Vitrage Graph.
Currently Vitrage supports OpenStack datasources like Nova, Cinder, Neutron,
Heat and Aodh, as well as external monitors like Nagios, Zabbix and collectd.
**Vitrage Graph** holds the information collected by the Data Sources, as well
as their inter-relations. Additionally, it implements a collection of basic
graph algorithms that are used by the Vitrage Evaluator (e.g., sub-matching,
BFS, DFS etc).
**Vitrage Evaluator** coordinates the analysis of (changes to) the Vitrage
Graph and processes the results of this analysis. It is responsible for
executing different kind of template-based actions in Vitrage, such as to add
an RCA (Root Cause Analysis) relationship between alarms, raise a deduced alarm
or set a deduced state.
**Vitrage Notifiers** can be used to notify external systems of Vitrage alarms
and states. Currently Vitrage has an Aodh notifier for raising Vitrage alarms
in Aodh, and a Nova notifier for marking that the host is down.
Developer Guide Developer Guide
--------------- ---------------