Skip to content

Commit

Permalink
[DOCS] Add deprecation docs for `xpack.searchable.snapshot.shared_cac…
Browse files Browse the repository at this point in the history
…he.size` (#77727)

We deprecated the `xpack.searchable.snapshot.shared_cache.size` setting on
non-frozen nodes in 7.12 with PR #70341. However, we didn't add a related item
to the 7.12 deprecation docs. This adds the missing item.

Relates to #71013.
  • Loading branch information
jrodewig authored Sep 15, 2021
1 parent a246cc9 commit 787465c
Showing 1 changed file with 24 additions and 2 deletions.
26 changes: 24 additions & 2 deletions docs/reference/migration/migrate_7_12.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ See also <<release-highlights>> and <<es-release-notes>>.
* <<breaking_712_engine_changes>>
* <<breaking_712_search_changes>>
* <<breaking_712_ssl_changes>>
* <<breaking_712_settings_deprecations>>

//NOTE: The notable-breaking-changes tagged regions are re-used in the
//Installation and Upgrade Guide
Expand Down Expand Up @@ -87,8 +88,8 @@ For instructions on how to enable these older TLS versions in your {es} cluster,
see {ref}/jdk-tls-versions.html#jdk-enable-tls-protocol[Enabling additional
SSL/TLS versions on your JDK].
====
//end::notable-breaking-changes[]

////
[discrete]
[[deprecated-7.11]]
=== Deprecations
Expand All @@ -104,4 +105,25 @@ the old behavior is supported until the next major release.
To find out if you are using any deprecated functionality,
enable <<deprecation-logging, deprecation logging>>.

////
//tag::notable-breaking-changes[]
[discrete]
[[breaking_712_settings_deprecations]]
==== Settings deprecations

[[deprecate-searchable_snapshot_shared_cache_size]]
.Setting `xpack.searchable.snapshot.shared_cache.size` on non-frozen nodes is deprecated.
[%collapsible]
====
*Details* +
Setting `xpack.searchable.snapshot.shared_cache.size` to a positive value on a
node without the `data_frozen` role is now deprecated.
The `xpack.searchable.snapshot.shared_cache.size` node setting reserves space
for a shared cache used by partially mounted {search-snap} indices. {es} only
allocates partially mounted indices to nodes with the `data_frozen` role.
*Impact* +
To avoid deprecation warnings, discontinue use of the setting on non-frozen
nodes.
====
//end::notable-breaking-changes[]

0 comments on commit 787465c

Please sign in to comment.