Skip to content

Document that disabling stack templates is not recommended #120963

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Jan 27, 2025
Merged

Document that disabling stack templates is not recommended #120963

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 2 additions & 1 deletion docs/reference/indices/index-templates.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,8 @@ applying the templates, do one or more of the following:

- To disable all built-in index and component templates, set
<<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.

Expand Down
8 changes: 7 additions & 1 deletion docs/reference/modules/indices/index_management.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down Expand Up @@ -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`.
Defaults to `full`.
Loading