logrotate-formula

Travis CI Build Status Semantic Release

Install and configure logrotate on a machine.

The config files are per OS. At the moment only Debian, RedHat, Scientific Linux and Archlinux supported with this formula

1. General notes

See the full SaltStack Formulas installation and usage instructions.

If you are interested in writing or contributing to formulas, please pay attention to the Writing Formula Section.

If you want to use this formula, please pay attention to the FORMULA file and/or git tag, which contains the currently released version. This formula is versioned according to Semantic Versioning.

See Formula Versioning Section for more details.

2. Contributing to this repo

Commit message formatting is significant!!

Please see How to contribute for more details.

3. Available states

3.1. logrotate

Installs the logrotate package and service/timer/cron.

3.2. logrotate.config

Manages logrotate config and include dir.

3.3. logrotate.install

Installs the logrotate package and its dependencies.

3.4. logrotate.jobs

Create custom job for logrotate.

3.5. logrotate.service

Manages the startup and running state of the logrotate service.

4. Testing

Linux testing is done with kitchen-salt.

4.1. Requirements

  • Ruby

  • Docker

$ gem install bundler
$ bundle install
$ bin/kitchen test [platform]

Where [platform] is the platform name defined in kitchen.yml, e.g. debian-9-2019-2-py3.

4.2. bin/kitchen converge

Creates the docker instance and runs the logrotate main state, ready for testing.

4.3. bin/kitchen verify

Runs the inspec tests on the actual instance.

4.4. bin/kitchen destroy

Removes the docker instance.

4.5. bin/kitchen test

Runs all of the stages above in one go: i.e. destroy + converge
verify + destroy.

4.6. bin/kitchen login

Gives you SSH access to the instance for manual testing.