summaryrefslogtreecommitdiff
path: root/README.markdown
diff options
context:
space:
mode:
authorRyan Coleman <ryan@puppetlabs.com>2013-02-13 11:26:52 -0800
committerRyan Coleman <ryan@puppetlabs.com>2013-02-13 11:26:52 -0800
commitab3edf97f92853fe40b92670d5d4ec9adfbeddcc (patch)
tree82245f8fb56e2611bc0c1dde5868418b625e34cf /README.markdown
parent5015ec6190ea415f080e6c062e57fc9bb0be96e1 (diff)
Update Documentation and Purge Extras
Commit message from laurenrother Before alterations, this content was the module author-determined description of and instructions for use of the module. As part of a joint Forge/Docs team effort to standardize formatting and encourage quality module documentation, a best practices README template was created via internal and external user testing. That template was then applied to this module. I pulled in content from the original README on GitHub as well as the Forge Module Description. Standard headings were added (Overview, Module Description, Setup, Usage, Implementation, etc.) to organize content, existent content was moved under its appropriate heading and edited for tone/flow/clarity, and basic formatting was done to adhere to template standards. Extraneous, empty READMEs were deleted.
Diffstat (limited to 'README.markdown')
-rw-r--r--README.markdown109
1 files changed, 100 insertions, 9 deletions
diff --git a/README.markdown b/README.markdown
index e3aef69..6cfa7c8 100644
--- a/README.markdown
+++ b/README.markdown
@@ -1,15 +1,106 @@
-# NTP #
+ntp
+====
[![Build Status](https://travis-ci.org/puppetlabs/puppetlabs-ntp.png?branch=master)](https://travis-ci.org/puppetlabs/puppetlabs-ntp)
-Manage the NTP service.
-This module has been built and tested using Puppet 2.6.x
+Overview
+--------
-# Platforms #
+The NTP module installs, configures, and manages the network time service.
- * Enterprise Linux 5 (and CentOS 5.4)
- * Ubuntu 10.04 Lucid
- * Amazon Linux 2011.09 has been tested on 2.7.x with facter version 1.6.2
- * FreeBSD 9.0
- * Debian 6.0 Squeeze
+
+Module Description
+-------------------
+
+The NTP module allows Puppet to install, configure, and then manage your Network Time Protocol service. The module allows you to setup and manage time settings across many servers from one place.
+
+Setup
+-----
+
+**What NTP affects:**
+
+* package/service/configuration files for NTP
+* server settings
+
+### Beginning with NTP
+
+To setup NTP on a server
+
+ class { "ntp":
+ servers => [ 'time.apple.com' ],
+ autoupdate => false,
+ }
+
+Usage
+------
+
+When making changes to your configuration of NTP, you may need to stop and restart the ntp service. To keep the ntp service stopped, pass ensure => stopped to the class:
+
+ class { ntp:
+ ensure => running,
+ servers => [ 'time.apple.com iburst',
+ 'pool.ntp.org iburst' , ]
+ autoupdate => true,
+ }
+
+The `ntp` class has several parameters to assist configuration of the ntp service.
+
+**Parameters within `ntp`**
+
+####`servers`
+
+NTP will use your operating system's default server if this parameter is left unspecified. This parameter accepts an array of servers,
+
+ class { 'ntp':
+ servers => [ '0.debian.pool.ntp.org iburst',
+ '1.debian.pool.ntp.org iburst',
+ '2.debian.pool.ntp.org iburst',
+ '3.debian.pool.ntp.org iburst', ]
+ }
+
+####`restrict`
+
+This parameter specifies whether to restrict ntp daemons from allowing others to use as a server.
+
+####`autoupdate`
+
+This parameter is used to determine whether the ntp package will be updated automatically or not.
+
+####`enable`
+
+This parameter allows you to choose whether to automatically start ntp daemon on boot.
+
+
+Limitations
+------------
+
+This module has been built and tested using Puppet 2.6.x, 2.7, and 3.x.
+
+The module has been tested on:
+
+* Enterprise Linux 5
+* Debian 6.0
+* CentOS 5.4.
+* Ubuntu 12.04
+
+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.](http://projects.puppetlabs.com/projects/module-site/wiki/Module_contributing)
+
+Release Notes
+--------------
+
+**0.2.0**
+
+0.2.0 is a backwards compatible feature and bug-fix release. Since
+0.1.0, support for Amazon Linux was added, fixes for style were
+implemented, and support was added for tinker_panic. tinker_panic
+will default to on when the fact is_virtual is true.