Skip to content

Commit eb47a8f

Browse files
authored
[DOCS] Add deprecation docs for xpack.searchable.snapshot.shared_cache.size (#77727) (#77765)
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. # Conflicts: # docs/reference/migration/migrate_7_12.asciidoc
1 parent 5c25cbd commit eb47a8f

File tree

1 file changed

+24
-3
lines changed

1 file changed

+24
-3
lines changed

docs/reference/migration/migrate_7_12.asciidoc

Lines changed: 24 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ See also <<release-highlights>> and <<es-release-notes>>.
1212
* <<breaking_712_engine_changes>>
1313
* <<breaking_712_search_changes>>
1414
* <<breaking_712_ssl_changes>>
15+
* <<breaking_712_settings_deprecations>>
1516

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

91-
////
9293
[discrete]
9394
[[deprecated-7.11]]
9495
=== Deprecations
@@ -104,5 +105,25 @@ the old behavior is supported until the next major release.
104105
To find out if you are using any deprecated functionality,
105106
enable <<deprecation-logging, deprecation logging>>.
106107

107-
////
108-
//end::notable-breaking-changes[]
108+
//tag::notable-breaking-changes[]
109+
[discrete]
110+
[[breaking_712_settings_deprecations]]
111+
==== Settings deprecations
112+
113+
[[deprecate-searchable_snapshot_shared_cache_size]]
114+
.Setting `xpack.searchable.snapshot.shared_cache.size` on non-frozen nodes is deprecated.
115+
[%collapsible]
116+
====
117+
*Details* +
118+
Setting `xpack.searchable.snapshot.shared_cache.size` to a positive value on a
119+
node without the `data_frozen` role is now deprecated.
120+
121+
The `xpack.searchable.snapshot.shared_cache.size` node setting reserves space
122+
for a shared cache used by partially mounted {search-snap} indices. {es} only
123+
allocates partially mounted indices to nodes with the `data_frozen` role.
124+
125+
*Impact* +
126+
To avoid deprecation warnings, discontinue use of the setting on non-frozen
127+
nodes.
128+
====
129+
//end::notable-breaking-changes[]

0 commit comments

Comments
 (0)