sumo-collector-puppet-module

Sumo Puppet Module Overview

• The Sumo Puppet module downloads the sumo logic collector agent from the Internet and installs the Sumo Collector agent. The module needs to download the package from the Sumologic API's so Internet access is required on your machines.
• The module also allows sources to be created during installation and updated afterwards.
• Currently, the module only supports the installation of latest collector version.
• Upgrade of the collector is not supported currently.

Note:

For Puppet 4.x and later:

• Utilize the release v0.2.1 or later. Release v0.2.1 and subsequent v0.2.x releases will be enhanced per puppet guidelines to support latest puppet versions.

For Puppet 3.x:

• Utilize the release v1.0.6 if you need sumo.conf compatibility.
• Utilize the release v1.0.8 if you need latest SumoLogic collector compatibility.

Setup

To begin using this module, use the Puppet Module Tool (PMT) from the command line to install this module:

puppet module install sumologic-sumo

To install Sumo Puppet Module from GitHub, follow below steps:

• Navigate to Puppet global modules directory or specific environment modules directory.
• Clone the Sumo Puppet module.
• Rename the module as sumo.

Usage

Once the Sumo puppet module is installed, you will need to supply the sumo class with the authentication information.

• The accessid.
• The accesskey.

OR

• One-time token for installation.

Additional optional parameters can be passed as required. The parameters details are explained in the next section.

Examples

A basic example, using accesskey/accessid, module expects the sources.json to be present on agent nodes in the default directory:

class { 'sumo':
  accessid       => 'accessid',
  accesskey      => 'accesskey',
}

Another example, using accesskey/accessid and manage_sources as true, the module will copy the sources.json on agent nodes in the default directory:

class { 'sumo':
  accessid       => 'accessid',
  accesskey      => 'accesskey',
  manage_sources => true,
}

Note: manage_sources will be deprecated in future releases, use sources_override instead.

Below example illustrates setting up local configuration management. In this case the syncsources.json file will be used for describing Sources to configure on registration, which will be continuously monitored and synchronized with the Collector's configuration. In this case the module expects the syncsources.json to be present on agent nodes in the default directory:

class { 'sumo':
  accessid              => 'accessid',
  accesskey             => 'accesskey',
  local_config_mgmt     => true,
}

Below example illustrates local configuration management with the syncsources.json being managed by the puppet master i.e. the module will copy the syncsources.json on agent nodes in the default directory:

class { 'sumo':
  accessid              => 'accessid',
  accesskey             => 'accesskey',
  local_config_mgmt     => true,
  sync_sources_override => true,
}

All the above examples illustrate setting up the sources using a single JSON file (sources.json/syncsources.json) present under the default directory. To specify sources in multiple JSON files, specify the parameter sources_directory_or_file as 'dir'. If specified as 'dir', the collector will look for any JSON files present under the default directory:

class { 'sumo':
  accessid                  => 'accessid',
  accesskey                 => 'accesskey',
  sources_directory_or_file => 'dir',
}

With local configuration management:

class { 'sumo':
  accessid                  => 'accessid',
  accesskey                 => 'accesskey',
  local_config_mgmt         => true,
  sources_directory_or_file => 'dir',
}

Advanced example illustrating passing additional command-line parameters and using rpm or deb package for installation:

class { 'sumo':
  accessid                => 'accessid',
  accesskey               => 'accesskey',
  sync_sources_override   => true,
  use_package             => true,
  local_config_mgmt       => true,
  clobber                 => false, 
  ephemeral               => true,
  skip_access_key_removal => true,
}

Advanced example illustrating tarball binary package for installation:

class { 'sumo':
  accessid                => 'accessid',
  accesskey               => 'accesskey',
  sync_sources_override   => true,
  use_package             => false,
  use_tar_pkg             => true,
  local_config_mgmt       => true,
  clobber                 => false, 
  ephemeral               => true,
  skip_access_key_removal => true,
}

Parameters

This module supports all the command-line options except dir [directory] listed in SumoLogic's documentation. Head there for a full explanation of what each option does to the SumoLogic collector.

The only required parameters are a pair of authentication parameters: accessid and accesskey.

Testing / Contributing

See CONTRIBUTING.md.

CHANGELOG for sumo-collector-puppet-module

This file is used to list changes made in each version of sumologic-collector.

0.2.3:

April 20, 2020 Merged PR40: Added Litmus Acceptance Tests.

0.2.3:

April 20, 2020 Merged PR39: Fixed Skip Registration Logic.

0.2.1:

August 28, 2018 Merged PR33: Added Vagrant Beaker test configurations.

0.2.0:

August 27, 2018 Merged PR32: Upgraded the module to support latest sumo collector.

0.1.5:

Apr 04, 2016: Merged PR17: Fixed an issue with installing collector on Windows

0.1.4:

Mar 26, 2016: Merged PR14 and PR15: Add some first tests and metadata.json

0.1.3:

Mar 24, 2016: Merged PR13: Unnest module so it will work with Librarian Puppet

0.1.2:

Mar 24, 2016: Merged PR12.

0.1.1:

Feb 29, 2016:

• Make paths for sumo.conf and sumo.json configurable

0.1.0:

• Initial release of sumologic-collector. Use template for sumo.conf