Skip to content

Commit

Permalink
[DOCS] Clarify frozen indices are read-only (#50318)
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
jrodewig authored Dec 18, 2019
1 parent 4d8d8d9 commit a762c29
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions docs/reference/indices/apis/freeze.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,10 @@ Freezes an index.
[[freeze-index-api-desc]]
==== {api-description-title}

A frozen index has almost no overhead on the cluster (except
for maintaining its metadata in memory), and is blocked for write operations.
See <<frozen-indices>> and <<unfreeze-index-api>>.
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>>.

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

0 comments on commit a762c29

Please sign in to comment.