Files
confdroid_nagios/README.md

91 lines
3.0 KiB
Markdown
Raw Normal View History

2021-09-13 14:00:17 +02:00
# Readme
2017-07-20 14:47:24 +01:00
2026-02-02 23:38:50 +01:00
- [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)
2021-09-13 14:00:17 +02:00
## Synopsis
2017-07-20 14:47:24 +01:00
Nagios is a powerful open source software solution for monitoring your IT environments.
2026-02-02 23:38:50 +01:00
`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`.
2017-07-20 14:47:24 +01:00
2021-09-13 14:00:17 +02:00
## 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***
2017-07-20 14:47:24 +01:00
2021-09-13 14:00:17 +02:00
## Features
2017-07-20 14:47:24 +01:00
2021-09-13 14:00:17 +02:00
## Repo Documentation
See the full Puppet documentation including parameters in `docs/index.html`
## Dependencies
2017-07-20 14:47:24 +01:00
All dependencies must be included in the catalogue.
2026-02-02 23:38:50 +01:00
2017-07-20 14:47:24 +01:00
2021-09-13 14:00:17 +02:00
## Deployment
2017-07-20 14:47:24 +01:00
2021-09-13 14:00:17 +02:00
* native Puppet deployment
2017-07-20 14:47:24 +01:00
via site.pp or nodes.pp
2021-09-13 14:00:17 +02:00
```ruby
2017-07-20 14:47:24 +01:00
node 'example.example.net' {
2026-02-02 23:38:50 +01:00
include confdroid_nagios
2017-07-20 14:47:24 +01:00
}
```
2021-09-13 14:00:17 +02:00
* through Foreman:
2017-07-20 14:47:24 +01:00
2026-02-02 23:38:50 +01:00
In order to apply parameters through Foreman, **__confdroid_nagios::params__** must be added to the host or host group in question.
2017-07-20 14:47:24 +01:00
2021-09-13 14:00:17 +02:00
See [more details about class deployment on Confdroid.com](https://confdroid.com/2017/05/deploying-our-puppet-modules/).
2017-07-20 14:47:24 +01:00
2021-09-13 14:00:17 +02:00
## PuppetDB
2017-07-20 14:47:24 +01:00
2025-05-21 12:02:34 +02:00
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.
2017-07-20 14:47:24 +01:00
2021-09-13 14:00:17 +02:00
## SELINUX
2017-07-20 14:47:24 +01:00
All files and directories are configured with correct selinux context. If selinux is disabled, these contexts are ignored.
2021-09-13 14:00:17 +02:00
## Support
2026-02-02 23:38:50 +01:00
* OS: Rocky 9
* Puppet 8
2017-07-20 14:47:24 +01:00
2021-09-13 14:00:17 +02:00
## Tests
2017-07-20 14:47:24 +01:00
* 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
2021-09-13 14:00:17 +02:00
* Sonar Quality Gate
2017-07-20 14:47:24 +01:00
2021-09-13 14:00:17 +02:00
## Contact Us
2017-07-20 14:47:24 +01:00
[contact Us](https://confdroid.com/contact/)
2026-02-02 23:38:50 +01:00
[Feedback portal](https://feedback.confdroid.com/)
2017-07-20 14:47:24 +01:00
2021-09-13 14:00:17 +02:00
## Disclaimer
2017-07-20 14:47:24 +01:00
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.