From 7bf66755f3bf0ff403221dfe88bd61e16dfc0cb6 Mon Sep 17 00:00:00 2001 From: James Rodewig <40268737+jrodewig@users.noreply.github.com> Date: Thu, 28 Oct 2021 16:45:51 -0400 Subject: [PATCH] [DOCS] ILM: Add ESS/ECE instructions for migrating to node roles (#79742) (#80045) Adds documentation informing the reader about how the Elasticsearch Service / Elastic Cloud Enterprise upgrade process and autoscaling system automate the migration of the Elasticsearch nodes and ILM policies to using node.roles rather than filtering on node attributes. Co-authored-by: debadair Co-authored-by: James Rodewig <40268737+jrodewig@users.noreply.github.com> Co-authored-by: Dan Roscigno Co-authored-by: debadair --- .../migrate-index-allocation-filters.asciidoc | 41 +++++++++++++++++-- 1 file changed, 37 insertions(+), 4 deletions(-) diff --git a/docs/reference/data-management/migrate-index-allocation-filters.asciidoc b/docs/reference/data-management/migrate-index-allocation-filters.asciidoc index 2cd24fd8c4cc5..32e131b79e062 100644 --- a/docs/reference/data-management/migrate-index-allocation-filters.asciidoc +++ b/docs/reference/data-management/migrate-index-allocation-filters.asciidoc @@ -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 <>. + +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: . <> to the appropriate data tier. @@ -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`. @@ -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 @@ -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. @@ -105,7 +138,7 @@ If you're using a custom index template, update it to remove the <>