monit

Table of Contents

1. Module Description - What the module does and why it is useful
2. Setup - The basics of getting started with monit
   • Setup requirements
   • Beginning with monit
3. Usage - Configuration options and additional functionality
   • Enable Monit Dashboard
   • Add a check
   • Remove a check
4. Reference - An under-the-hood peek at what the module is doing and how
5. Limitations - OS compatibility, etc.
6. Development - Guide for contributing to the module
7. 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.

Fork this module on GitHub

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

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[0]

Specifies the interval between two checks of Monit. Default value: 120

Default value: $monit::params::check_interval

config_file

Data type: String

Specifies a path to the main config file. Default value: varies with operating system

Default value: $monit::params::config_file

config_dir

Data type: String

Specifies a path to the config directory. Default value: varies with operating system

Default value: $monit::params::config_dir

config_dir_purge

Data type: Variant[Boolean, Enum['true', 'false']]

Specifies if unmanaged files in the config directory should be purged. Default value: 'false'

Default value: $monit::params::config_dir_purge

httpd

Data type: Variant[Boolean, Enum['true', 'false']]

Specifies whether to enable the Monit Dashboard. Default value: 'false'

Default value: $monit::params::httpd

httpd_port

Data type: Integer[0, 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: 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: Variant[Boolean, Enum['true', 'false']]

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: Variant[Boolean, Enum['true', 'false']]

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[0, 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: Variant[Boolean, Enum['true', 'false']]

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: Variant[Boolean, Enum['true', 'false']]

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: Integer[0]

Requires at least Monit 5.0 If set, Monit will wait the specified time in seconds before it starts checking services. Default value: 0

Default value: $monit::params::start_delay

service_enable

Data type: Variant[Boolean, Enum['true', 'false']]

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

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 to monit 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 to monit class and to the template of configuration file.
• Add alert_emails parameter to monit 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 to monit class and to the template of configuration file.
• Add mailserver parameter to monit 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 for monit::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