Fork 0
mirror of synced 2024-07-16 06:26:42 -04:00

121 lines
3 KiB

.. _readme:
|img_travis| |img_sr|
.. |img_travis| image:: https://travis-ci.com/saltstack-formulas/logrotate-formula.svg?branch=master
:alt: Travis CI Build Status
:scale: 100%
:target: https://travis-ci.com/saltstack-formulas/logrotate-formula
.. |img_sr| image:: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg
:alt: Semantic Release
:scale: 100%
:target: https://github.com/semantic-release/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
.. contents:: **Table of Contents**
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 <http://semver.org/>`_.
See `Formula Versioning Section <https://docs.saltstack.com/en/latest/topics/development/conventions/formulas.html#versioning>`_ for more details.
Contributing to this repo
**Commit message formatting is significant!!**
Please see `How to contribute <https://github.com/saltstack-formulas/.github/blob/master/CONTRIBUTING.rst>`_ for more details.
Available states
.. contents::
Installs the ``logrotate`` package and service/timer/cron.
Manages logrotate config and include dir.
Installs the logrotate package and its dependencies.
Create custom job for logrotate.
Manages the startup and running state of the logrotate service.
Linux testing is done with ``kitchen-salt``.
* Ruby
* Docker
.. code-block:: bash
$ 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``.
``bin/kitchen converge``
Creates the docker instance and runs the ``logrotate`` main state, ready for testing.
``bin/kitchen verify``
Runs the ``inspec`` tests on the actual instance.
``bin/kitchen destroy``
Removes the docker instance.
``bin/kitchen test``
Runs all of the stages above in one go: i.e. ``destroy`` + ``converge`` + ``verify`` + ``destroy``.
``bin/kitchen login``
Gives you SSH access to the instance for manual testing.