docs/release/configguide/postinstall.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 post installation procedures
   6 ======================================
   7 This document describes briefly the methods of validating the Barometer installation.
   8
   9 Automated post installation activities
  10 --------------------------------------
  11 The Barometer test-suite in Functest is called ``barometercollectd`` and is part of the ``Features``
  12 tier.  Running these tests is done automatically by the OPNFV deployment pipeline on the supported
  13 scenarios.  The testing consists of basic verifications that each plugin is functional per their
  14 default configurations.  Inside the Functest container, the detailed results can be found in the
  15 ``/home/opnfv/functest/results/barometercollectd.log``.
  16
  17 Barometer post configuration procedures
  18 ---------------------------------------
  19 The functionality for each plugin (such as enabling/disabling and configuring its capabilities)
  20 is controlled as described in the User Guide through their individual ``.conf`` file located in
  21 the ``/etc/collectd/collectd.conf.d/`` folder on the compute node(s).  In order for any changes to
  22 take effect, the collectd service must be stopped and then started again.
  23
  24 Platform components validation
  25 ------------------------------
  26 The following steps describe how to perform a simple "manual" testing of the Barometer components:
  27
  28 1. Connect to any compute node and ensure that the collectd service is running.  The log file
  29    ``collectd.log`` should contain no errors and should indicate that each plugin was successfully
  30    loaded.  For example, from the Jump Host:
  31
  32    .. code:: bash
  33
  34        $ opnfv-util overcloud compute0
  35        $ ls /etc/collectd/collectd.conf.d/
  36        $ systemctl status collectd
  37        $ vi /opt/stack/collectd.log
  38
  39    The following plugings should be found loaded:
  40    aodh, gnocchi, hugepages, intel_rdt, mcelog, ovs_events, ovs_stats, snmp, virt
  41
  42 2. On the compute node, 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 3. Connect to the controller and query the monitoring services.  Make sure the overcloudrc.v3
  66    file has been copied to the controller (from the undercloud VM or from the Jump Host) in order
  67    to be able to authenticate for OpenStack services.
  68
  69    .. code:: bash
  70
  71       $ opnfv-util overcloud controller0
  72       $ su
  73       $ source overcloudrc.v3
  74       $ gnocchi metric list
  75       $ aodh alarm list
  76
  77    The output for the gnocchi and aodh queries should be similar to the excerpts below:
  78
  79    .. code:: bash
  80
  81       +--------------------------------------+---------------------+------------------------------------------------------------------------------------------------------------+-----------+-------------+
  82       | id                                   | archive_policy/name | name                                                                                                       | unit      | resource_id |
  83       +--------------------------------------+---------------------+------------------------------------------------------------------------------------------------------------+-----------+-------------+
  84         [...]
  85       | 0550d7c1-384f-4129-83bc-03321b6ba157 | high                | overcloud-novacompute-0.jf.intel.com-hugepages-mm-2048Kb@vmpage_number.free                                | Pages     | None        |
  86       | 0cf9f871-0473-4059-9497-1fea96e5d83a | high                | overcloud-novacompute-0.jf.intel.com-hugepages-node0-2048Kb@vmpage_number.free                             | Pages     | None        |
  87       | 0d56472e-99d2-4a64-8652-81b990cd177a | high                | overcloud-novacompute-0.jf.intel.com-hugepages-node1-1048576Kb@vmpage_number.used                          | Pages     | None        |
  88       | 0ed71a49-6913-4e57-a475-d30ca2e8c3d2 | high                | overcloud-novacompute-0.jf.intel.com-hugepages-mm-1048576Kb@vmpage_number.used                             | Pages     | None        |
  89       | 11c7be53-b2c1-4c0e-bad7-3152d82c6503 | high                | overcloud-novacompute-0.jf.intel.com-mcelog-                                                               | None      | None        |
  90       |                                      |                     | SOCKET_0_CHANNEL_any_DIMM_any@errors.uncorrected_memory_errors_in_24h                                      |           |             |
  91       | 120752d4-385e-4153-aed8-458598a2a0e0 | high                | overcloud-novacompute-0.jf.intel.com-cpu-24@cpu.interrupt                                                  | jiffies   | None        |
  92       | 1213161e-472e-4e1b-9e56-5c6ad1647c69 | high                | overcloud-novacompute-0.jf.intel.com-cpu-6@cpu.softirq                                                     | jiffies   | None        |
  93         [...]
  94
  95       +--------------------------------------+-------+------------------------------------------------------------------+-------+----------+---------+
  96       | alarm_id                             | type  | name                                                             | state | severity | enabled |
  97       +--------------------------------------+-------+------------------------------------------------------------------+-------+----------+---------+
  98       | fbd06539-45dd-42c5-a991-5c5dbf679730 | event | gauge.memory_erros(overcloud-novacompute-0.jf.intel.com-mcelog)  | ok    | moderate | True    |
  99       | d73251a5-1c4e-4f16-bd3d-377dd1e8cdbe | event | gauge.mcelog_status(overcloud-novacompute-0.jf.intel.com-mcelog) | ok    | moderate | True    |
 100         [...]