Skip to content
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

[DOC] Adding details for template installation #867

Closed
Closed
Changes from all commits
Commits
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
9 changes: 8 additions & 1 deletion docs/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -701,6 +701,9 @@ https://www.cs.utexas.edu/~shmat/shmat_ccs12.pdf
You can set the path to your own template here, if you so desire.
If not set, the included template will be used.

Note that Logstash will not monitor the template file for changes.
The template file will be read when its installation is triggered.

[id="plugins-{type}s-{plugin}-template_name"]
===== `template_name`

Expand Down Expand Up @@ -730,7 +733,11 @@ you wanted to be able to update it regularly, this option could help there as we

Please note that if you are using your own customized version of the Logstash
template (logstash), setting this to true will make Logstash to overwrite
the "logstash" template (i.e. removing all customized settings)
the "logstash" template (i.e. removing all customized settings).

The template installation check is triggered at pipeline startup (or reload) but
will be actually installed if template_overwrite is set to true or if the
template doesn't exist on the Elasticsearch cluster.

[id="plugins-{type}s-{plugin}-timeout"]
===== `timeout`
Expand Down