diff --git a/README.md b/README.md index b69a4c9..e97ad45 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,8 @@ # ansible-logrotate-plusplus + + +## Description + Ansible role which installs and configures logrotate It can test if paths exist before writing a logrotate config to the server. Load the roles default vars with custom paths and per path parameters, and run the playbook across a dynamic @@ -7,3 +11,130 @@ infrastructure and only write logerotate rules to the appropriate system with th This project was based of https://github.com/arillso/ansible.logrotate 1.5.2 (https://github.com/arillso/ansible.logrotate/commit/038649f7933c21ba9f1f2c8363bfb4d49aaf46f2) +**This Ansible role was made possible by: Ansible consultant _Serge van Ginderachter_ of _Ginsys_:** + + +| [
Serge van Ginderachter](https://github.com/srgvg)
[📖](https://github.com/stationgroup/ansible-experiments/commits?author=srgvg) | [
Ginsys](https://ginsys.eu/)
[🌐](https://ginsys.eu/) | +| :---: | :---: | + + + + +## Installation + +```bash + ansible-galaxy install stationgroup.ansible_logrotate_plusplus +``` + +## Requirements + +None + +## Role Variables + +### imclude files + +Path to the imclude files. + +```yml +logrotate_include_dir: /etc/logrotate.d +``` + +### logrotate_use_hourly_rotation + +Enable hourly rotation with cron. + +```yml +logrotate_use_hourly_rotation: false +``` + +### logrotate options + +List of global options. + +```yml +logrotate_options: + - weekly + - rotate 4 + - create + - dateext + - su root syslog +``` + +### Package + +package name to install logrotate. + +```yml +logrotate_package: logrotate +``` + +### default config + +logroate for wtmp + +```yml +logrotate_wtmp: + logs: + - /var/log/wtmp + options: + - missingok + - monthly + - create 0664 root utmp + - rotate 1 +``` + +logroate for btmp + +```yml +logrotate_btmp: + logs: + - /var/log/btmp + options: + - missingok + - monthly + - create 0660 root utmp + - rotate 1 +``` + +### applications config + +More log files can be added that will logorate. + +```yml +logrotate_applications: [] +``` + +#### Example + +The following options are available. + +```yml +logrotate_applications: + - name: name-your-log-rotate-application + definitions: + - logs: + - /var/log/apt/term.log + - /var/log/apt/history.log + options: + - rotate 12 + - monthly + - missingok + - notifempty +``` + +## Dependencies + +None + +## Example Playbook + +```yml +- hosts: all + roles: + - stationgroup.ansible_logrotate_plusplus +``` + +## License + +This project is under the MIT License. diff --git a/meta/main.yml b/meta/main.yml index f417fd8..5f706b1 100644 --- a/meta/main.yml +++ b/meta/main.yml @@ -1,5 +1,6 @@ --- galaxy_info: + role_name: 'stationgroup.logrotate-plusplus' author: 'stationgroup' description: | Ansible role for installings and configuring lograte on Linux, deploying a list of defaults only if the