Salt/cron-formula
0
0
Fork 0
mirror of https://github.com/saltstack-formulas/cron-formula.git synced 2024-11-30 20:05:14 +01:00
Code Issues Activity
4504edfd8d
cron-formula/docs
History
semantic-release-bot 8cf0ec745a chore(release): 0.3.2 [skip ci] 
## [0.3.2](https://github.com/saltstack-formulas/cron-formula/compare/v0.3.1...v0.3.2) (2020-09-10)

### Continuous Integration

* **gemfile:** restrict `train` gem version until upstream fix [skip ci] ([ce61077](ce61077780))
* **gemfile.lock:** add to repo with updated `Gemfile` [skip ci] ([269b49f](269b49f38a))
* **kitchen:** avoid using bootstrap for `master` instances [skip ci] ([0afa1b1](0afa1b10d2))
* **kitchen:** use `saltimages` Docker Hub where available [skip ci] ([74999aa](74999aa17d))
* **kitchen+travis:** remove `master-py2-arch-base-latest` [skip ci] ([54b5a1a](54b5a1abaa))
* **travis:** add notifications => zulip [skip ci] ([fb46b07](fb46b0799e))
* **travis:** apply changes from build config validation [skip ci] ([730df10](730df1087f))
* **travis:** opt-in to `dpl v2` to complete build config validation [skip ci] ([4fc3960](4fc3960112))
* **travis:** quote pathspecs used with `git ls-files` [skip ci] ([0fef6f1](0fef6f1223))
* **travis:** run `shellcheck` during lint job [skip ci] ([1b2eb28](1b2eb285a5))
* **travis:** use `major.minor` for `semantic-release` version [skip ci] ([d4a6100](d4a6100949))
* **travis:** use build config validation (beta) [skip ci] ([db46bd9](db46bd9c90))
* **workflows/commitlint:** add to repo [skip ci] ([449c919](449c919f14))

### Reverts

* **codeowners:** update specific directories section [skip ci] ([2ac7785](2ac7785f64))

### Styles

* **state:** avoid complicated comparison ([496f09b](496f09b2e1))
2020-09-10 02:30:54 +00:00
..
AUTHORS.rst chore(release): 0.3.2 [skip ci] 2020-09-10 02:30:54 +00:00
CHANGELOG.rst chore(release): 0.3.2 [skip ci] 2020-09-10 02:30:54 +00:00
README.rst docs(readme): update link to CONTRIBUTING [skip ci] 2019-10-14 11:35:37 +01:00

README.rst 

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