honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[DOCS] Clarify frozen indices are read-only (#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.
This commit is contained in:
James Rodewig 2019-12-18 12:17:41 -05:00
parent ef54a9c23c
commit 498532a12d
1 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/reference/indices/apis/freeze.asciidoc
View File

@ -19,9 +19,10 @@ Freezes an index.
[[freeze-index-api-desc]] [[freeze-index-api-desc]]
==== {api-description-title} ==== {api-description-title}
A frozen index has almost no overhead on the cluster (except A frozen index has almost no overhead on the cluster (except for maintaining its
for maintaining its metadata in memory), and is blocked for write operations. metadata in memory) and is read-only. Read-only indices are blocked for write
See <<frozen-indices>> and <<unfreeze-index-api>>. 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 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 API call. This causes primaries to not be allocated for a short amount of time