Skip to content

[7.x] [DOCS] Remove and redirect frozen index overview content (#72990) #73001

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 12, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
110 changes: 0 additions & 110 deletions docs/reference/frozen-indices.asciidoc

This file was deleted.

15 changes: 0 additions & 15 deletions docs/reference/glossary.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -155,21 +155,6 @@ Manually triggers a <<glossary-merge,merge>> to reduce the number of
See the {ref}/indices-forcemerge.html[force merge API].
// end::force-merge-def[]

[[glossary-freeze]] freeze::
// tag::freeze-def[]
// tag::freeze-def-short[]
Makes an index read-only and minimizes its memory footprint.
// end::freeze-def-short[]
See the {ref}/freeze-index-api.html[freeze API].
// end::freeze-def[]

[[glossary-frozen-index]] frozen index::
// tag::frozen-index-def[]
An <<glossary-index,index>> reduced to a low overhead state that still enables
occasional searches.
See the {ref}/freeze-index-api.html[freeze API].
// end::frozen-index-def[]

[[glossary-frozen-phase]] frozen phase::
// tag::frozen-phase-def[]
Fourth possible phase in the <<glossary-index-lifecycle,index lifecycle>>. In
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/ilm/actions/ilm-freeze.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

Phases allowed: cold.

<<frozen-indices, Freezes>> an index to minimize its memory footprint.
<<freeze-index-api, Freezes>> an index.

IMPORTANT: Freezing an index closes the index and reopens it within the same API call.
This means that for a short time no primaries are allocated.
Expand Down
3 changes: 1 addition & 2 deletions docs/reference/ilm/ilm-overview.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,7 @@ include::../glossary.asciidoc[tag=rollover-def-short]
include::../glossary.asciidoc[tag=shrink-def-short]
* **Force merge**:
include::../glossary.asciidoc[tag=force-merge-def-short]
* **Freeze**:
include::../glossary.asciidoc[tag=freeze-def-short]
* **Freeze**: <<freeze-index-api, Freezes>> an index and makes it read-only.
* **Delete**: Permanently remove an index, including all of its data and metadata.

{ilm-init} makes it easier to manage indices in hot-warm-cold architectures,
Expand Down
2 changes: 0 additions & 2 deletions docs/reference/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,6 @@ include::autoscaling/index.asciidoc[]

include::monitoring/index.asciidoc[]

include::frozen-indices.asciidoc[]

include::data-rollup-transform.asciidoc[]

include::high-availability.asciidoc[]
Expand Down
4 changes: 3 additions & 1 deletion docs/reference/indices/apis/freeze.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@
<titleabbrev>Freeze index</titleabbrev>
++++

// tag::freeze-api-dep[]
deprecated::[7.14, Frozen indices are no longer useful due to https://www.elastic.co/blog/significantly-decrease-your-elasticsearch-heap-memory-usage[recent improvements in heap memory usage].]
// end::freeze-api-dep[]

Freezes an index.

Expand All @@ -27,7 +29,7 @@ Freezes an index.
A frozen index has almost no overhead on the cluster (except for maintaining its
metadata in memory) and is read-only. Read-only indices are blocked for write
operations, such as <<indexing,docs-index_>> or <<indices-forcemerge,force
merges>>. See <<frozen-indices>> and <<unfreeze-index-api>>.
merges>>. See <<unfreeze-index-api>>.

The current write index on a data stream cannot be frozen. In order to freeze
the current write index, the data stream must first be
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/indices/apis/unfreeze.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Unfreezes an index.
==== {api-description-title}

When a frozen index is unfrozen, the index goes through the normal recovery
process and becomes writeable again. See <<frozen-indices>> and <<freeze-index-api>>.
process and becomes writeable again. See <<freeze-index-api>>.

IMPORTANT: Freezing an index will close the index and reopen it within the same
API call. This causes primaries to not be allocated for a short amount of time
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/indices/index-mgmt.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Open {kib}'s main menu and click *Stack Management > Index Management*.
image::images/index-mgmt/management_index_labels.png[Index Management UI]

The *Index Management* page contains an overview of your indices.
Badges indicate if an index is <<frozen-indices,frozen>>, a
Badges indicate if an index is <<freeze-index-api,frozen>>, a
<<ccr-put-follow,follower index>>, or a
<<rollup-get-rollup-index-caps,rollup index>>.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ PUT my-index-000001/_mapping
------------
// TEST[continued]

IMPORTANT: On a <<frozen-indices,frozen index>>, global ordinals are discarded
IMPORTANT: On a <<freeze-index-api,frozen index>>, global ordinals are discarded
after each search and rebuilt again when they're requested. This means that
`eager_global_ordinals` should not be used on frozen indices: it would
cause global ordinals to be reloaded on every search. Instead, the index should
Expand Down
24 changes: 24 additions & 0 deletions docs/reference/redirects.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -1536,3 +1536,27 @@ See <<getting-started>>.
=== Settng JVM options

See <<set-jvm-options>>.

[role="exclude",id="frozen-indices"]
=== Frozen indices

// tag::frozen-index-redirect[]
include::{es-repo-dir}/indices/apis/freeze.asciidoc[tag=freeze-api-dep]

For API documentation, see <<freeze-index-api>> and <<unfreeze-index-api>>.
// end::frozen-index-redirect[]

[role="exclude",id="best_practices"]
=== Best practices for frozen indices

include::redirects.asciidoc[tag=frozen-index-redirect]

[role="exclude",id="searching_a_frozen_index"]
=== Searching a frozen index

include::redirects.asciidoc[tag=frozen-index-redirect]

[role="exclude",id="monitoring_frozen_indices"]
=== Monitoring frozen indices

include::redirects.asciidoc[tag=frozen-index-redirect]
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

{es} generally allows you to quickly search across big amounts of data. There are
situations where a search executes on many shards, possibly against
<<frozen-indices,frozen indices>> and spanning multiple
<<freeze-index-api,frozen indices>> and spanning multiple
<<modules-remote-clusters,remote clusters>>, for which
results are not expected to be returned in milliseconds. When you need to
execute long-running searches, synchronously
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -221,7 +221,7 @@ _synchronous_ by default. The search request waits for complete results before
returning a response.

However, complete results can take longer for searches across
<<frozen-indices,frozen indices>> or <<modules-cross-cluster-search,multiple
<<freeze-index-api,frozen indices>> or <<modules-cross-cluster-search,multiple
clusters>>.

To avoid long waits, you can run an _asynchronous_, or _async_, search
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/sql/endpoints/jdbc.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ will be - typically the first in natural ascending order) for fields with multip

[discrete]
==== Index
`index.include.frozen` (default `false`):: Whether to include <<frozen-indices, frozen-indices>> in the query execution or not (default).
`index.include.frozen` (default `false`):: Whether to include <<freeze-index-api, frozen-indices>> in the query execution or not (default).

[discrete]
==== Additional
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/sql/endpoints/rest.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -612,7 +612,7 @@ More information available https://docs.oracle.com/javase/8/docs/api/java/time/Z

|index_include_frozen
|false
|Whether to include <<frozen-indices, frozen-indices>> in the query execution or not (default).
|Whether to include <<freeze-index-api, frozen-indices>> in the query execution or not (default).

|params
|none
Expand Down
8 changes: 2 additions & 6 deletions docs/reference/sql/language/indices.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -88,12 +88,8 @@ requires the keyword `LIKE` for SQL `LIKE` pattern.
[[sql-index-frozen]]
=== Frozen Indices

{es} <<frozen-indices, frozen indices>> are a useful and powerful tool for hot/warm architecture introduced in {es} 6.6,
essentially by trading speed for memory.
{es-sql} supports frozen indices and similar to {es}, due to their performance characteristics, allows searches on them only
when explicitly told so by user - in other words, by default, frozen indices are not included in searches.

One can toggle the use of frozen indices through:
By default, {es-sql} doesn't search <<freeze-index-api,frozen indices>>. To
search frozen indices, use one of the following features:

dedicated configuration parameter::
Set to `true` properties `index_include_frozen` in the <<sql-rest>> or `index.include.frozen` in the drivers to include frozen indices.
Expand Down