aboutsummaryrefslogtreecommitdiffstats
path: root/docs/release/configguide/featureconfig.rst
diff options
context:
space:
mode:
authorramamani yeleswarapu <ramamani.yeleswarapu@intel.com>2017-12-13 11:46:05 -0800
committerMaryam Tahhan <maryam.tahhan@intel.com>2017-12-14 10:29:02 +0000
commitc8fb69defcc4f33371827a2889910b940fe70123 (patch)
treea8d87661bfde7cfba79806b05140732ff680418b /docs/release/configguide/featureconfig.rst
parentf04e17c162ed39fed95b3823ca106d195ee62342 (diff)
docs: Adding Compass4nfv installer support details
The following two files have been updated with info on deploying Barometer with Compass4nfv installer: docs/release/configguide/featureconfig.rst docs/release/configguide/postinstall.rst Change-Id: I99364b2e08afeee51407020149677c249ed75484 Signed-off-by: Ramamani Yeleswarapu <ramamani.yeleswarapu@intel.com>
Diffstat (limited to 'docs/release/configguide/featureconfig.rst')
-rw-r--r--docs/release/configguide/featureconfig.rst27
1 files changed, 22 insertions, 5 deletions
diff --git a/docs/release/configguide/featureconfig.rst b/docs/release/configguide/featureconfig.rst
index 8bce8d4..c264fff 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.