https://github.com/saltstack-formulas/ntp-formula
https://github.com/saltstack-formulas/ntp-formula
Last synced: 10 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/saltstack-formulas/ntp-formula
- Owner: saltstack-formulas
- License: other
- Created: 2013-06-12T22:22:27.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2025-01-06T23:09:33.000Z (about 1 year ago)
- Last Synced: 2025-03-28T08:09:13.214Z (11 months ago)
- Language: Ruby
- Homepage: http://docs.saltstack.com/en/latest/topics/development/conventions/formulas.html
- Size: 249 KB
- Stars: 23
- Watchers: 38
- Forks: 156
- Open Issues: 6
-
Metadata Files:
- Readme: docs/README.rst
- Changelog: CHANGELOG.md
- License: LICENSE
- Codeowners: CODEOWNERS
- Authors: AUTHORS.md
Awesome Lists containing this project
README
.. _readme:
ntp-formula
===========
|img_travis| |img_sr|
.. |img_travis| image:: https://travis-ci.com/saltstack-formulas/ntp-formula.svg?branch=master
:alt: Travis CI Build Status
:scale: 100%
:target: https://travis-ci.com/saltstack-formulas/ntp-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 the ntp client or server.
.. contents:: **Table of Contents**
General notes
-------------
See the full `SaltStack Formulas installation and usage instructions
`_.
If you are interested in writing or contributing to formulas, please pay attention to the `Writing Formula Section
`_.
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 `_.
See `Formula Versioning Section `_ for more details.
If you need (non-default) configuration, please pay attention to the ``pillar.example`` file and/or `Special notes`_ section.
Contributing to this repo
-------------------------
**Commit message formatting is significant!!**
Please see `How to contribute `_ for more details.
Special notes
-------------
None
Available states
----------------
.. contents::
:local:
``ntp``
^^^^^^^
Installs the ntp package, and optionally, a basic config.
``ntp.server``
^^^^^^^^^^^^^^
Installs the ntp server, an optional server config, and starts the ntp server.
``ntp.local_server``
^^^^^^^^^^^^^^^^^^^^
This formula uses pillar data to determine if the server is an internal NTP
server or a local server that syncs to the internal NTP server and will write
the ntp.conf file accordingly.
Requires CentOS 5.X or CentOS 6.X.
``ntp.ng``
^^^^^^^^^^
This state is a re-implementation of the original NTP formula. As a state, ``ntp.ng`` controls both the client and server through pillar parameters. This formula does not require that a configuration file be served directly and instead fully exposes all ntp configuration parameters as set in the pillar.
**Note:** ``ntp.ng`` relies upon some conventions first available in the *Helium* release.
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 ``template`` 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.