1
0
Fork 0
mirror of synced 2024-07-13 12:39:58 -04:00
formula-logrotate/docs
semantic-release-bot 5bd6c259e6 chore(release): 0.12.0 [skip ci]
# [0.12.0](https://github.com/saltstack-formulas/logrotate-formula/compare/v0.11.5...v0.12.0) (2021-07-07)

### Continuous Integration

* **3003.1:** update inc. AlmaLinux, Rocky & `rst-lint` [skip ci] ([bb6bfac](bb6bfac80e))
* **commitlint:** ensure `upstream/master` uses main repo URL [skip ci] ([ac5a57c](ac5a57c76d))
* **gemfile+lock:** use `ssf` customised `kitchen-docker` repo [skip ci] ([7368305](7368305919))
* **kitchen+gitlab:** remove Ubuntu 16.04 & Fedora 32 (EOL) [skip ci] ([1f55b57](1f55b57a61))
* add `arch-master` to matrix and update `.travis.yml` [skip ci] ([84b2f6a](84b2f6aa99))
* **gitlab-ci:** add `rubocop` linter (with `allow_failure`) [skip ci] ([1fc52cd](1fc52cd233))
* **gitlab-ci:** use GitLab CI as Travis CI replacement ([94c2cf7](94c2cf7d2c))
* **kitchen+ci:** use latest pre-salted images (after CVE) [skip ci] ([406dbbb](406dbbb4e5))
* **kitchen+gitlab:** adjust matrix to add `3003` [skip ci] ([b198955](b198955b5f))
* **kitchen+gitlab-ci:** use latest pre-salted images [skip ci] ([ea66a0d](ea66a0d2b8))
* **pre-commit:** add to formula [skip ci] ([e506d69](e506d6954d))
* **pre-commit:** enable/disable `rstcheck` as relevant [skip ci] ([267bb94](267bb944a4))
* **pre-commit:** finalise `rstcheck` configuration [skip ci] ([bd1dc81](bd1dc81dcb))
* **pre-commit:** update hook for `rubocop` [skip ci] ([2c964b0](2c964b09e4))

### Features

* **jobs:** add `jobs: {}` to defaults and state to init ([c3b64d3](c3b64d37a7)), closes [#57](https://github.com/saltstack-formulas/logrotate-formula/issues/57)

### Tests

* **alma+rocky:** add platforms (based on CentOS 8) [skip ci] ([dc63042](dc630420a5))
* standardise use of `share` suite & `_mapdata` state [skip ci] ([650cfad](650cfaddf0))
* **base:** update from `template-formula` and Arch Linux exclusion ([09d4f5a](09d4f5a034))
* **rubocop:** fix violation [skip ci] ([3f5edef](3f5edefc18))
2021-07-07 08:43:10 +00:00
..
AUTHORS.rst chore(release): 0.12.0 [skip ci] 2021-07-07 08:43:10 +00:00
CHANGELOG.rst chore(release): 0.12.0 [skip ci] 2021-07-07 08:43:10 +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.