ubuntu14.04: fix package list in base build
[barometer.git] / src / fuel-plugin / README.md
1 Barometer Plugin
2 ================
3
4 Plugin description
5 Installs collectd-ceilometer on compute via a fuel plugin.
6
7 Requirements
8 ------------
9
10 | Requirement                      | Version/Comment |
11 |----------------------------------|-----------------|
12 | Mirantis OpenStack compatibility | 10.0            |
13
14
15 Documents
16 ---------
17
18 1. https://wiki.openstack.org/wiki/Fuel
19 2. https://wiki.openstack.org/wiki/Fuel/Plugins
20
21 Build/Deploy/Verify
22 -------------------
23
24 step 1, 2, 3 may be bypassed if fuel plugin is installed from /opt/opnfv in fuel@opnfv.
25
26 1) install fuel plugin builder
27     sudo apt-get install -y ruby-dev rubygems-integration python-pip rpm createrepo dpkg-dev
28     sudo gem install fpm
29     sudo pip install fuel-plugin-builder
30
31 2) build plugin
32     fpb --build <plugin-dir>
33     e.g.: fpb --build barometer/src/fuel-plugin
34
35 3) copy plugin rpm to fuel master
36         e.g. scp fuel-plugin-collectd-ceilometer-1.0-1.0.0-1.noarch.rpm  <user>@<server-name>:~/
37
38 4) install plugin
39         fuel plugins --install <plugin-name>.rpm
40
41 5) prepare fuel environment
42   a) enable ceilometer service
43     go to settings/openstack services
44     check 'Install Ceilometer and Aodh' to enable ceilometer
45   b) enable collectd-ceilometer
46     go to settings/other
47     enable the barometer plugins using the checkboxes
48   c) save settings
49
50 6) add nodes to environment
51
52 7) deploy
53
54 8) verify
55 SSH to openstack controller node:
56     source openrc
57     ceilometer sample-list -m interface.if_packets
58     ceilometer sample-list -m hugepages.vmpage_number
59     ceilometer sample-list -m ovs_events.gauge
60     ceilometer sample-list -m mcelog.errors