NTP configuration cleanup and add documentation for new vars.

6 files changed, 85 insertions, 27 deletions

diff --git a/README.md b/README.md
index 49a459f..0a28255 100644
--- a/README.md
+++ b/README.md
@@ -20,6 +20,17 @@ Whether to start the ntpd service and enable it at system boot. On many virtual
 
 Set the timezone for your server.
 
+    ntp_manage_config: false
+
+Set to true to allow this role to manage the NTP configuration file (`/etc/ntp.conf`).
+
+    ntp_servers:
+     - 0.pool.ntp.org iburst
+     - 1.pool.ntp.org iburst
+     - 2.pool.ntp.org iburst
+     - 3.pool.ntp.org iburst
+
+Specify the NTP servers you'd like to use. Only takes effect if you allow this role to manage NTP's configuration, by setting `ntp_manage_config` to `true`.
 
 ## Dependencies
 
@@ -27,11 +38,9 @@ None.
 
 ## Example Playbook
 
-    - hosts: db-servers
-      vars_files:
-        - vars/main.yml
+    - hosts: all
       roles:
-        - { role: geerlingguy.ntp }
+        - geerlingguy.ntp
 
 *Inside `vars/main.yml`*:
 
diff --git a/defaults/main.yml b/defaults/main.yml
index 5b47eca..3ec5741 100644
--- a/defaults/main.yml
+++ b/defaults/main.yml
@@ -2,6 +2,7 @@
 ntp_enabled: true
 ntp_timezone: America/Chicago
 
+ntp_manage_config: false
 ntp_servers:
  - 0.pool.ntp.org iburst
  - 1.pool.ntp.org iburst
diff --git a/handlers/main.yml b/handlers/main.yml
index ee25a57..eb57480 100644
--- a/handlers/main.yml
+++ b/handlers/main.yml
@@ -1,3 +1,3 @@
 ---
  - name: restart ntp
-   service: name={{ ntp_daemon }} state=restarted
+   service: "name={{ ntp_daemon }} state=restarted"
diff --git a/tasks/main.yml b/tasks/main.yml
index b6213ba..6a58382 100644
--- a/tasks/main.yml
+++ b/tasks/main.yml
@@ -8,28 +8,27 @@
     dest: /etc/localtime
     state: link
     force: yes
-  when: ntp_enabled
 
 - name: Install NTP (RedHat).
   yum: name=ntp state=installed
-  when: ansible_os_family == 'RedHat' and ntp_enabled
+  when: ansible_os_family == 'RedHat'
 
 - name: Install NTP (Debian).
   apt: name=ntp state=installed
-  when: ansible_os_family == 'Debian' and ntp_enabled
+  when: ansible_os_family == 'Debian'
 
 - name: Install NTP (FreeBSD).
   pkgng: name=ntp state=present
-  when: ansible_os_family == 'FreeBSD' and ntp_enabled
+  when: ansible_os_family == 'FreeBSD'
 
-- name: Ensure NTP is running and enabled at system start.
+- name: Ensure NTP is running and enabled as configured.
   service:
     name: "{{ ntp_daemon }}"
     state: started
     enabled: yes
   when: ntp_enabled
 
-- name: Ensure NTP is stopped and disabled at system start.
+- name: Ensure NTP is stopped and disabled as configured.
   service:
     name: "{{ ntp_daemon }}"
     state: stopped
@@ -39,4 +38,4 @@
 - name: Generate ntp.conf file
   template: src=ntp.conf.j2 dest=/etc/ntp.conf
   notify: restart ntp
-  when: ntp_enabled
+  when: ntp_manage_config
diff --git a/templates/ntp.conf.j2 b/templates/ntp.conf.j2
index b0ddb0c..cc1e0f0 100644
--- a/templates/ntp.conf.j2
+++ b/templates/ntp.conf.j2
@@ -1,22 +1,70 @@
 # {{ ansible_managed }}
 
-# Default NTP servers for the operating system.
+# For more information about this file, see the man pages
+# ntp.conf(5), ntp_acc(5), ntp_auth(5), ntp_clock(5), ntp_misc(5), ntp_mon(5).
+
+driftfile /var/lib/ntp/drift
+
+# Enable this if you want statistics to be logged.
+#statsdir /var/log/ntpstats/
+
+statistics loopstats peerstats clockstats
+filegen loopstats file loopstats type day enable
+filegen peerstats file peerstats type day enable
+filegen clockstats file clockstats type day enable
+
+# Use public servers from the pool.ntp.org project.
+# Please consider joining the pool (http://www.pool.ntp.org/join.html).
 {% for item in ntp_servers %}
 server {{ item }}
 {% endfor %}
 
-# Security:
-#
-# By default, only allow time queries and block all other requests
-# from unauthenticated clients.
-#
-# See http://support.ntp.org/bin/view/Support/AccessRestrictions
-# for more information.
-#
-restrict default kod limited nomodify notrap nopeer noquery
-restrict -6 default kod limited nomodify notrap nopeer noquery
-
-# The following settings allow unrestricted access from the localhost
+# Permit time synchronization with our time source, but do not
+# permit the source to query or modify the service on this system.
+restrict default nomodify notrap nopeer noquery
+
+# Permit all access over the loopback interface.  This could
+# be tightened as well, but to do so would effect some of
+# the administrative functions.
 restrict 127.0.0.1
-restrict -6 ::1
-restrict 127.127.1.0
+restrict ::1
+
+# Clients from this (example!) subnet have unlimited access, but only if
+# cryptographically authenticated.
+#restrict 192.168.123.0 mask 255.255.255.0 notrust
+
+# Enable public key cryptography.
+#crypto
+
+#includefile /etc/ntp/crypto/pw
+
+# Key file containing the keys and key identifiers used when operating
+# with symmetric key cryptography.
+#keys /etc/ntp/keys
+
+# Specify the key identifiers which are trusted.
+#trustedkey 4 8 42
+
+# Specify the key identifier to use with the ntpdc utility.
+#requestkey 8
+
+# Specify the key identifier to use with the ntpq utility.
+#controlkey 8
+
+# Enable writing of statistics records.
+#statistics clockstats cryptostats loopstats peerstats
+
+# Disable the monitoring facility to prevent amplification attacks using ntpdc
+# monlist command when default restrict does not include the noquery flag. See
+# CVE-2013-5211 for more details.
+# Note: Monitoring will not be disabled with the limited restriction flag.
+disable monitor
+
+# If you want to provide time to your local subnet, change the next line.
+# (Again, the address is an example only.)
+#broadcast 192.168.123.255
+
+# If you want to listen to time broadcasts on your local subnet, de-comment the
+# next lines. Please do this only if you trust everybody on the network!
+#disable auth
+#broadcastclient
diff --git a/tests/test.yml b/tests/test.yml
index 794470d..34c9773 100644
--- a/tests/test.yml
+++ b/tests/test.yml
@@ -4,6 +4,7 @@
 
   vars:
     ntp_enabled: false
+    ntp_manage_config: true
 
   roles:
     - ansible-role-ntp