diff options
| -rw-r--r-- | docs/release/configguide/featureconfig.rst | 27 | ||||
| -rw-r--r-- | docs/release/configguide/postinstall.rst | 43 |
2 files changed, 63 insertions, 7 deletions
diff --git a/docs/release/configguide/featureconfig.rst b/docs/release/configguide/featureconfig.rst index 8bce8d4d..c264fff4 100644 --- a/docs/release/configguide/featureconfig.rst +++ b/docs/release/configguide/featureconfig.rst @@ -4,12 +4,12 @@ ============================= Barometer Configuration Guide ============================= -This document provides guidelines on how to install and configure Barometer with Apex. +This document provides guidelines on how to install and configure Barometer with Apex and Compass4nfv. The deployment script installs and enables a series of collectd plugins on the compute node(s), which collect and dispatch specific metrics and events from the platform. -Pre-configuration activities ----------------------------- +Pre-configuration activities - Apex +----------------------------------- Deploying the Barometer components in Apex is done through the deploy-opnfv command by selecting a scenario-file which contains the ``barometer: true`` option. These files are located on the Jump Host in the ``/etc/opnfv-apex/ folder``. Two scenarios are pre-defined to include Barometer, @@ -20,6 +20,23 @@ and they are: ``os-nosdn-bar-ha.yaml`` and ``os-nosdn-bar-noha.yaml``. $ cd /etc/opnfv-apex $ opnfv-deploy -d os-nosdn-bar-ha.yaml -n network_settings.yaml -i inventory.yaml –- debug +Pre-configuration activities - Compass4nfv +------------------------------------------ +Deploying the Barometer components in Compass4nfv is done by running the deploy.sh script after +exporting a scenario-file which contains the ``barometer: true`` option. Two scenarios are pre-defined +to include Barometer, and they are: ``os-nosdn-bar-ha.yaml`` and ``os-nosdn-bar-noha.yaml``. For more +information, please refer to these useful links: +https://github.com/opnfv/compass4nfv +https://wiki.opnfv.org/display/compass4nfv/Compass+101 +https://wiki.opnfv.org/display/compass4nfv/Containerized+Compass + +The quickest way to deploy using Compass4nfv is given below. + +.. code:: bash + + $ export SCENARIO=os-nosdn-bar-ha.yml + $ curl https://raw.githubusercontent.com/opnfv/compass4nfv/master/quickstart.sh | bash + Hardware configuration ---------------------- There's no specific Hardware configuration required. However, the ``intel_rdt`` plugin works @@ -33,5 +50,5 @@ directly on the compute node(s) after the deployment is completed. Upgrading the plugins --------------------- -The Barometer components are built-in in the Apex ISO image, and respectively the Apex RPMs. There -is no simple way to update only the Barometer plugins in an existing deployment. +The Barometer components are built-in in the ISO image, and respectively the RPM/Debian packages. +There is no simple way to update only the Barometer plugins in an existing deployment. diff --git a/docs/release/configguide/postinstall.rst b/docs/release/configguide/postinstall.rst index 45a79ffb..7ec047da 100644 --- a/docs/release/configguide/postinstall.rst +++ b/docs/release/configguide/postinstall.rst @@ -21,8 +21,8 @@ is controlled as described in the User Guide through their individual ``.conf`` 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. -Platform components validation ------------------------------- +Platform components validation - Apex +------------------------------------- The following steps describe how to perform a simple "manual" testing of the Barometer components: 1. Connect to any compute node and ensure that the collectd service is running. The log file @@ -98,3 +98,42 @@ The following steps describe how to perform a simple "manual" testing of the Bar | fbd06539-45dd-42c5-a991-5c5dbf679730 | event | gauge.memory_erros(overcloud-novacompute-0.jf.intel.com-mcelog) | ok | moderate | True | | d73251a5-1c4e-4f16-bd3d-377dd1e8cdbe | event | gauge.mcelog_status(overcloud-novacompute-0.jf.intel.com-mcelog) | ok | moderate | True | [...] + + +Platform components validation - Compass4nfv +-------------------------------------------- + +The procedure is similar to the above. + +The following steps describe how to perform a simple "manual" testing of the Barometer components: + +On the compute: + +1. Connect to any compute node and ensure that the collectd service is running. The log file + ``collectd.log`` should contain no errors and should indicate that each plugin was successfully + loaded. For example, ssh into a compute node and test: + + .. code:: bash + + $ ls /etc/collectd/collectd.conf.d/ + $ systemctl status collectd + $ vi /var/log/collectd.log + + The following plugings should be found loaded: + aodh, gnocchi, hugepages, mcelog, ovs_events, ovs_stats, cpu, interface, memory, disk, numa, virt, rrdtool + +2. Testing using mce-inject is similar to #2 shown above. + +On the controller: + +3. Connect to the controller and query the monitoring services. Make sure to log in to the lxc-utility +container before using the OpenStack CLI. Please refer to this wiki for details: +https://wiki.opnfv.org/display/compass4nfv/Containerized+Compass#ContainerizedCompass-HowtouseOpenStackCLI + + .. code:: bash + + $ source ~/openrc + $ gnocchi metric list + $ aodh alarm list + + The output for the gnocchi and aodh queries should be similar to the excerpts shown in #3 above. |