ansible.xymon_server/README.md

89 lines
2.7 KiB
Markdown
Raw Normal View History

# Xymon Server
1. [Overview](#overview)
2. [Role Variables](#role-variables)
3. [Example Playbook](#example-playbook)
4. [Configuration](#configuration)
5. [Development](#development)
6. [License](#license)
7. [Author Information](#author-information)
## Overview
Manage Xymon server installation and configuration.
## Role Variables
* **xymon_server__base_packages**: List of base packages in order to provide `xymon` server [default: `xymon`].
* **xymon_server__deploy_state**: The desired state this role should achieve [default: `present`].
2018-03-09 12:08:05 +01:00
* **ymon_server__etc_src**: Directory used as source to templating /etc/xymon configuration content [default: `../templates/etc/xymon`].
* **xymon_server__service_manage**: If the Xymon server service should be managed [default: `True`].
* **xymon_server__service_name**: The service name to manage [default: `xymon`].
## Example Playbook
* Use defaults vars:
``` yml
- hosts: serverXYZ
roles:
- role: ipr-cnrs.xymon_server
```
2018-03-09 12:08:05 +01:00
* Use your own Xymon's configuration as source:
``` yml
- hosts: xymon.DOMAIN
roles:
- role: ipr-cnrs.xymon_server
xymon_server__etc_src: '{{ inventory_dir + "/../resources/host/xymon.DOMAIN/etc/xymon/" }}'
```
* Ensure your directory contains only templates or sub-directories, such as:
``` sh
xymon.DOMAIN
└── etc
└── xymon
├── alerts.cfg.j2
├── analysis.cfg.j2
├── client-local.cfg.j2
├── hosts.cfg.j2
└── hosts.d
├── common.lxc.cfg.j2
├── common.storage.cfg.j2
└── test.cfg.j2
```
## Configuration
This role will:
* Install needed packages to provide `xymon` server.
2018-03-09 12:08:05 +01:00
* Manage `xymon` server configuration (/etc/xymon).
* Ensure `xymon` server service is enabled and started.
* Ensure to restart `xymon` server service if configuration changed.
## Development
This source code comes from our [Gogs instance][xymon_server source] and the [Github repo][xymon_server 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_server source] :)
## License
[WTFPL][wtfpl website]
## Author Information
Jérémy Gardais
* Source: [on IPR's Gogs][xymon_server source]
* [IPR][ipr website] (Institut de Physique de Rennes)
[gogs to github hook]: https://stackoverflow.com/a/21998477
2023-11-09 10:35:17 +01:00
[xymon_server source]: https://git.ipr.univ-rennes.fr/cellinfo/ansible.xymon_server
[xymon_server github]: https://github.com/ipr-cnrs/xymon_server
[wtfpl website]: http://www.wtfpl.net/about/
[ipr website]: https://ipr.univ-rennes1.fr/