Forge Home

Modules

Puppet

Resources

PuppetEcosystemPuppet CommunityUpdates

splunkuf

Splunk Universal Forwarder Install
Project URLRSS FeedReport issues

16,048 downloads

7,526 latest version

4.6 quality score

We run a couple of automated
scans to help you access a
module's quality. Each module is
given a score based on how well
the author has formatted their
code and documentation and
modules are also checked for
malware using VirusTotal.

Please note, the information below
is for guidance only and neither of
these methods should be considered
an endorsement by Puppet.

Support the Puppet Community by contributing to this module

You are welcome to contribute to this module by suggesting new features, currency updates, or fixes. Every contribution is valuable to help ensure that the module remains compatible with the latest Puppet versions and continues to meet community needs. Complete the following steps:

  1. Review the module’s contribution guidelines and any licenses. Ensure that your planned contribution aligns with the author’s standards and any legal requirements.
  2. Fork the repository on GitHub, make changes on a branch of your fork, and submit a pull request. The pull request must clearly document your proposed change.

For questions about updating the module, contact the module’s author.

Version information

  • 0.4.2 (latest)
  • 0.4.1
  • 0.4.0
  • 0.3.6
  • 0.3.5 (deleted)
  • 0.3.4
  • 0.3.3
  • 0.3.2
  • 0.3.1
  • 0.3.0
  • 0.2.0
  • 0.1.1
  • 0.1.0
released Dec 16th 2016
This version is compatible with:
  • , ,

Start using this module

  • r10k or Code Manager
  • Bolt
  • Manual installation
  • Direct download

Add this module to your Puppetfile:

mod 'paulbadcock-splunkuf', '0.4.2'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add paulbadcock-splunkuf
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install paulbadcock-splunkuf --version 0.4.2

Direct download is not typically how you would use a Puppet module to manage your infrastructure, but you may want to download the module in order to inspect the code.

Download
Tags: splunk, universalforwarder

Documentation

paulbadcock/splunkuf — version 0.4.2 Dec 16th 2016

splunkuf Build Status Coverage Status

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
  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',
}

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

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