Cleans up the NTP's readme file
Change-Id: I938ef172bd2f17ab6f4781a7320ee442eb6cbbe0
diff --git a/README.rst b/README.rst
index e5a96e8..6eeab8a 100644
--- a/README.rst
+++ b/README.rst
@@ -1,175 +1,168 @@
-===
-NTP
-===
+=====
+Usage
+=====
-Network time synchronisation services.
+The Network Time Protocol (NTP) formula is used to properly synchronize
+services across the nodes. This file provides the sample configurations for
+different use cases.
-Sample pillars
-==============
+* [Deprecated] NTP client configuration, should not be used if the ``stratum``
+ parameter exists:
-NTP client (old version), not used when stratum parameter exists
+ .. code-block:: yaml
-.. code-block:: yaml
-
- ntp:
- client:
- enabled: true
- strata:
- - ntp.cesnet.cz
- - ntp.nic.cz
-
-NTP client (extended definitions with auth)
-
-.. code-block:: yaml
-
- ntp:
- client:
- enabled: true
- stratum:
- primary:
- server: ntp.cesnet.cz
- key_id: 1
- secondary:
- server: ntp.nic.cz
- key_id: 2
-
-NTP with MD5 auth
-Requires extended definitions
-
-.. code-block:: yaml
-
- ntp:
- client:
- enabled: true
- auth:
+ ntp:
+ client:
enabled: true
- secrets:
- 1:
- secret_type: 'M'
- secret: 'Runrabbitrundigthath'
- trustedkey: true
- 2:
- secret_type: 'M'
- secret: 'Howiwishyouwereherew'
- trustedkey: true
- stratum:
- primary:
- server: ntp.cesnet.cz
- key_id: 1
- secondary:
- server: ntp.nic.cz
- key_id: 2
+ strata:
+ - ntp.cesnet.cz
+ - ntp.nic.cz
-.. code-block:: yaml
+* The NTP client extended definition with auth:
- ntp:
- client:
- enabled: false
- server:
- enabled: true
- auth:
+ .. code-block:: yaml
+
+ ntp:
+ client:
enabled: true
- secrets:
+ stratum:
+ primary:
+ server: ntp.cesnet.cz
+ key_id: 1
+ secondary:
+ server: ntp.nic.cz
+ key_id: 2
+
+* The NTP client with MD5 auth configuration:
+
+ .. code-block:: yaml
+
+ ntp:
+ client:
+ enabled: true
+ auth:
+ enabled: true
+ secrets:
+ 1:
+ secret_type: 'M'
+ secret: 'Runrabbitrundigthath'
+ trustedkey: true
+ 2:
+ secret_type: 'M'
+ secret: 'Howiwishyouwereherew'
+ trustedkey: true
+ stratum:
+ primary:
+ server: ntp.cesnet.cz
+ key_id: 1
+ secondary:
+ server: ntp.nic.cz
+ key_id: 2
+
+* The NTP server with MD5 auth configuration:
+
+ .. code-block:: yaml
+
+ ntp:
+ client:
+ enabled: false
+ server:
+ enabled: true
+ auth:
+ enabled: true
+ secrets:
+ 1:
+ secret_type: 'M'
+ secret: 'Runrabbitrundigthath'
+ trustedkey: true
+ 2:
+ secret_type: 'M'
+ secret: 'Howiwishyouwereherew'
+ trustedkey: true
+ stratum:
+ primary:
+ server: ntp.cesnet.cz
+ key_id: 1
+ secondary:
+ server: ntp.nic.cz
+ key_id: 2
+
+* A cleaning up of the NTP configurations left by DHCP:
+
+ .. code-block:: yaml
+
+ ntp:
+ client:
+ enabled: true
+ remove_dhcp_conf: true # default false
+
+* The NTP server simple peering definition:
+
+ .. code-block:: yaml
+
+ ntp:
+ server:
+ peers:
+ - 192.168.0.241
+ - 192.168.0.242
+
+* The NTP server extended peering definition:
+
+ .. code-block:: yaml
+
+ ntp:
+ server:
+ peers:
1:
- secret_type: 'M'
- secret: 'Runrabbitrundigthath'
- trustedkey: true
+ host: 192.168.31.1
2:
- secret_type: 'M'
- secret: 'Howiwishyouwereherew'
- trustedkey: true
- stratum:
- primary:
- server: ntp.cesnet.cz
- key_id: 1
- secondary:
- server: ntp.nic.cz
- key_id: 2
+ host: 192.168.31.2
+ 3:
+ host: 192.168.31.3
-Cleanup ntp configurations left by DHCP:
+* The NTP server definition enabling the ``listen`` and ``ignore`` actions on
+ specific addresses:
-.. code-block:: yaml
+ .. code-block:: yaml
- ntp:
- client:
- enabled: true
- remove_dhcp_conf: true # default false
+ ntp:
+ server:
+ 1:
+ value: wildcard
+ action: ignore
+ 2:
+ value: ::1
+ action: listen
+ 3:
+ value: 192.168.31.1
+ action: listen
-Peering (simple):
-
-.. code-block:: yaml
-
- ntp:
- server:
- peers:
- - 192.168.0.241
- - 192.168.0.242
-
-Peering (extended definitions):
-
-.. code-block:: yaml
-
- ntp:
- server:
- peers:
- 1:
- host: 192.168.31.1
- 2:
- host: 192.168.31.2
- 3:
- host: 192.168.31.3
-
-Enable listen/ignote on specific addresses
-
-.. code-block:: yaml
-
- ntp:
- server:
- 1:
- value: wildcard
- action: ignore
- 2:
- value: ::1
- action: listen
- 3:
- value: 192.168.31.1
- action: listen
-
-
-Read more
-=========
+**Read more**
* https://collectd.org/wiki/index.php/Plugin:NTPd
-Documentation and Bugs
-======================
+**Documentation and bugs**
-To learn how to install and update salt-formulas, consult the documentation
-available online at:
+* http://salt-formulas.readthedocs.io/
+ Learn how to install and update salt-formulas
- http://salt-formulas.readthedocs.io/
+* https://github.com/salt-formulas/salt-formula-ntp/issues
+ In the unfortunate event that bugs are discovered, report the issue to the
+ appropriate issue tracker. Use the Github issue tracker for a specific salt
+ formula
-In the unfortunate event that bugs are discovered, they should be reported to
-the appropriate issue tracker. Use Github issue tracker for specific salt
-formula:
+* https://launchpad.net/salt-formulas
+ For feature requests, bug reports, or blueprints affecting the entire
+ ecosystem, use the Launchpad salt-formulas project
- https://github.com/salt-formulas/salt-formula-ntp/issues
+* https://launchpad.net/~salt-formulas-users
+ Join the salt-formulas-users team and subscribe to mailing list if required
-For feature requests, bug reports or blueprints affecting entire ecosystem,
-use Launchpad salt-formulas project:
+* https://github.com/salt-formulas/salt-formula-ntp
+ Develop the salt-formulas projects in the master branch and then submit pull
+ requests against a specific formula
- https://launchpad.net/salt-formulas
+* #salt-formulas @ irc.freenode.net
+ Use this IRC channel in case of any questions or feedback which is always
+ welcome
-You can also join salt-formulas-users team and subscribe to mailing list:
-
- https://launchpad.net/~salt-formulas-users
-
-Developers wishing to work on the salt-formulas projects should always base
-their work on master branch and submit pull request against specific formula.
-
- https://github.com/salt-formulas/salt-formula-ntp
-
-Any questions or feedback is always welcome so feel free to join our IRC
-channel:
-
- #salt-formulas @ irc.freenode.net