aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorEmma Foley <efoley@redhat.com>2021-08-06 12:18:21 +0100
committerEmma Foley <efoley@redhat.com>2021-08-26 20:56:36 +0100
commit18e27d1c59cf34373b8079e066a296a5922a5b04 (patch)
tree15f13c3ebe71dc3f3759fa5e40425369603b3fb3
parentaa2982090189856bcf082d71c0d15d80367fa0d1 (diff)
[docs] Update config and post-installation guides
The configguide was removed previously because it only contained information about using the OPNFV installers, however, now there appears to be no config information about the plugins. The config information for each plugin is included in the user guide in docs/release/userguide/feature.userguide.rst. This change adds in a note to the the config guide on where to look. Signed-off-by: Emma Foley <efoley@redhat.com> Change-Id: I7f71d51846c9116bed3882b96e762ab5d70fdfa4
-rw-r--r--docs/release/configguide/featureconfig.rst8
-rw-r--r--docs/release/configguide/postinstall.rst74
-rw-r--r--docs/release/userguide/feature.userguide.rst2
-rw-r--r--docs/release/userguide/installguide.docker.rst8
4 files changed, 86 insertions, 6 deletions
diff --git a/docs/release/configguide/featureconfig.rst b/docs/release/configguide/featureconfig.rst
new file mode 100644
index 0000000..f9e197b
--- /dev/null
+++ b/docs/release/configguide/featureconfig.rst
@@ -0,0 +1,8 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+=============================
+Barometer Configuration Guide
+=============================
+Information on configuring Barometer are included in the :ref:`feature userguide <feature-userguide>`.
+
diff --git a/docs/release/configguide/postinstall.rst b/docs/release/configguide/postinstall.rst
index 7424cec..dad56b9 100644
--- a/docs/release/configguide/postinstall.rst
+++ b/docs/release/configguide/postinstall.rst
@@ -1,3 +1,5 @@
+.. _barometer-postinstall:
+
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
@@ -10,6 +12,14 @@ This document describes briefly the methods of validating the Barometer installa
Automated post installation activities
--------------------------------------
+.. This section will include how to run plugin validation tests, when they are created/merged.
+.. This section will also include some troubleshooting and debugging information.
+
+.. note:: This section is outdated and needs to be updated.
+
+.. TODO: Update this section; post-installation/verification shouldn't be in
+ the config guide. It should be in testing.
+
The Barometer test-suite in Functest is called ``barometercollectd`` and is part of the ``Features``
tier. Running these tests is done automatically by the OPNFV deployment pipeline on the supported
scenarios. The testing consists of basic verifications that each plugin is functional per their
@@ -19,7 +29,65 @@ default configurations. Inside the Functest container, the detailed results can
Barometer post configuration procedures
---------------------------------------
The functionality for each plugin (such as enabling/disabling and configuring its capabilities)
-is controlled as described in the User Guide through their individual ``.conf`` file located in
-the ``/etc/collectd/collectd.conf.d/`` folder on the compute node(s). In order for any changes to
-take effect, the collectd service must be stopped and then started again.
+is controlled as described in the :ref:`User Guide <barometer-userguide>` through their individual
+``.conf`` file located in the ``/etc/collectd/collectd.conf.d/`` on the host(s). In order for any
+changes to take effect, the collectd service must be stopped and then started again.
+
+Plugin verification
+~~~~~~~~~~~~~~~~~~~
+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.
+
+MCElog
+^^^^^^
+On the collectd host, you can induce an event monitored by the plugins; e.g. a corrected memory error:
+
+.. code:: bash
+
+ $ git clone https://git.kernel.org/pub/scm/utils/cpu/mce/mce-inject.git
+ $ cd mce-inject
+ $ make
+ $ modprobe mce-inject
+
+Modify the test/corrected script to include the following:
+
+.. code:: bash
+
+ CPU 0 BANK 0
+ STATUS 0xcc00008000010090
+ ADDR 0x0010FFFFFFF
+
+Inject the error:
+
+.. code:: bash
+
+ $ ./mce-inject < test/corrected
+
+.. TODO: How to check that the event was propogated to collectd
+
+.. _barometer-docker-verification:
+
+Barometer post installation verification on barometer-collectd container
+------------------------------------------------------------------------
+
+The following steps describe how to perform simple "manual" testing of the Barometer components
+after :ref:`successfully deploying the barometer-collectd container<barometer-docker-userguide>`:
+
+1. Connect to any compute node and ensure that the collectd container is running.
+
+ .. code:: bash
+
+ root@host2:~# docker ps | grep collectd
+
+ You should see the container ``opnfv/barometer-collectd`` running.
+
+2. Use a web browser to connect to Grafana at ``http://<serverip>:3000/``, using the hostname or
+ IP of your server and port 3000. Log in with admin/admin. You will see ``collectd``
+ InfluxDB database in the ``Data Sources``. Also, you will notice metrics coming in the several
+ dashboards such as ``CPU Usage`` and ``Host Overview``.
+
+For more details on the Barometer containers, Grafana and InfluxDB, please refer to
+the following documentation links:
+
+`Barometer Containers wiki page <https://wiki.opnfv.org/display/fastpath/Barometer+Containers#BarometerContainers-barometer-collectdcontainer>`_
+:ref:`Barometer Docker install guide<barometer-docker-userguide>`
diff --git a/docs/release/userguide/feature.userguide.rst b/docs/release/userguide/feature.userguide.rst
index 2f4639c..02f8bda 100644
--- a/docs/release/userguide/feature.userguide.rst
+++ b/docs/release/userguide/feature.userguide.rst
@@ -1,3 +1,5 @@
+.. _feature-userguide:
+
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
.. (c) Anuket and others
diff --git a/docs/release/userguide/installguide.docker.rst b/docs/release/userguide/installguide.docker.rst
index 20836af..38d467a 100644
--- a/docs/release/userguide/installguide.docker.rst
+++ b/docs/release/userguide/installguide.docker.rst
@@ -1,7 +1,7 @@
+.. _barometer-docker-userguide:
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
.. (c) Anuket and others
-.. _barometer-docker-userguide:
=====================================
Anuket Barometer Docker Install Guide
@@ -31,7 +31,9 @@ For steps to build and run VES and Kafka images please see section `Build and Ru
For overview of running VES application with Kafka please see the :ref:`VES Application User Guide <barometer-ves-userguide>`
-For an alternative installation method using ansible, please see the :ref:`Barometer One Click Install Guide <barometer-oneclick-userguide>`.
+For an alternative installation method using ansible, please see the :ref:`Barometer One Click Install Guide <barometer-oneclick-userguide>`.
+
+For post-installation verification and troubleshooting, please see the :ref:`Barometer post installation guide <barometer-postinstall>`.
Barometer Docker Images Description
-----------------------------------
@@ -93,7 +95,7 @@ The Barometer project's VES application and Kafka docker images are based on a C
docker image has a dependancy on `Zookeeper <https://zookeeper.apache.org/>`_. Kafka must be able to
connect and register with an instance of Zookeeper that is either running on local or remote host.
Kafka recieves and stores metrics recieved from Collectd. VES application pulls latest metrics from Kafka
-which it normalizes into VES format for sending to a VES collector. Please see details in
+which it normalizes into VES format for sending to a VES collector. Please see details in
:ref:`VES Application User Guide <barometer-ves-userguide>`
Installing Docker