Version information
This version is compatible with:
- Puppet Enterprise 3.x
- Puppet 3.x
- , , , , , , , ,
Start using this module
Add this module to your Puppetfile:
mod 'puppetlabs-ntp', '3.3.0'
Learn more about managing modules with a PuppetfileDocumentation
#ntp
####Table of Contents
- Overview
- Module Description - What the module does and why it is useful
- Setup - The basics of getting started with ntp
- Usage - Configuration options and additional functionality
- Reference - An under-the-hood peek at what the module is doing and how
- Limitations - OS compatibility, etc.
- Development - Guide for contributing to the module
##Overview
The ntp module installs, configures, and manages the NTP service.
##Module Description
The ntp module handles installing, configuring, and running NTP across a range of operating systems and distributions.
##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:
class { '::ntp':
servers => [ 'ntp1.corp.com', 'ntp2.corp.com' ],
}
##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.
###I just want NTP, what's the minimum I need?
include '::ntp'
###I just want to tweak the servers, nothing else.
class { '::ntp':
servers => [ 'ntp1.corp.com', 'ntp2.corp.com' ],
}
###I'd like to make sure I restrict who can connect as well.
class { '::ntp':
servers => [ 'ntp1.corp.com', 'ntp2.corp.com' ],
restrict => ['127.0.0.1'],
}
###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.
class { '::ntp':
servers => [ 'ntp1.corp.com', 'ntp2.corp.com' ],
interfaces => ['127.0.0.1', '1.2.3.4']
}
###I'd like to opt out of having the service controlled; we use another tool for that.
class { '::ntp':
servers => [ 'ntp1.corp.com', 'ntp2.corp.com' ],
restrict => ['127.0.0.1'],
service_manage => false,
}
###Looks great! But I'd like a different template; we need to do something unique here.
class { '::ntp':
servers => [ 'ntp1.corp.com', 'ntp2.corp.com' ],
restrict => ['127.0.0.1'],
service_manage => false,
config_template => 'different/module/custom.template.erb',
}
##Reference
###Classes
####Public Classes
- ntp: Main class, includes all other classes.
####Private Classes
- ntp::install: Handles the packages.
- ntp::config: Handles the configuration file.
- ntp::service: Handles the service.
###Parameters
The following parameters are available in the ntp module:
####autoupdate
Deprecated: This parameter determined whether the ntp module should be
automatically updated to the latest version available. Replaced by package_ensure
.
####config
Sets the file that ntp configuration is written into.
####config_template
Determines which template Puppet should use for the ntp configuration.
####disable_monitor
Disables monitoring of ntp.
####driftfile
Sets the location of the drift file for ntp.
####iburst_enable
Set the iburst option in the ntp configuration. If enabled the option is set for every ntp peer.
####interfaces
Sets the list of interfaces NTP will listen on. This parameter must be an array.
####keys_controlkey
The key to use as the control key.
####keys_enable
Whether the ntp keys functionality is enabled.
####keys_file
Location of the keys file.
####keys_requestkey
Which of the keys is the request key.
keys_trusted
Array of trusted keys.
####package_ensure
Sets the ntp package to be installed. Can be set to 'present', 'latest', or a specific version.
####package_name
Determines the name of the package to install.
####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.
####preferred_servers
List of ntp servers to prefer. Will append 'prefer' for any server in this list that also appears in the servers list.
####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.
####servers
Selects the servers to use for ntp peers.
####service_enable
Determines if the service should be enabled at boot.
####service_ensure
Determines if the service should be running or not.
####service_manage
Selects whether Puppet should manage the service.
####service_name
Selects the name of the ntp service for Puppet to manage.
####udlc
Enables configs for undisciplined local clock, regardless of status as a virtual machine.
##Limitations
This module has been built on and tested against Puppet 3.
The module has been tested on:
- RedHat Enterprise Linux 5/6/7
- CentOS 5/6/7
- Oracle Enterprise Linux 5/6/7
- Scientific Linux 5/6/7
- SLES 10SP4/11SP1/12
- Debian 6/7
- Ubuntu 10.04/12.04/14.04
- Solaris 11
- AIX 5.3/6.1/7.1
Testing on other platforms has been light and cannot be guaranteed.
##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.
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.
###Contributors
The list of contributors can be found at: https://github.com/puppetlabs/puppetlabs-ntp/graphs/contributors
##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
This is primarily a feature release. It adds a few new parameters to class ntp
and adds support for Solaris 11.
####Features
- Add the
$interfaces
parameter tontp
- Add support for Solaris 10 and 11
- Synchronized files with modulesync
- Test updates
- Add the
$iburst_enable
parameter tontp
####Bugfixes
- Fixes for strict variables
- Remove dependency on stdlib4
##2014-06-06 - Release 3.1.2 ###Summary
This is a supported release. This release fixes a manifest typo.
##2014-06-06 - Release 3.1.1 ###Summary
This is a bugfix release to get around dependency issues in PMT 3.6. This version has a dependency on puppetlabs-stdlib >= 4 so PE3.2.x is no longer supported.
####Bugfixes
- Remove deprecated Modulefile as it was causing duplicate dependencies with PMT.
##2014-05-14 - Release 3.1.0 ###Summary
This release adds disable_monitor
so you can disable the monitor functionality
of NTP, which was recently used in NTP amplification attacks. It also adds
support for RHEL7 and Ubuntu 14.04.
####Features
- Add
disable_monitor
####Bugfixes
#####Known Bugs
- No known bugs
##2014-04-09 - Supported Release 3.0.4 ###Summary This is a supported release.
The only functional change in this release is to split up the restrict defaults to be per operating system so that we can provide safer defaults for AIX, to resolve cases where IPv6 are disabled.
####Features
- Rework restrict defaults.
####Bugfixes
- Fix up a comment.
- Fix a test to work better on PE.
#####Known Bugs
- No known bugs
##2014-03-04 - Supported Release 3.0.3 ###Summary This is a supported release. Correct stdlib compatibility
####Bugfixes
- Remove
dirname()
call for correct stdlib compatibility. - Improved tests
####Known Bugs
- No known bugs
2014-02-13 - Release 3.0.2
###Summary
No functional changes: Update the README and allow custom gem sources.
2013-12-17 - Release 3.0.1
Summary
Work around a packaging bug with symlinks, no other functional changes.
2013-12-13 - Release 3.0.0
Summary
Final release of 3.0, enjoy!
2013-10-14 - Version 3.0.0-rc1
###Summary
This release changes the behavior of restrict and adds AIX osfamily support.
####Backwards-incompatible Changes:
restrict
no longer requires you to pass in parameters as:
restrict => [ 'restrict x', 'restrict y' ]
but just as:
restrict => [ 'x', 'y' ]
As the template now prefixes each line with restrict.
####Features
- Change the behavior of
restrict
so you no longer need the restrict keyword. - Add
udlc
parameter to enable undisciplined local clock regardless of the machines status as a virtual machine. - Add AIX support.
####Fixes
- Use class{} instead of including and then anchoring. (style)
- Extend Gentoo coverage to Facter 1.7.
##2013-09-05 - Version 2.0.1
###Summary
Correct the LICENSE file.
####Bugfixes
- Add in the appropriate year and name in LICENSE.
##2013-07-31 - Version 2.0.0
###Summary
The 2.0 release focuses on merging all the distro specific templates into a single reusable template across all platforms.
To aid in that goal we now allow you to change the driftfile, ntp keys, and perferred_servers.
####Backwards-incompatible changes
As all the distro specific templates have been removed and a unified one created you may be missing functionality you previously relied on. Please test carefully before rolling out globally.
Configuration directives that might possibly be affected:
filegen
fudge
(for virtual machines)keys
logfile
restrict
restrictkey
statistics
trustedkey
####Features:
- All templates merged into a single template.
- NTP Keys support added.
- Add preferred servers support.
- Parameters in
ntp
class:driftfile
: path for the ntp driftfile.keys_enable
: Enable NTP keys feature.keys_file
: Path for the NTP keys file.keys_trusted
: Which keys to trust.keys_controlkey
: Which key to use for the control key.keys_requestkey
: Which key to use for the request key.preferred_servers
: Array of servers to prefer.restrict
: Array of restriction options to apply.
###2013-07-15 - Version 1.0.1 ####Bugfixes
- Fix deprecated warning in
autoupdate
parameter. - Correctly quote is_virtual fact.
##2013-07-08 - Version 1.0.0 ####Features
- Completely refactored to split across several classes.
- rspec-puppet tests rewritten to cover more options.
- rspec-system tests added.
- ArchLinux handled via osfamily instead of special casing.
- parameters in
ntp
class:autoupdate
: deprecated in favor of directly setting package_ensure.panic
: set to false if you wish to allow large clock skews.
##2011-11-10 Dan Bode dan@puppetlabs.com - 0.0.4
- Add Amazon Linux as a supported platform
- Add unit tests
##2011-06-16 Jeff McCune jeff@puppetlabs.com - 0.0.3
- Initial release under puppetlabs
Dependencies
- puppetlabs/stdlib (>= 3.2.0 < 5.0.0)
Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [2013] [Puppet Labs] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.