1
0
Fork 0
mirror of synced 2024-12-12 17:45:43 -05:00
formula-logrotate/docs
semantic-release-bot 67cad29a38 chore(release): 0.11.3 [skip ci]
## [0.11.3](https://github.com/saltstack-formulas/logrotate-formula/compare/v0.11.2...v0.11.3) (2020-03-22)

### Bug Fixes

* **release.config.js:** use full commit hash in commit link [skip ci] ([c79d42e](c79d42e0e0))

### Continuous Integration

* **gemfile:** restrict `train` gem version until upstream fix [skip ci] ([e6a2d52](e6a2d52a4c))
* **kitchen:** avoid using bootstrap for `master` instances [skip ci] ([6200869](6200869f7a))
* **kitchen:** ensure `cron` installed on `Debian` ([4401a20](4401a20671))
* **kitchen:** use `debian-10-master-py3` instead of `develop` [skip ci] ([7ba188f](7ba188f535))
* **kitchen:** use `develop` image until `master` is ready (`amazonlinux`) [skip ci] ([c4a1fa9](c4a1fa9f6f))
* **kitchen+travis:** upgrade matrix after `2019.2.2` release [skip ci] ([74ab7a1](74ab7a144d))
* **travis:** apply changes from build config validation [skip ci] ([4e65a71](4e65a7197b))
* **travis:** opt-in to `dpl v2` to complete build config validation [skip ci] ([05f9738](05f973872e))
* **travis:** quote pathspecs used with `git ls-files` [skip ci] ([b7ff28d](b7ff28d630))
* **travis:** run `shellcheck` during lint job [skip ci] ([b60e2ab](b60e2abf73))
* **travis:** update `salt-lint` config for `v0.0.10` [skip ci] ([a75723c](a75723cbe5))
* **travis:** use `major.minor` for `semantic-release` version [skip ci] ([d08d9bf](d08d9bfa06))
* **travis:** use build config validation (beta) [skip ci] ([ef455ff](ef455fffae))

### Documentation

* **contributing:** remove to use org-level file instead [skip ci] ([01493e9](01493e95a9))
* **readme:** update link to `CONTRIBUTING` [skip ci] ([d2ee252](d2ee2524cd))

### Performance Improvements

* **travis:** improve `salt-lint` invocation [skip ci] ([ebd94f0](ebd94f078e))
2020-03-22 18:05:42 +00:00
..
AUTHORS.rst chore(release): 0.11.3 [skip ci] 2020-03-22 18:05:42 +00:00
CHANGELOG.rst chore(release): 0.11.3 [skip ci] 2020-03-22 18:05:42 +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.