Merge remote-tracking branch 'github/pull/440'

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

diff --git a/cookbooks/munin/README.md b/cookbooks/munin/README.md
index 205739199955017d846700bb599100dae9f89479..42ea706ece5581f94a1155cc1e0979dc84dfc3b4 100644 (file)
--- a/cookbooks/munin/README.md
+++ b/cookbooks/munin/README.md
@@ -1,34 +1,11 @@
-Cookbook
-========
-TODO: Enter the cookbook description here.
+# Munin Cookbook
 
-e.g.
-This cookbook makes your favorite breakfast sandwich.
+This cookbook configures munin, which we use for server monitoring at
+[munin.openstreetmap.org](https://munin.openstreetmap.org). The cookbook
+contains two recipes:
 
-Requirements
-------------
-TODO: List your cookbook requirements. Be sure to include any requirements this cookbook has on platforms, libraries, other cookbooks, packages, operating systems, etc.
+* default - installs and configures munin-node on each machine.
+* server - configures the central munin server
 
-Attributes
-----------
-TODO: List you cookbook attributes here.
-
-Usage
------
-TODO: Write usage instructions for each cookbook.
-
-Contributing
-------------
-TODO: (optional) If this is a public cookbook, detail the process for contributing. If this is a private cookbook, remove this section.
-
-e.g.
-1. Fork the repository on Github
-2. Create a named feature branch (like `add_component_x`)
-3. Write your change
-4. Write tests for your change (if applicable)
-5. Run the tests, ensuring they all pass
-6. Submit a Pull Request using Github
-
-License and Authors
--------------------
-Authors: TODO: List authors
+Additionally two providers are defined - munin_plugin and munin_plugin_conf, for
+configuring individual munin plugins.