From 9cf1751c1d2e8cce7eede6e4a0af97081aaa15d0 Mon Sep 17 00:00:00 2001 From: Ifat Afek Date: Wed, 24 Jan 2018 16:37:11 +0000 Subject: [PATCH] Remove from the documentation references to /etc/vitrage/templates Change-Id: I3bdb0a77573dd6ae77aba0b7e90fca839e741185 Implements: blueprint crud-templates --- doc/source/contributor/configuration.rst | 1 - doc/source/contributor/template-config.rst | 37 ------------------- doc/source/contributor/vitrage-api.rst | 2 +- .../contributor/vitrage-first_steps.rst | 4 +- doc/source/install/install-rdo.rst | 3 -- 5 files changed, 3 insertions(+), 44 deletions(-) delete mode 100644 doc/source/contributor/template-config.rst diff --git a/doc/source/contributor/configuration.rst b/doc/source/contributor/configuration.rst index 22212a0ca..24f2e3b6d 100644 --- a/doc/source/contributor/configuration.rst +++ b/doc/source/contributor/configuration.rst @@ -12,7 +12,6 @@ General alarm-severity-config profiler-config keycloak-config - template-config ../configuration/index diff --git a/doc/source/contributor/template-config.rst b/doc/source/contributor/template-config.rst deleted file mode 100644 index a6c676094..000000000 --- a/doc/source/contributor/template-config.rst +++ /dev/null @@ -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 diff --git a/doc/source/contributor/vitrage-api.rst b/doc/source/contributor/vitrage-api.rst index d959a59af..48a4aa6c8 100644 --- a/doc/source/contributor/vitrage-api.rst +++ b/doc/source/contributor/vitrage-api.rst @@ -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/ ~~~~~~~~~~~~~~~~~ diff --git a/doc/source/contributor/vitrage-first_steps.rst b/doc/source/contributor/vitrage-first_steps.rst index 6b779fee9..61b523e67 100644 --- a/doc/source/contributor/vitrage-first_steps.rst +++ b/doc/source/contributor/vitrage-first_steps.rst @@ -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 diff --git a/doc/source/install/install-rdo.rst b/doc/source/install/install-rdo.rst index 219229224..3ea129ba7 100644 --- a/doc/source/install/install-rdo.rst +++ b/doc/source/install/install-rdo.rst @@ -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