stdmod / puppet-elasticsearch

Puppet module for ElasticSearch based on stdmod naming standards
Other
0 stars 1 forks source link

parameter naming for config $file* vs. $config* #2

Open DavidS opened 11 years ago

DavidS commented 11 years ago

https://github.com/stdmod/puppet-elasticsearch/blob/master/manifests/init.pp#L46

I'm currently playing around myself with stuff in the stdmod arena and I'm uncomfortable with the $file param group. I'd change that to $config_* and $file to $config_path, to make it clearer what is managed here.

alvagante commented 11 years ago

Uhm, 2 different topics here:

alvagante commented 11 years ago

Also if we introduce config_file , there's some incoherency with the $service and $package parameters, as they don't have a specific prefix for the main resource . Still the point about clearness of the parameter name (config or config_file is more descriptive for sure) need attention.

DavidS commented 11 years ago

I see that I was very unclear in my original message. In my little universe (which may be very biased, I grant) the module manages "the package", "the service" and "the configuration file", which leads to the package service and config_ prefixes. That two of them coincide with the underlying resource type is nice, but not the driving force.

The _path suffix, too, comes from a linguistic argument (coming from a non-native speaker): contrary to $package and $service, $config might be misinterpreted as "the actual configuration (content)", and thus needs a clarification.

Using $configfile as group, instead of $config_ is a nice improvement over adding the _path suffix.