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 and Compass4nfv.
   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 - Apex
  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 Pre-configuration activities - Compass4nfv
  24 ------------------------------------------
  25 Deploying the Barometer components in Compass4nfv is done by running the deploy.sh script after
  26 exporting a scenario-file which contains the ``barometer: true`` option. Two scenarios are pre-defined
  27 to include Barometer, and they are: ``os-nosdn-bar-ha.yaml`` and ``os-nosdn-bar-noha.yaml``. For more
  28 information, please refer to these useful links:
  29 https://github.com/opnfv/compass4nfv
  30 https://wiki.opnfv.org/display/compass4nfv/Compass+101
  31 https://wiki.opnfv.org/display/compass4nfv/Containerized+Compass
  32
  33 The quickest way to deploy using Compass4nfv is given below.
  34
  35 .. code:: bash
  36
  37     $ export SCENARIO=os-nosdn-bar-ha.yml
  38     $ curl https://raw.githubusercontent.com/opnfv/compass4nfv/master/quickstart.sh | bash
  39
  40 Hardware configuration
  41 ----------------------
  42 There's no specific Hardware configuration required.  However, the ``intel_rdt`` plugin works
  43 only on platforms with Intel CPUs.
  44
  45 Feature configuration
  46 ---------------------
  47 All Barometer plugins are automatically deployed on all compute nodes.  There is no option to
  48 selectively install only a subset of plugins.  Any custom disabling or configuration must be done
  49 directly on the compute node(s) after the deployment is completed.
  50
  51 Upgrading the plugins
  52 ---------------------
  53 The Barometer components are built-in in the ISO image, and respectively the RPM/Debian packages.
  54 There is no simple way to update only the Barometer plugins in an existing deployment.