1
0
Fork 0
mirror of synced 2024-06-12 20:11:11 -04:00
Logrotate SaltStack Formula
Go to file
2019-11-20 16:31:28 +00:00
bin ci: merge travis matrix, add salt-lint & rubocop to lint job 2019-10-09 03:07:04 +01:00
docs docs(contributing): remove to use org-level file instead [skip ci] 2019-10-14 12:29:03 +01:00
logrotate feat(yamllint): include for this repo and apply rules throughout 2019-08-08 10:59:16 +01:00
test fix(rubocop): fix remaining errors manually 2019-10-11 22:51:03 +01:00
.gitignore chore: use semantic-release cross-formula standard structure 2019-07-20 06:13:05 +01:00
.rubocop.yml ci: merge travis matrix, add salt-lint & rubocop to lint job 2019-10-09 03:07:04 +01:00
.salt-lint ci(travis): update salt-lint config for v0.0.10 [skip ci] 2019-10-23 17:33:37 +01:00
.travis.yml ci(travis): opt-in to dpl v2 to complete build config validation [skip ci] 2019-11-20 16:31:28 +00:00
.yamllint ci: merge travis matrix, add salt-lint & rubocop to lint job 2019-10-09 03:07:04 +01:00
AUTHORS.md chore(release): 0.11.2 [skip ci] 2019-10-11 22:20:01 +00:00
CHANGELOG.md chore(release): 0.11.2 [skip ci] 2019-10-11 22:20:01 +00:00
commitlint.config.js feat: implement semantic release 2019-06-25 13:36:14 +02:00
FORMULA chore(release): 0.11.2 [skip ci] 2019-10-11 22:20:01 +00:00
Gemfile ci: merge travis matrix, add salt-lint & rubocop to lint job 2019-10-09 03:07:04 +01:00
kitchen.yml ci(kitchen): use develop image until master is ready (amazonlinux) [skip ci] 2019-11-03 11:35:03 +00:00
LICENSE Remove extra new line characters 2015-05-07 13:42:07 -04:00
pillar.example feat(yamllint): include for this repo and apply rules throughout 2019-08-08 10:59:16 +01:00
pre-commit_semantic-release.sh feat: implement semantic release 2019-06-25 13:36:14 +02:00
release-rules.js feat: implement semantic release 2019-06-25 13:36:14 +02:00
release.config.js fix(release.config.js): use full commit hash in commit link [skip ci] 2019-10-31 10:29:04 +00: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.