Forge Home

Modules

Puppet

Resources

PuppetEcosystemPuppet CommunityUpdates

splunk

Deploy and manage stand-alone or distributed Splunk architectures.
Project URLRSS FeedReport issues

17,005 downloads

211 latest version

4.7 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.

Version information

  • 2.1.9 (latest)
  • 2.1.8
  • 2.1.7
  • 2.1.6
  • 2.1.5
  • 2.1.4
  • 2.1.3
  • 2.1.2
  • 2.1.1
  • 2.1.0
  • 2.0.1
  • 2.0.0
  • 1.9.2
  • 1.9.1
  • 1.9.0
  • 1.8.2
  • 1.8.1
  • 1.8.0
  • 1.7.1
  • 1.7.0
  • 1.6.4
  • 1.6.3
  • 1.6.2
  • 1.6.1
  • 1.6.0
  • 1.5.4
  • 1.5.3
  • 1.5.2
  • 1.5.1
  • 1.4.8
  • 1.4.7
  • 1.4.6 (deleted)
  • 1.4.5
  • 1.4.4
  • 1.4.3
  • 1.4.2
released Oct 5th 2023
This version is compatible with:
  • Puppet Enterprise 2019.8.x, 2019.7.x, 2019.5.x, 2019.4.x, 2019.3.x, 2019.2.x, 2019.1.x, 2019.0.x, 2018.1.x, 2017.3.x, 2017.2.x, 2016.4.x
  • Puppet >= 4.10.0 < 7.0.0
  • , , ,

Start using this module

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

Add this module to your Puppetfile:

mod 'cudgel-splunk', '2.1.9'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add cudgel-splunk
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install cudgel-splunk --version 2.1.9

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

Documentation

cudgel/splunk — version 2.1.9 Oct 5th 2023

Build Status

splunk

Table of Contents

  1. Overview
  2. Module Description
  3. Security
  4. Usage
  5. Testing
  6. Limitations

Overview

This Splunk module supports deploying complex Splunk environments (forwarder, indexer, and search head roles, clustering, etc). By default, it is does not create the user or group, leaving that up to your implementation. It does require the user and group to exist prior to the application being installed. The module does include support for creating the Splunk user/group, but it is intended only for testing the code - not production environments.

It supports running as root or a dedicated account. By default it assumes running as user/group splunk/splunk and will apply Posix ACLs to grant access to log files specified in the hiera hash splunk::inputs.

This module is the descendent of some Puppet code I wrote a long time ago to manage our in-house Splunk intrastructure. I have been using this module to manage a large Splunk infrastructure consising of multiple stand-alone and clustered search heads, multiple single-site and multi-site indexer clusters, management hosts, and hundreds of forwarders (Universal and Heavy). I am not a git expert, so bear with me if I do not follow the best practices in releasing updates to the module.

FS Mounts

The module assumes installation on a single partition. If you set the parameter splunk::use_mounts to true, the module will not install Splunk until "splunk/etc" and "splunk/var" are mounted on the server.

File Source

To save everyone's bandwitdh, you should find another way to serve the Splunk installers and any certificates you want to distribute. The parameter splunk::source can be set to any valid Puppet file resource that contains the expected structure.

For example, given this export in fileserver.conf:

[splunk_files]
  path /etc/puppetlabs/puppet/files/splunk

And this file structure on disk:

splunk
├── auth
│   ├── ixc_splunkd.cert
│   ├── ixsite1_splunkd.cert
│   ├── ixsite2_splunkd.cert
│   ├── srchsite1_splunkd.cert
│   └── web
│       ├── ixc_web.cert
│       ├── ixc_web.key
│       ├── ixsite1_web.cert
│       ├── ixsite1_web.key
│       ├── ixsite2_web.cert
│       ├── ixsite2_web.key
│       ├── srchsite1_web.cert
│       ├── srchsite1_web.key
├── splunkforwarder-7.1.3-51d9cac7b837-Linux-x86_64.tgz
└── splunk-7.1.3-51d9cac7b837-Linux-x86_64.tgz

The source would have the setting splunk::source: 'puppet:///splunk_files' which will compile as using the fileserver for the splunk installer source. A similar setting splunk::cert_source controls where the certs are served from (should they differ). This setting is required if using non-default certs.

