Skip to content

logstash: config,patternfile respect $::logstash::ensure #411

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

logstash: config,patternfile respect $::logstash::ensure #411

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c289d28
logstash: config,patternfile respect `$::logstash::ensure`
damonbreeden May 6, 2022
0782872
Merge branch 'voxpupuli:master' into master
damonbreeden Jan 6, 2023
b6b4b63
logstash: configfile: document `ensure` param, fix lint, constrain it…
damonbreeden Jan 6, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions manifests/configfile.pp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@
# @author https://github.com/elastic/puppet-logstash/graphs/contributors
#
define logstash::configfile (
$ensure = $::logstash::ensure,
Copy link
Member

@smortex smortex Jan 3, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you think this parameter is required, please add some documentation above:

# @param ensure
#   ...

But AFAIAC, i think we do not need this extra parameter and we can directly use logstash::ensure. In this case, this line can be removed, and the two bellow changes are required:

Copy link
Author

@damonbreeden damonbreeden Jan 6, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i think that more granularity (with proper default values) is always better
in this case, we had a configfile that was placed by this module, then later i wanted to remove it so i made these changes and specifically called absent

could i have accomplished the same with a file resource? yes ofc! but we place the files in /etc/logstash/conf.d with logstash::configfile so we should be able to remove them the same way

alternatively (or probably?) we could/should manage the entire /etc/logstash/conf.d directory (with purge => true so that no files are leftover

$content = undef,
$source = undef,
$template = undef,
Expand All @@ -64,6 +65,7 @@

if($config) {
file { $config_file:
ensure => $ensure,
Copy link
Member

@smortex smortex Jan 3, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
ensure => $ensure,
ensure => $logstash::ensure,

Copy link
Member

@bastelfreak bastelfreak Jan 7, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

if there's a $ensure parameter, we should also use it?

content => $config,
owner => $owner,
group => $group,
Expand All @@ -74,6 +76,7 @@
}
elsif($source) {
file { $config_file:
ensure => $ensure,
Copy link
Member

@smortex smortex Jan 3, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
ensure => $ensure,
ensure => $logstash::ensure,

source => $source,
owner => $owner,
group => $group,
Expand Down
3 changes: 2 additions & 1 deletion manifests/patternfile.pp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
# @author https://github.com/elastic/puppet-logstash/graphs/contributors
#
define logstash::patternfile (
$ensure = $::logstash::ensure,
Copy link
Member

@smortex smortex Jan 3, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same, either we need to document this…

Pattern[/^(puppet|file):\/\//] $source = undef,
Optional[String[1]] $filename = undef,
) {
Expand All @@ -28,7 +29,7 @@
$destination = pick($filename, basename($source))

file { "${logstash::config_dir}/patterns/${destination}":
ensure => file,
ensure => $ensure,
Copy link
Member

@smortex smortex Jan 3, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

…otherwise:

Suggested change
ensure => $ensure,
ensure => $logstash::ensure,

source => $source,
owner => 'root',
group => $logstash::logstash_group,
Expand Down