Skip to content

Commit 8b1f376

Browse files
authored
Document that disabling stack templates is not recommended (#120963) (#120968)
There are many features of the Elasticsearch ecosystem that may malfunction, or fail to work entirely, if these templates are not installed. This commit adds documentation cautioning against disabling the installation of templates.
1 parent 8c39fff commit 8b1f376

File tree

2 files changed

+9
-2
lines changed

2 files changed

+9
-2
lines changed

docs/reference/indices/index-templates.asciidoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,8 @@ applying the templates, do one or more of the following:
5757
5858
- To disable all built-in index and component templates, set
5959
<<stack-templates-enabled,`stack.templates.enabled`>> to `false` using the
60-
<<cluster-update-settings,cluster update settings API>>.
60+
<<cluster-update-settings,cluster update settings API>>. Note, however, that this is not
61+
recommended, see the <<stack-templates-enabled,setting documentation>> for more information.
6162
6263
- Use a non-overlapping index pattern.
6364

docs/reference/modules/indices/index_management.asciidoc

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,12 @@ If `true`, enables built-in index and component templates.
3737
streams. If `false`, {es} disables these index and component templates. Defaults
3838
to `true`.
3939

40+
NOTE: It is not recommended to disable the built-in stack templates, as some functionality of {es}
41+
or Kibana will not work correctly when disabled. Features like log and metric collection, as well as
42+
Kibana reporting, may malfunction without the built-in stack templates. Stack templates should only
43+
be disabled temporarily, if necessary, to resolve upgrade issues, then re-enabled after any issues
44+
have been resolved.
45+
4046
This setting affects the following built-in index templates:
4147

4248
include::{es-ref-dir}/indices/index-templates.asciidoc[tag=built-in-index-template-patterns]
@@ -142,4 +148,4 @@ and certificate forgery.
142148
One of `full` (verify the hostname and the certificate path), `certificate`
143149
(verify the certificate path, but not the hostname) or `none` (perform no
144150
verification - this is strongly discouraged in production environments).
145-
Defaults to `full`.
151+
Defaults to `full`.

0 commit comments

Comments
 (0)