From 0a6be5195782e14e16944a0b0cd69e6fcb5bc05b Mon Sep 17 00:00:00 2001 From: Lee Hinman Date: Mon, 27 Jan 2025 14:51:11 -0700 Subject: [PATCH] Document that disabling stack templates is not recommended 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. --- docs/reference/indices/index-templates.asciidoc | 3 ++- docs/reference/modules/indices/index_management.asciidoc | 8 +++++++- 2 files changed, 9 insertions(+), 2 deletions(-) diff --git a/docs/reference/indices/index-templates.asciidoc b/docs/reference/indices/index-templates.asciidoc index b13921d263f71..ed6a8e89040f2 100644 --- a/docs/reference/indices/index-templates.asciidoc +++ b/docs/reference/indices/index-templates.asciidoc @@ -58,7 +58,8 @@ applying the templates, do one or more of the following: - To disable all built-in index and component templates, set <> to `false` using the -<>. +<>. Note, however, that this is not +recommended, see the <> for more information. - Use a non-overlapping index pattern. diff --git a/docs/reference/modules/indices/index_management.asciidoc b/docs/reference/modules/indices/index_management.asciidoc index 7aea86bd5ac76..bc5b0b76a3776 100644 --- a/docs/reference/modules/indices/index_management.asciidoc +++ b/docs/reference/modules/indices/index_management.asciidoc @@ -37,6 +37,12 @@ If `true`, enables built-in index and component templates. streams. If `false`, {es} disables these index and component templates. Defaults 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: include::{es-ref-dir}/indices/index-templates.asciidoc[tag=built-in-index-template-patterns] @@ -142,4 +148,4 @@ and certificate forgery. One of `full` (verify the hostname and the certificate path), `certificate` (verify the certificate path, but not the hostname) or `none` (perform no verification - this is strongly discouraged in production environments). -Defaults to `full`. \ No newline at end of file +Defaults to `full`.