1
0
mirror of https://github.com/krislamo/puppet-fluentd synced 2024-09-20 04:30:36 +00:00

changed class doc

This commit is contained in:
Max Wilhelm 2015-11-30 18:13:24 +01:00
parent 5385bf24e6
commit 2a35866e27

View File

@ -5,42 +5,42 @@
# #
# Parameters # Parameters
# ---------- # ----------
# # [*ensure*]
# Document parameters here. # Default: 'present'
# # [*manage_repo*]
# * `sample parameter` # Include repository to install recent fluentd (td-agent) from
# Explanation of what this parameter affects and what it defaults to. # Default: 'true'
# e.g. "Specify one or more upstream ntp servers as an array." # [*package_ensure*]
# # Package ensure
# Variables # Default: 'installed'
# ---------- # [*package_name*]
# # Package name
# Here you should define a list of variables that this module would require. # Default: 'td-agent'
# # [*package_install_options*]
# * `sample variable` # Package install options
# Explanation of how this variable affects the function of this class and if # Default: '[]'
# it has a default. e.g. "The parameter enc_ntp_servers must be set by the # [*service_manage*]
# External Node Classifier as a comma separated list of hostnames." (Note, # Defines if the service should be managed by puppet
# global variables should be avoided in favor of class parameters as # Default: 'true'
# of Puppet 2.6.) # [*service_name*]
# Name of the service
# Default: 'td-agent'
# [*service_ensure*]
# Service ensure
# Default: 'running'
# [*service_enabled*]
# Defines if the service should be enabled, defaults to 'true'
# #
# Examples # Examples
# -------- # --------
# #
# @example # @example
# class { 'fluentd': # include '::fluentd'
# servers => [ 'pool.ntp.org', 'ntp.local.company.com' ],
# }
#
# Authors
# -------
#
# Author Name <author@domain.com>
# #
# Copyright # Copyright
# --------- # ---------
# #
# Copyright 2015 Your name here, unless otherwise noted. # Copyright 2015 wywy GmbH, unless otherwise noted.
# #
class fluentd ( class fluentd (
$ensure = $::fluentd::params::ensure, $ensure = $::fluentd::params::ensure,