Skip to content

Commit

Permalink
[DOCS] Add deprecation docs for `cluster.routing.allocation.disk.incl…
Browse files Browse the repository at this point in the history
…ude_relocations` (#77726) (#77940)

We deprecated the `cluster.routing.allocation.disk.include_relocations` setting in 7.5 with PR #47443.
However, we didn't add a related item to the 7.5 deprecation docs. This adds
the missing item.

Relates to #47717.
  • Loading branch information
jrodewig authored Sep 16, 2021
1 parent ea8bbd1 commit 3ed1b11
Showing 1 changed file with 23 additions and 1 deletion.
24 changes: 23 additions & 1 deletion docs/reference/migration/migrate_7_5.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,32 @@ your application to Elasticsearch 7.5.

See also <<release-highlights>> and <<es-release-notes>>.

* <<breaking_75_allocation_deprecations>>
* <<breaking_75_search_changes>>

//NOTE: The notable-breaking-changes tagged regions are re-used in the
//Installation and Upgrade Guide

//tag::notable-breaking-changes[]

//end::notable-breaking-changes[]
[discrete]
[[breaking_75_allocation_deprecations]]
=== Allocation deprecations

[discrete]
[[deprecate-cluster-routing-allocation-disk-include-relocations-setting]]
==== The `cluster.routing.allocation.disk.include_relocations` setting is deprecated.

The `cluster.routing.allocation.disk.include_relocations` cluster setting is now
deprecated. In future versions, {es} will account for the sizes of relocating
shards when making allocation decisions based on the disk usage of nodes in the
cluster.

Currently, you can set `cluster.routing.allocation.disk.include_relocations` to
`false` to disable this accounting. This can result in poor allocation decisions
that might overshoot watermarks and require significant work to correct.

To avoid deprecation warnings, discontinue use of the setting.

[discrete]
[[breaking_75_search_changes]]
Expand All @@ -26,3 +46,5 @@ Previously, a wildcard query on the `_index` field matched directly against the
fully-qualified index name. Now, in order to match against remote indices like
`cluster:index`, the query must contain a colon, as in `cl*ster:inde*`. This
behavior aligns with the way indices are matched in the search endpoint.

//end::notable-breaking-changes[]

0 comments on commit 3ed1b11

Please sign in to comment.