Logrotate SaltStack Formula
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
Imran Iqbal 4c2a90bccd ci(workflows/commitlint): add to repo [skip ci] 3 years ago
.github/workflows ci(workflows/commitlint): add to repo [skip ci] 3 years ago
bin ci: merge travis matrix, add `salt-lint` & `rubocop` to `lint` job 3 years ago
docs chore(release): 0.11.3 [skip ci] 3 years ago
logrotate feat(yamllint): include for this repo and apply rules throughout 4 years ago
test fix(rubocop): fix remaining errors manually 3 years ago
.gitignore ci(gemfile.lock): add to repo with updated `Gemfile` [skip ci] 3 years ago
.rubocop.yml chore(rubocop): use org-wide standard settings for `Metrics/BlockLength` [skip ci] 3 years ago
.salt-lint ci(travis): update `salt-lint` config for `v0.0.10` [skip ci] 3 years ago
.travis.yml ci(kitchen+travis): remove `master-py2-arch-base-latest` [skip ci] 3 years ago
.yamllint ci: merge travis matrix, add `salt-lint` & `rubocop` to `lint` job 3 years ago
AUTHORS.md chore(release): 0.11.3 [skip ci] 3 years ago
CHANGELOG.md chore(release): 0.11.3 [skip ci] 3 years ago
FORMULA chore(release): 0.11.3 [skip ci] 3 years ago
Gemfile ci(gemfile.lock): add to repo with updated `Gemfile` [skip ci] 3 years ago
Gemfile.lock ci(gemfile.lock): add to repo with updated `Gemfile` [skip ci] 3 years ago
LICENSE Remove extra new line characters 8 years ago
commitlint.config.js feat: implement semantic release 4 years ago
kitchen.yml ci(kitchen+travis): remove `master-py2-arch-base-latest` [skip ci] 3 years ago
pillar.example feat(yamllint): include for this repo and apply rules throughout 4 years ago
pre-commit_semantic-release.sh ci(travis): run `shellcheck` during lint job [skip ci] 3 years ago
release-rules.js feat: implement semantic release 4 years ago
release.config.js fix(release.config.js): use full commit hash in commit link [skip ci] 3 years ago

docs/README.rst

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