Skip to content

Commit 3ef6283

Browse files
PeteGillinElasticmartijnvg
authored andcommitted
Remove unfreeze REST endpoint (elastic#119227)
This adds a sentence to `redirects.asciidoc` explaining what frozen indices were - otherwise, everything will point to the message about the unfreeze API having gone away, which is not very helpful. Some cross-references are updated to point to this rather than to the notice about the removal of the unfreeze API. ES-9736 #comment Removed `_unfreeze` REST endpoint in elastic#119227
1 parent 29d3e1a commit 3ef6283

File tree

9 files changed

+27
-232
lines changed

9 files changed

+27
-232
lines changed

docs/changelog/119227.yaml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
pr: 119227
2+
summary: Remove unfreeze REST endpoint
3+
area: Indices APIs
4+
type: breaking
5+
issues: []
6+
breaking:
7+
title: Remove unfreeze REST endpoint
8+
area: REST API
9+
details: >-
10+
The `/{index}/_unfreeze` REST endpoint is no longer supported. This API was deprecated, and the corresponding
11+
`/{index}/_freeze` endpoint was removed in 8.0.
12+
impact: None, since it is not possible to have a frozen index in a version which is readable by Elasticsearch 9.0
13+
notable: false

docs/reference/indices.asciidoc

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,6 @@ index settings, aliases, mappings, and index templates.
2424
* <<indices-split-index>>
2525
* <<indices-clone-index>>
2626
* <<indices-rollover-index>>
27-
* <<unfreeze-index-api>>
2827
* <<indices-resolve-index-api>>
2928
* <<indices-resolve-cluster-api>>
3029
* <<indices-downsample-data-stream>>
@@ -143,6 +142,5 @@ include::indices/shrink-index.asciidoc[]
143142
include::indices/simulate-index.asciidoc[]
144143
include::indices/simulate-template.asciidoc[]
145144
include::indices/split-index.asciidoc[]
146-
include::indices/apis/unfreeze.asciidoc[]
147145
include::indices/update-settings.asciidoc[]
148146
include::indices/put-mapping.asciidoc[]

docs/reference/indices/apis/unfreeze.asciidoc

Lines changed: 0 additions & 61 deletions
This file was deleted.

docs/reference/indices/index-mgmt.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ For more information on managing indices, refer to <<indices, Index APIs>>.
4343

4444
* To filter the list of indices, use the search bar or click a badge.
4545
Badges indicate if an index is a <<ccr-put-follow,follower index>>, a
46-
<<rollup-get-rollup-index-caps,rollup index>>, or <<unfreeze-index-api,frozen>>.
46+
<<rollup-get-rollup-index-caps,rollup index>>, or <<frozen-indices,frozen>>.
4747

4848
* To drill down into the index
4949
<<mapping,mappings>>, <<index-modules-settings,settings>>, and statistics,

docs/reference/redirects.asciidoc

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -156,10 +156,16 @@ See <<restore-entire-cluster>>.
156156
The freeze index API was removed in 8.0.
157157
// tag::frozen-removal-explanation[]
158158
Frozen indices are no longer useful due to
159-
https://www.elastic.co/blog/significantly-decrease-your-elasticsearch-heap-memory-usage[recent
160-
improvements in heap memory usage].
159+
https://www.elastic.co/blog/significantly-decrease-your-elasticsearch-heap-memory-usage[improvements
160+
in heap memory usage].
161161
// end::frozen-removal-explanation[]
162162

163+
[role="exclude",id="unfreeze-index-api"]
164+
=== Unfreeze index API
165+
166+
The unfreeze index API was removed in 9.0.
167+
include::redirects.asciidoc[tag=frozen-removal-explanation]
168+
163169
[role="exclude",id="ilm-freeze"]
164170
=== Freeze {ilm-init} action
165171

@@ -1749,8 +1755,10 @@ See <<search-terms-enum>>.
17491755
=== Frozen indices
17501756

17511757
// tag::frozen-index-redirect[]
1752-
1753-
For API documentation, see <<unfreeze-index-api>>.
1758+
Older versions of {es} provided the option to reduce the amount of data kept in memory for an index, at the expense of
1759+
increasing search latency. This was known as 'freezing' the index.
1760+
include::redirects.asciidoc[tag=frozen-removal-explanation]
1761+
The freeze index API was removed in 8.0, and the unfreeze index API was removed in 9.0.
17541762
// end::frozen-index-redirect[]
17551763

