summaryrefslogtreecommitdiffstats
path: root/roles/nickhammond.logrotate/README.md
diff options
context:
space:
mode:
authorTroy Dawson <tdawson@redhat.com>2015-08-27 10:27:46 -0500
committerTroy Dawson <tdawson@redhat.com>2015-08-27 15:19:45 -0500
commitf0d03d257f2186c91e99c06e34be737468ea6ad6 (patch)
treebe5ad866e94abe66ed76aad2f98a31ae8229f645 /roles/nickhammond.logrotate/README.md
parent5c7e1366ad8ae67ef23117d296a65a6ee81ccd29 (diff)
downloadopenshift-f0d03d257f2186c91e99c06e34be737468ea6ad6.tar.gz
openshift-f0d03d257f2186c91e99c06e34be737468ea6ad6.tar.bz2
openshift-f0d03d257f2186c91e99c06e34be737468ea6ad6.tar.xz
openshift-f0d03d257f2186c91e99c06e34be737468ea6ad6.zip
Add a role that allows logrotate config editing.
This role gets called for each type of machine, but if logrotate_scripts is not set, nothing happens.
Diffstat (limited to 'roles/nickhammond.logrotate/README.md')
-rw-r--r--roles/nickhammond.logrotate/README.md71
1 files changed, 71 insertions, 0 deletions
diff --git a/roles/nickhammond.logrotate/README.md b/roles/nickhammond.logrotate/README.md
new file mode 100644
index 000000000..602b5ef6c
--- /dev/null
+++ b/roles/nickhammond.logrotate/README.md
@@ -0,0 +1,71 @@
+[![Build Status](https://travis-ci.org/nickhammond/ansible-logrotate.svg?branch=master)](https://travis-ci.org/nickhammond/ansible-logrotate)
+
+Role Name
+========
+
+Installs logrotate and provides an easy way to setup additional logrotate scripts by specifying a list of directives.
+
+Requirements
+------------
+
+None
+
+Role Variables
+--------------
+
+**logrotate_scripts**: A list of logrotate scripts and the directives to use for the rotation.
+
+* name - The name of the script that goes into /etc/logrotate.d/
+* path - Path to point logrotate to for the log rotation
+* options - List of directives for logrotate, view the logrotate man page for specifics
+* scripts - Dict of scripts for logrotate (see Example below)
+
+```
+logrotate_scripts:
+ - name: rails
+ path: "/srv/current/log/*.log"
+ options:
+ - weekly
+ - size 25M
+ - missingok
+ - compress
+ - delaycompress
+ - copytruncate
+```
+
+Dependencies
+------------
+
+None
+
+Example Playbook
+-------------------------
+
+Setting up logrotate for additional Nginx logs, with postrotate script.
+
+```
+logrotate_scripts:
+ - name: nginx
+ path: /var/log/nginx/*.log
+ options:
+ - weekly
+ - size 25M
+ - rotate 7
+ - missingok
+ - compress
+ - delaycompress
+ - copytruncate
+ scripts:
+ postrotate: "[ -s /run/nginx.pid ] && kill USR1 `cat /run/nginx.pid`"
+
+```
+
+License
+-------
+
+BSD
+
+Author Information
+------------------
+
+Find [Nick Hammond]( http://www.nickhammond.com ) on [Twitter](http://twitter.com/nickhammond).