Skip to content

Commit

Permalink
[docs] Clarify how ILM affects template setup options (elastic#16704) (
Browse files Browse the repository at this point in the history
…elastic#16910)

Co-authored-by: chrousto <christophe.chazeau@gmail.com>

Co-authored-by: chrousto <christophe.chazeau@gmail.com>
  • Loading branch information
dedemorton and chrousto authored Mar 10, 2020
1 parent e39494d commit eeddacf
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 1 deletion.
4 changes: 3 additions & 1 deletion libbeat/docs/shared-ilm.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
== Configure index lifecycle management

Use the {ref}/getting-started-index-lifecycle-management.html[index lifecycle
management] feature in {es} to manage your {beatname_uc} indices as they age.
management] (ILM) feature in {es} to manage your {beatname_uc} indices as they age.
For example, instead of creating daily indices where index size can vary based
on the number of Beats and number of events sent, use an index lifecycle policy
to automate a rollover to a new index when the existing index reaches a
Expand All @@ -30,6 +30,8 @@ setup.ilm.pattern: "{now/d}-000001" <1>
{ref}/indices-rollover-index.html#_using_date_math_with_the_rollover_api[Using
date math with the rollover API].

WARNING: If <<ilm,index lifecycle management>> is enabled (which is typically the default), `setup.template.name` and `setup.template.pattern` are ignored.

[float]
=== Configuration options

Expand Down
2 changes: 2 additions & 0 deletions libbeat/docs/shared-template-load.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,8 @@ output.elasticsearch.index: "customname-%{[{beat_version_key}]}-%{+yyyy.MM.dd}"
setup.template.name: "customname"
setup.template.pattern: "customname-*"
-----
WARNING: If <<ilm,index lifecycle management>> is enabled (which is typically the default), `setup.template.name` and `setup.template.pattern` are ignored.

ifndef::no_dashboards[]
+
If you're using pre-built Kibana dashboards, also set the
Expand Down

0 comments on commit eeddacf

Please sign in to comment.