Some documentation changes

- Added missing documentation of Nova notifier
- Moved osprofiler doc under contributor folder
- Marked the static-physical datasource as obsolete
- Removed a link to Aodh notifier (the document was deleted, as it was just a POC)

Depends-On: Ifcde995130486c859e6a9ce23e47a89910187732
Change-Id: Ib2b7880d65d4c6edd7cfd1f831da9da7af5e114c
This commit is contained in:
Ifat Afek 2017-07-30 08:20:01 +00:00 committed by Eyal
parent d78b49666d
commit b27a29fde3
7 changed files with 73 additions and 7 deletions

View File

@ -2,13 +2,34 @@
Vitrage configuration Vitrage configuration
===================== =====================
General
-------
.. toctree::
:maxdepth: 1
resource-state-config
alarm-severity-config
profiler-config
Datasources
-----------
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
nagios-config nagios-config
static-config static-config
static-physical-config static-physical-config
resource-state-config
alarm-severity-config
zabbix_vitrage zabbix_vitrage
Notifiers
---------
.. toctree::
:maxdepth: 1
nova-notifier
notifier-snmp-plugin notifier-snmp-plugin

View File

Before

Width:  |  Height:  |  Size: 122 KiB

After

Width:  |  Height:  |  Size: 122 KiB

View File

@ -9,7 +9,6 @@ The Evaluator may determine that an alarm should be created, deleted or otherwis
Other components are notified of such changes by the Vitrage Notifier service. Among others, Vitrage Notifier is responsible for sending snmp traps for raised and deleted deduced alarms. Other components are notified of such changes by the Vitrage Notifier service. Among others, Vitrage Notifier is responsible for sending snmp traps for raised and deleted deduced alarms.
This document describes the implementation of generating SNMP Traps on Vitrage alarms. This document describes the implementation of generating SNMP Traps on Vitrage alarms.
You can find a description of the Vitrage Notifier infrastructure in the documentation file `notifier-aodh-plugin.rst <https://github.com/openstack/vitrage/blob/master/doc/source/notifier-aodh-plugin.rst>`_.
SNMP Plugin SNMP Plugin
=========== ===========

View File

@ -0,0 +1,47 @@
=====================
Vitrage Nova Notifier
=====================
Overview
--------
The main purpose of Vitrage is to provide insights about the state of the
system on problems that are not directly monitored. An example of such
a problem is a switch failure that causes a Nova host to become unreachable,
while Nova is not aware of this problem.
The Nova notifier tries to solve this use case, by calling Nova force-down API
to notify Nova that the host is down.
Configuration
-------------
In order to support this use case, the user should perform the following:
1. Activate the nova notifier. In /etc/vitrage/vitrage.conf:
.. code:: yaml
[DEFAULT]
notifiers = nova
2. Determine, in the Vitrage templates, what condition(s) indicates that the
host is down. For example:
.. code:: yaml
scenarios:
- scenario:
condition: host_down_alarm_on_host
actions:
action:
action_type : mark_down
action_target:
target: host
For more information about the mark-down action, see the Vitrage templates
documentation: templates_
.. _templates: https://docs.openstack.org/vitrage/latest/contributor/vitrage-template-format.html

View File

@ -1,6 +1,6 @@
======================================== ===================================================
Static Physical Datasource Configuration (Obsolete) Static Physical Datasource Configuration
======================================== ===================================================
Overview Overview
-------- --------

View File

@ -77,7 +77,6 @@ Developer Guide
contributor/vitrage-template-format contributor/vitrage-template-format
contributor/devstack-installation contributor/devstack-installation
contributor/configuration contributor/configuration
profiler-config
Design Documents Design Documents
---------------- ----------------