Update ntp to 05b6a27

05b6a27 Merge pull request redhat-openstack#242 from psoloway/readme-overhaul ad419f0 Update the README Table of Contents 7443778 Merge pull request redhat-openstack#241 from psoloway/readme-overhaul 5b9e8a5 General stye & content overhaul 955ef51 Merge pull request redhat-openstack#240 from cmurphy/rspec 81913cb Pin rspec gems e57ad70 Merge pull request redhat-openstack#236 from hunner/fix_233 e33e0ee These tests are better covered by the existing unit tests. 6e56c07 Merge pull request redhat-openstack#232 from jamesdobson/bug/master/invalid_logfile_parameter 3de8b3b Merge pull request redhat-openstack#234 from bastelfreak/update-readme 2be7648 extend Readme for a simple client 9f2dd0d Merge pull request redhat-openstack#233 from juniorsysadmin/package-manage-parameter 5d821a8 (MODULES-1479) Add package_manage parameter 3a4342e Fixing logfile parameter. 15bd628 Merge pull request redhat-openstack#229 from cmurphy/master 879782e Add IntelliJ files to the ignore list d9cd2a0 Merge pull request redhat-openstack#227 from laurenrother/summary d593de1 Merge pull request redhat-openstack#228 from cmurphy/master 68e5db9 Add json gem ad96090 Update .travis.yml, Gemfile, Rakefile, and CONTRIBUTING.md 5d23441 dd metadata summary per FM-1523 00b34f3 Merge pull request redhat-openstack#226 from mhaskel/MODULES-207 7cd29cc There are no setup-requirements for puppetlabs-ntp 1e98668 Merge pull request redhat-openstack#225 from mhaskel/test 948d053 Merge remote-tracking branch 'upstream/3.3.x' into test 1f519f7 Merge pull request redhat-openstack#224 from cyberious/3.3.x f31b195 add support for solaris given the ssl cert issue d0fe294 Merge pull request redhat-openstack#223 from mhaskel/spec_helper_fix 0718d95 stdlib installation wasn't working bb52d23 Merge pull request redhat-openstack#222 from mhaskel/limitations fa30e14 Limitations was out of date. cc1c866 Merge pull request redhat-openstack#221 from mhaskel/moar_sles12 9753f95 Updated testing and support for sles12 4fd5093 Merge pull request redhat-openstack#220 from cyberious/Sles12 252d5b3 Updated testing and support for sles12 7a20fb6 Merge pull request redhat-openstack#219 from mhaskel/3.3.0-prep 00e30e0 Merge pull request redhat-openstack#218 from mhaskel/test ca7be1d 3.3.0 prep 5a63a51 Merge remote-tracking branch 'upstream/3.2.x' into test 177aebf Merge pull request redhat-openstack#217 from cyberious/Sles12 be63c07 Fix spec tests and update to use stdlib 3.2.x branch for spec acceptance testing 8491dd6 Add SLES12 support as it has changed to Systemd a607bd4 Merge pull request redhat-openstack#216 from mhaskel/test e5cd001 Merge pull request redhat-openstack#215 from mhaskel/3.2.1-prep d55e372 Missed some EL7 platforms dcbefaa Merge pull request redhat-openstack#214 from mhaskel/3.2.1-prep 9596d3c 3.2.1 prep Signed-off-by: Gael Chamoulaud <[email protected]>
strider · Feb 19, 2015 · b1ecb0f · b1ecb0f
1 parent 741f4f1
commit b1ecb0f
Show file tree

Hide file tree

Showing 19 changed files with 265 additions and 152 deletions.
diff --git a/Puppetfile b/Puppetfile
@@ -119,7 +119,7 @@ mod 'nssdb',
   :git => 'https://github.com/rcritten/puppet-nssdb.git'
 
 mod 'ntp',
-  :commit => '8f697e32bc279b36ada752273e6c788716b95315',
+  :commit => '05b6a27be2ca2fc011eace13782d958cf6fe4999',
   :git => 'https://github.com/puppetlabs/puppetlabs-ntp'
 
 mod 'openstack_extras',

