Version information
This version is compatible with:
- , ,
This module has been deprecated by its author since Aug 26th 2019.
The author has suggested puppet-check_mk as its replacement.
Start using this module
Documentation
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.
Original code by erwbgy, forked as upstream seems unmaintained.
Server
-
Installs omd package either using the system repository (eg. yum, apt) or from a package file retrieved from the Puppet file store
-
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'
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 package.
-
Configures the /etc/xinetd.d/check_mk configuration file
Example 1
include check_mk::agent
Installs the check_mk package 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 package 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'
mrpe_checks: Specifies a hash of check_mk::agent::mrpe resources to create. Default: {}
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 needs to get added to hiera. check_mk::config creates the config file /omd/sites/monitoring/etc/check_mk/all_hosts_static from a template. The template will look for hiera variables. The hiera variable check_mk::all_hosts_static has to be an array:
check_mk::all_hosts_static:
- host1.domain
- host2.domain
You can also include host tags - for example:
check_mk::all_hosts_static:
- host1.domain|windows|dev,
- host2.domain|windows|prod,
0.7.1:
- Add check_mk::agent::mrpe, code from Bas Grolleman contributed by gerhardsam.
0.7.0:
- Rework of check_mk::agent classes, contributed by gerhardsam.
0.6.2:
- Add rspec tests contributed by gerhardsam.
0.4.0:
-
Fix all_hosts_static.erb, update xinetd on wheezy and use cron instead of a scheduled exec.
-
Package a new version has upstream seems unmaintained.
0.3.0:
-
Added host tags to agent config so that host groups can be auto-populated
-
Fixed incorrect package name when using a file store that was causing the package existence check to fail always causing an often failing reinstall
-
Enable a static list of hosts to be specified for those without the Puppet check_mk module installed
0.2.0:
-
Switched to using OMD rather than manually compiling check_mk
-
Added support for host tags and creating host groups based on these tags
-
Allow local check_mk configuration to be specified in /etc/check_mk/main.mk.local that is appended to /etc/check_mk/main.mk as check_mk can do a lot more than is covered by this module
0.1.1:
- Brown paper bag release to fix a silly typo
0.1:
- Initial release
Dependencies
- puppetlabs/concat (>= 1.0.0 <2.0.0)
- puppetlabs/stdlib (>= 2.3.0 <5.0.0)
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "{}"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright {yyyy} {name of copyright owner}
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.