Version information
This version is compatible with:
- Puppet Enterprise 2023.8.x, 2023.7.x, 2023.6.x, 2023.5.x, 2023.4.x, 2023.3.x, 2023.2.x, 2023.1.x, 2023.0.x, 2021.7.x, 2021.6.x, 2021.5.x, 2021.4.x, 2021.3.x, 2021.2.x, 2021.1.x, 2021.0.x
- Puppet >= 7.0.0 < 9.0.0
- , , , , , , ,
Start using this module
Add this module to your Puppetfile:
mod 'aursu-monit', '3.1.1'
Learn more about managing modules with a PuppetfileDocumentation
monit
Table of Contents
- Module Description - What the module does and why it is useful
- Setup - The basics of getting started with monit
- Usage - Configuration options and additional functionality
- Reference - An under-the-hood peek at what the module is doing and how
- Limitations - OS compatibility, etc.
- Development - Guide for contributing to the module
- Contributors
Module Description
This module installs and configures Monit. It allows you to enable HTTP Dashboard an to add check from a file.
Setup
Setup Requirements
WARNING: For RedHat systems, you may need to add an additional repository like the EPEL repository. You can use the module stahnma-epel to do this.
Beginning with monit
include monit
Usage
Enable Monit Dashboard
class { 'monit':
httpd => true,
httpd_address => '172.16.0.3',
httpd_password => 'CHANGE_ME',
}
Add a check
Using the source parameter:
monit::check { 'ntp':
source => "puppet:///modules/${module_name}/ntp",
}
Or using the content parameter with a string:
monit::check { 'ntp':
content => 'check process ntpd with pidfile /var/run/ntpd.pid
start program = "/etc/init.d/ntpd start"
stop program = "/etc/init.d/ntpd stop"
if failed host 127.0.0.1 port 123 type udp then alert
if 5 restarts within 5 cycles then timeout
',
}
Or using the content parameter with a template:
monit::check { 'ntp':
content => template("${module_name}/ntp.erb"),
}
Remove a check
monit::check { 'ntp':
ensure => absent,
}
Reference
See REFERENCE.md
Limitations
RedHat and Debian family OSes are officially supported. Tested and built on Debian and CentOS.
Development
Solution Libre modules on the Puppet Forge are open projects, and community contributions are essential for keeping them great.
Contributors
The list of contributors can be found at: https://github.com/solution-libre/puppet-monit/graphs/contributors
Reference
Table of Contents
Classes
Public Classes
monit
: Main class, includes all other classes.
Private Classes
monit::config
: This class handles the configuration file.monit::firewall
: This class handles the firewall configuration.monit::install
: This class handles monit packages.monit::params
: This is a container class with default parameters for monit classes.monit::service
: This class handles the monit service.
Defined types
monit::check
: Adds a Monit check.
Classes
monit
Main class, includes all other classes.
Examples
class { 'monit': }
Parameters
The following parameters are available in the monit
class:
alert_emails
check_interval
config_file
config_dir
config_dir_purge
httpd
httpd_port
httpd_address
httpd_allow
httpd_user
httpd_password
logfile
mailserver
mailformat
manage_firewall
mmonit_address
mmonit_https
mmonit_port
mmonit_user
mmonit_password
mmonit_without_credential
package_ensure
package_name
service_ensure
service_manage
service_name
start_delay
service_enable
alert_emails
Data type: Array[String]
Specifies one or more email addresses to send global alerts to. Default value: []
Default value: $monit::params::alert_emails
check_interval
Data type: Integer[1]
Specifies the interval between two checks of Monit. Default value: 120
Default value: $monit::params::check_interval
config_file
Data type: Stdlib::Absolutepath
Specifies a path to the main config file. Default value: varies with operating system
Default value: $monit::params::config_file
config_dir
Data type: Stdlib::Absolutepath
Specifies a path to the config directory. Default value: varies with operating system
Default value: $monit::params::config_dir
config_dir_purge
Data type: Boolean
Specifies if unmanaged files in the config directory should be purged. Default value: 'false'
Default value: $monit::params::config_dir_purge
httpd
Data type: Boolean
Specifies whether to enable the Monit Dashboard. Default value: 'false'
Default value: $monit::params::httpd
httpd_port
Data type: Integer[1, 65535]
Specifies the port of the Monit Dashboard. Default value: 2812
Default value: $monit::params::httpd_port
httpd_address
Data type: String
Specifies the IP address of the Monit Dashboard. Default value: 'locahost'
Default value: $monit::params::httpd_address
httpd_allow
Data type: String
Specifies the allow option of the Monit Dashboard. Default value: '0.0.0.0/0.0.0.0'
Default value: $monit::params::httpd_allow
httpd_user
Data type: String
Specifies the user to access the Monit Dashboard. Default value: 'admin'
Default value: $monit::params::httpd_user
httpd_password
Data type: String
Specifies the password to access the Monit Dashboard. Default value: 'monit'
Default value: $monit::params::httpd_password
logfile
Data type: Optional[String]
Specifies the logfile directive value. Default value: '/var/log/monit.log' It is possible to use syslog instead of direct file logging. (e.g. 'syslog facility log_daemon')
Default value: $monit::params::logfile
mailserver
Data type: Optional[String]
If set to a string, alerts will be sent by email to this mailserver. Default value: undef For more details, see: https://mmonit.com/monit/documentation/monit.html#Setting-a-mail-server-for-alert-delivery
Default value: $monit::params::mailserver
mailformat
Data type: Optional[Hash]
Specifies the alert message format. Default value: undef For more details, see: https://mmonit.com/monit/documentation/monit.html#Message-format
Default value: $monit::params::mailformat
manage_firewall
Data type: Boolean
If true and if puppetlabs-firewall module is present, Puppet manages firewall to allow HTTP access for Monit Dashboard. Default value: 'false'
Default value: $monit::params::manage_firewall
mmonit_address
Data type: Optional[String]
Requires at least Monit 5.0 Specifies the remote address of an M/Monit server to be used by Monit agent for report. If set to undef, M/Monit connection is disabled. Default value: undef
Default value: $monit::params::mmonit_address
mmonit_https
Data type: Boolean
Requires at least Monit 5.0 Specifies wheither the protocol of the M/Monit server is HTTPs. Default value: 'true'
Default value: $monit::params::mmonit_https
mmonit_port
Data type: Integer[1, 65535]
Requires at least Monit 5.0 Specifies the remote port of the M/Monit server. Default value: 8443
Default value: $monit::params::mmonit_port
mmonit_user
Data type: String
Requires at least Monit 5.0 Specifies the user to connect to the remote M/Monit server. Default value: 'monit' If you set both user and password to an empty string, authentication is disabled.
Default value: $monit::params::mmonit_user
mmonit_password
Data type: String
Requires at least Monit 5.0 Specifies the password of the account used to connect to the remote M/Monit server. Default value: 'monit' If you set both user and password to an empty string, authentication is disabled.
Default value: $monit::params::mmonit_password
mmonit_without_credential
Data type: Boolean
Requires at least Monit 5.0 By default Monit registers credentials with M/Monit so M/Monit can smoothly communicate back to Monit and you don't have to register Monit credentials manually in M/Monit. It is possible to disable credential registration setting this option to 'true'. Default value: 'false'
Default value: $monit::params::mmonit_without_credential
package_ensure
Data type: String
Tells Puppet whether the Monit package should be installed, and what version. Valid options: 'present', 'latest', or a specific version number. Default value: 'present'
Default value: $monit::params::package_ensure
package_name
Data type: String
Tells Puppet what Monit package to manage. Default value: 'monit'
Default value: $monit::params::package_name
service_ensure
Data type: Enum['running', 'stopped']
Tells Puppet whether the Monit service should be running. Default value: 'running'
Default value: $monit::params::service_ensure
service_manage
Data type: Boolean
Tells Puppet whether to manage the Monit service. Default value: 'true'
Default value: $monit::params::service_manage
service_name
Data type: String
Tells Puppet what Monit service to manage. Default value: 'monit'
Default value: $monit::params::service_name
start_delay
Data type: Optional[Integer[1]]
Requires at least Monit 5.0 If set, Monit will wait the specified time in seconds before it starts checking services. Default value: undef
Default value: $monit::params::start_delay
service_enable
Data type: Boolean
Default value: $monit::params::service_enable
Defined types
monit::check
Adds a Monit check.
Parameters
The following parameters are available in the monit::check
defined type:
content
Data type: Optional[String]
Specifies the content of the configuration file. The content
and source
parameters are exclusive of each other.
Default value: undef
ensure
Data type: Enum['present', 'absent']
Tells Puppet whether the check should exist.
Default value: present
source
Data type: Optional[String]
Tells Puppet what is the path of the configuration file. The content
and source
parameters are exclusive of each other.
Default value: undef
2023-08-23 - Release 3.1.0
Summary
This release removes support for old Ubuntu, Debian and RedHat operating systems This release removes support for Amazon Linux Renamed module to aursu/monit PDK upgrade to 3.0.0
2020-12-09 - Release 3.0.0
Summary
This release adds the support for Debian 10/Buster and for CentOS 8 and the ability to use special characters in httpd_password
parameter.
It fixes logging limitations and Amazon Linux compatibility.
It uses a Docker Compose file to use PDK 1.8.1.
BREAKING CHANGES This release remove the support for Puppet 3.
Features
- Added the support for Debian 10/Buster
- Added the support for CentOS 8
- Added ability to use special characters in
httpd_password
parameter
BugFixes
- Fixed logging limitations
- Fixed Amazon Linux compatibility
Development
- Added a Docker Compose file to use PDK
2018-11-23 - Release 2.0.1
Summary
This release fixes the support for Amazon Linux 2 and uses PDK 1.7.1.
BugFixes
- Fixed the support for Amazon Linux 2
2018-10-07 - Release 2.0.0
Summary
This release adds httpd_allow
configuration and support for MMonit HTTPs addresses and uses PDK 1.7.0.
BREAKING CHANGES The MMonit address is now by default with HTTPs with the port 8443 (8080 previously).
Features
- Add
httpd_allow
configuration - Add support for MMonit HTTPs addresses
2018-07-09 - Release 1.4.0
Summary
This release adds support to Amazon Linux 2 and uses PDK 1.6.1.
Features
- Added support to Amazon Linux 2
2018-05-03 - Release 1.3.0
Summary
This release adds support to Ubuntu Bionic and uses PDK 1.5.0.
Features
- Added support to Ubuntu Bionic
2018-01-26 - Release 1.2.0
Summary
This release adds support to Debian Stretch and uses PDK 1.3.2.
Features
- Added support to Debian Stretch
2018-01-26 - Release 1.1.3
Summary
This release benefited from the changes introduced by PDK 1.3 (pdk convert
)
2016-11-07 - Release 1.1.2
Summary
This release adds support to Ubuntu Xenial and improves compatibility with Puppet Server.
Features
- Added support to Ubuntu 16.04.
Bugfixes
- Fixed condition that fails with
strict_variables
enabled on the Puppet Server side.
2016-08-30 - Release 1.1.1
Summary
This release fixes typo and a bad URL. It is published with Geppeto.
2016-08-05 - Release 1.1.0
Summary
This release adds support to Debian jessie, OracleLinux and Scientific OSes, as well as a config_dir_purge
parameter and a lot of great test improvements.
Features
- Added support to Debian jessie.
- Added support to OracleLinux and Scientific.
- Added
monit_version
fact. - Added
config_dir_purge
parameter tomonit
class and to the template of configuration file.
Bugfixes
- Fixed bad dependencies (puppetlabs/stdlib >= 4.6.0 + add puppetlabs/firewall)
Tests
- Amazing enhancement of code coverage (special thanks to Phil Friderici and Garrett Honeycutt)
- Puppet v3 (optionally with future parser) and v4 with Ruby versions 1.8.7 (Puppet v3 only), 1.9.3, 2.0.0 and 2.1.0.
- Improvment of style and additional community style checks
2015-08-06 - Release 1.0.0
Summary
This release updates metadata to support new version of RedHat family OSes, as well as new features and test improvements.
Features
- Added support to RedHat family OSes version 7.
- Added configuration option to set an M/Monit report server in Monit configuration file.
- Added support for start delay parameter.
- Made HTTPd authentication by user and password optional.
Tests
- Added future parser in Travis matrix.
- Added acceptance tests.
##2015-06-06 - Release 0.5.0
###Summary
This release adds mail-format
and alert
parameters to the monit configuration file.
####Features
- Add
mailformat
parameter tomonit
class and to the template of configuration file. - Add
alert_emails
parameter tomonit
class and to the template of configuration file.
####Bugfixes
ìdfile
parameter does not exist for Monit 4
##2015-04-02 - Release 0.4.0
###Summary
This release adds logile
and mailserver
parameters to the monit configuration file.
####Features
- Add
logfile
parameter tomonit
class and to the template of configuration file. - Add
mailserver
parameter tomonit
class and to the template of configuration file.
####Bugfixes
- Bad variable use for configuration directory in
monit::check
##2015-04-01 - Release 0.3.0 ###Summary
This release adds support for RedHat family OSes.
##2015-02-22 - Release 0.2.0 ###Summary
This release adds content
parameter to monit::check
.
##2015-02-09 - Release 0.1.4 ###Summary
This release improves the compliance with Debian Squeeze and Ubuntu Lucid.
##2014-12-22 - Release 0.1.3 ###Summary
This release adds tests and improves the compliance with Puppet Guidelines.
##0.1.2
2014-09-18
- Add parameter
ensure
formonit::check
- wild wild@portal - Fix bad validation for package_name for
monit::check
- Florent Poinsaut florent.poinsaut@echoes-tech.com
##0.1.1 2014-09-15 Florent Poinsaut florent.poinsaut@echoes-tech.com
- Typo
2014-09-03 https://github.com/wild-r
- Disable validate_absolute_path on check.pp to allow link like 'puppet://...'
##0.1.0 2014-08-29 Florent Poinsaut florent.poinsaut@echoes-tech.com
- Initial release
Dependencies
- puppetlabs/stdlib (>= 4.6.0 < 10.0.0)
- puppetlabs/firewall (>= 5.0.0 < 9.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.