Document removal of freeze index API in migration guide #79801
Conversation
danhermann
added
>docs
elasticmachine
added
Team:Data Management
|
Pinging @elastic/es-data-management (Team:Data Management) |
|
Pinging @elastic/es-docs (Team:Docs) |
danhermann
changed the title
| 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>>. |
There was a problem hiding this comment.
For some reason, it doesn't like the reference to <<unfreeze-index-api?
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
Thanks @danhermann! I left some small comments and suggestions.
| .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. | ||
| ==== | ||
|
|
There was a problem hiding this comment.
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 freeze index API (`POST /<index>/_freeze`) was deprecated in 7.14 and | ||
| removed in 8.0. |
There was a problem hiding this comment.
| 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>>. |
There was a problem hiding this comment.
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.
|
Thanks, @jrodewig. I made those changes. I thought it would be good to link to the data tiers documentation from the recommendation to consider the frozen tier in place of frozen indices, but I wasn't able to find an asciidoc file that corresponds to those docs. |
There was a problem hiding this comment.
LGTM. Thanks @danhermann.
I thought it would be good to link to the data tiers documentation from the recommendation to consider the frozen tier in place of frozen indices, but I wasn't able to find an asciidoc file that corresponds to those docs.
I can work with the docs team to get some better migration docs around this pending the discussion in #70192.
|
Thanks, @jrodewig! |
Relates to #70192 and #78918