Add a bunch more cookbooks

[chef.git] / cookbooks / ntp / README.md

diff --git a/cookbooks/ntp/README.md b/cookbooks/ntp/README.md
new file mode 100644 (file)
index 0000000..227b395
--- /dev/null
+++ b/cookbooks/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.