1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
|
# check_mk
Puppet module for:
* Installing and configuring the Open Monitoring Distribution (OMD) which
includes Nagios, check_mk and lots of other tools
* Installing and configuring check_mk agents
Agent hostnames are automatically added to the server all_hosts configuration
using stored configs.
Currently only tested on Redhat-like systems and on Debian.
For examples how to use this class on a debian wheezy system, check out following
snippets: https://git.codecoop.org/snippets/1, https://git.codecoop.org/snippets/2
## Server
* Installs omd package either using the system repository (eg. yum, apt) or
from a package file retrieved from the Puppet file store
* Use check_mk::omd_repo to enable a debian repository for omd
(requires apt module from i.e. https://labs.riseup.net/code/projects/shared-apt).
For now, you need to fetch the omd apt-key manually from
http://labs.consol.de/nagios/omd-repository/, put it into your site_apt/files/keys
directory and pass the custom_key_dir parameter to the apt class, like
class { 'apt':
custom_key_dir => 'puppet:///modules/site-apt/keys'
}
* Populates the all_hosts array in /etc/check_mk/main.mk with hostnames
exported by check::agent classes on agent hosts
### Example 1
include check_mk
Installs the 'monitoring' package from the system repository. The default 'monitoring' site is used.
### Example 2
class { 'check_mk':
filestore => 'puppet:///files/check_mk',
package => 'omd-0.56-rh60-29.x86_64.rpm'
}
Installs the specified omd package after retrieving it from the Puppet file store.
### Example 3
class { 'check_mk':
site => 'acme',
}
Installs the omd package from the system repository. A site called 'acme' is
created making the URL http://hostname/acme/check_mk/ running as the 'acme' user.
### check_mk parameters
*package*: The omd package (rpm or deb) to install. Optional.
*filestore*: The Puppet file store location where the package can be found (eg. 'puppet:///files/check_mk'). Optional.
*host_groups*: A hash with the host group names as the keys with a list of host tags to match as values. (See 'Host groups and tags' below). Optional.
*site*: The name of the omd site (and the user/group it runs as). Default: 'monitoring'
*workspace*: The directory to use to store files used during installation. Default: '/root/check_mk'
*omdadmin_htpasswd*: changes the htpasswd of the amdadmin user (requires apache module from i.e.
https://labs.riseup.net/code/projects/shared-apache)
*use_ssh*: Configures ssh to agents that use the same parameter.
Default: false.
### Notes
* A user and group with the same value as the site parameter is created. By default this is 'monitoring'.
* The URL is http://yourhostname/sitename/check_mk/ - for example http://monhost.domain/monitoring/check_mk/
* The default username/password is omdadmin/omd. To change this or add additional users log in as the site user and run htpasswd - for example:
monitoring$ htpasswd -b ~/etc/htpasswd guest guest
* A user called 'guest' is configured as a guest user but is not enabled unless a password is set (as above).
* RedHat-like RPM downloads from http://files.omdistro.org/releases/centos_rhel/
## Agent
* Installs the check_mk-agent and check_mk-agent-logwatch packages
* Configures the /etc/xinetd.d/check_mk configuration file
### Example 1
include check_mk::agent
Installs the check_mk and check_mk_logwatch packages from the system repository
and configures /etc/xinetd.d/check_mk with no IP whitelist restrictions.
### Example 2
class { 'check_mk::agent':
version => '1.2.0p3-1',
ip_whitelist => [ '10.7.96.21', '10.7.96.22' ],
}
Installs the specified versions of the check_mk and check_mk_logwatch packages
after retrieving them from the Puppet file store. Configures
/etc/xinetd.d/check_mk so that only the specified IPs (and localhost/127.0.0.1)
are allowed to connect.
### check_mk::agent parameters
*filestore*: The Puppet file store location where the packages can be found (eg. 'puppet:///files/check_mk'). Optional.
*ip_whitelist*: The list of IP addresses that are allowed to retrieve check_mk
data. (Note that localhost is always allowed to connect.) By default any IP can
connect.
*port*: The port the check_mk agent listens on. Default: '6556'
*server_dir*: The directory in which the check_mk_agent executable is located.
Default: '/usr/bin'
*use_cache*: Whether or not to cache the results - useful with redundant
monitoring server setups. Default: 'false'
*user*: The user that the agent runs as. Default: 'root'
*version*: The version in the check_mk packages - for example if the RPM is
'check_mk-agent-1.2.0p3-1.noarch.rpm' then the version is '1.2.0p3-1'.
Only required if a filestore is used.
*workspace*: The directory to use to store files used during installation.
Default: '/root/check_mk'
*use_ssh*: Use ssh instead of the tcp wrapper. Deploys ssh keypair on server and
allows the server to execute the agent on the client.
Default: false.
## Host groups and tags
By default check_mk puts all hosts into a group called 'check_mk' but where you
have more than a few you will often want your own groups. We can do this by
setting host tags on the agents and then configuring host groups on the server
side to match hosts with these tags.
For example in the hiera config for your agent hosts you could have:
check_mk::agent::host_tags:
- '%{osfamily}'
and on the monitoring host you could have:
check_mk::host_groups:
RedHat:
description: 'RedHat or_CentOS hosts'
host_tags:
- RedHat
Debian:
description: 'Debian or Ubuntu_hosts'
host_tags:
- Debian
SuSE:
description: 'SuSE hosts'
host_tags:
- Suse
You can of course have as many host tags as you like. I have custom facts for
the server role and the environment type (dev, qa, stage, prod) and define
groups based on the role and envtype host tags.
Remember to run the Puppet agent on your agent hosts to export any host tags
and run the Puppet agent on the monitoring host to pick up any changes to the
host groups.
## Static host config
Hosts that do not run Puppet with the check_mk module are not automatically
added to the all_hosts list in main.mk. To manually include these hosts you can
add them to '/omd/sites/monitoring/etc/check_mk/all_hosts_static' (replacing
'monitoring' with your site name). Use the quoted fully qualified domain name
with a two-space prefix and a comma suffix - for example:
'host1.domain',
'host2.domain',
You can also include host tags - for example:
'host1.domain|windows|dev',
'host2.domain|windows|prod',
Remember to run the Puppet agent on your monitoring host to pick up any changes.
|
