Skip to content

Commit 4bc487d

Browse files
lucabellucciniyaauie
authored andcommitted
Adding details for template installation
Clarify Template file is not monitored. Clarify when the Template is installed and what conditions apply.
1 parent c93abd1 commit 4bc487d

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

docs/index.asciidoc

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -707,6 +707,9 @@ https://www.cs.utexas.edu/~shmat/shmat_ccs12.pdf
707707
You can set the path to your own template here, if you so desire.
708708
If not set, the included template will be used.
709709

710+
Note that Logstash will not monitor the template file for changes.
711+
The template file will be read when its installation is triggered.
712+
710713
[id="plugins-{type}s-{plugin}-template_name"]
711714
===== `template_name`
712715

@@ -736,7 +739,11 @@ you wanted to be able to update it regularly, this option could help there as we
736739

737740
Please note that if you are using your own customized version of the Logstash
738741
template (logstash), setting this to true will make Logstash to overwrite
739-
the "logstash" template (i.e. removing all customized settings)
742+
the "logstash" template (i.e. removing all customized settings).
743+
744+
The template installation check is triggered at pipeline startup (or reload) but
745+
will be actually installed if template_overwrite is set to true or if the
746+
template doesn't exist on the Elasticsearch cluster.
740747

741748
[id="plugins-{type}s-{plugin}-timeout"]
742749
===== `timeout`

0 commit comments

Comments
 (0)