Build config files with Go text/template#18148
Merged
andrewkroh merged 4 commits intoelastic:masterfrom May 4, 2020
Merged
Conversation
0befef4 to
1321ab8
Compare
Contributor
💔 Build Failed
Expand to view the summary
Build stats
Test stats 🧪
Test errorsExpand to view the tests failures
--------------------- >> end captured stdout << ---------------------- Steps errorsExpand to view the steps failures
Log outputExpand to view the last 100 lines of log output
|
1321ab8 to
e1227d0
Compare
Contributor
|
Pinging @elastic/siem (Team:SIEM) |
cf7876e to
d433aa7
Compare
6 tasks
Rather than relying on file concatenation followed by Go text/template we'll just
use Go text/template. This makes is easier to customize a template without having
to modify libbeat since you can just overwrite a template section (like inject your own
processors section).
This works by loading all of the templates from `libbeat/_meta/config/*.tmpl` followed
by templates from `$mybeat/_meta/config/*.tmpl`. Files loaded last take precedence
(it uses go text/template ParseGlob). Finally each template is created from
`libbeat/_meta/config/default{., reference, docker}.yml.tmpl` (which can be changed
if needed, see elastic/agent).
d433aa7 to
af7be22
Compare
kvch
approved these changes
May 4, 2020
Contributor
kvch
left a comment
There was a problem hiding this comment.
Great timing! :D I wanted to add similar functionality to add information about the advanced settings of modules in Filebeat to the reference and modules configuration.
…ols/config-go-text-template # Conflicts: # libbeat/_meta/config.yml.tmpl # winlogbeat/_meta/beat.yml.tmpl # winlogbeat/_meta/config/header.yml.tmpl # winlogbeat/scripts/mage/config.go # winlogbeat/winlogbeat.reference.yml # winlogbeat/winlogbeat.yml # x-pack/winlogbeat/_meta/config/winlogbeat.event_logs.yml.tmpl # x-pack/winlogbeat/winlogbeat.yml
…ols/config-go-text-template # Conflicts: # libbeat/_meta/config.reference.yml.tmpl
…ols/config-go-text-template
5 tasks
andrewkroh
added a commit
to andrewkroh/beats
that referenced
this pull request
May 4, 2020
Rather than relying on file concatenation followed by Go text/template we'll just
use Go text/template. This makes is easier to customize a template without having
to modify libbeat since you can just overwrite a template section (like inject your own
processors section).
This works by loading all of the templates from `libbeat/_meta/config/*.tmpl` followed
by templates from `$mybeat/_meta/config/*.tmpl`. Files loaded last take precedence
(it uses go text/template ParseGlob). Finally each template is created from
`libbeat/_meta/config/default{., reference, docker}.yml.tmpl` (which can be changed
if needed, see elastic/agent).
(cherry picked from commit c81adcc)
andrewkroh
added a commit
that referenced
this pull request
May 5, 2020
…18212) Rather than relying on file concatenation followed by Go text/template we'll just use Go text/template. This makes is easier to customize a template without having to modify libbeat since you can just overwrite a template section (like inject your own processors section). This works by loading all of the templates from `libbeat/_meta/config/*.tmpl` followed by templates from `$mybeat/_meta/config/*.tmpl`. Files loaded last take precedence (it uses go text/template ParseGlob). Finally each template is created from `libbeat/_meta/config/default{., reference, docker}.yml.tmpl` (which can be changed if needed, see elastic/agent). (cherry picked from commit c81adcc)
6 tasks
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
What does this PR do?
Rather than relying on file concatenation followed by Go text/template we'll just
use Go text/template. This makes is easier to customize a template without having
to modify libbeat since you can just overwrite a template section (like inject your own
processors section).
This works by loading all of the templates from
libbeat/_meta/config/*.tmplfollowedby templates from
$mybeat/_meta/config/*.tmpl. Files loaded last take precedence(it uses go text/template ParseGlob). Finally each template is created from
libbeat/_meta/config/default{., reference, docker}.yml.tmpl(which can be changedif needed, see elastic-agent as an example).
Why is it important?
I need to customize the default processors in the Winlogbeat configuration file and I don't want to add some special logic to the libbeat config files (see an example in https://github.com/elastic/beats/pull/18153/files#diff-5a4f08fe070667029d82636401b2aaf9R95). So with this change a Beat can more easily tailor the config to its needs.
Checklist
- [x] I have made corresponding changes to the documentation- [ ] I have added tests that prove my fix is effective or that my feature worksCHANGELOG.next.asciidocorCHANGELOG-developer.next.asciidoc.Author's Checklist
How to test this PR locally
make updateDeveloper Docs
Any magefile.go that used
devtools.ConfigFileParamsmust switch to usingdevtools.DefaultConfigFileParams(). The append their config file template glob to the list ofTemplates. Conventionally this is_meta/config/*.tmpl.