Starting with version 1.8.0 the module can install an updated version of GeoLite2-City.mmdb and correct the hash if you specify splunk::geo_source and splunk::geo_hash. I put updated versions in the same Puppet fileserver as the Splunk software.

splunk::geo_source: 'puppet:///splunk_files'
splunk::geo_hash: 'c669f86e6bd1dc4fe14af21b9e79aebfb05c89d29a9ed0e26e648b6b0c94c2a6'

Security

The app can install certificates from a Puppet file server if any of the default cert names are overridden in hiera. If you supply a new cert you must also supply the cert password.

Use hiera-eyaml to protect secrets in your control repo, like the server cert password, e.g. 'password':

splunk::servercertpass: >
    ENC[PKCS7,MIIBeQYJKoZIhvcNAQcDoIIBajCCAWYCAQAxggEhMIIBHQIBADAFMAACAQEw
    DQYJKoZIhvcNAQEBBQAEggEAVty92SXg30srYUJaM6YxF9NWPYC3RnkqKWWt
    08xK5822JhbbqeOCFsz+DJ34EGeJY5UJ7VRCnJjFyWANGl79PsFaCQ/36BkG
    LyWx5BSFRbqP75L6SHm4/bETWre3IN4GCj9rEU08ejqFIayhmGbZ+oPZH8RW
    AvtdesxepNvNgRFjI3sQOAwMo8mGTxokLzQ05mmpi+yVBpre4i3t07Wfh2Od
    SobPPDI/lr8izHYXBmqpyQuPUgPgKr9hN3pRR6BzYCpVvEfpR6T1t0dh6WZG
    zR7ATolZqbAU9tduLYiu3nIZ7X+7j9c2ksCXSaqPX4dDLi3nOpD4CS4f2aF/
    b0n6IzA8BgkqhkiG9w0BBwEwHQYJYIZIAWUDBAEqBBAULtw3VN2+8goqyOMa
    Hn0pgBAKWUW3IYF42XuuivjTfZlN]

Starting with v1.5.0, the app will store only hashed passwords on-disk once it knows them.

ACLs

Since the module defaults to user 'splunk', it includes a defined type 'splunk::acl' that will apply read-only POSIX ACLs for group 'splunk' to any inputs defined using this app. There are optional parameters 'recurse' and 'parents' that will try to apply minimial read-only ACLs to parent paths or contents of a directory if set to true.

Usage

Including the Splunk class:

classes:
  - splunk

Specify a version to install in your hiera. The included defaults are for testing only.

splunk::version: 7.2.3
splunk::release: 06d57c595b80

Typically I would define outputs and cluster sites based on a fact like datacenter, but the examples below show it in a node context.

Authentication

Starting with v1.5.0 the app has tested support for deploying a working LDAP authentication configuration. If you supply the setting splunk::auth_pass in EYAML, the module will hash and use this password instead of the cleartext password in the authconfig setting.

splunk::authentication: 'LDAP'
splunk::authconfig:
  sslenabled: 1
  anonymous_referrals: 1
  charset: 'utf8'
  groupbasedn: 'ou=Groups,dc=example,dc=com;'
  groupmappingattribute: 'dn'
  groupmemberattribute: 'member'
  groupNameAttribute: 'cn'
  label: 'AD'
  type: 'Active Directory'
  host: 'ad.example.com'
  binddn: 'cn=Directory Manager'
  binddnpassword: 'password'
  nestedgroups: 1
  network_timeout: 20
  port: 636
  realnameattribute: 'displayname'
  sizelimit: 1000
  timelimit: 15
  userbasedn: 'ou=People,dc=example,dc=com;'
  userbasefilter: '(|(memberOf=CN=SplunkAdmins,OU=Groups,DC=example,DC=com)(memberOf=CN=SplunkPowerUsers,OU=Groups,DC=example,DC=com)(memberOf=CN=SplunkUsers,OU=Groups,DC=example,DC=com))'
  usernameattribute: 'samaccountname'
  emailattribute: 'userprincipalname'
  role_maps:
    - role: 'admin'
      groups:
        - 'SplunkAdmins'
    - role: 'power'
      groups:
        - 'SplunkPowerUsers'
    - role: 'users'
      groups:
        - 'SplunkUsers'
        - 'Contractors'