diff --git a/ntp/.gitignore b/ntp/.gitignore
@@ -5,3 +5,5 @@ spec/fixtures/
 .vagrant/
 .bundle/
 coverage/
+.idea/
+*.iml
diff --git a/ntp/.travis.yml b/ntp/.travis.yml
@@ -1,6 +1,6 @@
 ---
 language: ruby
-bundler_args: --without development
+bundler_args: --without system_tests
 script: "bundle exec rake validate && bundle exec rake lint && bundle exec rake spec SPEC_OPTS='--format documentation'"
 matrix:
   fast_finish: true

diff --git a/ntp/CHANGELOG.md b/ntp/CHANGELOG.md
@@ -1,3 +1,19 @@
+##2014-11-04 - Supported Release 3.3.0
+###Summary
+
+This release adds support for SLES 12.
+
+####Features
+- Added support for SLES 12
+
+##2014-10-02 - Supported Release 3.2.1
+###Summary
+
+This is a bug-fix release addressing the security concerns of setting /etc/ntp to mode 0755 recursively.
+
+####Bugfixes
+- Do not recursively set ownership/mode of /etc/ntp
+
 ##2014-09-10 - Supported Release 3.2.0
 ###Summary
 

diff --git a/ntp/CONTRIBUTING.md b/ntp/CONTRIBUTING.md
@@ -41,11 +41,9 @@ Checklist (and a short version for the impatient)
 
     * Pre-requisites:
 
