openstack/vitrage
Code Issues Proposed changes

Documentation updates

Browse Source 
Change-Id: I6729b73ab5fdcc07ebe37732ddaf0ed2d619af35
This commit is contained in:
Ifat Afek 2016-09-29 09:21:27 +00:00
parent a07c7b146d
commit 5e05d161fb
8 changed files with 41 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.rst
View File

@ -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
----------------------------

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

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 78 KiB

After

Width:  |  Height:  |  Size: 77 KiB

46
doc/source/index.rst
View File

@ -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

3
doc/source/installation-and-configuration.rst
View File

@ -22,3 +22,6 @@ Configuration
* `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>`_
* `Zabbix Configuration <https://github.com/openstack/vitrage/blob/master/doc/source/zabbix_vitrage.rst>`_

2
doc/source/vitrage-api.rst
View File

@ -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
^^^^^^^^^^^^^

1
doc/source/vitrage-graph-design.rst
View File

@ -9,7 +9,6 @@ Vitrage Graph Design
Main Components
===============
**Note:** The gray datasources will not be implemented in Mitaka
Graph
-----

2
initial.txt
View File

@ -1 +1 @@
Vitrage - The OpenStack RCA Engine
Vitrage - The OpenStack RCA Service

2
setup.cfg
View File

@ -1,6 +1,6 @@
[metadata]
name = vitrage
summary = The OpenStack RCA Engine
summary = The OpenStack RCA Service
description-file =
README.rst
author = OpenStack