splunkuf

Table of Contents

1. Overview
2. Module Description - What the module does and why it is useful
3. Setup - The basics of getting started with splunkuf
   • What splunkuf affects
   • Setup requirements
   • Beginning with splunkuf
4. Usage - Configuration options and additional functionality
5. Reference - An under-the-hood peek at what the module is doing and how
6. Limitations - OS compatibility, etc.
7. Development - Guide for contributing to the module

Overview

The SplunkUF module manages the Splunk Universal forwarder on RedHat, Debian, and Ubuntu.

Module Description

This module installs the Splunk Universal forwarder only and will configure it to talk to a deployment server. Supported OS's include RedHat, Debian, and Ubuntu.

For a more full featured Splunk install or module look at huit/splunk

Setup

What splunkuf affects

• /etc/init.d/splunkforwarder
• /opt/splunkforwarder

Setup Requirements

Have access to a yum repository or debian repository with splunkforwarder from Splunk

Beginning with splunkuf

The only mode this module has is to install a Universal Forwarder If you need a fully featured Splunk install huit/splunk

Usage

To use the universal forwarder set the targeturi parameter of the deployment server to communicate with

class { 'splunkuf':
  targeturi => 'deployment.tld:8089',
}

Optional: To change the default management communication port use the mgmthostport parameter

class { 'splunkuf':
  targeturi    => 'deployment.tld:8089',
  mgmthostport => 'managementhost.tld:9089',
}

Optional: To change the default system user (splunk) running the universal forwarder binary

class { 'splunkuf':
  targeturi    => 'deployment.tld:8089',
  system_user  => 'root',
}

Optional: To specify a client name

class { 'splunkuf':
  targeturi    => 'deployment.tld:8089',
  clientname   => "${::hostname}-role",
}

Reference

Here, list the classes, types, providers, facts, etc contained in your module. This section should include all of the under-the-hood workings of your module so people know what the module is touching on their system but don't need to mess with things. (We are working on automating this section!)

Limitations

RHEL/CentOS 7

RHEL/CentOS 7 is fully supported and functional

Debian/Ubuntu

Currently under testing

Development

Since your module is awesome, other users will want to play with it. Let them know what the ground rules for contributing are.

Release Notes/Contributors/Etc

v0.4.2

• Contributions from Natale Vinto for service_user parameter for non root installs
• Disabled some older Travis tests due to json gem breaking on 1.9 ruby

v0.4.1

• Contributions from LightAxe to fix module usage on other RHEL based OS types.
• Cleanup in Gemfile and gitignore

v0.4.0

• Contributions from Ryan Sabatini to override the management service port

v0.3.6

• Credit fixed

v0.3.5

• Fixes from Ryan Sabatini for systemd

v0.3.4

• Typo and general spelling stuff, 100% code coverage for RHEL6/7

v0.3.3

• Metadata work to improve code quality

v0.3.2

• Reworked the deployment info into a file to do things correctly

v0.3.1

• Silly default line endings in Windows

v0.3.0

• Working Ubuntu/Debian code

v0.2.0

• Working CentOS/RHEL7 code

v0.1.1

• Cleaned up readme

v0.1.0

• Initial work