docs/release/configguide/postinstall.rst

   1 .. _barometer-postinstall:
   2
   3 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   4 .. http://creativecommons.org/licenses/by/4.0
   5
   6 ======================================
   7 Barometer post installation procedures
   8 ======================================
   9 This document describes briefly the methods of validating the Barometer installation.
  10
  11 .. TODO: Update this to include reference to containers rather than an Openstack deployment.
  12
  13 Automated post installation activities
  14 --------------------------------------
  15 .. This section will include how to run plugin validation tests, when they are created/merged.
  16 .. This section will also include some troubleshooting and debugging information.
  17
  18 .. note:: This section is outdated and needs to be updated.
  19
  20 .. TODO: Update this section; post-installation/verification shouldn't be in
  21    the config guide. It should be in testing.
  22
  23 The Barometer test-suite in Functest is called ``barometercollectd`` and is part of the ``Features``
  24 tier.  Running these tests is done automatically by the OPNFV deployment pipeline on the supported
  25 scenarios.  The testing consists of basic verifications that each plugin is functional per their
  26 default configurations.  Inside the Functest container, the detailed results can be found in the
  27 ``/home/opnfv/functest/results/barometercollectd.log``.
  28
  29 Barometer post configuration procedures
  30 ---------------------------------------
  31 The functionality for each plugin (such as enabling/disabling and configuring its capabilities)
  32 is controlled as described in the :ref:`User Guide <barometer-userguide>` through their individual
  33 ``.conf`` file located in the ``/etc/collectd/collectd.conf.d/`` on the host(s). In order for any
  34 changes to take effect, the collectd service must be stopped and then started again.
  35
  36 Plugin verification
  37 ~~~~~~~~~~~~~~~~~~~
  38 Once collectd has been installed and deployed, you will see metrics from most plugins immediately. However, in some cases, you may want to verify that the configuration is correct and that the plugion is functioning as intended (particularly during development, or when testing an experimental version). The following sections provide some verification steps to make sure the plugins are working as expected.
  39
  40 MCElog
  41 ^^^^^^
  42 On the collectd host, you can induce an event monitored by the plugins; e.g. a corrected memory error:
  43
  44 .. code:: bash
  45
  46    $ git clone https://git.kernel.org/pub/scm/utils/cpu/mce/mce-inject.git
  47    $ cd mce-inject
  48    $ make
  49    $ modprobe mce-inject
  50
  51 Modify the test/corrected script to include the following:
  52
  53 .. code:: bash
  54
  55    CPU 0 BANK 0
  56    STATUS 0xcc00008000010090
  57    ADDR 0x0010FFFFFFF
  58
  59 Inject the error:
  60
  61 .. code:: bash
  62
  63    $ ./mce-inject < test/corrected
  64
  65 .. TODO: How to check that the event was propogated to collectd
  66
  67 .. _barometer-docker-verification:
  68
  69 Barometer post installation verification on barometer-collectd container
  70 ------------------------------------------------------------------------
  71
  72 The following steps describe how to perform simple "manual" testing of the Barometer components
  73 after :ref:`successfully deploying the barometer-collectd container<barometer-docker-userguide>`:
  74
  75 1. Connect to any compute node and ensure that the collectd container is running.
  76
  77    .. code:: bash
  78
  79        root@host2:~# docker ps | grep collectd
  80
  81    You should see the container ``opnfv/barometer-collectd`` running.
  82
  83 2. Use a web browser to connect to Grafana at ``http://<serverip>:3000/``, using the hostname or
  84    IP of your server and port 3000. Log in with admin/admin. You will see ``collectd``
  85    InfluxDB database in the ``Data Sources``. Also, you will notice metrics coming in the several
  86    dashboards such as ``CPU Usage`` and ``Host Overview``.
  87
  88 For more details on the Barometer containers, Grafana and InfluxDB, please refer to
  89 the following documentation links:
  90
  91 `Barometer Containers wiki page <https://wiki.opnfv.org/display/fastpath/Barometer+Containers#BarometerContainers-barometer-collectdcontainer>`_
  92
  93 :ref:`Barometer Docker install guide<barometer-docker-userguide>`