add rdoc for ganglia::gmond

manifests/gmond.pp

@@ -1,3 +1,91 @@
+# == Class: ganglia::gmond
+#
+# installs and configures the ganglia gmond daemon
+#
+# === Parameters
+#
+# All parameteres are optional.
+#
+# [*cluster_name*]
+#   string - defaults to "unspecified"
+#
+# [*cluster_owner*]
+#   string - defaults to "unspecified"
+#
+# [*cluster_latlong*]
+#   string - defaults to "unspecified"
+#
+# [*cluster_url*]
+#   string - defaults to "unspecified"
+#
+# [*host_location*]
+#   string - defaults to "unspecified"
+#
+# [*udp_send_channel*]
+#   array of hashes.  Valid keys are:
+#
+#   -mcast_join
+#   -host
+#   -port
+#   -ttl
+#     
+#   defaults to:
+#   [ { mcast_join => '239.2.11.71', port => 8649, bind => '239.2.11.71' } ]
+#
+# [*udp_recv_channel*]
+#   array of hashes.  Valid keys are:
+#
+#   -channel
+#   -mcast_join
+#   -port
+#   -bind
+#     
+#   defaults to:
+#   [ { mcast_join => '239.2.11.71', port => 8649, ttl => 1 } ]
+#
+# [*tcp_accept_channel*]
+#   array of hashes.  Valid keys are:
+#
+#   -port
+#
+#   defaults to:
+#   [ { port => 8659 } ]
+#
+#
+# === Examples
+#
+#    udp_recv_channel = [
+#      {'port' => 8649, 'bind' => 'localhost'},
+#      {'port' => 8649, 'bind' => '0.0.0.0'},
+#    ]
+#    udp_send_channel = [
+#      {'port' => 8649, 'host' => 'test1.example.org', 'ttl' => 2},
+#      {'port' => 8649, 'host' => 'test2.example.org', 'ttl' => 2},
+#    ]
+#    tcp_accept_channel = [
+#      {'port' => 8649},
+#    ]
+#    params = {
+#      'cluster_name'        => "example grid",
+#      'cluster_owner'       => "ACME, Inc.",
+#      'cluster_latlong'     => "N32.2332147 W110.9481163",
+#      'cluster_url'         => "www.example.org",
+#      'host_location'       => "Example Computer Room",
+#      'udp_recv_channel'    => udp_recv_channel,
+#      'udp_send_channel'    => udp_send_channel,
+#      'tcp_accept_channel'  => tcp_accept_channel,
+#    }
+#
+#
+# === Authors
+#
+# Joshua Hoblitt <[email protected]>
+#
+# === Copyright
+#
+# Copyright (C) 2012 Joshua Hoblitt
+#
+
 class ganglia::gmond (
   $cluster_name       = 'unspecified',
   $cluster_owner      = 'unspecified',
@@ -17,8 +105,8 @@
   validate_string($cluster_latlong)
   validate_string($cluster_lurl)
   validate_string($cluster_location)
-  validate_array($udp_recv_channel)
   validate_array($udp_send_channel)
+  validate_array($udp_recv_channel)
   validate_array($tcp_accept_channel)
 
   class{ 'ganglia::gmond::install': } ->