made munin_allow a lot more scalable
[puppet_munin.git] / README
1
2 Munin is a performance monitoring system which creates nice RRD graphs and has
3 a very easy plugin interface. The munin homepage is http://munin.projects.linpro.no/
4
5 To use this module, follow these directions:
6
7 1. Install the "common" module -- the munin module depends on functions that are
8    defined and installed via the common module, see README.common for how to do this
9
10 2. You will need storedconfigs enabled in your puppet setup, to do that you need to
11    add a line to your puppet.conf in your [puppetmasterd] section which says:
12    
13    storeconfigs=true
14
15    You may wish to immediately setup a mysql/pgsql database for your storedconfigs, as
16    the default method uses sqlite, and is not very efficient, to do that you need lines
17    such as the following below the storeconfigs=true line (adjust as needed):
18
19    dbadapter=mysql
20    dbserver=localhost
21    dbuser=puppet
22    dbpassword=puppetspasswd
23
24 3. Install the "munin" module:
25
26    a. Your modules directory will need all the files included in this repository placed 
27       under a directory called "munin"
28
29    b. add the following line to your modules.pp:
30    
31       import "munin" 
32
33       (NOTE: if you have followed the directions in README.common then you will have import 
34       "modules.pp" in your site.pp, if you do not have that, then you will need to add the 
35       import line to your site.pp)
36
37    c. you will also need to create the following empty directories:
38
39       mkdir /etc/puppet/modules/munin/files/empty
40       mkdir /etc/puppet/modules/munin/files/modules_dir
41       mkdir -p /etc/puppet/modules/munin/files/nodes/modules_dir
42       mkdir -p /etc/puppet/modules/munin/files/plugins/modules_dir
43
44    d. Add to the top of your site.pp a variable which indicates what IP should be allowed to 
45       connect to your individual munin-nodes (this is typically your main munin host's IP):
46
47       $munin_allow = '192.168.0.1'
48       
49       If you want to define more than one host, you can seperate them by colon:
50
51       $munin_allow = '127.0.0.1:192.168.0.1'
52
53    e. In the node definition in your site.pp for your main munin host, add the following:
54
55       include munin::host
56    
57    f. On each node that will gather munin statistics, add this line to that node's entry 
58       in site.pp (you may want to also add this to your main munin host):
59       
60       include munin::client
61
62    g. If there are particular munin plugins you want to enable or configure, you define them
63       in the node definition, like follows:
64
65       # Enable monitoring of disk stats in bytes
66       munin::plugin { df_abs: }
67
68       # Use a non-standard plugin path to use custom plugins
69       munin::plugin { "spamassassin":
70          ensure => "spamassassin",
71          script_path => "/usr/local/share/munin-plugins",
72       }
73
74       # Use a special config to pass parameters to the plugin
75       munin::plugin {
76          [ "apache_accesses", "apache_processes", "apache_volume" ]:
77             ensure => present,
78             config => "env.url http://127.0.0.1:80/server-status?auto"
79       }
80
81
82    h. If you have Linux-Vservers configured, you will likely have multiple munin-node processes
83       competing for the default port 4949, for those nodes, set an alternate port for munin-node
84       to run on by putting something similar to the following in the node definition:
85
86       $munin_port = 4948
87