Skip to content
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.

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

[DOCS] ILM: Add ESS/ECE instructions for migrating to node roles #79742

Merged
merged 21 commits into from
Oct 28, 2021
Merged
Changes from all commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
ebf2c02
Add note about automated migration for ESS and ECE
DanRoscigno Oct 21, 2021
9e455fd
add note about custom index templates in ESS/ECE
DanRoscigno Oct 25, 2021
bc95a3c
use asciidoc attributes
DanRoscigno Oct 25, 2021
ebb1bcd
Update docs/reference/data-management/migrate-index-allocation-filter…
DanRoscigno Oct 26, 2021
5dcf808
Update docs/reference/data-management/migrate-index-allocation-filter…
DanRoscigno Oct 26, 2021
57b7936
Update docs/reference/data-management/migrate-index-allocation-filter…
DanRoscigno Oct 26, 2021
3de3bd3
Update docs/reference/data-management/migrate-index-allocation-filter…
DanRoscigno Oct 26, 2021
811e1b3
Update docs/reference/data-management/migrate-index-allocation-filter…
DanRoscigno Oct 26, 2021
464c353
Update docs/reference/data-management/migrate-index-allocation-filter…
DanRoscigno Oct 26, 2021
549f661
remove redundant sentence
DanRoscigno Oct 26, 2021
8ef0938
incorporate feedback from dev
DanRoscigno Oct 26, 2021
2c2f867
reduce section levels
DanRoscigno Oct 27, 2021
a05e28f
spelling
DanRoscigno Oct 28, 2021
57de58b
Update docs/reference/data-management/migrate-index-allocation-filter…
DanRoscigno Oct 28, 2021
0087619
Update docs/reference/data-management/migrate-index-allocation-filter…
DanRoscigno Oct 28, 2021
9c8a272
wrap
DanRoscigno Oct 28, 2021
caf8c2c
wrap
DanRoscigno Oct 28, 2021
12d2bd3
migrating > migrate
DanRoscigno Oct 28, 2021
9363691
Update docs/reference/data-management/migrate-index-allocation-filter…
DanRoscigno Oct 28, 2021
978fd11
clearer wording
DanRoscigno Oct 28, 2021
8a65cb0
add anchor
DanRoscigno Oct 28, 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
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,39 @@ your data in a hot-warm-cold architecture,
you can still use attribute-based allocation filters to
control shard allocation for other purposes.

{ess} and {ece} can perform the migration automatically. For self-managed
deployments, you need to manually update your configuration, ILM policies, and
indices to switch to node roles.

[discrete]
[[cloud-migrate-to-node-roles]]
=== Automatically migrate to node roles on {ess} or {ece}

If you are using node attributes on {ess} or {ece}, you will be
prompted to switch to node roles when you:

* Upgrade to {es} 7.10 or higher
* Deploy a warm, cold, or frozen data tier
* {cloud}/ec-autoscaling.html[Enable autoscaling]

These actions automatically update your cluster configuration
and {ilm-init} policies to use node roles. Additionally, upgrading to
version 7.14 or higher automatically update {ilm-init} policies
whenever any configuration change is applied to your deployment.


If you use custom index templates, check them after the automatic migration
completes and remove any <<shard-allocation-filtering, attribute-based
allocation filters>>.

NOTE: You do not need to take any further action after the automatic migration.
The following manual steps are only necessary if you do not allow the automatic
migration or have a self-managed deployment.

[discrete]
[[on-prem-migrate-to-node-roles]]
=== Migrate to node roles on self-managed deployments

To switch to using node roles:

. <<assign-data-tier, Assign data nodes>> to the appropriate data tier.
Expand All @@ -28,7 +61,7 @@ on new indices.

[discrete]
[[assign-data-tier]]
=== Assign data nodes to a data tier
==== Assign data nodes to a data tier

Configure the appropriate roles for each data node to assign it to one or more
data tiers: `data_hot`, `data_content`, `data_warm`, `data_cold`, or `data_frozen`.
Expand Down Expand Up @@ -66,7 +99,7 @@ node.roles [ data_hot, data_content ]

[discrete]
[[remove-custom-allocation-settings]]
=== Remove custom allocation settings from existing {ilm-init} policies
==== Remove custom allocation settings from existing {ilm-init} policies

Update the allocate action for each lifecycle phase to remove the attribute-based
allocation settings. {ilm-init} will inject a
Expand All @@ -85,7 +118,7 @@ your policy must include the hot, warm, and cold phases.

[discrete]
[[stop-setting-custom-hot-attribute]]
=== Stop setting the custom hot attribute on new indices
==== Stop setting the custom hot attribute on new indices

When you create a data stream, its first backing index
is now automatically assigned to `data_hot` nodes.
Expand All @@ -105,7 +138,7 @@ If you're using a custom index template, update it to remove the <<shard-allocat

[discrete]
[[set-tier-preference]]
=== Set a tier preference for existing indices.
==== Set a tier preference for existing indices.

{ilm-init} automatically transitions managed indices through the available
data tiers by automatically injecting a <<ilm-migrate,migrate action>>
Expand Down