-      - Sign the [Contributor License Agreement](https://cla.puppetlabs.com/)
-
       - Make sure you have a [GitHub account](https://github.com/join)
 
-      - [Create a ticket](http://projects.puppetlabs.com/projects/modules/issues/new), or [watch the ticket](http://projects.puppetlabs.com/projects/modules/issues) you are patching for.
+      - [Create a ticket](https://tickets.puppetlabs.com/secure/CreateIssue!default.jspa), or [watch the ticket](https://tickets.puppetlabs.com/browse/) you are patching for.
 
     * Preferred method:
 
@@ -94,17 +92,7 @@ The long version
       whitespace or other "whitespace errors".  You can do this by
       running "git diff --check" on your changes before you commit.
 
-  2.  Sign the Contributor License Agreement
-
-      Before we can accept your changes, we do need a signed Puppet
-      Labs Contributor License Agreement (CLA).
-
-      You can access the CLA via the [Contributor License Agreement link](https://cla.puppetlabs.com/)
-
-      If you have any questions about the CLA, please feel free to
-      contact Puppet Labs via email at [email protected].
-
-  3.  Sending your patches
+  2.  Sending your patches
 
       To submit your changes via a GitHub pull request, we _highly_
       recommend that you have them on a topic branch, instead of
@@ -124,7 +112,7 @@ The long version
       in order to open a pull request.
 
 
-  4.  Update the related GitHub issue.
+  3.  Update the related GitHub issue.
 
       If there is a GitHub issue associated with the change you
       submitted, then you should update the ticket to include the
@@ -220,14 +208,12 @@ review.
 Additional Resources
 ====================
 
-* [Getting additional help](http://projects.puppetlabs.com/projects/puppet/wiki/Getting_Help)
+* [Getting additional help](http://puppetlabs.com/community/get-help)
 
 * [Writing tests](http://projects.puppetlabs.com/projects/puppet/wiki/Development_Writing_Tests)
 
 * [Patchwork](https://patchwork.puppetlabs.com)
 
-* [Contributor License Agreement](https://projects.puppetlabs.com/contributor_licenses/sign)
-
 * [General GitHub documentation](http://help.github.com/)
 
 * [GitHub pull request documentation](http://help.github.com/send-pull-requests/)

diff --git a/ntp/Gemfile b/ntp/Gemfile
@@ -1,15 +1,19 @@
 source ENV['GEM_SOURCE'] || "https://rubygems.org"
 
-group :development, :test do
+group :development, :unit_tests do
   gem 'rake',                    :require => false
-  gem 'rspec-puppet',            :require => false
+  gem 'rspec-core', '3.1.7',     :require => false
+  gem 'rspec-puppet', '~> 1.0',  :require => false
   gem 'puppetlabs_spec_helper',  :require => false
-  gem 'serverspec',              :require => false
   gem 'puppet-lint',             :require => false
-  gem 'beaker',                  :require => false
-  gem 'beaker-rspec',            :require => false
-  gem 'pry',                     :require => false
   gem 'simplecov',               :require => false
+  gem 'puppet_facts',            :require => false
+  gem 'json',                    :require => false
+end
+
+group :system_tests do
+  gem 'beaker-rspec',  :require => false
+  gem 'serverspec',    :require => false
 end
 
 if facterversion = ENV['FACTER_GEM_VERSION']

diff --git a/ntp/README.markdown b/ntp/README.markdown
@@ -5,9 +5,6 @@
 1. [Overview](#overview)
 2. [Module Description - What the module does and why it is useful](#module-description)
 3. [Setup - The basics of getting started with ntp](#setup)
-    * [What ntp affects](#what-ntp-affects)
-    * [Setup requirements](#setup-requirements)
-    * [Beginning with ntp](#beginning-with-ntp)
 4. [Usage - Configuration options and additional functionality](#usage)
 5. [Reference - An under-the-hood peek at what the module is doing and how](#reference)
 5. [Limitations - OS compatibility, etc.](#limitations)
@@ -23,16 +20,9 @@ The ntp module handles installing, configuring, and running NTP across a range o
 
 ##Setup
 
-###What ntp affects
-
-* ntp package.
-* ntp configuration file.
-* ntp service.
-
 ###Beginning with ntp
 
-`include '::ntp'` is enough to get you up and running.  If you wish to pass in
-parameters specifying which servers to use, then:
+`include '::ntp'` is enough to get you up and running.  If you wish to pass in parameters specifying which servers to use, then:
 
 ```puppet
 class { '::ntp':
@@ -42,8 +32,7 @@ class { '::ntp':
 
 ##Usage
 
-All interaction with the ntp module can do be done through the main ntp class.
-This means you can simply toggle the options in `::ntp` to have full functionality of the module.
+All interaction with the ntp module can be done through the main ntp class. This means you can simply toggle the options in `::ntp` to have full functionality of the module.
 
 ###I just want NTP, what's the minimum I need?
 
@@ -68,9 +57,25 @@ class { '::ntp':
 }
 ```
 
+###I just want to install a client that can't be queried
+
+```puppet
+class { '::ntp':
+  servers   => ['ntp1.corp.com', 'ntp2.corp.com'],
+  restrict  => [
+    'default ignore',
+    '-6 default ignore',
+    '127.0.0.1',
+    '-6 ::1',
+    'ntp1.corp.com nomodify notrap nopeer noquery',
+    'ntp1.corp.com nomodify notrap nopeer noquery'
+  ],
+}
+```
+
 ###I only want to listen on specific interfaces, not on 0.0.0.0
 
-Restricting this is especially useful on Openstack nodes which may have numerous virtual interfaces.
+Restricting ntp to a specific interface is especially useful on Openstack nodes which may have numerous virtual interfaces.
 
 ```puppet
 class { '::ntp':
@@ -89,6 +94,14 @@ class { '::ntp':
 }
 ```
 
+###I'd like to configure and run ntp, but I don't need to install it.
+
+```puppet
+class { '::ntp':
+  package_manage => false,
+}
+```
+
 ###Looks great!  But I'd like a different template; we need to do something unique here.
 
 ```puppet
@@ -116,137 +129,137 @@ class { '::ntp':
 
 ###Parameters
 
-The following parameters are available in the ntp module:
+The following parameters are available in the `::ntp` class:
 
 ####`autoupdate`
 
-**Deprecated:** This parameter determined whether the ntp module should be
-automatically updated to the latest version available.  Replaced by `package_ensure`.
+**Deprecated; replaced by the `package_ensure` parameter**. Tells Puppet whether to keep the ntp module updated to the latest version available. Valid options: 'true' or 'false'. Default value: 'false'
 
 ####`config`
 
-Sets the file that ntp configuration is written into.
+Specifies a file for ntp's configuration info. Valid options: string containing an absolute path. Default value: '/etc/ntp.conf' (or '/etc/inet/ntp.conf' on Solaris)
 
 ####`config_template`
 
-Determines which template Puppet should use for the ntp configuration.
+Specifies a file to act as a template for the config file. Valid options: string containing a path (absolute, or relative to the module path). Default value: 'ntp/ntp.conf.erb'
 
 ####`disable_monitor`
 
-Disables monitoring of ntp.
+Tells Puppet whether to refrain from monitoring the NTP service. Valid options: 'true' or 'false'. Default value: 'false'
 
 ####`driftfile`
 
-Sets the location of the drift file for ntp.
+Specifies an NTP driftfile. Valid options: string containing an absolute path. Default value: '/var/lib/ntp/drift' (except on AIX and Solaris)
 
 ####`iburst_enable`
 
-Set the iburst option in the ntp configuration. If enabled the option is set for every ntp peer.
+Specifies whether to enable the iburst option for every NTP peer. Valid options: 'true' or 'false'. Default value: 'false' (except on AIX and Debian)
 
 ####`interfaces`
 
-Sets the list of interfaces NTP will listen on. This parameter must be an array.
+Specifies one or more network interfaces for NTP to listen on. Valid options: array. Default value: [ ]
 
 ####`keys_controlkey`
 
-The key to use as the control key.
+Provides a control key to be used by NTP. Valid options: string. Default value: ' '
 
 ####`keys_enable`
 
-Whether the ntp keys functionality is enabled.
+Tells Puppet whether to enable key-based authentication. Valid options: 'true' or 'false'. Default value: 'false'
 
 ####`keys_file`
 
-Location of the keys file.
+Specifies an NTP keys file. Valid options: string containing an absolute path. Default value: '/etc/ntp/keys' (except on AIX, SLES, and Solaris)
 
 ####`keys_requestkey`
 
-Which of the keys is the request key.
+Provides a request key to be used by NTP. Valid options: string. Default value: ' '
+
+#### `keys_trusted`:
+Provides one or more keys to be trusted by NTP. Valid options: array of keys. Default value: [ ]
 
-#### `keys_trusted`
+#### `logfile`
 
-Array of trusted keys.
+Specifies a log file for NTP to use instead of syslog. Valid options: string containing an absolute path. Default value: ' '
 
 ####`package_ensure`
 
-Sets the ntp package to be installed. Can be set to 'present', 'latest', or a specific version. 
+Tells Puppet whether the NTP package should be installed, and what version. Valid options: 'present', 'latest', or a specific version number. Default value: 'present'
+
+####`package_manage`
+
+Tells Puppet whether to manage the NTP package. Valid options: 'true' or 'false'. Default value: 'true'
 
 ####`package_name`
 
-Determines the name of the package to install.
+Tells Puppet what NTP package to manage. Valid options: string. Default value: 'ntp' (except on AIX and Solaris)
 
 ####`panic`
 
-Determines if ntp should 'panic' in the event of a very large clock skew.
-This defaults to false for virtual machines, as they don't do a great job with keeping time.
+Specifies whether NTP should "panic" in the event of a very large clock skew. Valid options: 'true' or 'false'. Default value: 'true' (except on virtual machines, where major time shifts are normal)
 
 ####`preferred_servers`
 
-List of ntp servers to prefer.  Will append 'prefer' for any server in this list
-that also appears in the servers list.
+Specifies one or more preferred peers. Puppet will append 'prefer' to each matching item in the `servers` array. Valid options: array. Default value: [ ]
 
 ####`restrict`
 
-Sets the restrict options in the ntp configuration.  The lines are
-prefixed with 'restrict', so you just need to list the rest of the restriction.
+Specifies one or more `restrict` options for the NTP configuration. Puppet will prefix each item with 'restrict', so you only need to list the content of the restriction. Valid options: array. Default value for most operating systems:
+
+~~~~
+[
+  'default kod nomodify notrap nopeer noquery',
+  '-6 default kod nomodify notrap nopeer noquery',
+  '127.0.0.1',
+  '-6 ::1',
+]
+~~~~
+
+Default value for AIX systems:
+
+~~~~
+[
+  'default nomodify notrap nopeer noquery',
+  '127.0.0.1',
+]
+~~~~
 
 ####`servers`
 
-Selects the servers to use for ntp peers.
+Specifies one or more servers to be used as NTP peers. Valid options: array. Default value: varies by operating system
 
 ####`service_enable`
 
-Determines if the service should be enabled at boot.
+Tells Puppet whether to enable the NTP service at boot. Valid options: 'true' or 'false'. Default value: 'true'
 
 ####`service_ensure`
 
-Determines if the service should be running or not.
+Tells Puppet whether the NTP service should be running. Valid options: 'running' or 'stopped'. Default value: 'running'
 
 ####`service_manage`
 
-Selects whether Puppet should manage the service.
+Tells Puppet whether to manage the NTP service. Valid options: 'true' or 'false'. Default value: 'true'
 
 ####`service_name`
 
-Selects the name of the ntp service for Puppet to manage.
+Tells Puppet what NTP service to manage. Valid options: string. Default value: varies by operating system
 
 ####`udlc`
 
-Enables configs for undisciplined local clock, regardless of
-status as a virtual machine. 
-
+Specifies whether to enable specialized configuration options for an undisciplined local clock, regardless of its status as a virtual machine. Valid options: 'true' or 'false'. Default value: 'false'
 
 ##Limitations
 
-This module has been built on and tested against Puppet 2.7 and higher.
-
-The module has been tested on:
-
-* RedHat Enterprise Linux 5/6
-* Debian 6/7
-* CentOS 5/6
-* Ubuntu 12.04
-* Gentoo
-* Arch Linux
-* FreeBSD
-* Solaris 11
-* AIX 5.3, 6.1, 7.1
-
-Testing on other platforms has been light and cannot be guaranteed. 
+This module has been tested on [all PE-supported platforms](https://forge.puppetlabs.com/supported#compat-matrix), and no issues have been identified.
 
 ##Development
 
-Puppet Labs modules on the Puppet Forge are open projects, and community
-contributions are essential for keeping them great. We can’t access the
-huge number of platforms and myriad of hardware, software, and deployment
-configurations that Puppet is intended to serve.
+Puppet Labs modules on the Puppet Forge are open projects, and community contributions are essential for keeping them great. We can’t access the huge number of platforms and myriad of hardware, software, and deployment configurations that Puppet is intended to serve.
 
-We want to keep it as easy as possible to contribute changes so that our
-modules work in your environment. There are a few guidelines that we need
-contributors to follow so that we can have a chance of keeping on top of things.
+We want to keep it as easy as possible to contribute changes so that our modules work in your environment. There are a few guidelines that we need contributors to follow so that we can have a chance of keeping on top of things.
 
-You can read the complete module contribution guide [on the Puppet Labs wiki.](http://projects.puppetlabs.com/projects/module-site/wiki/Module_contributing)
+For more information, see our [module contribution guide.](https://docs.puppetlabs.com/forge/contributing.html)
 
 ###Contributors
 
-The list of contributors can be found at: [https://github.com/puppetlabs/puppetlabs-ntp/graphs/contributors](https://github.com/puppetlabs/puppetlabs-ntp/graphs/contributors)
+To see who's already involved, see the [list of contributors.](https://github.com/puppetlabs/puppetlabs-ntp/graphs/contributors)