Starting with version 1.8.0 the app has tested support for deploying a working SAML authentication configuration. Here is an example minimal configuratio for AzureAD using a generated GUID.

splunk::authconfig:
  fqdn: 'splunk.example.com'
  idpslourl: 'https://login.microsoftonline.com/e0ee69a0-6181-449d-8229-eae7e8fa8eb3/saml2'
  idpssourl: 'https://login.microsoftonline.com/e0ee69a0-6181-449d-8229-eae7e8fa8eb3/saml2'
  issuerid: 'https://sts.windows.net/e0ee69a0-6181-449d-8229-eae7e8fa8eb3/'
  slobinding: 'HTTP-POST'
  ssobinding: 'HTTP-POST'
  role_maps:
    - role: 'admin'
      groups:
         - 'splunk_admins'

Roles

Beginning with v1.5.4, the module will populate authorize.conf with roles defined in hiera.

splunk::roles:
  - name: 'admin'
    disabled: false
    options:
      - 'rtsearch = enabled'
      - 'srchIndexesDefault = *'
      - 'srchMaxTime = 0'
  - name: 'power'
    disabled: false
    options:
      - 'rtsearch = disabled'
      - 'schedule_rtsearch = disabled'
      - 'schedule_search = enabled'
      - 'srchDiskQuota = 5000'

Licenses

The module can manage license pools if you supply the GUIDs for the members.

splunk::license_master_mode: 'master'
splunk::licenses:
  - label: 'auto_generated_pool_enterprise'
    description: 'Non-Indexers'
    quota: 20MB
    stack_id: 'enterprise'
    slaves:
      - '796b94a2-1e35-4902-8e8c-4d3a6f0348bb'
      - 'be7415d7-2b59-4cfc-9b62-dff99c570c64'
      - 'c181c480-1c01-4904-b11b-10c25d8e62cb'
      - 'd5ef522b-a62b-4776-ae06-f4f2e9f59fe7'
      - '47219520-6f02-44d7-b381-084c52c85495'
      - '6b1c447c-5d5b-4445-aeaf-051e7831a0bc'
  - label: 'test_pool'
    description: 'Test Indexer Cluster'
    quota: 5120MB
    stack_id: 'enterprise'
    slaves:
      - '84fb0502-073d-4f0c-a58c-e469c8f26a84'
      - '429a2667-4cb6-4e84-842a-5fd00a484ba7'
      - 'b58d3395-a7dd-4d6c-bada-c6e7524939a6'
  - label: 'prod_pool'
    description: 'Production Indexer Cluster'
    quota: 97360
    stack_id: 'enterprise'
    slaves:
      - '7c972455-537e-4efc-8860-6fd755c1426c'
      - '9eb1ca61-ffa1-4453-b29e-7c8360ed89a0'
      - 'a0e9af28-c6d3-49fa-9c95-6a0f9e70f906'
      - 'f5375728-5885-496a-a83b-81da6260b15b'
      - '1aa025a2-eed0-458f-90b4-e2ce1dc9e10c'
      - '714eacc1-fcd6-4b63-9951-2b6169e19697'

Splunk Server Types

Below are some examples of various Splunk types.

A Splunk Universal forwarder, Puppet manages the outputs

splunk::type: 'forwarder'
splunk::tcpout:
  group: 'site1'
  cname: 'idx-site1.example.com'
  servers:
    - 'idx1.example.com:9998'
    - 'idx2.example.com:9998'
    - 'idx3.example.com:9998'

A Splunk Universal forwarder with deployment server

splunk::type: 'forwarder'
splunk::deployment_server: 'https://ds.example.com:8089'

A Splunk heavy forwarder with deployment server

splunk::type: 'heavyforwarder'
splunk::deployment_server: 'https://ds.example.com:8089'

Indexer cluster master

Deploy the cluster master before any cluster memebers.

