Make most configuration options available

SumoLogic / sumologic-collector-puppet-module

Puppet module for installing Sumo Logic's collector.

Other

11 stars 22 forks source link

Make most configuration options available #16

Closed mcasper closed 8 years ago

mcasper commented 8 years ago

This PR does a few things:

Make most of the collector configuration options outlined in http://help.sumologic.com/Send_Data/Installed_Collectors/sumo.conf available.
Add unit tests around most of the module.
Flesh out the README to include a valid usage example, and document all available parameters.
Require that users pass either an accessid and accesskey, or an email and password. Otherwise, because we give no hooks into the installation command, the collector will never be able to connect to the user's SumoLogic account.

mcasper commented 8 years ago

Because CI isn't set up yet, here are the results of running specs:

 - MATTCASPER.local code/work/sumo-collector-puppet-module (fix_collector_setup) $ bundle exec rake spec
/Users/mattcasper/.rbenv/versions/2.2.2/bin/ruby -I/Users/mattcasper/.rbenv/versions/2.2.2/lib/ruby/gems/2.2.0/gems/rspec-core-3.4.1/lib:/Users/mattcasper/.rbenv/versions/2.2.2/lib/ruby/gems/2.2.0/gems/rspec-support-3.4.1/lib /Users/mattcasper/.rbenv/versions/2.2.2/lib/ruby/gems/2.2.0/gems/rspec-core-3.4.1/exe/rspec --pattern spec/\{classes,defines,unit,functions,hosts,integration,types\}/\*\*/\*_spec.rb --color
........................

Finished in 3.6 seconds (files took 0.98402 seconds to load)
24 examples, 0 failures

/cc @duchatran

duchatran commented 8 years ago

you are fast @mcasper ! :). Just curious, why sumo::nix_config and sumo::win_config do not inherit from class sumo (inside manifest/init)?

mcasper commented 8 years ago

Because they don't really need to. They're never declared on their own, always through the base class, which ensures that the base class with get evaluated first, and we're always accessing parameters through their fully qualified name, so we don't need to ensure that the base class is the parent class of the *_config classes.

Plus, we already do the only necessary inheritance in init.pp when it inherits sumo::params, so there's no need for the second inheritance.

For anyone not familiar with the particulars of inheritence in Puppet: https://docs.puppetlabs.com/puppet/latest/reference/lang_classes.html#inheritance

duchatran commented 8 years ago

Thanks @mcasper. LGTM.

mcasper commented 8 years ago

Thanks @duchatran! Are there any plans to publish this module to Puppet Forge?