Removed Table of content
[barometer.git] / docs / release / configguide / featureconfig.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
3
4 =============================
5 Barometer Configuration Guide
6 =============================
7 This document provides guidelines on how to install and configure Barometer with Apex.
8 The deployment script installs and enables a series of collectd plugins on the compute node(s),
9 which collect and dispatch specific metrics and events from the platform.
10
11 Pre-configuration activities
12 ----------------------------
13 Deploying the Barometer components in Apex is done through the deploy-opnfv command by selecting
14 a scenario-file which contains the ``barometer: true`` option.  These files are located on the
15 Jump Host in the ``/etc/opnfv-apex/ folder``.  Two scenarios are pre-defined to include Barometer,
16 and they are: ``os-nosdn-bar-ha.yaml`` and ``os-nosdn-bar-noha.yaml``.
17
18 .. code:: bash
19
20     $ cd /etc/opnfv-apex
21     $ opnfv-deploy -d os-nosdn-bar-ha.yaml -n network_settings.yaml -i inventory.yaml –- debug
22
23 Hardware configuration
24 ----------------------
25 There's no specific Hardware configuration required.  However, the ``intel_rdt`` plugin works
26 only on platforms with Intel CPUs.
27
28 Feature configuration
29 ---------------------
30 All Barometer plugins are automatically deployed on all compute nodes.  There is no option to
31 selectively install only a subset of plugins.  Any custom disabling or configuration must be done
32 directly on the compute node(s) after the deployment is completed.
33
34 Upgrading the plugins
35 ---------------------
36 The Barometer components are built-in in the Apex ISO image, and respectively the Apex RPMs.  There
37 is no simple way to update only the Barometer plugins in an existing deployment.