diff --git a/README.rst b/README.rst index 6f48f77f6..a1804c0a0 100644 --- a/README.rst +++ b/README.rst @@ -2,9 +2,9 @@ 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 ---------------------------- diff --git a/doc/source/images/vitrage_graph_architecture.png b/doc/source/images/vitrage_graph_architecture.png index 565c95c53..c4ac9dfba 100644 Binary files a/doc/source/images/vitrage_graph_architecture.png and b/doc/source/images/vitrage_graph_architecture.png differ diff --git a/doc/source/index.rst b/doc/source/index.rst index 2e014354a..b8d1ae86a 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -3,23 +3,43 @@ You can adapt this file completely to your liking, but it should at least 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:: - :maxdepth: 2 + :maxdepth: 1 - readme - installation - usage - contributing + vitrage-first_steps + vitrage-api + vitrage-template-format + installation-and-configuration -Indices and tables -================== +Design Documents +---------------- -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` +.. toctree:: + :maxdepth: 1 + + vitrage-graph-design + scenario-evaluator + vitrage-use-cases + add-new-datasource diff --git a/doc/source/installation-and-configuration.rst b/doc/source/installation-and-configuration.rst index 1c68dd6f7..529cea68a 100644 --- a/doc/source/installation-and-configuration.rst +++ b/doc/source/installation-and-configuration.rst @@ -22,3 +22,6 @@ Configuration * `Resource State Configuration `_ * `Alarm State Configuration `_ + +* `Zabbix Configuration `_ + diff --git a/doc/source/vitrage-api.rst b/doc/source/vitrage-api.rst index 953766756..00137f4f0 100644 --- a/doc/source/vitrage-api.rst +++ b/doc/source/vitrage-api.rst @@ -22,7 +22,7 @@ Overview ******** **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 ^^^^^^^^^^^^^ diff --git a/doc/source/vitrage-graph-design.rst b/doc/source/vitrage-graph-design.rst index 2f4f01eea..be92fa415 100644 --- a/doc/source/vitrage-graph-design.rst +++ b/doc/source/vitrage-graph-design.rst @@ -9,7 +9,6 @@ Vitrage Graph Design Main Components =============== -**Note:** The gray datasources will not be implemented in Mitaka Graph ----- diff --git a/initial.txt b/initial.txt index 4cd6ed6ae..1b8de3421 100644 --- a/initial.txt +++ b/initial.txt @@ -1 +1 @@ -Vitrage - The OpenStack RCA Engine +Vitrage - The OpenStack RCA Service diff --git a/setup.cfg b/setup.cfg index c1182a26c..fca436475 100644 --- a/setup.cfg +++ b/setup.cfg @@ -1,6 +1,6 @@ [metadata] name = vitrage -summary = The OpenStack RCA Engine +summary = The OpenStack RCA Service description-file = README.rst author = OpenStack