Skip to content

Commit

Permalink
Add readme for 'ntp' cookbook
Browse files Browse the repository at this point in the history
  • Loading branch information
jtimberman committed Jul 11, 2010
1 parent b47591e commit b8c7d19
Show file tree
Hide file tree
Showing 3 changed files with 45 additions and 3 deletions.
41 changes: 41 additions & 0 deletions ntp/README.md
@@ -0,0 +1,41 @@
DESCRIPTION
===========

Installs and configures ntp, optionally set up a local NTP server.

USAGE
=====

Set up the ntp attributes in a role. For example in a base.rb role applied to all nodes:

"ntp" => {
"servers" => "time.int.example.org"
}

Then in an ntpserver.rb role that is applied to NTP servers:

"ntp" => {
"is_server" => "true",
"servers" => "0.us.pool.ntp.org"
}

The time.int.example.org used in the base role is a CNAME for the NTP server.

LICENSE AND AUTHOR
==================

Author:: Joshua Timberman (<joshua@opscode.com>)

Copyright 2009, Opscode, Inc.

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.
4 changes: 2 additions & 2 deletions ntp/metadata.json
Expand Up @@ -87,7 +87,7 @@
]
},
"license": "Apache 2.0",
"version": "0.8.1",
"version": "0.8.2",
"maintainer": "Opscode, Inc.",
"suggestions": {
},
Expand All @@ -99,5 +99,5 @@
"conflicting": {
},
"description": "Installs and configures ntp as a client or server",
"long_description": ""
"long_description": "DESCRIPTION\n===========\n\nInstalls and configures ntp, optionally set up a local NTP server.\n\nUSAGE\n=====\n\nSet up the ntp attributes in a role. For example in a base.rb role applied to all nodes:\n\n \"ntp\" => {\n \"servers\" => \"time.int.example.org\"\n }\n\nThen in an ntpserver.rb role that is applied to NTP servers:\n\n \"ntp\" => {\n \"is_server\" => \"true\",\n \"servers\" => \"0.us.pool.ntp.org\"\n }\n\nThe time.int.example.org used in the base role is a CNAME for the NTP server.\n\nLICENSE AND AUTHOR\n==================\n\nAuthor:: Joshua Timberman (<joshua@opscode.com>)\n\nCopyright 2009, Opscode, Inc.\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n"
}
3 changes: 2 additions & 1 deletion ntp/metadata.rb
Expand Up @@ -2,7 +2,8 @@
maintainer_email "cookbooks@opscode.com"
license "Apache 2.0"
description "Installs and configures ntp as a client or server"
version "0.8.1"
long_description IO.read(File.join(File.dirname(__FILE__), 'README.md'))
version "0.8.2"

recipe "ntp", "Installs and configures ntp either as a server or client"

Expand Down

0 comments on commit b8c7d19

Please sign in to comment.