-
-
Notifications
You must be signed in to change notification settings - Fork 299
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.
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
RFC: WIP: Pipeline configuration improvements #380
Open
alexjfisher
wants to merge
1
commit into
voxpupuli:master
Choose a base branch
from
alexjfisher:pipelines
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
define logstash::pipeline | ||
( | ||
Hash $config = {}, | ||
Optional[String] $content = undef, | ||
Optional[String] $source = undef, | ||
Optional[Stdlib::Unixpath] $path = undef, | ||
Optional[String] $id = undef, | ||
) | ||
{ | ||
unless $logstash::pipelines { fail('You must set base class `logstash`\'s `pipeline` parameter to `true` to use this defined type.') } | ||
if $content and $source { fail('You can\'t specify both `content` and `source`') } | ||
|
||
# overwrite keys in $config with values from $path and $id (if they're set). | ||
$real_config = $config + { | ||
'pipeline.id' => $id, | ||
'path.config' => $path, | ||
}.filter |$key, $val| { $val =~ NotUndef } | ||
|
||
unless 'pipeline.id' in $real_config { fail("logstash::pipeline ${title} is missing a pipeline id") } | ||
|
||
$yaml = [$real_config].to_yaml | ||
$yaml_without_header = join($yaml.split("\n")[1,-1],"\n") | ||
|
||
concat::fragment { "logstash pipeline ${title}": | ||
target => '/etc/logstash/pipelines.yml', | ||
content => "${yaml_without_header}\n", | ||
} | ||
|
||
if $content or $source { | ||
if 'path.config' in $real_config { | ||
$real_path = $real_config['path.config'] | ||
} else { | ||
fail('To use logstash::pipeline with `content` or `source`, the `config` hash must contain a `path.config` key or you must specify `path`') | ||
} | ||
logstash::configfile { "Config file for pipeline.id ${real_config['pipeline.id']}": | ||
content => $content, | ||
source => $source, | ||
path => $real_path, | ||
} | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Would it be possible to do this without overloading the
$pipelines
variable? Having a variable that can be either an array or a boolean is a bit odd and it kinda goes against Puppet's continuing march toward type safety.Also, what would happen if I declared an array of pipelines and also added another one as a defined type elsewhere? Can I do that with this implementation?
I think the ideal API would allow:
Ideally, neither of these should require a flag to "turn them on" and they should be able to co-exist. Do you think it's possible?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The good news is that you like the idea of being able to declare pipelines outside of the main class. The tricky bit has been making the implementation backwards compatible and compatible with people not using multiple pipelines. Maybe I will need a separate flag parameter. I'll see how I can make this better. Maybe we could deprecate the old
Array
implementation and support passing a hash oflogstash::pipeline
resources to the main class instead? That's quite a common pattern for being able to create defined types from a module's base class.That does work :)