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
This commit is contained in:
Spencer Krum 2015-02-07 05:56:41 -08:00
parent 6239dc5f2c
commit fd00522597
6 changed files with 53 additions and 7 deletions

View File

@ -12,9 +12,16 @@
# License for the specific language governing permissions and limitations # License for the specific language governing permissions and limitations
# under the License. # 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 ( class logstash::agent (
$conf_template = 'logstash/agent.conf.erb' $conf_template = 'logstash/agent.conf.erb'
) { ) {

View File

@ -12,7 +12,10 @@
# License for the specific language governing permissions and limitations # License for the specific language governing permissions and limitations
# under the License. # under the License.
# #
# Class to install elasticsearch. #
# = Class: logstash::elasticsearch
#
# Class to install elasticsearch
# #
class logstash::elasticsearch { class logstash::elasticsearch {
file { '/etc/elasticsearch/templates/logstash_settings.json': file { '/etc/elasticsearch/templates/logstash_settings.json':

View File

@ -12,9 +12,15 @@
# License for the specific language governing permissions and limitations # License for the specific language governing permissions and limitations
# under the License. # under the License.
# #
# Class to install logstash indexer. # = Class: logstash::indexer
# conf_template accepts path to indexer config template.
# #
# Class to install logstash indexer
#
# == Parameters
#
# [*conf_template*]
# String. Path to indexer config template.
# Default: 'logstash/agent.conf.erb'
class logstash::indexer ( class logstash::indexer (
$conf_template = 'logstash/indexer.conf.erb' $conf_template = 'logstash/indexer.conf.erb'
) { ) {

View File

@ -12,6 +12,8 @@
# License for the specific language governing permissions and limitations # License for the specific language governing permissions and limitations
# under the License. # under the License.
# #
# = Class: Logstash
#
# Class to install common logstash items. # Class to install common logstash items.
# #
class logstash { class logstash {

View File

@ -12,7 +12,10 @@
# License for the specific language governing permissions and limitations # License for the specific language governing permissions and limitations
# under the License. # under the License.
# #
# Class to install redis. #
# = Class: logstash::redis
#
# Class to install redis
# #
class logstash::redis { class logstash::redis {
# TODO(clarkb): Access to redis should be controlled at a network level # TODO(clarkb): Access to redis should be controlled at a network level

View File

@ -12,7 +12,32 @@
# License for the specific language governing permissions and limitations # License for the specific language governing permissions and limitations
# under the License. # 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 ( class logstash::web (
$vhost_name = $::fqdn, $vhost_name = $::fqdn,