splunk::type: 'indexer'
splunk::cluster_mode: 'master'
splunk::clusters:
  - label: 'IDX-MS'
    access_logging: 1
    build_load: 5
    multisite: true
    sites:
      - site1
      - site2
    site_repl_factor: 'origin:2,total:3'
    repl_factor: 3
    search_factor: 'origin:1,total:2'
    uri: 'ixc.example.com:8089'
splunk::server_site: 'site1'
splunk::privkey: 'ixc_web.key'
splunk::servercert: 'ixc_splunkd.cert'
splunk::webcert: 'ixc_web.cert'

Indexer cluster member

splunk::type: 'indexer'
splunk::cluster_mode: 'slave'
splunk::repl_port: 8193
splunk::clusters:
  - label: 'IDX-MS'
    access_logging: 1
    build_load: 5
    multisite: true
    sites:
      - site1
      - site2
    repl_factor: 'origin:2,total:3'
    repl_factor: 3
    search_factor: 'origin:1,total:2'
    uri: 'ixc.example.com:8089'
splunk::server_site: 'site1'
splunk::privkey: 'ixsite1_web.key'
splunk::servercert: 'ixsite1_splunkd.cert'
splunk::webcert: 'ixsite1_web.cert'

Search head with indexer-cluster for search peers

splunk::type: 'search'
splunk::repl_port: 8192
splunk::clusters:
  - label: 'IDX-MS'
    multisite: true
    sites:
      - site1
    uri: 'ixc.example.com:8089'
splunk::server_site: 'site1'
splunk::tcpout:
  group: 'site1'
  cname: 'idx-site1.example.com'
  servers:
    - 'idx1.example.com:9998'
    - 'idx2.example.com:9998'
    - 'idx3.example.com:9998'

Splunk search cluster member, multiple indexer clusters

