Merge "Docs: Updating Barometer Configuration Guide for E Release"

1 files changed, 21 insertions, 40 deletions

diff --git a/docs/release/configguide/featureconfig.rst b/docs/release/configguide/featureconfig.rst
index f7f7ec5e..52546178 100644
--- a/docs/release/configguide/featureconfig.rst
+++ b/docs/release/configguide/featureconfig.rst
@@ -1,14 +1,12 @@
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
 .. http://creativecommons.org/licenses/by/4.0
 
-========================
-Barometer Configuration
-========================
-This document provides guidelines on how to install and configure the Barometer
-plugin when using Fuel as a deployment tool. The plugin name is: Collectd
-Ceilometer Plugin. This plugin installs collectd on a compute node and enables
-a number of collectd plugins to collect metrics and events from the platform
-and send them to ceilometer.
+=============================
+Barometer Configuration Guide
+=============================
+This document provides guidelines on how to install and configure Barometer with Apex.
+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.
 
 .. contents::
    :depth: 3
@@ -16,45 +14,28 @@ and send them to ceilometer.
 
 Pre-configuration activities
 ----------------------------
-The Barometer Fuel plugin can be found in /opt/opnfv on the fuel master.
-To enable this plugin:
+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,
+and they are: ``os-nosdn-bar-ha.yaml`` and ``os-nosdn-bar-noha.yaml``.
 
 .. code:: bash
 
-    $ cd /opt/opnfv
-    $ fuel plugins --install fuel-plugin-collectd-ceilometer-1.0-1.0.0-1.noarch.rpm
-
-On the Fuel UI, create a new environment.
-* In Settings > OpenStack Services
-* Enable "Install Ceilometer and Aodh"
-* In Settings > Other
-* Enable "Deploy Collectd Ceilometer Plugin"
-* Enable the barometer plugins you'd like to deploy using the checkboxes
-* Continue with environment configuration and deployment as normal.
+    $ cd /etc/opnfv-apex
+    $ opnfv-deploy -d os-nosdn-bar-ha.yaml -n network_settings.yaml -i inventory.yaml –- debug
 
 Hardware configuration
 ----------------------
-There's no specific Hardware configuration required for this the barometer fuel plugin.
+There's no specific Hardware configuration required.  However, the ``intel_rdt`` plugin works
+only on platforms with Intel CPUs.
 
 Feature configuration
 ---------------------
-Describe the procedures to configure your feature on the platform in order
-that it is ready to use according to the feature instructions in the platform
-user guide.  Where applicable you should add content in the postinstall.rst
-to validate the feature is configured for use.
-(checking components are installed correctly etc...)
-
-Upgrading the plugin
---------------------
-
-From time to time new versions of the plugin may become available.
-
-The plugin cannot be upgraded if an active environment is using the plugin.
-
-In order to upgrade the plugin:
-
-* Copy the updated plugin file to the fuel-master.
-* On the Fuel UI, reset the environment.
-* On the Fuel CLI "fuel plugins --update <fuel-plugin-file>"
-* On the Fuel UI, re-deploy the environment.
+All Barometer plugins are automatically deployed on all compute nodes.  There is no option to
+selectively install only a subset of plugins.  Any custom disabling or configuration must be done
+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.