Puppet Class: splunk

Inherits:
splunk::params
Defined in:
manifests/init.pp

Overview

Class: splunk

The splunk module will install Splunk agents in the form of a Light Weight Fowarder, Heavy Forwarder, Universal Forwarder. It will also install servers for index, job and search configurations.

Please Note: This Module assumes you have the Splunk Packages in some sort of package repo.

Parameters

configure_outputs

Toggle to enable/disable managment of the outputs.conf file. You may want to disable the module managment of outputs.conf if you use a deployment server to manage that file. Defaults to true

index

Default index to sent inputs to. Defaults to ‘os’

localusers
licenseserver

fqdn of License host, passing this param will turn the node into a license slave of a configured license server. For a license master set licenseserver => ‘self’

nagios_contacts

Accepts a comma seperated list of contacts. Then enables and exports Nagios Service checks for monitoring.

output_hash

Optional hash of outputs that can be used instead of, or in addition to the default group (tcpout) Useful for forwarding data to third party tools from indexers.

output_hash => { ‘syslog:example_group’ => {

    'server' => 'server.example.com:514' }
}
package_provider

Defaults to undef

package_source

Defaults to undef

port

Splunk Default Input Port for indexers. Defaults to 9997. This sets both The ports Monitored and the ports set in outputs.conf

proxyserver

Define a proxy server for Splunk to use. Defaults to false.

purge

purge => true purge defaults to false, and only accepts a boolean as an argument. purge purges all traces of splunk without a backup.

splunkadmin
target_group

Hash used to define splunk default groups and servers, valid configs are { ‘target group name’ => ‘server/ip’ }

type

Install type. Defaults to Universal Forwarder valid inputs are: uf : Splunk Universal Forwarder lwf : Splunk Light Weight Forwarder hwf : Splunk Heavy Weight Forwarder jobs : Splunk Jobs Server - Search + Forwarding search : Splunk Search Head indexer : Splunk Distribuited Index Server

version

Install package version, defaults to ‘latest’

Variables

Here you should define a list of variables that this module would require.

sample_variable

Explanation of how this variable affects the funtion of this class and if it has a default. e.g. “The parameter enc_ntp_servers must be set by the External Node Classifier as a comma separated list of hostnames.” (Note, global variables should not be used in preference to class parameters as of Puppet 2.6.)

Examples

class { splunk:
  type => 'lwf',
}

Authors

Tim Hartmann <tfhartmann@gmail.com>

Copyright 2013 Network Systems Team - Harvard University

Parameters:

  • configure_outputs (Any) (defaults to: $::splunk::params::configure_outputs)
  • service_ensure (Any) (defaults to: $::splunk::params::service_ensure)
  • service_enable (Any) (defaults to: $::splunk::params::service_enable)
  • index (Any) (defaults to: $::splunk::params::index)
  • index_hash (Any) (defaults to: $::splunk::params::index_hash)
  • indexandforward (Any) (defaults to: false)
  • localusers (Any) (defaults to: $::splunk::params::localusers)
  • licenseserver (Any) (defaults to: undef)
  • nagios_contacts (Any) (defaults to: $::splunk::params::nagios_contacts)
  • nagiosserver (Any) (defaults to: undef)
  • output_hash (Any) (defaults to: $::splunk::params::output_hash)
  • port (Any) (defaults to: $::splunk::params::port)
  • proxyserver (Any) (defaults to: $::splunk::params::proxyserver)
  • purge (Any) (defaults to: $::splunk::params::purge)
  • splunkadmin (Any) (defaults to: $::splunk::params::splunkadmin)
  • target_group (Any) (defaults to: $::splunk::params::target_group)
  • type (Any) (defaults to: $::splunk::params::type)
  • package_source (Any) (defaults to: undef)
  • package_provider (Any) (defaults to: undef)
  • version (Any) (defaults to: $::splunk::params::version)
  • replace_passwd (Any) (defaults to: $::splunk::params::replace_passwd) 


101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'manifests/init.pp', line 101

