91 lines
3.0 KiB
Markdown
91 lines
3.0 KiB
Markdown
# Readme
|
|
|
|
|
|
|
|
- [Readme](#readme)
|
|
- [Synopsis](#synopsis)
|
|
- [WARNING](#warning)
|
|
- [Features](#features)
|
|
- [Repo Documentation](#repo-documentation)
|
|
- [Dependencies](#dependencies)
|
|
- [Deployment](#deployment)
|
|
- [PuppetDB](#puppetdb)
|
|
- [SELINUX](#selinux)
|
|
- [Support](#support)
|
|
- [Tests](#tests)
|
|
- [Contact Us](#contact-us)
|
|
- [Disclaimer](#disclaimer)
|
|
|
|
|
|
## Synopsis
|
|
|
|
Nagios is a powerful open source software solution for monitoring your IT environments.
|
|
|
|
`confdroid_nagios` is a Puppet module allowing to fully automate the setup & configuration of the Nagios server, as well as actively adding client hosts and services to the monitoring environment through defines and `PuppetDB`.
|
|
|
|
## WARNING
|
|
|
|
***Attention: Never use this puppet module on systems which have been previously configured manually. It is impossible to predict how and what would have been configured, hence previous configurations outside the scope of this module may be overwritten! Automated configurations require a test environment to verify that the module suits the purpose intended by the user, as well as tune the parameters, before deploying into live production***
|
|
|
|
## Features
|
|
|
|
## Repo Documentation
|
|
|
|
See the full Puppet documentation including parameters in `docs/index.html`
|
|
|
|
## Dependencies
|
|
|
|
All dependencies must be included in the catalogue.
|
|
|
|
|
|
|
|
## Deployment
|
|
|
|
* native Puppet deployment
|
|
|
|
via site.pp or nodes.pp
|
|
|
|
```ruby
|
|
node 'example.example.net' {
|
|
include confdroid_nagios
|
|
}
|
|
```
|
|
|
|
* through Foreman:
|
|
|
|
In order to apply parameters through Foreman, **__confdroid_nagios::params__** must be added to the host or host group in question.
|
|
|
|
See [more details about class deployment on Confdroid.com](https://confdroid.com/2017/05/deploying-our-puppet-modules/).
|
|
|
|
## PuppetDB
|
|
|
|
A working instance of PuppetDB connected to the Puppet master is required for this to work. Installation and configuration of PuppetDB is out of scope for this module, however [cd_puppetdb](https://gitlab.confdroid.com/puppet/cd_puppetdb) is available to automate this task for you as well within a few minutes.
|
|
|
|
## SELINUX
|
|
|
|
All files and directories are configured with correct selinux context. If selinux is disabled, these contexts are ignored.
|
|
|
|
## Support
|
|
|
|
* OS: Rocky 9
|
|
* Puppet 8
|
|
|
|
## Tests
|
|
|
|
* Puppet Lint
|
|
* excluded tests:
|
|
* `--no-variable_scope-check`: not applicable as we are inheriting parameters from params class. the lint check does not distinguish between facts and inherited parameters.
|
|
* Puppet Parser
|
|
* ERB Template Parser
|
|
* Sonar Quality Gate
|
|
|
|
## Contact Us
|
|
|
|
[contact Us](https://confdroid.com/contact/)
|
|
[Feedback portal](https://feedback.confdroid.com/)
|
|
|
|
## Disclaimer
|
|
|
|
ConfDroid as entity is entirely independent from Puppet. We provide custom configuration modules, written for specific purposes and specific environments.
|
|
The modules are tested and supported only as documented, and require testing in designated environments (i.e. lab or development environments) for parameter tuning etc. before deploying into production environments.
|