X-Git-Url: https://gerrit.opnfv.org/gerrit/gitweb?a=blobdiff_plain;f=docs%2Frelease%2Fconfigguide%2Ffeatureconfig.rst;h=c264fff47fde33b6366a13a9514d8d62a80acbf1;hb=0b190aba77eab84fdbf53e6a2b3ad4e64cc608b1;hp=f7f7ec5ee5a550423258c91260597c74af25c37f;hpb=5649793d2037d6f26211be4035e28842ebb3e737;p=barometer.git diff --git a/docs/release/configguide/featureconfig.rst b/docs/release/configguide/featureconfig.rst index f7f7ec5e..c264fff4 100644 --- a/docs/release/configguide/featureconfig.rst +++ b/docs/release/configguide/featureconfig.rst @@ -1,60 +1,54 @@ .. 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. - -.. contents:: - :depth: 3 - :local: - -Pre-configuration activities ----------------------------- -The Barometer Fuel plugin can be found in /opt/opnfv on the fuel master. -To enable this plugin: +============================= +Barometer Configuration Guide +============================= +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 - 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, +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 + $ cd /etc/opnfv-apex + $ opnfv-deploy -d os-nosdn-bar-ha.yaml -n network_settings.yaml -i inventory.yaml –- debug -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. +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 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 " -* 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 ISO image, and respectively the RPM/Debian packages. +There is no simple way to update only the Barometer plugins in an existing deployment.