17561764
[role="exclude",id="best_practices"]

docs/reference/sql/language/indices.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ requires the keyword `LIKE` for SQL `LIKE` pattern.
100100
[[sql-index-frozen]]
101101
=== Frozen Indices
102102

103-
By default, {es-sql} doesn't search <<unfreeze-index-api,frozen indices>>. To
103+
By default, {es-sql} doesn't search <<frozen-indices,frozen indices>>. To
104104
search frozen indices, use one of the following features:
105105

106106
dedicated configuration parameter::

rest-api-spec/src/main/resources/rest-api-spec/api/indices.unfreeze.json

Lines changed: 0 additions & 67 deletions
This file was deleted.

x-pack/plugin/frozen-indices/src/main/java/org/elasticsearch/xpack/frozen/FrozenIndices.java

Lines changed: 0 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -8,36 +8,22 @@
88

99
import org.elasticsearch.action.ActionRequest;
1010
import org.elasticsearch.action.ActionResponse;
11-
import org.elasticsearch.cluster.metadata.IndexNameExpressionResolver;
12-
import org.elasticsearch.cluster.node.DiscoveryNodes;
13-
import org.elasticsearch.common.io.stream.NamedWriteableRegistry;
14-
import org.elasticsearch.common.settings.ClusterSettings;
15-
import org.elasticsearch.common.settings.IndexScopedSettings;
1611
import org.elasticsearch.common.settings.Setting;
17-
import org.elasticsearch.common.settings.Settings;
18-
import org.elasticsearch.common.settings.SettingsFilter;
19-
import org.elasticsearch.features.NodeFeature;
2012
import org.elasticsearch.index.IndexSettings;
2113
import org.elasticsearch.index.engine.EngineFactory;
2214
import org.elasticsearch.index.engine.frozen.FrozenEngine;
2315
import org.elasticsearch.plugins.ActionPlugin;
2416
import org.elasticsearch.plugins.EnginePlugin;
2517
import org.elasticsearch.plugins.Plugin;
26-
import org.elasticsearch.rest.RestController;
27-
import org.elasticsearch.rest.RestHandler;
2818
import org.elasticsearch.xpack.core.action.XPackInfoFeatureAction;
2919
import org.elasticsearch.xpack.core.action.XPackUsageFeatureAction;
3020
import org.elasticsearch.xpack.core.frozen.action.FreezeIndexAction;
3121
import org.elasticsearch.xpack.frozen.action.TransportFreezeIndexAction;
32-
import org.elasticsearch.xpack.frozen.rest.action.RestFreezeIndexAction;
3322

3423
import java.util.ArrayList;
3524
import java.util.Arrays;
36-
import java.util.Collections;
3725
import java.util.List;
3826
import java.util.Optional;
39-
import java.util.function.Predicate;
40-
import java.util.function.Supplier;
4127

4228
public class FrozenIndices extends Plugin implements ActionPlugin, EnginePlugin {
4329

@@ -63,19 +49,4 @@ public List<Setting<?>> getSettings() {
6349
actions.add(new ActionHandler<>(FreezeIndexAction.INSTANCE, TransportFreezeIndexAction.class));
6450
return actions;
6551
}
66-
67-
@Override
68-
public List<RestHandler> getRestHandlers(
69-
Settings settings,
70-
NamedWriteableRegistry namedWriteableRegistry,
71-
RestController restController,
72-
ClusterSettings clusterSettings,
73-
IndexScopedSettings indexScopedSettings,
74-
SettingsFilter settingsFilter,
75-
IndexNameExpressionResolver indexNameExpressionResolver,
76-
Supplier<DiscoveryNodes> nodesInCluster,
77-
Predicate<NodeFeature> clusterSupportsFeature
78-
) {
79-
return Collections.singletonList(new RestFreezeIndexAction());
80-
}
8152
}

x-pack/plugin/frozen-indices/src/main/java/org/elasticsearch/xpack/frozen/rest/action/RestFreezeIndexAction.java

Lines changed: 0 additions & 67 deletions
This file was deleted.

0 commit comments

Comments
 (0)