/sumo-collector-chef-cookbook

Chef Recipe to install Sumo Logic Collector

Primary LanguageRuby

sumologic-collector Cookbook

This cookbook will install either the 32-bit and 64-bit Sumo Logic Linux collector using the shell script installer (based on the CPU type). It first sets up the files required for an unattended install (sumo.conf and the JSON configuration file) with the standard linux system log files, downloads the latest installer, and then runs the installer. If the requirements are met, then the collector will automatically install and activate itself. The JSON template can be edited for your environment's specifications.

Requirements

Most importantly, you need access to the following URL on each server:

This will allow for activation and downloading the installer.

For additional requirements, see this URL:

Attributes

['sumologic']['useAccessID'] Boolean Indicates whether you will use AccessID-Key or Email-Password for authentication Required
['sumologic']['userID'] String Sumo Logic User ID Optional
['sumologic']['password'] String Sumo Logic Password Optional
['sumologic']['accessID'] String Sumo Logic Access ID Optional
['sumologic']['accessKey'] String Sumo Logic Access Key Optional
['sumologic']['ephemeral'] Boolean Sumo Logic Ephemeral Setting Required
['sumologic']['sources']['default_timezone'] String Timezone for source setup (defaults to UTC) Required
['sumologic']['installDir'] String Sumo Logic Install Directory Required

The following attributes are not required but can be used to define custom cookbooks and templates within a wrapper cookbook for generating custom sumo.conf and sumo.json configuration files.

['sumologic']['json_config_cookbook'] Default: sumologic-collector String User defined cookbook for generating custom sumo.json templates Not Required
['sumologic']['json_template'] String User defined sumo.json template name Not Required
['sumologic']['conf_config_cookbook'] Default: sumologic-collector String User defined cookbook for generating custom sumo.conf templates Not Required
['sumologic']['conf_template'] String User defined sumo.conf template name Not Required

The following attributes are not required but can be used to define an encrypted data bag containing the authentication credentials. The data bag that this points to should have 'email' and 'password' keys containing the email address and password to use to authenticate this collector.

['sumologic']['credentials']['bag_name'] String Name of the data bag. Required
['sumologic']['credentials']['item_name'] String Name of the item within the data bag. Required
['sumologic']['credentials']['secret_file'] String Path to the local file containing the encryption secret key. Optional

Usage

Just include sumologic-collector in your node's run_list:

{
  "name":"my_node",
  "run_list": [
    "recipe[sumologic-collector]"
  ]
}

Contributing

This cookbook is meant to help customers use chef to install Sumo Logic collectors, so please feel to fork this repository, and make whatever changes you need for your environment.

License and Authors

Authors: Ben Newton (ben@sumologic.com)