From a9e38121fdfce63a82da3b4d0177b9bdc485b1c9 Mon Sep 17 00:00:00 2001 From: Tomas Barton Date: Wed, 21 Aug 2013 17:33:24 +0200 Subject: README converted to MarkDown syntax --- README | 83 --------------------------------------------------------------- README.md | 82 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 82 insertions(+), 83 deletions(-) delete mode 100644 README create mode 100644 README.md diff --git a/README b/README deleted file mode 100644 index ef3c2fd..0000000 --- a/README +++ /dev/null @@ -1,83 +0,0 @@ -== Munin == - -Munin is a performance monitoring system which creates nice RRD graphs and has -a very easy plugin interface. The munin homepage is http://munin.projects.linpro.no/ - -To use this module, follow these directions: - -0. This module requires puppet 2.7 or newer. - -1. Install the "common", "concat" and "stdlib" modules -- the munin module - depends on functions that are defined and installed via these modules. - -2. You will need storedconfigs enabled in your puppet setup, to do that you need to - add a line to your puppet.conf in your [puppetmasterd] section which says: - - storeconfigs=true - - You may wish to immediately setup a mysql/pgsql database for your storedconfigs, as - the default method uses sqlite, and is not very efficient, to do that you need lines - such as the following below the storeconfigs=true line (adjust as needed): - - dbadapter=mysql - dbserver=localhost - dbuser=puppet - dbpassword=puppetspasswd - -3. Install the "munin" module: - - a. Your modules directory will need all the files included in this repository placed - under a directory called "munin" - - b. For every host you wish to gather munin statistics, add the class munin::client to that - node. You will want to set the class parameter 'allow' to be the IP(s) of the munin - collector, this defines what IP is permitted to connect to the node, for example: - - node foo { - class { 'munin::client': allow => '192.168.0.1'} - } - - for multiple munin nodes, you can pass an array: - - class { 'munin::client': allow => [ '192.168.0.1', '10.0.0.1' ] } - - c. In the node definition in your site.pp for your main munin host, add the following: - - class { 'munin::host': } - - If you want cgi graphing you can pass cgi_graphing => true. - (For CentOS this is enabled in the default header config) - for more information, see: http://munin.projects.linpro.no/wiki/CgiHowto - - d. If there are particular munin plugins you want to enable or configure, you define them - in the node definition, like follows: - - # Enable monitoring of disk stats in bytes - munin::plugin { 'df_abs': } - - # Use a non-standard plugin path to use custom plugins - munin::plugin { 'spamassassin': - ensure => present, - script_path => '/usr/local/share/munin-plugins', - } - - # For wildcard plugins (eg. ip_, snmp_, etc.), use the name variable to - # configure the plugin name, and the ensure parameter to indicate the base - # plugin name to which you want a symlink, for example: - munin::plugin { [ 'ip_192.168.0.1', 'ip_10.0.0.1' ]: - ensure => 'ip_' - } - - # Use a special config to pass parameters to the plugin - munin::plugin { - [ 'apache_accesses', 'apache_processes', 'apache_volume' ]: - ensure => present, - config => 'env.url http://127.0.0.1:80/server-status?auto' - } - - e. If you have Linux-Vservers configured, you will likely have multiple munin-node processes - competing for the default port 4949, for those nodes, set an alternate port for munin-node - to run on by putting something similar to the following class parameter: - - class { 'munin::client': allow => '192.168.0.1', port => '4948' } - diff --git a/README.md b/README.md new file mode 100644 index 0000000..1a46be2 --- /dev/null +++ b/README.md @@ -0,0 +1,82 @@ +# Munin + +Munin is a performance monitoring system which creates nice RRD graphs and has +a very easy plugin interface. The munin homepage is http://munin.projects.linpro.no/ + +To use this module, follow these directions: + +## Requirements + + * puppet 2.7 or newer + * install the `common`, `concat` and `stdlib` modules -- the munin module depends on functions that are defined and installed via these modules + * you will need storedconfigs enabled in your puppet setup, to do that you need to add a line to your `puppet.conf` in your `[puppetmasterd]` section which says: + + storeconfigs=true + + * You may wish to immediately setup a `mysql`/ `pgsql` database for your storedconfigs, as + the default method uses sqlite, and is not very efficient, to do that you need lines + such as the following below the `storeconfigs=true` line (adjust as needed): + + dbadapter=mysql + dbserver=localhost + dbuser=puppet + dbpassword=puppetspasswd + +## Usage + + a. Your modules directory will need all the files included in this repository placed + under a directory called "munin" + + b. For every host you wish to gather munin statistics, add the class munin::client to that + node. You will want to set the class parameter 'allow' to be the IP(s) of the munin + collector, this defines what IP is permitted to connect to the node, for example: + + node foo { + class { 'munin::client': allow => '192.168.0.1'} + } + + +for multiple munin nodes, you can pass an array: + + class { 'munin::client': allow => [ '192.168.0.1', '10.0.0.1' ] } + + c. In the node definition in your site.pp for your main munin host, add the following: + + class { 'munin::host': } + + If you want cgi graphing you can pass cgi_graphing => true. + (For CentOS this is enabled in the default header config) + for more information, see: http://munin.projects.linpro.no/wiki/CgiHowto + + d. If there are particular munin plugins you want to enable or configure, you define them + in the node definition, like follows: + + # Enable monitoring of disk stats in bytes + munin::plugin { 'df_abs': } + + # Use a non-standard plugin path to use custom plugins + munin::plugin { 'spamassassin': + ensure => present, + script_path => '/usr/local/share/munin-plugins', + } + + # For wildcard plugins (eg. ip_, snmp_, etc.), use the name variable to + # configure the plugin name, and the ensure parameter to indicate the base + # plugin name to which you want a symlink, for example: + munin::plugin { [ 'ip_192.168.0.1', 'ip_10.0.0.1' ]: + ensure => 'ip_' + } + + # Use a special config to pass parameters to the plugin + munin::plugin { + [ 'apache_accesses', 'apache_processes', 'apache_volume' ]: + ensure => present, + config => 'env.url http://127.0.0.1:80/server-status?auto' + } + + e. If you have Linux-Vservers configured, you will likely have multiple munin-node processes + competing for the default port 4949, for those nodes, set an alternate port for munin-node + to run on by putting something similar to the following class parameter: + + class { 'munin::client': allow => '192.168.0.1', port => '4948' } + -- cgit v1.2.3 From 8f8ef21afd6424fc7f6ecaabb968b8278073d430 Mon Sep 17 00:00:00 2001 From: Tomas Barton Date: Wed, 21 Aug 2013 17:35:46 +0200 Subject: lists formatting --- README.md | 14 ++++++-------- 1 file changed, 6 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 1a46be2..d6347ee 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,8 @@ -# Munin +# Puppet-Munin Munin is a performance monitoring system which creates nice RRD graphs and has a very easy plugin interface. The munin homepage is http://munin.projects.linpro.no/ -To use this module, follow these directions: - ## Requirements * puppet 2.7 or newer @@ -24,10 +22,10 @@ To use this module, follow these directions: ## Usage - a. Your modules directory will need all the files included in this repository placed + 1. Your modules directory will need all the files included in this repository placed under a directory called "munin" - b. For every host you wish to gather munin statistics, add the class munin::client to that + 2. For every host you wish to gather munin statistics, add the class munin::client to that node. You will want to set the class parameter 'allow' to be the IP(s) of the munin collector, this defines what IP is permitted to connect to the node, for example: @@ -40,7 +38,7 @@ for multiple munin nodes, you can pass an array: class { 'munin::client': allow => [ '192.168.0.1', '10.0.0.1' ] } - c. In the node definition in your site.pp for your main munin host, add the following: + 3. In the node definition in your site.pp for your main munin host, add the following: class { 'munin::host': } @@ -48,7 +46,7 @@ for multiple munin nodes, you can pass an array: (For CentOS this is enabled in the default header config) for more information, see: http://munin.projects.linpro.no/wiki/CgiHowto - d. If there are particular munin plugins you want to enable or configure, you define them + 4. If there are particular munin plugins you want to enable or configure, you define them in the node definition, like follows: # Enable monitoring of disk stats in bytes @@ -74,7 +72,7 @@ for multiple munin nodes, you can pass an array: config => 'env.url http://127.0.0.1:80/server-status?auto' } - e. If you have Linux-Vservers configured, you will likely have multiple munin-node processes + 5. If you have Linux-Vservers configured, you will likely have multiple munin-node processes competing for the default port 4949, for those nodes, set an alternate port for munin-node to run on by putting something similar to the following class parameter: -- cgit v1.2.3 From 67af1c2b32e4557cc9b62d1b8046bb6c2b006319 Mon Sep 17 00:00:00 2001 From: Tomas Barton Date: Wed, 21 Aug 2013 17:38:02 +0200 Subject: fixed list numbering --- README.md | 9 +++------ 1 file changed, 3 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index d6347ee..74d82ba 100644 --- a/README.md +++ b/README.md @@ -26,15 +26,14 @@ a very easy plugin interface. The munin homepage is http://munin.projects.linpro under a directory called "munin" 2. For every host you wish to gather munin statistics, add the class munin::client to that - node. You will want to set the class parameter 'allow' to be the IP(s) of the munin + node. You will want to set the class parameter `allow` to be the IP(s) of the munin collector, this defines what IP is permitted to connect to the node, for example: node foo { class { 'munin::client': allow => '192.168.0.1'} } - -for multiple munin nodes, you can pass an array: + for multiple munin nodes, you can pass an array: class { 'munin::client': allow => [ '192.168.0.1', '10.0.0.1' ] } @@ -42,9 +41,7 @@ for multiple munin nodes, you can pass an array: class { 'munin::host': } - If you want cgi graphing you can pass cgi_graphing => true. - (For CentOS this is enabled in the default header config) - for more information, see: http://munin.projects.linpro.no/wiki/CgiHowto + If you want cgi graphing you can pass `cgi_graphing => true`. (For CentOS this is enabled in the default header config) for more information, see: http://munin.projects.linpro.no/wiki/CgiHowto 4. If there are particular munin plugins you want to enable or configure, you define them in the node definition, like follows: -- cgit v1.2.3 From cef87f9f10e48c11713e182ce8dcc367145f2ba9 Mon Sep 17 00:00:00 2001 From: Tomas Barton Date: Wed, 21 Aug 2013 17:59:45 +0200 Subject: added modulefile --- Modulefile | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 Modulefile diff --git a/Modulefile b/Modulefile new file mode 100644 index 0000000..99c61a1 --- /dev/null +++ b/Modulefile @@ -0,0 +1,14 @@ +name 'puppet-munin' +version '0.0.1' +source 'git://github.com/duritong/puppet-munin.git' +author 'duritong' +license 'Apache License, Version 2.0' +summary 'Puppet module for Munin monitoring' +description 'Munin is a performance monitoring system which creates nice RRD graphs and has a very easy plugin interface' +project_page 'https://github.com/duritong/puppet-munin' + +## Add dependencies, if any: +# dependency 'username/name', '>= 1.2.0' +dependency 'ripienaar/concat', '>= 0.2.0' +dependency 'DavidSchmitt/common', '>= 1.0.0' +dependency 'puppetlabs/stdlib', '>= 3.2.0' -- cgit v1.2.3