splunk::type: 'search'
splunk::repl_port: 8192
splunk::shcluster_id: 'dae3f0c5-230a-11e9-9c70-4a0003e77c50'
splunk::shcluster_mode: 'peer'
splunk::shcluster_label: 'SHC'
splunk::clusters:
  - label: 'IDX-MS'
    multisite: true
    sites:
      - site1
    uri: 'ixc.example.com:8089'
  - label: 'IDX-SS'
    multisite: false`
    sites:
      - default
    uri: 'ixc.cloud.example.com:8089'
splunk::privkey: 'srchsite1_web.key'
splunk::servercert: 'srchsite1_splunkd.cert'
splunk::webcert: 'srchsite1_web.cert'

Deploy the search head capitain last and the module will build a working search cluster. The capitain needs special hiera with a list of cluster members.

splunk::is_captain: true
splunk::preferred_captain: true
splunk::shcluster_members:
  - https://splunksh1.example.com:8089
  - https://splunksh2.example.com:8089
  - https://splunksh3.example.com:8089

Inputs

splunk::input(
user       => <string> (Default splunk::user), # user and group will be used in ACLs
group      => <string> (Default splunk::group),
target     => <string> (Optional), # if not given, the title param will be used
inputtype  => <string> [monitor, udp, tcp, tcp-ssl, splunktcp, etc], # valid server.conf input types
sourcetype => <string> (Default 'auto'),
index      => <string> (Default 'default'),
cache      => <boolean> (Default true), # whether to establish a persistent queue for a network input
size       => <int> (Default 1), # size of queue on disk in GB
options    => <array>, # a list of strings containing any other valid inputs.conf parameters for the input type
recurse    => <boolean>, # should the acls applied to the input recurse
content    => <string>, # any custom input definition you would like to use instead of the templated input options
)

RedHat log files

splunk::inputs:
  'messages':
    target: '/var/log/messages'
    index: 'main'
    sourcetype: 'linux_messages_syslog'
  'secure':
    target: '/var/log/secure'
    index: 'main'
    sourcetype: 'linux_secure'
  'maillog':
    target: '/var/log/maillog'
    index: 'main'
    sourcetype: 'syslog'
  'spooler':
    target: '/var/log/spooler'
    index: 'main'
    sourcetype: 'syslog'
  'cron':
    target: '/var/log/cron'
    index: 'main'
    sourcetype: 'syslog'

A network input

splunk::inputs:
  'syslog-ssl':
    target: '5140'
    inputtype: 'tcp-ssl'
    index: 'secure'
    sourcetype: 'syslog'
    cache: true
    size: 6
    options:
      - 'connection_host = dns'
      - 'no_appending_timestamp = true'

Indexes

Starting with version 1.6.0, you can define indexes in Puppet if you are configuring a stand-alone indexer or an S1 architecture. Indexes are defined as a hash in hiera, any valid index settings can be added as an array of strings under options. The settings splunk::cold_path and splunk::warm_path can be used to relocate indexes outside of the Splunk var/lib/splunk directory.

splunk::indexes:
  'main':
    frozen_time: 604800
    options:
      - 'maxDataSize = auto'
      - 'maxWarmDBCount = 10'

The module supports a great number of SmartStore settings and can configure it for a stand-alone server or a cluster.

splunk::s3_access_key: >
    ENC[PKCS7,MIIBeQYJKoZIhvcNAQcDoIIBajCCAWYCAQAxggEhMIIBHQIBADAFMAACAQEw
    DQYJKoZIhvcNAQEBBQAEggEAnVBv1OUPWDbBXaA8T0BIpYuKI7vIIrapLqZ+
    XdbHjBuR+/8ACAPIPChq7uoXXuHVN6bTyqcWFXBRTGTwTM0NbJ7J88xx4fJH
    Ic0ZcwmljPvjMAY2NEqUfLo4YNPHKBrH0TMraae1U4CfddSk7xVjLszL61R/
    udsYjISYylL+xa3VBIjatoQYFU8QmFrkmaUzT1fLgS9e8RZoC6+DtK4q2JLI
    51DFKanwfIZkIjIrDJP3HiwnNFWQmVHmxGeWaZZv/N+awkNGhwAI3OV0oIol
    rysyEUCb9Y1RPPl7kEImgbgYN1Zzm5CVHE12DWMuj6vK9FQKTo1dpuEG9cnn
    FU2ljzA8BgkqhkiG9w0BBwEwHQYJYIZIAWUDBAEqBBCfypAQFgUI0HjTTTyo
    W0+5gBDfFi8OaQp8W7OTMywIJ4Dy]
splunk::s3_secret_key: >
    ENC[PKCS7,MIIBeQYJKoZIhvcNAQcDoIIBajCCAWYCAQAxggEhMIIBHQIBADAFMAACAQEw
    DQYJKoZIhvcNAQEBBQAEggEAnnRCCxywIDPEprc8wx1u9DPE7y1cHadcK7Uh
    igeBV4OTVZcdhaJLA18wFJhl9rS2YwMv/P8n6JYyIYgHuX4U6GZMQk1Lyzos
    OiU7AiIpBydjk7ilO8B/WgCym0npNLYZVN5jP8JDnRJ5T/UyZGwqHZSfbyxH
    GMg3nIVBNzFxEvTONM/YB/tyVDz1/dhwz2B8y5P1YGc+ou9id3BcNWtckHwn
    UiQrDFrPh96FQ5/XPJ89c0rruEGJzua52+Gnv9GYq8r/Qm2LmdnIe09oM699
    Ph4BaP0Yqm8SUE2Q0frbgPGQXh4VVcsSHRBORmlDe33OP87oULvvnzVb3lVJ
    eyp3jzA8BgkqhkiG9w0BBwEwHQYJYIZIAWUDBAEqBBBlXvuusuH2PXC1et3E
    e4WvgBBFuYuh/W5+tlbHQrnW8BYi]

This is the bare minimum configuration to use S3 managed keys.

splunk::remote_path: 's3://my-aws-bucket/splunkidx'
splunk::s3_endpoint: 's3.amazonaws.com'
splunk::s3_encryption: 'sse-s3'

Testing

You can test the module using Vagrant. This repo has the minimum hiera necessary to deploy a deployer, 3 node search head cluster, and 3 node indexer cluster (with master). You can find a working Vagrantfile configuration in the vagrant directory of the Puppet module. You will need a base box with Puppet installed.

Freshly installed cluster from Vagrantfile.

Limitations

The module has only been tested on RHEL and Debian derivatives.

License

Apache 2.0

Contact

If you need help implementing, contact me [ caldwell @ gwu dot edu ]

Support

Please log tickets and issues at the Projects site