chrony-formula

Saltstack Official Chrony Formula

semantic-release-bot 6fb31ef79c chore(release): 1.2.2 [skip ci] ## [1.2.2](https://github.com/saltstack-formulas/chrony-formula/compare/v1.2.1...v1.2.2) (2020-12-16) ### Bug Fixes * libtofs: “files_switch” mess up the variable exported by “map.jinja” [skip ci] ([`264151d`](`264151d1cb`)) * release.config.js: use full commit hash in commit link [skip ci] ([`9122f1a`](`9122f1a486`)) ### Continuous Integration * gemfile: restrict `train` gem version until upstream fix [skip ci] ([`92fcb44`](`92fcb44337`)) * gemfile.lock: add to repo with updated `Gemfile` [skip ci] ([`c3d1b91`](`c3d1b917ac`)) * gitlab-ci: use GitLab CI as Travis CI replacement ([`b9e269e`](`b9e269e965`)) * kitchen: avoid using bootstrap for `master` instances [skip ci] ([`28c7470`](`28c7470600`)) * kitchen: use `debian-10-master-py3` instead of `develop` [skip ci] ([`62a2819`](`62a2819b8d`)) * kitchen: use `develop` image until `master` is ready (`amazonlinux`) [skip ci] ([`5e6f085`](`5e6f085fd4`)) * kitchen: use `saltimages` Docker Hub where available [skip ci] ([`cc33b93`](`cc33b93a58`)) * kitchen+travis: remove `master-py2-arch-base-latest` [skip ci] ([`85b8bc7`](`85b8bc7700`)) * kitchen+travis: upgrade matrix after `2019.2.2` release [skip ci] ([`b336538`](`b3365386aa`)) * pre-commit: add to formula [skip ci] ([`1d979af`](`1d979af015`)) * pre-commit: enable/disable `rstcheck` as relevant [skip ci] ([`3ecb741`](`3ecb7415ab`)) * pre-commit: finalise `rstcheck` configuration [skip ci] ([`f876619`](`f876619876`)) * travis: add notifications => zulip [skip ci] ([`de6cc9e`](`de6cc9e235`)) * travis: apply changes from build config validation [skip ci] ([`95928da`](`95928da597`)) * travis: opt-in to `dpl v2` to complete build config validation [skip ci] ([`2e68bca`](`2e68bcad91`)) * travis: quote pathspecs used with `git ls-files` [skip ci] ([`c426c62`](`c426c62301`)) * travis: run `shellcheck` during lint job [skip ci] ([`66a147d`](`66a147df78`)) * travis: update `salt-lint` config for `v0.0.10` [skip ci] ([`3668973`](`3668973688`)) * travis: use `major.minor` for `semantic-release` version [skip ci] ([`2d2bf7a`](`2d2bf7a8f7`)) * travis: use build config validation (beta) [skip ci] ([`a21bf73`](`a21bf73c8d`)) * workflows/commitlint: add to repo [skip ci] ([`de7860d`](`de7860d74c`)) ### Documentation * contributing: remove to use org-level file instead [skip ci] ([`eae8e87`](`eae8e87c8b`)) * readme: update link to `CONTRIBUTING` [skip ci] ([`16e6cb8`](`16e6cb8279`)) ### Performance Improvements * travis: improve `salt-lint` invocation [skip ci] ([`5f0e77f`](`5f0e77f93a`)) ### Styles * libtofs.jinja: use Black-inspired Jinja formatting [skip ci] ([`f43da51`](`f43da517a7`))		4年前
..
AUTHORS.rst	chore(release): 1.2.2 [skip ci]	4年前
CHANGELOG.rst	chore(release): 1.2.2 [skip ci]	4年前
README.rst	docs(readme): update link to `CONTRIBUTING` [skip ci]	5年前
TOFS_pattern.rst	ci(pre-commit): finalise `rstcheck` configuration [skip ci]	4年前

README.rst

.. _readme:

chrony-formula
==============

|img_travis| |img_sr|

.. |img_travis| image:: https://travis-ci.com/saltstack-formulas/chrony-formula.svg?branch=master
   :alt: Travis CI Build Status
   :scale: 100%
   :target: https://travis-ci.com/saltstack-formulas/chrony-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 chrony

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

``chrony``
^^^^^^^^^^

*Meta-state (This is a state that includes other states)*.

This installs the chrony package,
manages the chrony configuration file and then
starts the associated chrony service.

``chrony.package``
^^^^^^^^^^^^^^^^^^

This state will install the chrony package only.

``chrony.config``
^^^^^^^^^^^^^^^^^

This state will configure the chrony service and has a dependency on ``chrony.install``
via include list.

``chrony.service``
^^^^^^^^^^^^^^^^^^

This state will start the chrony service and has a dependency on ``chrony.config``
via include list.

``chrony.clean``
^^^^^^^^^^^^^^^^

*Meta-state (This is a state that includes other states)*.

this state will undo everything performed in the ``chrony`` meta-state in reverse order, i.e.
stops the service,
removes the configuration file and
then uninstalls the package.

``chrony.service.clean``
^^^^^^^^^^^^^^^^^^^^^^^^

This state will stop the chrony service and disable it at boot time.

``chrony.config.clean``
^^^^^^^^^^^^^^^^^^^^^^^

This state will remove the configuration of the chrony service and has a
dependency on ``chrony.service.clean`` via include list.

``chrony.package.clean``
^^^^^^^^^^^^^^^^^^^^^^^^

This state will remove the chrony package and has a depency on
``chrony.config.clean`` via include list.