mirror of
https://github.com/saltstack-formulas/cron-formula.git
synced 2025-04-16 07:52:38 +02:00
9b338dd6e3
# [0.4.0](https://github.com/saltstack-formulas/cron-formula/compare/v0.3.2...v0.4.0) (2022-01-14) ### Continuous Integration * **3003.1:** update inc. AlmaLinux, Rocky & `rst-lint` [skip ci] ([d52490b](d52490b1d3)) * **gemfile+lock:** use `ssf` customised `inspec` repo [skip ci] ([c20c85d](c20c85d48a)) * **gemfile+lock:** use `ssf` customised `kitchen-docker` repo [skip ci] ([9dd756d](9dd756d7cd)) * **kitchen:** move `provisioner` block & update `run_command` [skip ci] ([53b7f38](53b7f380c2)) * **kitchen+ci:** update with `3004` pre-salted images/boxes [skip ci] ([0142c55](0142c55ba5)) * **kitchen+ci:** update with latest `3003.2` pre-salted images [skip ci] ([dfb1c33](dfb1c33dbf)) * **kitchen+ci:** update with latest CVE pre-salted images [skip ci] ([2971748](29717486b9)) * add `arch-master` to matrix and update `.travis.yml` [skip ci] ([8a264b7](8a264b759d)) * add Debian 11 Bullseye & update `yamllint` configuration [skip ci] ([452afbe](452afbe6ec)) * **commitlint:** ensure `upstream/master` uses main repo URL [skip ci] ([c9e1a2b](c9e1a2b6a3)) * **gitlab-ci:** add `rubocop` linter (with `allow_failure`) [skip ci] ([76ee797](76ee797cb5)) * **gitlab-ci:** use GitLab CI as Travis CI replacement ([920c438](920c4388e9)) * **kitchen+ci:** use latest pre-salted images (after CVE) [skip ci] ([64260e8](64260e85b0)) * **kitchen+gitlab:** adjust matrix to add `3003` [skip ci] ([9072f83](9072f83d8f)) * **kitchen+gitlab:** remove Ubuntu 16.04 & Fedora 32 (EOL) [skip ci] ([e588573](e588573892)) * **kitchen+gitlab-ci:** use latest pre-salted images [skip ci] ([750e242](750e242b39)) * **pre-commit:** add to formula [skip ci] ([b36d0ec](b36d0ecd6e)) * **pre-commit:** enable/disable `rstcheck` as relevant [skip ci] ([8856f60](8856f60dd2)) * **pre-commit:** finalise `rstcheck` configuration [skip ci] ([a3fa371](a3fa3710f5)) * **pre-commit:** update hook for `rubocop` [skip ci] ([8317265](8317265a7d)) ### Features * **osfamilymap:** add Gentoo support ([547ae1b](547ae1b593)) ### Tests * standardise use of `share` suite & `_mapdata` state [skip ci] ([73b9643](73b96437a1))
.. _readme:
cron-formula
============
|img_travis| |img_sr|
.. |img_travis| image:: https://travis-ci.com/saltstack-formulas/cron-formula.svg?branch=master
:alt: Travis CI Build Status
:scale: 100%
:target: https://travis-ci.com/saltstack-formulas/cron-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
Formula to set up and configure cron.
.. 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:
``cron``
^^^^^^^^
Installs and configures the cron package.
``cron.package``
^^^^^^^^^^^^^^^^
Installs the cron package.
``cron.config``
^^^^^^^^^^^^^^^
This state manages the file ``cron.conf`` under ``/etc/cron`` (template found in "cron/files"). The configuration is populated by values in "cron/map.jinja" based on the package's default values (and RedHat, Debian, Suse and Arch family distribution specific values), which can then be overridden by values of the same name in pillar.
``cron.service``
^^^^^^^^^^^^^^^^
Manage the ``cron`` service. Stopping or starting it. If needed, you can disable the cron service by setting the ``enabled: false`` option in the pillar.
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 ``cron`` 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.