Skip to content

Commit 498532a

Browse files
committed
[DOCS] Clarify frozen indices are read-only (elastic#50318)
The freeze index API docs state that frozen indices are blocked for write operations. While this implies frozen indices are read-only, it does not explicitly use the term "read-only", which is found in other docs, such as the force merge docs. This adds the "ready-only" term to the freeze index API docs as well as other clarification.
1 parent ef54a9c commit 498532a

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

docs/reference/indices/apis/freeze.asciidoc

+4-3
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,10 @@ Freezes an index.
1919
[[freeze-index-api-desc]]
2020
==== {api-description-title}
2121

22-
A frozen index has almost no overhead on the cluster (except
23-
for maintaining its metadata in memory), and is blocked for write operations.
24-
See <<frozen-indices>> and <<unfreeze-index-api>>.
22+
A frozen index has almost no overhead on the cluster (except for maintaining its
23+
metadata in memory) and is read-only. Read-only indices are blocked for write
24+
operations, such as <<indexing,docs-index_>> or <<indices-forcemerge,force
25+
merges>>. See <<frozen-indices>> and <<unfreeze-index-api>>.
2526

2627
IMPORTANT: Freezing an index will close the index and reopen it within the same
2728
API call. This causes primaries to not be allocated for a short amount of time

0 commit comments

Comments
 (0)