Documentation updates
Change-Id: I6729b73ab5fdcc07ebe37732ddaf0ed2d619af35
This commit is contained in:
parent
a07c7b146d
commit
5e05d161fb
@ -2,9 +2,9 @@
|
|||||||
Vitrage
|
Vitrage
|
||||||
=======
|
=======
|
||||||
|
|
||||||
The OpenStack RCA Engine
|
The OpenStack RCA Service
|
||||||
|
|
||||||
Vitrage is the OpenStack RCA (Root Cause Analysis) Engine for organizing, analyzing and expanding OpenStack alarms & events, yielding insights regarding the root cause of problems and deducing the existence of problems 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 the existence of problems before they are directly detected.
|
||||||
|
|
||||||
Enabling Vitrage in DevStack
|
Enabling Vitrage in DevStack
|
||||||
----------------------------
|
----------------------------
|
||||||
|
Binary file not shown.
Before Width: | Height: | Size: 78 KiB After Width: | Height: | Size: 77 KiB |
@ -3,23 +3,43 @@
|
|||||||
You can adapt this file completely to your liking, but it should at least
|
You can adapt this file completely to your liking, but it should at least
|
||||||
contain the root `toctree` directive.
|
contain the root `toctree` directive.
|
||||||
|
|
||||||
Welcome to vitrage's documentation!
|
Welcome to Vitrage documentation!
|
||||||
===================================
|
=================================
|
||||||
|
|
||||||
Contents:
|
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
|
||||||
|
------------------------
|
||||||
|
|
||||||
|
* Physical-to-Virtual entities mapping
|
||||||
|
|
||||||
|
* Deduced alarms and states (i.e., raising an alarm or modifying a state based on analysis of the system, instead of direct monitoring)
|
||||||
|
|
||||||
|
* Root Cause Analysis (RCA) for alarms/events
|
||||||
|
|
||||||
|
* Horizon plugin for the above features
|
||||||
|
|
||||||
|
|
||||||
|
Developer Guide
|
||||||
|
---------------
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 2
|
:maxdepth: 1
|
||||||
|
|
||||||
readme
|
vitrage-first_steps
|
||||||
installation
|
vitrage-api
|
||||||
usage
|
vitrage-template-format
|
||||||
contributing
|
installation-and-configuration
|
||||||
|
|
||||||
Indices and tables
|
Design Documents
|
||||||
==================
|
----------------
|
||||||
|
|
||||||
* :ref:`genindex`
|
.. toctree::
|
||||||
* :ref:`modindex`
|
:maxdepth: 1
|
||||||
* :ref:`search`
|
|
||||||
|
vitrage-graph-design
|
||||||
|
scenario-evaluator
|
||||||
|
vitrage-use-cases
|
||||||
|
add-new-datasource
|
||||||
|
|
||||||
|
@ -22,3 +22,6 @@ Configuration
|
|||||||
* `Resource State Configuration <https://github.com/openstack/vitrage/blob/master/doc/source/resource-state-config.rst>`_
|
* `Resource State Configuration <https://github.com/openstack/vitrage/blob/master/doc/source/resource-state-config.rst>`_
|
||||||
|
|
||||||
* `Alarm State Configuration <https://github.com/openstack/vitrage/blob/master/doc/source/alarm-state-config.rst>`_
|
* `Alarm State Configuration <https://github.com/openstack/vitrage/blob/master/doc/source/alarm-state-config.rst>`_
|
||||||
|
|
||||||
|
* `Zabbix Configuration <https://github.com/openstack/vitrage/blob/master/doc/source/zabbix_vitrage.rst>`_
|
||||||
|
|
||||||
|
@ -22,7 +22,7 @@ Overview
|
|||||||
********
|
********
|
||||||
**This document describes the Vitrage API v1.**
|
**This document describes the Vitrage API v1.**
|
||||||
|
|
||||||
**The Vitrage API provides a RESTful JSON interface for interacting with Vitrage Engine.**
|
**The Vitrage API provides a RESTful JSON interface for interacting with Vitrage Service.**
|
||||||
|
|
||||||
List Versions
|
List Versions
|
||||||
^^^^^^^^^^^^^
|
^^^^^^^^^^^^^
|
||||||
|
@ -9,7 +9,6 @@ Vitrage Graph Design
|
|||||||
|
|
||||||
Main Components
|
Main Components
|
||||||
===============
|
===============
|
||||||
**Note:** The gray datasources will not be implemented in Mitaka
|
|
||||||
|
|
||||||
Graph
|
Graph
|
||||||
-----
|
-----
|
||||||
|
@ -1 +1 @@
|
|||||||
Vitrage - The OpenStack RCA Engine
|
Vitrage - The OpenStack RCA Service
|
||||||
|
Loading…
Reference in New Issue
Block a user