ves: update VES app user guide
[barometer.git] / docs / release / userguide / feature.userguide.rst
index 099d8e2..30e34b9 100644 (file)
@@ -6,10 +6,6 @@
 OPNFV Barometer User Guide
 ===================================
 
-.. contents::
-   :depth: 3
-   :local:
-
 Barometer collectd plugins description
 ---------------------------------------
 .. Describe the specific features and how it is realised in the scenario in a brief manner
@@ -321,7 +317,7 @@ To configure some hugepages:
 
    $ sudo mkdir -p /mnt/huge
    $ sudo mount -t hugetlbfs nodev /mnt/huge
-   $ sudo echo 14336 > /sys/devices/system/node/node0/hugepages/hugepages-2048kB/nr_hugepages
+   $ sudo bash -c "echo 14336 > /sys/devices/system/node/node0/hugepages/hugepages-2048kB/nr_hugepages"
 
 Building and installing collectd:
 
@@ -514,41 +510,24 @@ Remove old version of OpenIPMI library:
 
     $ sudo yum remove OpenIPMI ipmitool
 
-Download OpenIPMI library sources:
+Build and install OpenIPMI library:
 
 .. code:: bash
 
     $ git clone https://git.code.sf.net/p/openipmi/code openipmi-code
     $ cd openipmi-code
-
-Patch the OpenIPMI pkg-config file to provide correct compilation flags
-for collectd IPMI plugin:
-
-.. code:: diff
-
-    diff --git a/OpenIPMIpthread.pc.in b/OpenIPMIpthread.pc.in
-    index 59b52e5..fffa0d0 100644
-    --- a/OpenIPMIpthread.pc.in
-    +++ b/OpenIPMIpthread.pc.in
-    @@ -6,6 +6,6 @@ includedir=@includedir@
-     Name: OpenIPMIpthread
-     Description: Pthread OS handler for OpenIPMI
-     Version: @VERSION@
-    -Requires: OpenIPMI pthread
-    +Requires: OpenIPMI
-     Libs: -L${libdir} -lOpenIPMIutils -lOpenIPMIpthread
-    -Cflags: -I${includedir}
-    +Cflags: -I${includedir} -pthread
-
-Build and install OpenIPMI library:
-
-.. code:: bash
-
     $ autoreconf --install
     $ ./configure --prefix=/usr
     $ make
     $ sudo make install
 
+Add the directory containing ``OpenIPMI*.pc`` files to the ``PKG_CONFIG_PATH``
+environment variable:
+
+.. code:: bash
+
+    export PKG_CONFIG_PATH=/usr/lib/pkgconfig
+
 Enable IPMI support in the kernel:
 
 .. code:: bash
@@ -733,6 +712,7 @@ Then you can run the mcelog test suite with
 This will inject different classes of errors and check that the mcelog triggers
 runs. There will be some kernel messages about page offlining attempts. The
 test will also lose a few pages of memory in your system (not significant).
+
 .. note::
   This test will kill any running mcelog, which needs to be restarted
   manually afterwards.
@@ -924,9 +904,11 @@ On Centos 7:
 .. code:: bash
 
     $ sudo yum install net-snmp net-snmp-libs net-snmp-utils net-snmp-devel
-    $ systemctl start snmpd.service
+    $ sudo systemctl start snmpd.service
 
-Or build from source
+go to the `snmp configuration`_ steps.
+
+From source:
 
 Clone and build net-snmp:
 
@@ -967,12 +949,14 @@ Configure snmpd as a service:
     $ systemctl enable snmpd.service
     $ systemctl start snmpd.service
 
+.. _`snmp configuration`:
+
 Add the following line to snmpd.conf configuration file
-"/usr/share/snmp/snmpd.conf" to make all OID tree visible for SNMP clients:
+``/etc/snmp/snmpd.conf`` to make all OID tree visible for SNMP clients:
 
 .. code:: bash
 
-    view   systemonly  included   .1
+    view    systemview    included   .1
 
 To verify that SNMP is working you can get IF-MIB table using SNMP client
 to view the list of Linux interfaces:
@@ -981,11 +965,28 @@ to view the list of Linux interfaces:
 
     $ snmpwalk -v 2c -c public localhost IF-MIB::interfaces
 
+Get the default MIB location:
+
+.. code:: bash
+
+    $ net-snmp-config --default-mibdirs
+    /opt/stack/.snmp/mibs:/usr/share/snmp/mibs
+
+Install Intel specific MIBs (if needed) into location received by
+``net-snmp-config`` command (e.g. ``/usr/share/snmp/mibs``).
+
+.. code:: bash
+
+    $ git clone https://gerrit.opnfv.org/gerrit/barometer.git
+    $ sudo cp -f barometer/mibs/*.txt /usr/share/snmp/mibs/
+    $ sudo systemctl restart snmpd.service
+
 Clone and install the collectd snmp_agent plugin:
 
 .. code:: bash
 
-    $ git clone  https://github.com/maryamtahhan/collectd
+    $ cd ~
+    $ git clone https://github.com/maryamtahhan/collectd
     $ cd collectd
     $ git checkout feat_snmp
     $ ./build.sh
@@ -1013,6 +1014,15 @@ memAvailReal OID to value represented as free memory type of memory plugin:
       </Data>
     </Plugin>
 
+
+The ``snmpwalk`` command can be used to validate the collectd configuration:
+
+.. code:: bash
+
+    $ snmpwalk -v 2c -c public localhost 1.3.6.1.4.1.2021.4.6.0
+    UCD-SNMP-MIB::memAvailReal.0 = INTEGER: 135237632 kB
+
+
 **Limitations**
 
 * Object instance with Counter64 type is not supported in SNMPv1. When GetNext
@@ -1027,6 +1037,8 @@ https://github.com/maryamtahhan/collectd/blob/feat_snmp/src/collectd.conf.pod
 For more details on AgentX subagent, please see:
 http://www.net-snmp.org/tutorial/tutorial-5/toolkit/demon/
 
+.. _virt-plugin:
+
 virt plugin
 ^^^^^^^^^^^^
 Repo: https://github.com/maryamtahhan/collectd
@@ -1162,6 +1174,8 @@ statistics are disabled. They can be enabled with ``ExtraStats`` option.
 For more information on the plugin parameters, please see:
 https://github.com/maryamtahhan/collectd/blob/feat_libvirt_upstream/src/collectd.conf.pod
 
+.. _install-collectd-as-a-service:
+
 Installing collectd as a service
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 **NOTE**: In an OPNFV installation, collectd is installed and configured as a
@@ -1198,9 +1212,9 @@ Reload
 Additional useful plugins
 ^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-* **Exec Plugin** : Can be used to show you when notifications are being
- generated by calling a bash script that dumps notifications to file. (handy
- for debug). Modify /opt/collectd/etc/collectd.conf:
+**Exec Plugin** : Can be used to show you when notifications are being
+generated by calling a bash script that dumps notifications to file. (handy
+for debug). Modify /opt/collectd/etc/collectd.conf:
 
 .. code:: bash