openstack/vitrage
Code Issues Proposed changes

Remove from the documentation references to /etc/vitrage/templates

Browse Source 
Change-Id: I3bdb0a77573dd6ae77aba0b7e90fca839e741185
Implements: blueprint crud-templates
This commit is contained in:
Ifat Afek 2018-01-24 16:37:11 +00:00
parent ea6fd06820
commit 9cf1751c1d
5 changed files with 3 additions and 44 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/source/contributor/configuration.rst
View File

@ -12,7 +12,6 @@ General
alarm-severity-config
profiler-config
keycloak-config
template-config
../configuration/index

37
doc/source/contributor/template-config.rst
View File

@ -1,37 +0,0 @@
================================
Template Directory Configuration
================================
Overview
--------
Vitrage uses configuration files called ``templates``, to express rules
regarding raising deduced alarms, setting deduced states, and detecting/setting
RCA links.
Configuration
-------------
The templates, definition templates and entity equivalence directories should be defined in the
Vitrage configuration file, **/etc/vitrage/vitrage.conf** under the ``[evaluator]`` section.
+-------------------+------------------------------------------------------------------+--------------------------------------+
| Name | Description | Default Value |
+===================+==================================================================+======================================+
| templates_dir | A path for the templates used by the evaluator | /etc/vitrage/templates |
+-------------------+------------------------------------------------------------------+--------------------------------------+
| def_templates_dir | A path for the definition template files used by the evaluator. | /etc/vitrage/templates/def_templates |
| | These are template files that contain only definitions and | |
| | can be included and used in regular template files to create | |
| | scenarios. | |
+-------------------+------------------------------------------------------------------+--------------------------------------+
|equivalences_dir | A path for for entity equivalences used by the evaluator. | /etc/vitrage/templates/equivalences |
+-------------------+------------------------------------------------------------------+--------------------------------------+
.. code:: yaml
[evaluator]
templates_dir = /etc/vitrage/templates
def_templates_dir = /etc/vitrage/templates/def_templates
equivalences_dir = /etc/vitrage/templates/equivalences

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

@ -1103,7 +1103,7 @@ Response Examples
Template List
=============
List all templates loaded from /etc/vitrage/templates, both those that passed validation and those that did not.
List all templates in the database, both those that passed validation and those that did not.
GET /v1/template/
~~~~~~~~~~~~~~~~~

4
doc/source/contributor/vitrage-first_steps.rst
View File

@ -34,8 +34,8 @@ as the trigger for deduced alarms, states and RCA templates in Vitrage.
Vitrage in action
=================
In order to see Vitrage in action, you should place your templates under
*/etc/vitrage/templates*. See template_ example.
In order to see Vitrage in action, you should add templates to Vitrage using
``vitrage template add`` API. See template_ example.
.. _template: host_high_memory_consumption.yaml

3
doc/source/install/install-rdo.rst
View File

@ -57,9 +57,6 @@ Create the Vitrage folders
$ mkdir /etc/vitrage/static_datasources
$ chmod 755 /etc/vitrage/static_datasources
$ mkdir /etc/vitrage/templates
$ chmod 755 /etc/vitrage/templates
$ sudo mkdir /var/log/vitrage
$ sudo chmod 755 /var/log/vitrage