1
0
Fork 0
Logrotate SaltStack Formula
Go to file
Imran Iqbal dc630420a5
test(alma+rocky): add platforms (based on CentOS 8) [skip ci]
2021-07-01 08:31:03 +01:00
.github/workflows ci(workflows/commitlint): add to repo [skip ci] 2020-05-04 09:29:34 +01:00
bin ci(pre-commit): add to formula [skip ci] 2020-10-03 10:33:58 +01:00
docs chore(release): 0.11.5 [skip ci] 2020-06-29 16:57:46 +00:00
logrotate test: standardise use of `share` suite & `_mapdata` state [skip ci] 2021-03-23 21:29:48 +00:00
test test(alma+rocky): add platforms (based on CentOS 8) [skip ci] 2021-07-01 08:31:03 +01:00
.gitignore chore: standardise structure (`.gitignore` & `_mapdata.rb`) [skip ci] 2021-02-11 11:50:36 +00:00
.gitlab-ci.yml ci(kitchen+gitlab): remove Ubuntu 16.04 & Fedora 32 (EOL) [skip ci] 2021-06-21 20:45:23 +01:00
.pre-commit-config.yaml chore(pre-commit): use `info` report level for `rstcheck` [skip ci] 2021-05-20 14:08:02 +01:00
.rstcheck.cfg chore(pre-commit): use `info` report level for `rstcheck` [skip ci] 2021-05-20 14:08:02 +01:00
.rubocop.yml test: standardise use of `share` suite & `_mapdata` state [skip ci] 2021-03-23 21:29:48 +00: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(kitchen+gitlab): remove Ubuntu 16.04 & Fedora 32 (EOL) [skip ci] 2021-06-21 20:45:23 +01:00
.yamllint chore: update `CODEOWNERS` & `.yamllint` re: `kitchen-vagrant` [skip ci] 2021-04-05 18:19:23 +01:00
AUTHORS.md chore(release): 0.11.5 [skip ci] 2020-06-29 16:57:46 +00:00
CHANGELOG.md chore(release): 0.11.5 [skip ci] 2020-06-29 16:57:46 +00:00
CODEOWNERS chore: update `CODEOWNERS` & `.yamllint` re: `kitchen-vagrant` [skip ci] 2021-04-05 18:19:23 +01:00
FORMULA chore(release): 0.11.5 [skip ci] 2020-06-29 16:57:46 +00:00
Gemfile test: standardise use of `share` suite & `_mapdata` state [skip ci] 2021-03-23 21:29:48 +00:00
Gemfile.lock ci(gemfile+lock): use `ssf` customised `kitchen-docker` repo [skip ci] 2021-02-17 13:50:49 +00:00
LICENSE Remove extra new line characters 2015-05-07 13:42:07 -04:00
commitlint.config.js chore(commitlint): add `{body,footer,header}-max(-line)-length` [skip ci] 2020-10-07 09:07:04 +01:00
kitchen.yml ci(kitchen+gitlab): remove Ubuntu 16.04 & Fedora 32 (EOL) [skip ci] 2021-06-21 20:45:23 +01: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 ci(gitlab-ci): use GitLab CI as Travis CI replacement 2020-12-16 06:35:12 +00:00
release-rules.js feat: implement semantic release 2019-06-25 13:36:14 +02:00
release.config.js ci(gitlab-ci): use GitLab CI as Travis CI replacement 2020-12-16 06:35:12 +00:00

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.