puppet-graylogcollectorsidecar's Introduction

dodevops/graylogcollectorsidecar

Description
Setup
- Beginning with graylogcollectorsidecar
Reference
Limitations

Description

This module installs and configures the Graylog collector sidecar.

Setup

Beginning with graylogcollectorsidecar

To install the graylog collector sidecar, simply configure the class:

class { 'graylogcollectorsidecar':
  api_url => 'http://graylog.example.com:9000/api',
  version => '0.1.0',
  tags => [ 'apache.accesslog' ]
}

Or using hiera:

graylogcollectorsidecar::api_url: "http://graylog.example.com:9000/api"
graylogcollectorsidecar::version: "0.1.0"
graylogcollectorsidecar::tags:
    - apache.accesslog

Reference

class `graylogcollectorsidecar`

Parameter	Description
version	Select the version of the collector to install. Defaults to 'latest', which selects the latest available release version
api_url	Graylog server api url (e.g. http://graylog.example.com:9000/api)
tags	An array of tags that the collector should be set up with

Additionally, all other parameters as noted in the collector sidecar documentation can be specified.

The node_id will be set to the local hostname, if not specified.

Limitations

This module uses the githubreleases module to download the graylog distribution package from Github. However, Github imposes a rate limiting on unauthenticated requests, which the module does (currently, this module doesn't allow setting Github credentials).

So if you have a rather large deployment using this module, the rate limit might fail the deployment. If so, you'll have to wait for the Rate limit to be reset.

If this is a constant pain, please open an issue.

OS compatibility: