Browse Source

[DOCS] Document `indices.lifecycle.poll_interval` ILM cluster setting (#45744)

James Rodewig 6 years ago
parent
commit
b97d87afdf

+ 5 - 2
docs/reference/ilm/policy-definitions.asciidoc

@@ -66,8 +66,11 @@ index is rolled over, then `min_age` is the time elapsed from the time the index
 is rolled over. The intention here is to execute following phases and actions
 is rolled over. The intention here is to execute following phases and actions
 relative to when data was written last to a rolled over index.
 relative to when data was written last to a rolled over index.
 
 
-The previous phase's actions must complete before {ilm} will check `min_age`
-and transition into the next phase.
+The previous phase's actions must complete before {ilm} will check `min_age` and
+transition into the next phase. By default, {ilm} checks for indices that meet
+policy criteria, like `min_age`, every 10 minutes. You can use the
+`indices.lifecycle.poll_interval` cluster setting to control how often this
+check occurs.
 
 
 === Phase Execution
 === Phase Execution
 
 

+ 4 - 0
docs/reference/settings/ilm-settings.asciidoc

@@ -13,3 +13,7 @@ The index alias to update when the index rolls over. Specify when using a
 policy that contains a rollover action. When the index rolls over, the alias is
 policy that contains a rollover action. When the index rolls over, the alias is
 updated to reflect that the index is no longer the write index. For more
 updated to reflect that the index is no longer the write index. For more
 information about rollover, see <<using-policies-rollover>>.
 information about rollover, see <<using-policies-rollover>>.
+
+`indices.lifecycle.poll_interval`::
+(<<time-units, time units>>) How often {ilm} checks for indices that meet policy
+criteria. Defaults to `10m`.