class splunk (
  $configure_outputs = $::splunk::params::configure_outputs,
  $service_ensure    = $::splunk::params::service_ensure,
  $service_enable    = $::splunk::params::service_enable,
  $index             = $::splunk::params::index,
  $index_hash        = $::splunk::params::index_hash,
  $indexandforward   = false,
  $localusers        = $::splunk::params::localusers,
  $licenseserver     = undef,
  $nagios_contacts   = $::splunk::params::nagios_contacts,
  $nagiosserver      = undef,
  $output_hash       = $::splunk::params::output_hash,
  $port              = $::splunk::params::port,
  $proxyserver       = $::splunk::params::proxyserver,
  $purge             = $::splunk::params::purge,
  $splunkadmin       = $::splunk::params::splunkadmin,
  $target_group      = $::splunk::params::target_group,
  $type              = $::splunk::params::type,
  $package_source    = undef,
  $package_provider  = undef,
  $version           = $::splunk::params::version,
  $replace_passwd    = $::splunk::params::replace_passwd,
) inherits splunk::params {

# Added the preseed hack after getting the idea from very cool
# TransGaming manifest
# at https://github.com/TransGaming/puppet/blob/master/splunk
#
  validate_string($type)
  case $type {
    'uf': {
      $pkgname    = 'splunkforwarder'
      $splunkhome = '/opt/splunkforwarder'
      $license    = undef
    }
    'hfw','lwf': {
      $splunkhome = '/opt/splunk'
      $pkgname    = 'splunk'
      $license    = 'puppet:///modules/splunk/noarch/opt/splunk/etc/splunk-forwarder.license'
    }
    default: {
      $splunkhome = '/opt/splunk'
      $pkgname    = 'splunk'
      $license    = undef
    }
  }


  if ( $purge ) {
    validate_bool($purge)
    class { 'splunk::purge': }

  } else {
    class { 'splunk::install':
      notify => Class['splunk::service'],
      before => Class['splunk::outputs'],
    }
    class { 'splunk::service': }

    case $type {
      'uf': {
        class { 'splunk::outputs': }
        class { 'splunk::config::mgmt_port': }
    }
      'lwf': {
        class { 'splunk::outputs': }
        class { 'splunk::config::lwf': }
        class { 'splunk::config::mgmt_port': }
        class { 'splunk::config::remove_uf': }
      }
      'hwf': {
        fail("Server type: ${type} feature has not yet been implemented")
        #class { 'splunk::outputs': }
        #class { 'splunk::config::lwf': status => 'disabled' }
        #class { 'splunk::config::mgmt_port': }
        #class { 'splunk::config::hwf': }


        #class { 'splunk::app'                 : }
        #class { 'splunk::app::unix'           : }
        #class { 'splunk::app::ta-sos'         : }
        #class { 'splunk::app::collector'      : }
        #class { 'splunk::app::splunkforwarder': }

        # expect should be in the site/module
        #package { 'expect': }
      }
      'search': {
        class { 'splunk::outputs': tcpout_disabled => true }
        class { 'splunk::indexes': }

        class { 'splunk::config::lwf': status => 'disabled' }
        class { 'splunk::config::mgmt_port': disableDefaultPort => 'False' }
        class { 'splunk::config::remove_uf': }

        class { 'splunk::monitor::mgmt_port': }
        class { 'splunk::monitor::input_port': }

        #class { 'splunk::app::config'  : }
      }
      'indexer': {
        class { 'splunk::outputs': tcpout_disabled => true }
        class { 'splunk::indexes': }

        class { 'splunk::config::lwf': status => 'disabled' }
        class { 'splunk::config::mgmt_port': disableDefaultPort => 'False' }
        class { 'splunk::config::remove_uf': }
        class { 'splunk::config::license': server => $licenseserver }

        class { 'splunk::monitor::mgmt_port': }
        class { 'splunk::monitor::input_port': }

        #class { 'splunk::server'     : }
        #class { 'splunk::app'        : }
        #class { 'splunk::app::unix'  : }
        #class { 'splunk::app::index' : }
        #class { 'splunk::app::config': }
        #class { 'splunk::app::ta-sos': }
      }
      default: { fail("Server type: ${type} is not a supported Splunk type.") }
    }
  }
}