Gitiles
Code Review Sign In
gerrit.mcp.mirantis.com / salt-formulas / ntp / 38585e5448925d8283aae8a9277f15525ae72d09 / . / README.rst
blob: 1ef273e5952bf442fd4a0f404e91259bb99af98b [file] [log] [blame]
OlgaGusarenko5fc09322018-06-19 11:29:32 +0300[diff] [blame]1=====
2Usage
3=====
Filip Pytloun10e4d6c2015-10-06 16:28:32 +0200[diff] [blame]4
OlgaGusarenko5fc09322018-06-19 11:29:32 +0300[diff] [blame]5The Network Time Protocol (NTP) formula is used to properly synchronize
6services across the nodes. This file provides the sample configurations for
7different use cases.
Filip Pytloun10e4d6c2015-10-06 16:28:32 +0200[diff] [blame]8
OlgaGusarenko5fc09322018-06-19 11:29:32 +0300[diff] [blame]9* [Deprecated] NTP client configuration, should not be used if the ``stratum``
10 parameter exists:
Filip Pytloun10e4d6c2015-10-06 16:28:32 +0200[diff] [blame]11
OlgaGusarenko5fc09322018-06-19 11:29:32 +0300[diff] [blame]12 .. code-block:: yaml
Filip Pytloun10e4d6c2015-10-06 16:28:32 +0200[diff] [blame]13
OlgaGusarenko5fc09322018-06-19 11:29:32 +0300[diff] [blame]14 ntp:
15 client:
Ondrej Smolad3c67032018-04-04 12:16:05 +0200[diff] [blame]16 enabled: true
OlgaGusarenko5fc09322018-06-19 11:29:32 +0300[diff] [blame]17 strata:
18 - ntp.cesnet.cz
19 - ntp.nic.cz
Ondrej Smolad3c67032018-04-04 12:16:05 +0200[diff] [blame]20
OlgaGusarenko5fc09322018-06-19 11:29:32 +0300[diff] [blame]21* The NTP client extended definition with auth:
Ondrej Smolad3c67032018-04-04 12:16:05 +0200[diff] [blame]22
OlgaGusarenko5fc09322018-06-19 11:29:32 +0300[diff] [blame]23 .. code-block:: yaml
24
25 ntp:
26 client:
Ondrej Smolad3c67032018-04-04 12:16:05 +0200[diff] [blame]27 enabled: true
OlgaGusarenko5fc09322018-06-19 11:29:32 +0300[diff] [blame]28 stratum:
29 primary:
30 server: ntp.cesnet.cz
31 key_id: 1
32 secondary:
33 server: ntp.nic.cz
34 key_id: 2
35
36* The NTP client with MD5 auth configuration:
37
38 .. code-block:: yaml
39
40 ntp:
41 client:
42 enabled: true
43 auth:
44 enabled: true
45 secrets:
46 1:
47 secret_type: 'M'
48 secret: 'Runrabbitrundigthath'
49 trustedkey: true
50 2:
51 secret_type: 'M'
52 secret: 'Howiwishyouwereherew'
53 trustedkey: true
54 stratum:
55 primary:
56 server: ntp.cesnet.cz
57 key_id: 1
58 secondary:
59 server: ntp.nic.cz
60 key_id: 2
61
Stanislav Riazanovb1027022019-03-25 17:42:22 +0400[diff] [blame]62* The NTP client definition enabling the ``listen`` and ``ignore`` actions on
63 specific addresses:
64
65 .. code-block:: yaml
66
67 ntp:
68 client:
69 interface:
70 1:
71 value: wildcard
72 action: ignore
73 2:
74 value: ::1
75 action: listen
76 3:
77 value: 192.168.31.1
78 action: listen
79
OlgaGusarenko5fc09322018-06-19 11:29:32 +0300[diff] [blame]80* The NTP server with MD5 auth configuration:
81
82 .. code-block:: yaml
83
84 ntp:
85 client:
86 enabled: false
87 server:
88 enabled: true
89 auth:
90 enabled: true
91 secrets:
92 1:
93 secret_type: 'M'
94 secret: 'Runrabbitrundigthath'
95 trustedkey: true
96 2:
97 secret_type: 'M'
98 secret: 'Howiwishyouwereherew'
99 trustedkey: true
100 stratum:
101 primary:
102 server: ntp.cesnet.cz
103 key_id: 1
104 secondary:
105 server: ntp.nic.cz
106 key_id: 2
107
108* A cleaning up of the NTP configurations left by DHCP:
109
110 .. code-block:: yaml
111
112 ntp:
113 client:
114 enabled: true
115 remove_dhcp_conf: true # default false
116
117* The NTP server simple peering definition:
118
119 .. code-block:: yaml
120
121 ntp:
122 server:
123 peers:
124 - 192.168.0.241
125 - 192.168.0.242
126
127* The NTP server extended peering definition:
128
129 .. code-block:: yaml
130
131 ntp:
132 server:
133 peers:
Ondrej Smolad3c67032018-04-04 12:16:05 +0200[diff] [blame]134 1:
OlgaGusarenko5fc09322018-06-19 11:29:32 +0300[diff] [blame]135 host: 192.168.31.1
Ondrej Smolad3c67032018-04-04 12:16:05 +0200[diff] [blame]136 2:
OlgaGusarenko5fc09322018-06-19 11:29:32 +0300[diff] [blame]137 host: 192.168.31.2
138 3:
139 host: 192.168.31.3
Ondrej Smolad3c67032018-04-04 12:16:05 +0200[diff] [blame]140
OlgaGusarenko5fc09322018-06-19 11:29:32 +0300[diff] [blame]141* The NTP server definition enabling the ``listen`` and ``ignore`` actions on
142 specific addresses:
azvyagintsev4e404702018-05-30 20:02:03 +0300[diff] [blame]143
OlgaGusarenko5fc09322018-06-19 11:29:32 +0300[diff] [blame]144 .. code-block:: yaml
azvyagintsev4e404702018-05-30 20:02:03 +0300[diff] [blame]145
OlgaGusarenko5fc09322018-06-19 11:29:32 +0300[diff] [blame]146 ntp:
147 server:
Stanislav Riazanovb1027022019-03-25 17:42:22 +0400[diff] [blame]148 interface:
OlgaGusarenko5fc09322018-06-19 11:29:32 +0300[diff] [blame]149 1:
150 value: wildcard
151 action: ignore
152 2:
153 value: ::1
154 action: listen
155 3:
156 value: 192.168.31.1
157 action: listen
azvyagintsev4e404702018-05-30 20:02:03 +0300[diff] [blame]158
OlgaGusarenko5fc09322018-06-19 11:29:32 +0300[diff] [blame]159**Read more**
Filip Pytloun10e4d6c2015-10-06 16:28:32 +0200[diff] [blame]160
161* https://collectd.org/wiki/index.php/Plugin:NTPd