Skip to content

Document removal of freeze index API in migration guide #79801

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.

Sign up for GitHub

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 2 commits into from
Oct 27, 2021
Merged

Document removal of freeze index API in migration guide #79801

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f8f431a
Document removal of freeze index API
danhermann Oct 26, 2021
9fa1341
review comments
danhermann Oct 26, 2021
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
15 changes: 15 additions & 0 deletions docs/reference/migration/migrate_8_0/api.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,21 @@
//Installation and Upgrade Guide

//tag::notable-breaking-changes[]
.The deprecated freeze index API has been removed.
[%collapsible]
====
*Details* +
The freeze index API (`POST /<index>/_freeze`) was deprecated in 7.14 and
removed in 8.0.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The freeze index API (`POST /<index>/_freeze`) was deprecated in 7.14 and
removed in 8.0.
The freeze index API (`POST /<index>/_freeze`) has been removed.

https://www.elastic.co/blog/significantly-decrease-your-elasticsearch-heap-memory-usage[Improvements
in heap memory usage] have eliminated the reason to freeze indices.
Existing frozen indices can still be unfrozen with the
<<unfreeze-index-api,unfreeze index API>>.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For some reason, it doesn't like the reference to <<unfreeze-index-api?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This content is reused in the Stack Install and Upgrade Guide. Internal links, such as <<blah>>, won't work there. You'll need to use {ref}/unfreeze-index-api.html[unfreeze index API] instead.

I'd also reword this sentence slightly:

You can still unfreeze existing frozen indices using the
{ref}/unfreeze-index-api.html[unfreeze index API].

As CJ pointed out in #70192, it'd be good to recommend the frozen data tier as a replacement (if applicable) and provide some steps for migrating formerly frozen indices to the frozen tier.


*Impact* +
Requests made to the old freeze index API will return an error.
====

.The cat node API's `local` query parameter has been removed.
[%collapsible]
====
Expand Down
15 changes: 15 additions & 0 deletions docs/reference/migration/migrate_8_0/indices.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,21 @@ instead for that purpose.
Requests made to the old `_upgrade` API will return an error.
====

.The deprecated freeze index API has been removed.
[%collapsible]
====
*Details* +
The freeze index API (`POST /<index>/_freeze`) was deprecated in 7.14 and
removed in 8.0.
https://www.elastic.co/blog/significantly-decrease-your-elasticsearch-heap-memory-usage[Improvements
in heap memory usage] have eliminated the reason to freeze indices.
Existing frozen indices can still be unfrozen with the
<<unfreeze-index-api,unfreeze index API>>.

*Impact* +
Requests made to the old freeze index API will return an error.
====

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd just add the breaking change to one file. I plan to reorganize this by component in #79162 so it doesn't really matter which file you put it in. If I had to chose, I'd go with indices.asciidoc.

.The force merge API's `max_num_segments` and `only_expunge_deletes` parameters cannot both be specified in the same request.
[%collapsible]
====
Expand Down