From fd00522597b9e7fdb88e4b8bc663f26c89f1677c Mon Sep 17 00:00:00 2001
From: Spencer Krum <nibz@spencerkrum.com>
Date: Sat, 7 Feb 2015 05:56:41 -0800
Subject: [PATCH] Enhance and refactor head-of-file docs

The strange looking syntax the head-of-file docs are in is in
compliance with the new puppet-strings system for inline documentation

This enables neato stuff like 'puppet string <modulename>' to get docs
on the command line, and generating html, which we could then ship to
somewhere.

Change-Id: Icb0be2c733e4d3ee6beff32780c171b9f750b06f
---
 manifests/agent.pp         | 11 +++++++++--
 manifests/elasticsearch.pp |  5 ++++-
 manifests/indexer.pp       | 10 ++++++++--
 manifests/init.pp          |  2 ++
 manifests/redis.pp         |  5 ++++-
 manifests/web.pp           | 27 ++++++++++++++++++++++++++-
 6 files changed, 53 insertions(+), 7 deletions(-)

diff --git a/manifests/agent.pp b/manifests/agent.pp
index 2ff0667..7d37cb2 100644
--- a/manifests/agent.pp
+++ b/manifests/agent.pp
@@ -12,9 +12,16 @@
 # License for the specific language governing permissions and limitations
 # under the License.
 #
-# Class to install logstash agent (shipper).
-# conf_template accepts path to agent config template.
 #
+# = Class: logstash::agent
+#
+# Class to install logstash agent (shipper)
+#
+# == Parameters
+#
+# [*conf_template*]
+#   String. Path to agent config template.
+#   Default: 'logstash/agent.conf.erb'
 class logstash::agent (
   $conf_template = 'logstash/agent.conf.erb'
 ) {
diff --git a/manifests/elasticsearch.pp b/manifests/elasticsearch.pp
index be958f3..4efc494 100644
--- a/manifests/elasticsearch.pp
+++ b/manifests/elasticsearch.pp
@@ -12,7 +12,10 @@
 # License for the specific language governing permissions and limitations
 # under the License.
 #
-# Class to install elasticsearch.
+#
+# = Class: logstash::elasticsearch
+#
+# Class to install elasticsearch
 #
 class logstash::elasticsearch {
   file { '/etc/elasticsearch/templates/logstash_settings.json':
diff --git a/manifests/indexer.pp b/manifests/indexer.pp
index b68ed08..51c6643 100644
--- a/manifests/indexer.pp
+++ b/manifests/indexer.pp
@@ -12,9 +12,15 @@
 # License for the specific language governing permissions and limitations
 # under the License.
 #
-# Class to install logstash indexer.
-# conf_template accepts path to indexer config template.
+# = Class: logstash::indexer
 #
+# Class to install logstash indexer
+#
+# == Parameters
+#
+# [*conf_template*]
+#   String. Path to indexer config template.
+#   Default: 'logstash/agent.conf.erb'
 class logstash::indexer (
   $conf_template = 'logstash/indexer.conf.erb'
 ) {
diff --git a/manifests/init.pp b/manifests/init.pp
index 0b08c63..3c73ac4 100644
--- a/manifests/init.pp
+++ b/manifests/init.pp
@@ -12,6 +12,8 @@
 # License for the specific language governing permissions and limitations
 # under the License.
 #
+# = Class: Logstash
+#
 # Class to install common logstash items.
 #
 class logstash {
diff --git a/manifests/redis.pp b/manifests/redis.pp
index 8a632bb..12baa2d 100644
--- a/manifests/redis.pp
+++ b/manifests/redis.pp
@@ -12,7 +12,10 @@
 # License for the specific language governing permissions and limitations
 # under the License.
 #
-# Class to install redis.
+#
+# = Class: logstash::redis
+#
+# Class to install redis
 #
 class logstash::redis {
   # TODO(clarkb): Access to redis should be controlled at a network level
diff --git a/manifests/web.pp b/manifests/web.pp
index 9919301..32dd2d5 100644
--- a/manifests/web.pp
+++ b/manifests/web.pp
@@ -12,7 +12,32 @@
 # License for the specific language governing permissions and limitations
 # under the License.
 #
-# Class to run logstash web front end.
+# = Class: logstash::web
+#
+# Class to run logstash web front end
+#
+# == Parameters
+#
+# [*vhost_name*]
+#   String. FQDN of the web listener
+#   Default: $::fqdn
+#
+# [*serveradmin*]
+#   String. Email address of the administator
+#   Default: webserver@${::fqdn}
+#
+# [*frontend*]
+#   String. Which kind of web frontend to use
+#   Default: internal
+#   Valid Values: 'internal', 'kibana'
+#
+# [*discover_nodes*]
+#   Array of strings. Nodes to connect to by default (kibana only)
+#   Default: ['localhost:9200']
+#
+# [*proxy_elasticsearch*]
+#   Boolean. Enables using apache mod_proxy to proxy reqs to ES (kibana only)
+#   Default: false
 #
 class logstash::web (
   $vhost_name = $::fqdn,