100 lines
4.8 KiB
Markdown
100 lines
4.8 KiB
Markdown
# Xymon
|
||
|
||
1. [Overview](#overview)
|
||
2. [Role Variables](#role-variables)
|
||
* [OS Specific Variables](#os-specific-variables)
|
||
3. [Example Playbook](#example-playbook)
|
||
4. [Configuration](#configuration)
|
||
4. [Plugins](#plugins)
|
||
6. [Development](#development)
|
||
7. [License](#license)
|
||
8. [Author Information](#author-information)
|
||
|
||
## Overview
|
||
|
||
Manage Xymon (client) installation and configuration.
|
||
|
||
## Role Variables
|
||
|
||
* **xymon_cli_manage** : If `xymon-client` should be managed with this role [default : `true`].
|
||
* **xymon_cli_pkg_state** : State of new `xymon-client` package(s) [default : `installed`].
|
||
* **xymon_cli_default_conf_path** : Configuration file for `xymon-client` [default : `/etc/default/xymon-client`].
|
||
* **xymon_cli_default_conf_tpl** : Template used to generate the previous config file [default : `etc/default/xymon-client.j2`].
|
||
* **xymon_cli_hostname** : Allow to override default value of CLIENTHOSTNAME var [default : `{{ ansible_fqdn }}`].
|
||
* **xymon_user_groups** : List of 'xymon' user's groups [default : `xymon`].
|
||
* **xymon_cli_service_manage** : If `xymon-client` service should be managed with this role [default : `true`].
|
||
* **xymon_cli_service_name** : `xymon-client` service name [default : `xymon-client`].
|
||
* **xymon_cli_service_enabled** : Set `xymon-client` service available at startup [default : `true`].
|
||
* **xymon_srv_list** : The list of Xymon servers (you must give an hostname, IP,… reachable from any clients) [defaults : `monitoring.{{ ansible_domain }}`].
|
||
* **xymon_plug_manage** : If this role should manage plugins configuration [default : `true`].
|
||
* **xymon_plug_apt_state** : The state of plugin `apt` [default : `true`].
|
||
* **xymon_plug_apt_package** : The packages to install to provide `apt` plugin [default : `[ 'libtimedate-perl' ]`].
|
||
* **xymon_plug_apt_path** : Configuration file for the `apt` plugin [default : `/etc/xymon/clientlaunch.d/apt.cfg`].
|
||
* **xymon_plug_apt_tpl** : Template used to generate the previous config file [default : `etc/xymon/clientlaunch.d/apt.cfg.j2`].
|
||
* **xymon_plug_mq_state** : The state of plugin `mq` [default : `true`].
|
||
* **xymon_plug_mq_package** : The packages to install to provide `mq` plugin [default : `[ 'libtimedate-perl' ]`].
|
||
* **xymon_plug_mq_path** : Configuration file for the `mq` plugin [default : `/etc/xymon/clientlaunch.d/mq.cfg`].
|
||
* **xymon_plug_mq_tpl** : Template used to generate the previous config file [default : `etc/xymon/clientlaunch.d/mq.cfg.j2`].
|
||
* **xymon_plug_libs_state** : The state of plugin `libs` [default : `true`].
|
||
* **xymon_plug_libs_package** : The packages to install to provide `libs` plugin [default : `[ 'binutils', 'lsof', 'libyaml-tiny-perl', 'libsort-naturally-perl' ]`].
|
||
* **xymon_plug_libs_path** : Configuration file for the `libs` plugin [default : `/etc/xymon/clientlaunch.d/libs.cfg`].
|
||
* **xymon_plug_libs_tpl** : Template used to generate the previous config file [default : `etc/xymon/clientlaunch.d/libs.cfg.j2`].
|
||
* **xymon_plug_libs_default_whitelist** : Default whitelist of processes that should not be monitored with `libs` plugin.
|
||
* **xymon_plug_libs_group_whitelist** : Group whitelist of processes that should not be monitored with `libs` plugin.
|
||
* **xymon_plug_libs_host_whitelist** : Host whitelist of processes that should not be monitored with `libs` plugin.
|
||
|
||
### OS Specific Variables
|
||
|
||
Please see default value by Operating System file in [vars][vars directory] directory.
|
||
|
||
* **xymon_cli_pkg_list** : The list of packages to install to provide `xymon-client`.
|
||
|
||
## Example Playbook
|
||
|
||
* Use defaults vars :
|
||
|
||
``` yml
|
||
- hosts: serverXYZ
|
||
roles:
|
||
- role: ipr-cnrs.xymon
|
||
```
|
||
|
||
## Configuration
|
||
|
||
This role will :
|
||
* Install needed packages to provide `xymon-client`.
|
||
* Manage `xymon-client` configuration and service.
|
||
* Add 'xymon' user to new groups.
|
||
|
||
## Plugins
|
||
|
||
Some plugins and options can be managed with this role :
|
||
* apt : Check state of packages and repositories.
|
||
* libs : Check for running processes with upgraded libraries.
|
||
* mq : Check mail queue.
|
||
|
||
## Development
|
||
|
||
This source code comes from our [Gogs instance][xymon source] and the [Github repo][xymon github] exist just to be able to send the role to Ansible Galaxy…
|
||
|
||
But feel free to send issue/PR here :)
|
||
|
||
Thanks to this [hook][gogs to github hook], Github automatically got updates from our [Gogs instance][xymon source] :)
|
||
|
||
## License
|
||
|
||
[WTFPL][wtfpl website]
|
||
|
||
## Author Information
|
||
|
||
Jérémy Gardais
|
||
* Source : [on IPR's Gogs][xymon source]
|
||
* [IPR][ipr website] (Institut de Physique de Rennes)
|
||
|
||
[vars directory]: ./vars
|
||
[gogs to github hook]: https://stackoverflow.com/a/21998477
|
||
[xymon source]: https://git.ipr.univ-rennes1.fr/cellinfo/ansible.xymon
|
||
[xymon github]: https://github.com/ipr-cnrs/xymon
|
||
[wtfpl website]: http://www.wtfpl.net/about/
|
||
[ipr website]: https://ipr.univ-rennes1.fr/
|