- Overview
- Module Description - What the module does and why it is useful
- Installation and Usage
- Reference - An under-the-hood peek at what the module is doing and how
- Limitations - OS compatibility, etc.
This is a plug-in puppet report processor to send report mail based on environment.
This module is a report processor plugin to generate a report similar to the built-in tagmail. The envmail report sends all log messages for a particular environment via email.
The recipient email address is defined in a configuration file called envmail.conf. To use the plugin, add envmail to the reports configuration in the [master] section of puppet.conf.
[master]
reports = puppetdb,console,tagmail,envmail
On the agent ensure pluginsync is enabled. It is enabled by default.
[agent]
report = true
pluginsync = true
To use this report, you must create a envmail.conf file on the puppet master in the $confdir. The envmail.conf is a simple file that maps environments to email addresses: Any log messages in the report that originate from the specified environment will be sent to the specified email addresses.
An example envmail.conf:
production: admins@domain.com
development: devs@domain.com
If you are using anti-spam controls such as grey-listing on your mail server, you should whitelist the sending email address (controlled by reportfrom configuration option) to ensure your email is not discarded as spam.
The tagmail.conf file contains a list of tags and email addresses separated by colons. Multiple tags and email addresses can be specified by separating them with commas.
Other settings can also be optionally in puppet.conf to control the email notification settings: smtpserver, smtpport, smtphelo, sendmail.
It is based on the original tagmail report processor which is a part of core puppet.