docs: moving to new doc structure
[barometer.git] / docs / release / configguide / featureconfig.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
3
4 ========================
5 Barometer Configuration
6 ========================
7 This document provides guidelines on how to install and configure the Barometer
8 plugin when using Fuel as a deployment tool. The plugin name is: Collectd
9 Ceilometer Plugin. This plugin installs collectd on a compute node and enables
10 a number of collectd plugins to collect metrics and events from the platform
11 and send them to ceilometer.
12
13 .. contents::
14    :depth: 3
15    :local:
16
17 Pre-configuration activities
18 ----------------------------
19 The Barometer Fuel plugin can be found in /opt/opnfv on the fuel master.
20 To enable this plugin:
21
22 .. code:: bash
23
24     $ cd /opt/opnfv
25     $ fuel plugins --install fuel-plugin-collectd-ceilometer-1.0-1.0.0-1.noarch.rpm
26
27 On the Fuel UI, create a new environment.
28 * In Settings > OpenStack Services
29 * Enable "Install Ceilometer and Aodh"
30 * In Settings > Other
31 * Enable "Deploy Collectd Ceilometer Plugin"
32 * Enable the barometer plugins you'd like to deploy using the checkboxes
33 * Continue with environment configuration and deployment as normal.
34
35 Hardware configuration
36 ----------------------
37 There's no specific Hardware configuration required for this the barometer fuel plugin.
38
39 Feature configuration
40 ---------------------
41 Describe the procedures to configure your feature on the platform in order
42 that it is ready to use according to the feature instructions in the platform
43 user guide.  Where applicable you should add content in the postinstall.rst
44 to validate the feature is configured for use.
45 (checking components are installed correctly etc...)
46
47 Upgrading the plugin
48 --------------------
49
50 From time to time new versions of the plugin may become available.
51
52 The plugin cannot be upgraded if an active environment is using the plugin.
53
54 In order to upgrade the plugin:
55
56 * Copy the updated plugin file to the fuel-master.
57 * On the Fuel UI, reset the environment.
58 * On the Fuel CLI "fuel plugins --update <fuel-plugin-file>"
59 * On the Fuel UI, re-deploy the environment.
60