From b27a29fde36c8972a28c508a6360bc5d070ac15a Mon Sep 17 00:00:00 2001 From: Ifat Afek Date: Sun, 30 Jul 2017 08:20:01 +0000 Subject: [PATCH] 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 --- doc/source/contributor/configuration.rst | 25 +++++++++- .../images/osprofiler-html-output.png | Bin .../contributor/notifier-snmp-plugin.rst | 1 - doc/source/contributor/nova-notifier.rst | 47 ++++++++++++++++++ .../{ => contributor}/profiler-config.rst | 0 .../contributor/static-physical-config.rst | 6 +-- doc/source/index.rst | 1 - 7 files changed, 73 insertions(+), 7 deletions(-) rename doc/source/{ => contributor}/images/osprofiler-html-output.png (100%) create mode 100644 doc/source/contributor/nova-notifier.rst rename doc/source/{ => contributor}/profiler-config.rst (100%) diff --git a/doc/source/contributor/configuration.rst b/doc/source/contributor/configuration.rst index acad1d1a3..c9579d089 100644 --- a/doc/source/contributor/configuration.rst +++ b/doc/source/contributor/configuration.rst @@ -2,13 +2,34 @@ Vitrage configuration ===================== +General +------- + +.. toctree:: + :maxdepth: 1 + + resource-state-config + alarm-severity-config + profiler-config + + +Datasources +----------- + .. toctree:: :maxdepth: 1 nagios-config static-config static-physical-config - resource-state-config - alarm-severity-config zabbix_vitrage + + +Notifiers +--------- + +.. toctree:: + :maxdepth: 1 + + nova-notifier notifier-snmp-plugin diff --git a/doc/source/images/osprofiler-html-output.png b/doc/source/contributor/images/osprofiler-html-output.png similarity index 100% rename from doc/source/images/osprofiler-html-output.png rename to doc/source/contributor/images/osprofiler-html-output.png diff --git a/doc/source/contributor/notifier-snmp-plugin.rst b/doc/source/contributor/notifier-snmp-plugin.rst index 1f745607a..8109b12d0 100644 --- a/doc/source/contributor/notifier-snmp-plugin.rst +++ b/doc/source/contributor/notifier-snmp-plugin.rst @@ -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. 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 `_. SNMP Plugin =========== diff --git a/doc/source/contributor/nova-notifier.rst b/doc/source/contributor/nova-notifier.rst new file mode 100644 index 000000000..b04a7b0fd --- /dev/null +++ b/doc/source/contributor/nova-notifier.rst @@ -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 diff --git a/doc/source/profiler-config.rst b/doc/source/contributor/profiler-config.rst similarity index 100% rename from doc/source/profiler-config.rst rename to doc/source/contributor/profiler-config.rst diff --git a/doc/source/contributor/static-physical-config.rst b/doc/source/contributor/static-physical-config.rst index 7c8e9fb85..540893593 100644 --- a/doc/source/contributor/static-physical-config.rst +++ b/doc/source/contributor/static-physical-config.rst @@ -1,6 +1,6 @@ -======================================== -Static Physical Datasource Configuration -======================================== +=================================================== +(Obsolete) Static Physical Datasource Configuration +=================================================== Overview -------- diff --git a/doc/source/index.rst b/doc/source/index.rst index 460ec4870..5dc143b80 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -77,7 +77,6 @@ Developer Guide contributor/vitrage-template-format contributor/devstack-installation contributor/configuration - profiler-config Design Documents ----------------