Skip to content

_tier_preference docs changes for 8.0 #81389

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 6 commits into from
Dec 7, 2021
Merged

_tier_preference docs changes for 8.0 #81389

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
72a9367
We ignore nulls here now
joegallo Dec 6, 2021
78d2d5d
Shard allocation filtering doesn't affect this either
joegallo Dec 6, 2021
4f47879
Drop remaining vestigial _tier documentation
joegallo Dec 6, 2021
0f882e0
We always inject the migrate action
joegallo Dec 6, 2021
49a05b6
Reword slightly
joegallo Dec 6, 2021
f61533c
Mention "enabled": false
joegallo Dec 6, 2021
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
12 changes: 4 additions & 8 deletions docs/reference/datatiers.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,13 +112,8 @@ by default {es} sets
<<tier-preference-allocation-filter, `index.routing.allocation.include._tier_preference`>>
to `data_hot` to automatically allocate the index shards to the hot tier.

You can override the automatic tier-based allocation by specifying
<<shard-allocation-filtering, shard allocation filtering>>
settings in the create index request or index template that matches the new index.

You can also explicitly set `index.routing.allocation.include._tier_preference`
You can explicitly set `index.routing.allocation.include._tier_preference`
to opt out of the default tier-based allocation.
If you set the tier preference to `null`, {es} ignores the data tier roles during allocation.

[discrete]
[[data-tier-migration]]
Expand All @@ -127,5 +122,6 @@ If you set the tier preference to `null`, {es} ignores the data tier roles durin
{ilm-init} automatically transitions managed
indices through the available data tiers using the <<ilm-migrate, migrate>> action.
By default, this action is automatically injected in every phase.
You can explicitly specify the migrate action to override the default behavior,
or use the <<ilm-allocate, allocate action>> to manually specify allocation rules.
You can explicitly specify the migrate action with `"enabled": false` to disable automatic migration,
for example, if you're using the <<ilm-allocate, allocate action>> to manually
specify allocation rules.
11 changes: 5 additions & 6 deletions docs/reference/index-modules/allocation/data_tier_allocation.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,10 @@
[[data-tier-shard-filtering]]
=== Index-level data tier allocation filtering

You can use index-level allocation settings to control which <<data-tiers, data tier>>
the index is allocated to. The data tier allocator is a
<<shard-allocation-filtering, shard allocation filter>> that uses two built-in
node attributes: `_tier` and `_tier_preference`.
You can use the index-level `_tier_preference` setting to control
which <<data-tiers, data tier>> an index is allocated to.

These tier attributes are set using the data node roles:
This setting corresponds to the data node roles:

* <<data-content-node, data_content>>
* <<data-hot-node, data_hot>>
Expand All @@ -16,7 +14,7 @@ These tier attributes are set using the data node roles:
* <<data-frozen-node, data_frozen>>

NOTE: The <<data-node, data>> role is not a valid data tier and cannot be used
for data tier filtering. The frozen tier stores <<partially-mounted,partially
with the `_tier_preference` setting. The frozen tier stores <<partially-mounted,partially
mounted indices>> exclusively.

[discrete]
Expand All @@ -34,3 +32,4 @@ mounted indices>> exclusively.
are nodes with the `data_warm` role. If there are no nodes in the warm tier,
but there are nodes with the `data_hot` role, the index is allocated to
the hot tier.
Used in conjuction with <<data-tier-allocation,data tiers>>.