Skip to content

Latest commit

 

History

History
111 lines (72 loc) · 3.98 KB

README.md

File metadata and controls

111 lines (72 loc) · 3.98 KB
Raw

Opsmatic Puppet Module

Build Status

Overview

This module installs and configures the Opsmatic Puppet Reporter, Opsmatic Agent, and Opsmatic CLI tool.

Requirements

The Opsmatic Puppet Reporter, Opsmatic Agent, and Opsmatic CLI tool are supported on the following platforms:

  • Ubuntu: 10.04, 11.04, 11.10, 12.04, 12.10, 13.04, 13.10 and 14.04.
  • CentOS: 6.x, 7.x.

Usage

To use this module to install Opsmatic Puppet Reporter you will need to set the variable $token in your puppet configuration:

class { 'opsmatic::puppet_reporter':
  token => 'my_integration_token',
}

and make sure to set the report setting in your puppet.conf to true in order to turn on reporting capabilities on agent nodes:

[agent]
    report = true

After that, the manifest will handle the appropriate platform detection and configuration. The Puppet Reporter will run as a daemon waiting for changes performed by Puppet runs, and reporting the results to Opsmatic.

The Puppet Reporter uses the puppet executable command to discover certain configuration values of your infrastructure. If the path of the puppet executable command is not in your $PATH, you will need to set the variable $puppet_bin in your puppet configuration:

class { 'opsmatic::puppet_reporter':
  token => 'my_integration_token',
  puppet_bin => '/usr/bin',
}

To use this module to install the Opsmatic Agent or the Opsmatic CLI tool you will need to set the variable $token in your puppet configuration (Note that you can include additional attributes below):

class { 'opsmatic::agent':
  token => 'my_integration_token',
}

and to install the Opsmatic CLI tool, simply include the following:

class { 'opsmatic::cli':
}

Finally, if you ever want to purge the Opsmatic Puppet Reporter, Opsmatic Agent, and Opsmatic CLI tool from any of your hosts, change the variable $ensure to the following:

class { 'opsmatic::puppet_reporter':
  ensure => 'absent',
}

Attributes

  • $token - this is your integration token.
  • $host_alias - this is the host alias that will override the default hostname.
  • $groups - Array of which group(s) this host is a member of [array of strings]
  • $ensure - ensure the Opsmatic Puppet Reporter, Opsmatic Agent, or Opsmatic CLI tool is installed or not. Give it the value latest to install the latest version available of the package.
  • $filemonitorlist - An array of file-paths to be monitored [array of strings, must be full path of file]

File Monitoring

The Opsmatic Agent has the ability to do file integrity monitoring. You can add a list of these files by passing an array of strings that contain the full file path. To add this to your Puppet runs do the following:

    $filemonitorlist  = ['/etc/nginx/nginx.conf','/etc/ssh/sshd_config','/etc/hosts']

    class { 'opsmatic::agent':
      ...
      filemonitorlist => $filemonitorlist,
      ...
      }

Support

Please create bug reports and feature requests in [GitHub issues] 1. And feel free to contribute:

  1. Fork it ( https://github.com/opsmatic/puppet-opsmatic/fork ).
  2. Create your feature branch (git checkout -b my-new-feature).
  3. Commit your changes (git commit -am 'Add some feature').
  4. Push to the branch (git push origin my-new-feature).
  5. Create a new Pull Request.

Testing

The repo ships with a lint task you can run using bundle exec rake lint

There is also a separate repo at opsmatic/puppet-opsmatic-kitchen which contains a test-kitchen configuration and an ever-growing set of integration tests. Check out that repo alongside this one and use it to verify that you're not breaking anything.

Author:: Opsmatic Inc. ([email protected])