e2b21d516d
- Beautify, re-indent, format code in a lot of doc files
- Use relative URLs instead of absolute github URLs
- Some absolute github urls are not corrected yet:
+ URL for enabling vitrage in devstack
+ URL for enabling vitrage in horizon
- Update year number in doc/source/config.py from 2013 to 2016
My thought: We should have a blueprint
to create more concise and easy to access like other project
(nova: http://docs.openstack.org/developer/nova/).
Currently, that site for vitrage has not existed yet.
Notes: Change github URLs to relative URLs
(or absolute URLs in docs.openstack.org/developers)
will not work correctly
if we do not have official documentation site.
Hence, other people cannot follow the link to html page
if they read vitrage documentation in github mirror.
Change-Id: Ifff8355c7e5291f68a7592d1617644053d790d5e
46 lines
1.1 KiB
ReStructuredText
46 lines
1.1 KiB
ReStructuredText
.. vitrage documentation master file, created by
|
|
sphinx-quickstart on Tue Jul 9 22:26:36 2013.
|
|
You can adapt this file completely to your liking, but it should at least
|
|
contain the root `toctree` directive.
|
|
|
|
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.
|
|
|
|
|
|
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: 1
|
|
|
|
vitrage-first_steps
|
|
vitrage-api
|
|
vitrage-template-format
|
|
installation-and-configuration
|
|
|
|
Design Documents
|
|
----------------
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
vitrage-graph-design
|
|
scenario-evaluator
|
|
vitrage-use-cases
|
|
add-new-datasource
|
|
|