doc: Update IPMI/Hugepages/SNMP instructions
[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 .. contents::
12    :depth: 3
13    :local:
14
15 Pre-configuration activities
16 ----------------------------
17 Deploying the Barometer components in Apex is done through the deploy-opnfv command by selecting
18 a scenario-file which contains the ``barometer: true`` option.  These files are located on the
19 Jump Host in the ``/etc/opnfv-apex/ folder``.  Two scenarios are pre-defined to include Barometer,
20 and they are: ``os-nosdn-bar-ha.yaml`` and ``os-nosdn-bar-noha.yaml``.
21
22 .. code:: bash
23
24     $ cd /etc/opnfv-apex
25     $ opnfv-deploy -d os-nosdn-bar-ha.yaml -n network_settings.yaml -i inventory.yaml –- debug
26
27 Hardware configuration
28 ----------------------
29 There's no specific Hardware configuration required.  However, the ``intel_rdt`` plugin works
30 only on platforms with Intel CPUs.
31
32 Feature configuration
33 ---------------------
34 All Barometer plugins are automatically deployed on all compute nodes.  There is no option to
35 selectively install only a subset of plugins.  Any custom disabling or configuration must be done
36 directly on the compute node(s) after the deployment is completed.
37
38 Upgrading the plugins
39 ---------------------
40 The Barometer components are built-in in the Apex ISO image, and respectively the Apex RPMs.  There
41 is no simple way to update only the Barometer plugins in an existing deployment.