1
0
Fork 0
mirror of synced 2024-07-15 22:26:41 -04:00
formula-logrotate/docs
semantic-release-bot 1848fd6e0d chore(release): 0.14.0 [skip ci]
# [0.14.0](https://github.com/saltstack-formulas/logrotate-formula/compare/v0.13.2...v0.14.0) (2022-08-29)

### Continuous Integration

* update `pre-commit` configuration inc. for pre-commit.ci [skip ci] ([df61825](df618259eb))
* **kitchen+gitlab:** update for new pre-salted images [skip ci] ([af19654](af196541ad))

### Features

* **osfingermap:** add Debian-11 entry to osfingermap.yaml ([756769a](756769aeca))

### Tests

* **system.rb:** add support for `mac_os_x` [skip ci] ([e8d4e7e](e8d4e7eb9e))
2022-08-29 15:43:25 +00:00
..
AUTHORS.rst chore(release): 0.14.0 [skip ci] 2022-08-29 15:43:25 +00:00
CHANGELOG.rst chore(release): 0.14.0 [skip ci] 2022-08-29 15:43:25 +00:00
README.rst docs(readme): update link to CONTRIBUTING [skip ci] 2019-10-14 11:36:56 +01:00

.. _readme:

logrotate-formula
=================

|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
<https://docs.saltstack.com/en/latest/topics/development/conventions/formulas.html>`_.

If you are interested in writing or contributing to formulas, please pay attention to the `Writing Formula Section
<https://docs.saltstack.com/en/latest/topics/development/conventions/formulas.html#writing-formulas>`_.

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::
   :local:

``logrotate``
^^^^^^^^^^^^^

Installs the ``logrotate`` package and service/timer/cron.

``logrotate.config``
^^^^^^^^^^^^^^^^^^^^

Manages logrotate config and include dir.

``logrotate.install``
^^^^^^^^^^^^^^^^^^^^^

Installs the logrotate package and its dependencies.

``logrotate.jobs``
^^^^^^^^^^^^^^^^^^

Create custom job for logrotate.

``logrotate.service``
^^^^^^^^^^^^^^^^^^^^^

Manages the startup and running state of the logrotate service.

Testing
-------

Linux testing is done with ``kitchen-salt``.

Requirements
^^^^^^^^^^^^

* 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.