github-mirrors/elasticsearch
1
0
Fork 0
mirror of https://github.com/elastic/elasticsearch.git synced 2025-04-25 07:37:19 -04:00
Code Issues Projects Releases Packages Wiki Activity

Document that disabling stack templates is not recommended (#120963) (#120967)

Browse source 
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.
This commit is contained in:
Lee Hinman 2025-01-27 15:44:13 -07:00 • committed by GitHub
parent 43d4b60b7f
commit b2e62f0d31
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 9 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

3
docs/reference/indices/index-templates.asciidoc
View file

@ -57,7 +57,8 @@ applying the templates, do one or more of the following:
- To disable all built-in index and component templates, set - To disable all built-in index and component templates, set
<<stack-templates-enabled,`stack.templates.enabled`>> to `false` using the <<stack-templates-enabled,`stack.templates.enabled`>> to `false` using the
<<cluster-update-settings,cluster update settings API>>. <<cluster-update-settings,cluster update settings API>>. Note, however, that this is not
recommended, see the <<stack-templates-enabled,setting documentation>> for more information.
- Use a non-overlapping index pattern. - Use a non-overlapping index pattern.

6
docs/reference/modules/indices/index_management.asciidoc
View file

@ -37,6 +37,12 @@ If `true`, enables built-in index and component templates.
streams. If `false`, {es} disables these index and component templates. Defaults streams. If `false`, {es} disables these index and component templates. Defaults
to `true`. to `true`.
NOTE: It is not recommended to disable the built-in stack templates, as some functionality of {es}
or Kibana will not work correctly when disabled. Features like log and metric collection, as well as
Kibana reporting, may malfunction without the built-in stack templates. Stack templates should only
be disabled temporarily, if necessary, to resolve upgrade issues, then re-enabled after any issues
have been resolved.
This setting affects the following built-in index templates: This setting affects the following built-in index templates:
include::{es-ref-dir}/indices/index-templates.asciidoc[tag=built-in-index-template-patterns] include::{es-ref-dir}/indices/index-templates.asciidoc[tag=built-in-index-template-patterns]